305 lines
98 KiB
HTML
305 lines
98 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EditorToolbarCodec | @maxgraph/core</title><meta name="description" content="Documentation for @maxgraph/core"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@maxgraph/core</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">@maxgraph/core</a></li><li><a href="EditorToolbarCodec.html">EditorToolbarCodec</a></li></ul><h1>Class EditorToolbarCodec</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Custom codec for configuring <EditorToolbar>s. This class is created
|
|
and registered dynamically at load time and used implicitly via
|
|
<Codec> and the <CodecRegistry>. This codec only reads configuration
|
|
data for existing toolbars handlers, it does not encode or create toolbars.</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="ObjectCodec.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectCodec</a><ul class="tsd-hierarchy"><li><span class="target">EditorToolbarCodec</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="EditorToolbarCodec.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#exclude" class="tsd-kind-icon">exclude</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#idrefs" class="tsd-kind-icon">idrefs</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#mapping" class="tsd-kind-icon">mapping</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#reverse" class="tsd-kind-icon">reverse</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#template" class="tsd-kind-icon">template</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="EditorToolbarCodec.html#allowEval" class="tsd-kind-icon">allow<wbr/>Eval</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#addObjectValue" class="tsd-kind-icon">add<wbr/>Object<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#afterDecode" class="tsd-kind-icon">after<wbr/>Decode</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#afterEncode" class="tsd-kind-icon">after<wbr/>Encode</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#beforeDecode" class="tsd-kind-icon">before<wbr/>Decode</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#beforeEncode" class="tsd-kind-icon">before<wbr/>Encode</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#cloneTemplate" class="tsd-kind-icon">clone<wbr/>Template</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#convertAttributeFromXml" class="tsd-kind-icon">convert<wbr/>Attribute<wbr/>From<wbr/>Xml</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#convertAttributeToXml" class="tsd-kind-icon">convert<wbr/>Attribute<wbr/>To<wbr/>Xml</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="EditorToolbarCodec.html#decode" class="tsd-kind-icon">decode</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#decodeAttribute" class="tsd-kind-icon">decode<wbr/>Attribute</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#decodeAttributes" class="tsd-kind-icon">decode<wbr/>Attributes</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#decodeChild" class="tsd-kind-icon">decode<wbr/>Child</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#decodeChildren" class="tsd-kind-icon">decode<wbr/>Children</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#decodeNode" class="tsd-kind-icon">decode<wbr/>Node</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="EditorToolbarCodec.html#encode" class="tsd-kind-icon">encode</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#encodeObject" class="tsd-kind-icon">encode<wbr/>Object</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#encodeValue" class="tsd-kind-icon">encode<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#getAttributeName" class="tsd-kind-icon">get<wbr/>Attribute<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#getFieldName" class="tsd-kind-icon">get<wbr/>Field<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#getFieldTemplate" class="tsd-kind-icon">get<wbr/>Field<wbr/>Template</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#getName" class="tsd-kind-icon">get<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#isBooleanAttribute" class="tsd-kind-icon">is<wbr/>Boolean<wbr/>Attribute</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#isExcluded" class="tsd-kind-icon">is<wbr/>Excluded</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#isIgnoredAttribute" class="tsd-kind-icon">is<wbr/>Ignored<wbr/>Attribute</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#isNumericAttribute" class="tsd-kind-icon">is<wbr/>Numeric<wbr/>Attribute</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#isReference" class="tsd-kind-icon">is<wbr/>Reference</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#processInclude" class="tsd-kind-icon">process<wbr/>Include</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#writeAttribute" class="tsd-kind-icon">write<wbr/>Attribute</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#writeComplexAttribute" class="tsd-kind-icon">write<wbr/>Complex<wbr/>Attribute</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#writePrimitiveAttribute" class="tsd-kind-icon">write<wbr/>Primitive<wbr/>Attribute</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Editor<wbr/>Toolbar<wbr/>Codec<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="EditorToolbarCodec.html" class="tsd-signature-type" data-tsd-kind="Class">EditorToolbarCodec</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/editor/EditorToolbar.ts#L454">editor/EditorToolbar.ts:454</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="EditorToolbarCodec.html" class="tsd-signature-type" data-tsd-kind="Class">EditorToolbarCodec</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="exclude" class="tsd-anchor"></a><h3>exclude</h3><div class="tsd-signature tsd-kind-icon">exclude<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#exclude">exclude</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L226">serialization/ObjectCodec.ts:226</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Array containing the variable names that should be
|
|
ignored by the codec.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="idrefs" class="tsd-anchor"></a><h3>idrefs</h3><div class="tsd-signature tsd-kind-icon">idrefs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#idrefs">idrefs</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L233">serialization/ObjectCodec.ts:233</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Array containing the variable names that should be
|
|
turned into or converted from references. See
|
|
<a href="Codec.html#getId">Codec.getId</a> and <a href="Codec.html#getObject">Codec.getObject</a>.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="mapping" class="tsd-anchor"></a><h3>mapping</h3><div class="tsd-signature tsd-kind-icon">mapping<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#mapping">mapping</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L238">serialization/ObjectCodec.ts:238</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Maps from from fieldnames to XML attribute names.</p>
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="reverse" class="tsd-anchor"></a><h3>reverse</h3><div class="tsd-signature tsd-kind-icon">reverse<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#reverse">reverse</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L243">serialization/ObjectCodec.ts:243</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Maps from from XML attribute names to fieldnames.</p>
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="template" class="tsd-anchor"></a><h3>template</h3><div class="tsd-signature tsd-kind-icon">template<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#template">template</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L220">serialization/ObjectCodec.ts:220</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Holds the template object associated with this codec.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a id="allowEval" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> allow<wbr/>Eval</h3><div class="tsd-signature tsd-kind-icon">allow<wbr/>Eval<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#allowEval">allowEval</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L215">serialization/ObjectCodec.ts:215</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Static global switch that specifies if expressions in arrays are allowed.
|
|
Default is false. NOTE: Enabling this carries a possible security risk.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="addObjectValue" class="tsd-anchor"></a><h3>add<wbr/>Object<wbr/>Value</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">add<wbr/>Object<wbr/>Value<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, fieldname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, template<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#addObjectValue">addObjectValue</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L823">serialization/ObjectCodec.ts:823</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sets the decoded child node as a value of the given object. If the
|
|
object is a map, then the value is added with the given fieldname as a
|
|
key. If the fieldname is not empty, then setFieldValue is called or
|
|
else, if the object is a collection, the value is added to the
|
|
collection. For strongly typed languages it may be required to
|
|
override this with the correct code to add an entry to an object.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>obj: <span class="tsd-signature-type">any</span></h5></li><li><h5>fieldname: <span class="tsd-signature-type">string</span></h5></li><li><h5>value: <span class="tsd-signature-type">any</span></h5></li><li><h5>template: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="afterDecode" class="tsd-anchor"></a><h3>after<wbr/>Decode</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">after<wbr/>Decode<span class="tsd-signature-symbol">(</span>dec<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span>, obj<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#afterDecode">afterDecode</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L889">serialization/ObjectCodec.ts:889</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Hook for subclassers to post-process the object after
|
|
decoding. This implementation returns the given object
|
|
without any changes. The return value of this method
|
|
is returned to the decoder from <a href="EditorToolbarCodec.html#decode">decode</a>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>dec: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5></li><li><h5>node: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>XML node to be decoded.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Object that represents the default decoding.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="afterEncode" class="tsd-anchor"></a><h3>after<wbr/>Encode</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">after<wbr/>Encode<span class="tsd-signature-symbol">(</span>enc<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#afterEncode">afterEncode</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L591">serialization/ObjectCodec.ts:591</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Hook for subclassers to post-process the node
|
|
for the given object after encoding and return the
|
|
post-processed node. This implementation returns
|
|
the input node. The return value of this method
|
|
is returned to the encoder from <a href="EditorToolbarCodec.html#encode">encode</a>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>enc: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="Codec.html">Codec</a> that controls the encoding process.</p>
|
|
</div></div></li><li><h5>obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Object to be encoded.</p>
|
|
</div></div></li><li><h5>node: <span class="tsd-signature-type">Element</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>XML node that represents the default encoding.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="beforeDecode" class="tsd-anchor"></a><h3>before<wbr/>Decode</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">before<wbr/>Decode<span class="tsd-signature-symbol">(</span>dec<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#beforeDecode">beforeDecode</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L875">serialization/ObjectCodec.ts:875</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Hook for subclassers to pre-process the node for
|
|
the specified object and return the node to be
|
|
used for further processing by <a href="EditorToolbarCodec.html#decode">decode</a>.
|
|
The object is created based on the template in the
|
|
calling method and is never null. This implementation
|
|
returns the input node. The return value of this
|
|
function is used in <a href="EditorToolbarCodec.html#decode">decode</a> to perform
|
|
the default decoding into the given object.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>dec: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="Codec.html">Codec</a> that controls the decoding process.</p>
|
|
</div></div></li><li><h5>node: <span class="tsd-signature-type">Element</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>XML node to be decoded.</p>
|
|
</div></div></li><li><h5>obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Object to encode the node into.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="beforeEncode" class="tsd-anchor"></a><h3>before<wbr/>Encode</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">before<wbr/>Encode<span class="tsd-signature-symbol">(</span>enc<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, node<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#beforeEncode">beforeEncode</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L576">serialization/ObjectCodec.ts:576</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Hook for subclassers to pre-process the object before
|
|
encoding. This returns the input object. The return
|
|
value of this function is used in <a href="EditorToolbarCodec.html#encode">encode</a> to perform
|
|
the default encoding into the given node.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>enc: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="Codec.html">Codec</a> that controls the encoding process.</p>
|
|
</div></div></li><li><h5>obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Object to be encoded.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> node: <span class="tsd-signature-type">Element</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>XML node to encode the object into.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="cloneTemplate" class="tsd-anchor"></a><h3>clone<wbr/>Template</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">clone<wbr/>Template<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#cloneTemplate">cloneTemplate</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L259">serialization/ObjectCodec.ts:259</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns a new instance of the template for this codec.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="convertAttributeFromXml" class="tsd-anchor"></a><h3>convert<wbr/>Attribute<wbr/>From<wbr/>Xml</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">convert<wbr/>Attribute<wbr/>From<wbr/>Xml<span class="tsd-signature-symbol">(</span>dec<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, attr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#convertAttributeFromXml">convertAttributeFromXml</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L531">serialization/ObjectCodec.ts:531</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Converts booleans and numeric values to the respective types. Values are
|
|
numeric if <a href="EditorToolbarCodec.html#isNumericAttribute">isNumericAttribute</a> returns true.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>dec: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="Codec.html">Codec</a> that controls the decoding process.</p>
|
|
</div></div></li><li><h5>attr: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>XML attribute to be converted.</p>
|
|
</div></div></li><li><h5>obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Objec to convert the attribute for.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="convertAttributeToXml" class="tsd-anchor"></a><h3>convert<wbr/>Attribute<wbr/>To<wbr/>Xml</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">convert<wbr/>Attribute<wbr/>To<wbr/>Xml<span class="tsd-signature-symbol">(</span>enc<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#convertAttributeToXml">convertAttributeToXml</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L501">serialization/ObjectCodec.ts:501</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Converts true to "1" and false to "0" is <a href="EditorToolbarCodec.html#isBooleanAttribute">isBooleanAttribute</a> returns true.
|
|
All other values are not converted.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>enc: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="Codec.html">Codec</a> that controls the encoding process.</p>
|
|
</div></div></li><li><h5>obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Objec to convert the attribute for.</p>
|
|
</div></div></li><li><h5>name: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Name of the attribute to be converted.</p>
|
|
</div></div></li><li><h5>value: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Value to be converted.</p>
|
|
</div></div></li><li><h5>node: <span class="tsd-signature-type">Element</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a id="decode" class="tsd-anchor"></a><h3>decode</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">decode<span class="tsd-signature-symbol">(</span>dec<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, _node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span>, into<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#decode">decode</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/editor/EditorToolbar.ts#L555">editor/EditorToolbar.ts:555</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Reads a sequence of the following child nodes
|
|
and attributes:</p>
|
|
</div><div><p>Child Nodes:</p>
|
|
<p>add - Adds a new item to the toolbar. See below for attributes.
|
|
separator - Adds a vertical separator. No attributes.
|
|
hr - Adds a horizontal separator. No attributes.
|
|
br - Adds a linefeed. No attributes.</p>
|
|
<p>Attributes:</p>
|
|
<p>as - Resource key for the label.
|
|
action - Name of the action to execute in enclosing editor.
|
|
mode - Modename (see below).
|
|
template - Template name for cell insertion.
|
|
style - Optional style to override the template style.
|
|
icon - Icon (relative/absolute URL).
|
|
pressedIcon - Optional icon for pressed state (relative/absolute URL).
|
|
id - Optional ID to be used for the created DOM element.
|
|
toggle - Optional 0 or 1 to disable toggling of the element. Default is
|
|
1 (true).</p>
|
|
<p>The action, mode and template attributes are mutually exclusive. The
|
|
style can only be used with the template attribute. The add node may
|
|
contain another sequence of add nodes with as and action attributes
|
|
to create a combo box in the toolbar. If the icon is specified then
|
|
a list of the child node is expected to have its template attribute
|
|
set and the action is ignored instead.</p>
|
|
<p>Nodes with a specified template may define a function to be used for
|
|
inserting the cloned template into the graph. Here is an example of such
|
|
a node:</p>
|
|
<pre><code class="language-javascript"><span class="hl-11"><</span><span class="hl-12">add</span><span class="hl-1"> </span><span class="hl-13">as</span><span class="hl-1">=</span><span class="hl-6">"Swimlane"</span><span class="hl-1"> </span><span class="hl-13">template</span><span class="hl-1">=</span><span class="hl-6">"swimlane"</span><span class="hl-1"> </span><span class="hl-13">icon</span><span class="hl-1">=</span><span class="hl-6">"images/swimlane.gif"</span><span class="hl-11">></span><span class="hl-1"><![CDATA[</span><br/><span class="hl-1"> function (editor, cell, evt, targetCell)</span><br/><span class="hl-1"> </span><span class="hl-3">{</span><br/><span class="hl-14"> </span><span class="hl-0">let</span><span class="hl-14"> </span><span class="hl-0">pt</span><span class="hl-14"> </span><span class="hl-1">=</span><span class="hl-14"> </span><span class="hl-0">mxUtils</span><span class="hl-14">.</span><span class="hl-2">convertPoint</span><span class="hl-14">(</span><br/><span class="hl-14"> </span><span class="hl-0">editor</span><span class="hl-14">.</span><span class="hl-0">graph</span><span class="hl-14">.</span><span class="hl-0">container</span><span class="hl-14">, </span><span class="hl-0">mxEvent</span><span class="hl-14">.</span><span class="hl-2">getClientX</span><span class="hl-14">(</span><span class="hl-0">evt</span><span class="hl-14">),</span><br/><span class="hl-14"> </span><span class="hl-0">mxEvent</span><span class="hl-14">.</span><span class="hl-2">getClientY</span><span class="hl-14">(</span><span class="hl-0">evt</span><span class="hl-14">));</span><br/><span class="hl-14"> </span><span class="hl-0">return</span><span class="hl-14"> </span><span class="hl-0">editor</span><span class="hl-14">.</span><span class="hl-2">addVertex</span><span class="hl-14">(</span><span class="hl-0">targetCell</span><span class="hl-14">, </span><span class="hl-0">cell</span><span class="hl-14">, </span><span class="hl-0">pt</span><span class="hl-14">.</span><span class="hl-0">x</span><span class="hl-14">, </span><span class="hl-0">pt</span><span class="hl-14">.</span><span class="hl-0">y</span><span class="hl-14">);</span><br/><span class="hl-14"> </span><span class="hl-3">}</span><br/><span class="hl-1">]]></span><span class="hl-11"></</span><span class="hl-12">add</span><span class="hl-11">></span>
|
|
</code></pre>
|
|
<p>In the above function, editor is the enclosing <Editor> instance, cell
|
|
is the clone of the template, evt is the mouse event that represents the
|
|
drop and targetCell is the cell under the mousepointer where the drop
|
|
occurred. The targetCell is retrieved using {@link Graph#getCellAt}.</p>
|
|
<p>Futhermore, nodes with the mode attribute may define a function to
|
|
be executed upon selection of the respective toolbar icon. In the
|
|
example below, the default edge style is set when this specific
|
|
connect-mode is activated:</p>
|
|
<pre><code class="language-javascript"><span class="hl-11"><</span><span class="hl-12">add</span><span class="hl-1"> </span><span class="hl-13">as</span><span class="hl-1">=</span><span class="hl-6">"connect"</span><span class="hl-1"> </span><span class="hl-13">mode</span><span class="hl-1">=</span><span class="hl-6">"connect"</span><span class="hl-11">></span><span class="hl-1"><![CDATA[</span><br/><span class="hl-1"> function (editor)</span><br/><span class="hl-1"> </span><span class="hl-3">{</span><br/><span class="hl-14"> </span><span class="hl-2">if</span><span class="hl-14"> (</span><span class="hl-0">editor</span><span class="hl-14">.</span><span class="hl-0">defaultEdge</span><span class="hl-14"> </span><span class="hl-1">!=</span><span class="hl-14"> </span><span class="hl-3">null</span><span class="hl-14">)</span><br/><span class="hl-14"> {</span><br/><span class="hl-14"> editor.defaultEdge.</span><span class="hl-0">style</span><span class="hl-14"> </span><span class="hl-1">=</span><span class="hl-14"> </span><span class="hl-6">'straightEdge'</span><span class="hl-14">;</span><br/><span class="hl-14"> }</span><br/><span class="hl-14"> </span><span class="hl-3">}</span><br/><span class="hl-1">]]></span><span class="hl-11"></</span><span class="hl-12">add</span><span class="hl-11">></span>
|
|
</code></pre>
|
|
<p>Both functions require <DefaultToolbarCodec.allowEval> to be set to true.</p>
|
|
<p>Modes:</p>
|
|
<p>select - Left mouse button used for rubberband- & cell-selection.
|
|
connect - Allows connecting vertices by inserting new edges.
|
|
pan - Disables selection and switches to panning on the left button.</p>
|
|
<p>Example:</p>
|
|
<p>To add items to the toolbar:</p>
|
|
<pre><code class="language-javascript"><span class="hl-11"><</span><span class="hl-10">EditorToolbar</span><span class="hl-1"> </span><span class="hl-13">as</span><span class="hl-1">=</span><span class="hl-6">"toolbar"</span><span class="hl-11">></span><br/><span class="hl-1"> </span><span class="hl-11"><</span><span class="hl-12">add</span><span class="hl-1"> </span><span class="hl-13">as</span><span class="hl-1">=</span><span class="hl-6">"save"</span><span class="hl-1"> </span><span class="hl-13">action</span><span class="hl-1">=</span><span class="hl-6">"save"</span><span class="hl-1"> </span><span class="hl-13">icon</span><span class="hl-1">=</span><span class="hl-6">"images/save.gif"</span><span class="hl-11">/></span><br/><span class="hl-1"> </span><span class="hl-11"><</span><span class="hl-12">br</span><span class="hl-11">/><</span><span class="hl-12">hr</span><span class="hl-11">/></span><br/><span class="hl-1"> </span><span class="hl-11"><</span><span class="hl-12">add</span><span class="hl-1"> </span><span class="hl-13">as</span><span class="hl-1">=</span><span class="hl-6">"select"</span><span class="hl-1"> </span><span class="hl-13">mode</span><span class="hl-1">=</span><span class="hl-6">"select"</span><span class="hl-1"> </span><span class="hl-13">icon</span><span class="hl-1">=</span><span class="hl-6">"images/select.gif"</span><span class="hl-11">/></span><br/><span class="hl-1"> </span><span class="hl-11"><</span><span class="hl-12">add</span><span class="hl-1"> </span><span class="hl-13">as</span><span class="hl-1">=</span><span class="hl-6">"connect"</span><span class="hl-1"> </span><span class="hl-13">mode</span><span class="hl-1">=</span><span class="hl-6">"connect"</span><span class="hl-1"> </span><span class="hl-13">icon</span><span class="hl-1">=</span><span class="hl-6">"images/connect.gif"</span><span class="hl-11">/></span><br/><span class="hl-11"></</span><span class="hl-10">EditorToolbar</span><span class="hl-11">></span>
|
|
</code></pre>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>dec: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5></li><li><h5>_node: <span class="tsd-signature-type">Element</span></h5></li><li><h5>into: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="decodeAttribute" class="tsd-anchor"></a><h3>decode<wbr/>Attribute</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Attribute<span class="tsd-signature-symbol">(</span>dec<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, attr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, obj<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#decodeAttribute">decodeAttribute</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L712">serialization/ObjectCodec.ts:712</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Reads the given attribute into the specified object.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>dec: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="Codec.html">Codec</a> that controls the decoding process.</p>
|
|
</div></div></li><li><h5>attr: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>XML attribute to be decoded.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Objec to encode the attribute into.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="decodeAttributes" class="tsd-anchor"></a><h3>decode<wbr/>Attributes</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Attributes<span class="tsd-signature-symbol">(</span>dec<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#decodeAttributes">decodeAttributes</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L683">serialization/ObjectCodec.ts:683</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Decodes all attributes of the given node using <a href="EditorToolbarCodec.html#decodeAttribute">decodeAttribute</a>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>dec: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="Codec.html">Codec</a> that controls the decoding process.</p>
|
|
</div></div></li><li><h5>node: <span class="tsd-signature-type">Element</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>XML node to be decoded.</p>
|
|
</div></div></li><li><h5>obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Objec to encode the node into.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="decodeChild" class="tsd-anchor"></a><h3>decode<wbr/>Child</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Child<span class="tsd-signature-symbol">(</span>dec<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, child<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#decodeChild">decodeChild</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L771">serialization/ObjectCodec.ts:771</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Reads the specified child into the given object.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>dec: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="Codec.html">Codec</a> that controls the decoding process.</p>
|
|
</div></div></li><li><h5>child: <span class="tsd-signature-type">Element</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>XML child element to be decoded.</p>
|
|
</div></div></li><li><h5>obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Objec to encode the node into.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="decodeChildren" class="tsd-anchor"></a><h3>decode<wbr/>Children</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Children<span class="tsd-signature-symbol">(</span>dec<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span>, obj<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#decodeChildren">decodeChildren</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L750">serialization/ObjectCodec.ts:750</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Decodes all children of the given node using <a href="EditorToolbarCodec.html#decodeChild">decodeChild</a>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>dec: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="Codec.html">Codec</a> that controls the decoding process.</p>
|
|
</div></div></li><li><h5>node: <span class="tsd-signature-type">Element</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>XML node to be decoded.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Objec to encode the node into.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="decodeNode" class="tsd-anchor"></a><h3>decode<wbr/>Node</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Node<span class="tsd-signature-symbol">(</span>dec<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#decodeNode">decodeNode</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L669">serialization/ObjectCodec.ts:669</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Calls <a href="EditorToolbarCodec.html#decodeAttributes">decodeAttributes</a> and <a href="EditorToolbarCodec.html#decodeChildren">decodeChildren</a> for the given node.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>dec: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="Codec.html">Codec</a> that controls the decoding process.</p>
|
|
</div></div></li><li><h5>node: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>XML node to be decoded.</p>
|
|
</div></div></li><li><h5>obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Objec to encode the node into.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a id="encode" class="tsd-anchor"></a><h3>encode</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">encode<span class="tsd-signature-symbol">(</span>enc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#encode">encode</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/editor/EditorToolbar.ts#L461">editor/EditorToolbar.ts:461</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns null.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>enc: <span class="tsd-signature-type">any</span></h5></li><li><h5>obj: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="encodeObject" class="tsd-anchor"></a><h3>encode<wbr/>Object</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">encode<wbr/>Object<span class="tsd-signature-symbol">(</span>enc<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#encodeObject">encodeObject</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L383">serialization/ObjectCodec.ts:383</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Encodes the value of each member in then given obj into the given node using
|
|
<a href="EditorToolbarCodec.html#encodeValue">encodeValue</a>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>enc: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="Codec.html">Codec</a> that controls the encoding process.</p>
|
|
</div></div></li><li><h5>obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Object to be encoded.</p>
|
|
</div></div></li><li><h5>node: <span class="tsd-signature-type">Element</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>XML node that contains the encoded object.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="encodeValue" class="tsd-anchor"></a><h3>encode<wbr/>Value</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">encode<wbr/>Value<span class="tsd-signature-symbol">(</span>enc<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#encodeValue">encodeValue</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L411">serialization/ObjectCodec.ts:411</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Converts the given value according to the mappings
|
|
and id-refs in this codec and uses <a href="EditorToolbarCodec.html#writeAttribute">writeAttribute</a>
|
|
to write the attribute into the given node.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>enc: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="Codec.html">Codec</a> that controls the encoding process.</p>
|
|
</div></div></li><li><h5>obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Object whose property is going to be encoded.</p>
|
|
</div></div></li><li><h5>name: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>XML node that contains the encoded object.</p>
|
|
</div></div></li><li><h5>value: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Value of the property to be encoded.</p>
|
|
</div></div></li><li><h5>node: <span class="tsd-signature-type">Element</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>XML node that contains the encoded object.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getAttributeName" class="tsd-anchor"></a><h3>get<wbr/>Attribute<wbr/>Name</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Attribute<wbr/>Name<span class="tsd-signature-symbol">(</span>fieldname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#getAttributeName">getAttributeName</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L287">serialization/ObjectCodec.ts:287</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the attributename for the given fieldname.
|
|
Looks up the value in the <a href="EditorToolbarCodec.html#mapping">mapping</a> or returns
|
|
the input if there is no mapping for the
|
|
given name.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>fieldname: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getFieldName" class="tsd-anchor"></a><h3>get<wbr/>Field<wbr/>Name</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Field<wbr/>Name<span class="tsd-signature-symbol">(</span>attributename<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#getFieldName">getFieldName</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L269">serialization/ObjectCodec.ts:269</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the fieldname for the given attributename.
|
|
Looks up the value in the <a href="EditorToolbarCodec.html#reverse">reverse</a> mapping or returns
|
|
the input if there is no reverse mapping for the
|
|
given name.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>attributename: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getFieldTemplate" class="tsd-anchor"></a><h3>get<wbr/>Field<wbr/>Template</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Field<wbr/>Template<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, fieldname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, child<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#getFieldTemplate">getFieldTemplate</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L804">serialization/ObjectCodec.ts:804</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the template instance for the given field. This returns the
|
|
value of the field, null if the value is an array or an empty collection
|
|
if the value is a collection. The value is then used to populate the
|
|
field for a new instance. For strongly typed languages it may be
|
|
required to override this to return the correct collection instance
|
|
based on the encoded child.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>obj: <span class="tsd-signature-type">any</span></h5></li><li><h5>fieldname: <span class="tsd-signature-type">string</span></h5></li><li><h5>child: <span class="tsd-signature-type">Element</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="getName" class="tsd-anchor"></a><h3>get<wbr/>Name</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#getName">getName</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L252">serialization/ObjectCodec.ts:252</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the name used for the nodenames and lookup of the codec when
|
|
classes are encoded and nodes are decoded. For classes to work with
|
|
this the codec registry automatically adds an alias for the classname
|
|
if that is different than what this returns. The default implementation
|
|
returns the classname of the template class.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="isBooleanAttribute" class="tsd-anchor"></a><h3>is<wbr/>Boolean<wbr/>Attribute</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Boolean<wbr/>Attribute<span class="tsd-signature-symbol">(</span>enc<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#isBooleanAttribute">isBooleanAttribute</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L519">serialization/ObjectCodec.ts:519</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns true if the given object attribute is a boolean value.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>enc: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="Codec.html">Codec</a> that controls the encoding process.</p>
|
|
</div></div></li><li><h5>obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Objec to convert the attribute for.</p>
|
|
</div></div></li><li><h5>name: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Name of the attribute to be converted.</p>
|
|
</div></div></li><li><h5>value: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Value of the attribute to be converted.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="isExcluded" class="tsd-anchor"></a><h3>is<wbr/>Excluded</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Excluded<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, attr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, write<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#isExcluded">isExcluded</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L309">serialization/ObjectCodec.ts:309</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns true if the given attribute is to be ignored by the codec. This
|
|
implementation returns true if the given fieldname is in <a href="EditorToolbarCodec.html#exclude">exclude</a> or
|
|
if the fieldname equals <a href="ObjectIdentity.html#FIELD_NAME">ObjectIdentity.FIELD_NAME</a>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Object instance that contains the field.</p>
|
|
</div></div></li><li><h5>attr: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Fieldname of the field.</p>
|
|
</div></div></li><li><h5>value: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Value of the field.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> write: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Boolean indicating if the field is being encoded or decoded.
|
|
Write is true if the field is being encoded, else it is being decoded.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="isIgnoredAttribute" class="tsd-anchor"></a><h3>is<wbr/>Ignored<wbr/>Attribute</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Ignored<wbr/>Attribute<span class="tsd-signature-symbol">(</span>dec<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, attr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, obj<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#isIgnoredAttribute">isIgnoredAttribute</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L701">serialization/ObjectCodec.ts:701</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns true if the given attribute should be ignored. This implementation
|
|
returns true if the attribute name is "as" or "id".</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>dec: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="Codec.html">Codec</a> that controls the decoding process.</p>
|
|
</div></div></li><li><h5>attr: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>XML attribute to be decoded.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Objec to encode the attribute into.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="isNumericAttribute" class="tsd-anchor"></a><h3>is<wbr/>Numeric<wbr/>Attribute</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Numeric<wbr/>Attribute<span class="tsd-signature-symbol">(</span>dec<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, attr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#isNumericAttribute">isNumericAttribute</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L552">serialization/ObjectCodec.ts:552</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns true if the given XML attribute is or should be a numeric value.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>dec: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="Codec.html">Codec</a> that controls the decoding process.</p>
|
|
</div></div></li><li><h5>attr: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>XML attribute to be converted.</p>
|
|
</div></div></li><li><h5>obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Objec to convert the attribute for.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="isReference" class="tsd-anchor"></a><h3>is<wbr/>Reference</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Reference<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, attr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, write<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#isReference">isReference</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L324">serialization/ObjectCodec.ts:324</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns true if the given fieldname is to be treated
|
|
as a textual reference (ID). This implementation returns
|
|
true if the given fieldname is in <a href="EditorToolbarCodec.html#idrefs">idrefs</a>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Object instance that contains the field.</p>
|
|
</div></div></li><li><h5>attr: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Fieldname of the field.</p>
|
|
</div></div></li><li><h5>value: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Value of the field.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> write: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Boolean indicating if the field is being encoded or decoded.
|
|
Write is true if the field is being encoded, else it is being decoded.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="processInclude" class="tsd-anchor"></a><h3>process<wbr/>Include</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">process<wbr/>Include<span class="tsd-signature-symbol">(</span>dec<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span>, into<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#processInclude">processInclude</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L843">serialization/ObjectCodec.ts:843</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns true if the given node is an include directive and
|
|
executes the include by decoding the XML document. Returns
|
|
false if the given node is not an include directive.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>dec: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="Codec.html">Codec</a> that controls the encoding/decoding process.</p>
|
|
</div></div></li><li><h5>node: <span class="tsd-signature-type">Element</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>XML node to be checked.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> into: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optional object to pass-thru to the codec.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="writeAttribute" class="tsd-anchor"></a><h3>write<wbr/>Attribute</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">write<wbr/>Attribute<span class="tsd-signature-symbol">(</span>enc<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#writeAttribute">writeAttribute</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L440">serialization/ObjectCodec.ts:440</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Writes the given value into node using <a href="EditorToolbarCodec.html#writePrimitiveAttribute">writePrimitiveAttribute</a>
|
|
or <a href="EditorToolbarCodec.html#writeComplexAttribute">writeComplexAttribute</a> depending on the type of the value.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>enc: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5></li><li><h5>obj: <span class="tsd-signature-type">any</span></h5></li><li><h5>name: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li><li><h5>value: <span class="tsd-signature-type">any</span></h5></li><li><h5>node: <span class="tsd-signature-type">Element</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="writeComplexAttribute" class="tsd-anchor"></a><h3>write<wbr/>Complex<wbr/>Attribute</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">write<wbr/>Complex<wbr/>Attribute<span class="tsd-signature-symbol">(</span>enc<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#writeComplexAttribute">writeComplexAttribute</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L478">serialization/ObjectCodec.ts:478</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Writes the given value as a child node of the given node.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>enc: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5></li><li><h5>obj: <span class="tsd-signature-type">any</span></h5></li><li><h5>name: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li><li><h5>value: <span class="tsd-signature-type">any</span></h5></li><li><h5>node: <span class="tsd-signature-type">Element</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="writePrimitiveAttribute" class="tsd-anchor"></a><h3>write<wbr/>Primitive<wbr/>Attribute</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">write<wbr/>Primitive<wbr/>Attribute<span class="tsd-signature-symbol">(</span>enc<span class="tsd-signature-symbol">: </span><a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ObjectCodec.html">ObjectCodec</a>.<a href="ObjectCodec.html#writePrimitiveAttribute">writePrimitiveAttribute</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/ObjectCodec.ts#L451">serialization/ObjectCodec.ts:451</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Writes the given value as an attribute of the given node.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>enc: <a href="Codec.html" class="tsd-signature-type" data-tsd-kind="Class">Codec</a></h5></li><li><h5>obj: <span class="tsd-signature-type">any</span></h5></li><li><h5>name: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li><li><h5>value: <span class="tsd-signature-type">any</span></h5></li><li><h5>node: <span class="tsd-signature-type">Element</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/DomHelpers.html">Dom<wbr/>Helpers</a></li><li class=" tsd-kind-namespace"><a href="../modules/cloneUtils.html">clone<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/constants.html">constants</a></li><li class=" tsd-kind-namespace"><a href="../modules/domUtils.html">dom<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/eventUtils.html">event<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/gestureUtils.html">gesture<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/mathUtils.html">math<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/stringUtils.html">string<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/styleUtils.html">style<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/xmlUtils.html">xml<wbr/>Utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="EditorToolbarCodec.html" class="tsd-kind-icon">Editor<wbr/>Toolbar<wbr/>Codec</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="EditorToolbarCodec.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#exclude" class="tsd-kind-icon">exclude</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#idrefs" class="tsd-kind-icon">idrefs</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#mapping" class="tsd-kind-icon">mapping</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#reverse" class="tsd-kind-icon">reverse</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#template" class="tsd-kind-icon">template</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="EditorToolbarCodec.html#allowEval" class="tsd-kind-icon">allow<wbr/>Eval</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#addObjectValue" class="tsd-kind-icon">add<wbr/>Object<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#afterDecode" class="tsd-kind-icon">after<wbr/>Decode</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#afterEncode" class="tsd-kind-icon">after<wbr/>Encode</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#beforeDecode" class="tsd-kind-icon">before<wbr/>Decode</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#beforeEncode" class="tsd-kind-icon">before<wbr/>Encode</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#cloneTemplate" class="tsd-kind-icon">clone<wbr/>Template</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#convertAttributeFromXml" class="tsd-kind-icon">convert<wbr/>Attribute<wbr/>From<wbr/>Xml</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#convertAttributeToXml" class="tsd-kind-icon">convert<wbr/>Attribute<wbr/>To<wbr/>Xml</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="EditorToolbarCodec.html#decode" class="tsd-kind-icon">decode</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#decodeAttribute" class="tsd-kind-icon">decode<wbr/>Attribute</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#decodeAttributes" class="tsd-kind-icon">decode<wbr/>Attributes</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#decodeChild" class="tsd-kind-icon">decode<wbr/>Child</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#decodeChildren" class="tsd-kind-icon">decode<wbr/>Children</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#decodeNode" class="tsd-kind-icon">decode<wbr/>Node</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="EditorToolbarCodec.html#encode" class="tsd-kind-icon">encode</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#encodeObject" class="tsd-kind-icon">encode<wbr/>Object</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#encodeValue" class="tsd-kind-icon">encode<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#getAttributeName" class="tsd-kind-icon">get<wbr/>Attribute<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#getFieldName" class="tsd-kind-icon">get<wbr/>Field<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#getFieldTemplate" class="tsd-kind-icon">get<wbr/>Field<wbr/>Template</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#getName" class="tsd-kind-icon">get<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#isBooleanAttribute" class="tsd-kind-icon">is<wbr/>Boolean<wbr/>Attribute</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#isExcluded" class="tsd-kind-icon">is<wbr/>Excluded</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#isIgnoredAttribute" class="tsd-kind-icon">is<wbr/>Ignored<wbr/>Attribute</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#isNumericAttribute" class="tsd-kind-icon">is<wbr/>Numeric<wbr/>Attribute</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#isReference" class="tsd-kind-icon">is<wbr/>Reference</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#processInclude" class="tsd-kind-icon">process<wbr/>Include</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#writeAttribute" class="tsd-kind-icon">write<wbr/>Attribute</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#writeComplexAttribute" class="tsd-kind-icon">write<wbr/>Complex<wbr/>Attribute</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="EditorToolbarCodec.html#writePrimitiveAttribute" class="tsd-kind-icon">write<wbr/>Primitive<wbr/>Attribute</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |