refactor(docs): move all docs sources to a dedicated docs package (#168)
Keep the former mxGraph documentation to allow a later documentation migration. Remove both the former mxGraph and the new maxGraph API docs as they can be generated. Remove the former mxGraph examples home page as it has been replaced by Storybook. Update the configuration to generate the maxGraph API docs - remove jsdoc resources as it is not used anymore - configure the core package to generate the API docs in the docs package - add a GitHub workflow to ensure we can generate the API docs without errorsdevelopment
Thomas Bouffard
GitHub
parent
3d1d68afd7
commit
ed2ae41428
|
|
@ -0,0 +1,26 @@
|
|||
name: Generate documentation
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- development
|
||||
paths:
|
||||
- '.github/workflows/generate-documentation.yml'
|
||||
- 'packages/core/*'
|
||||
- 'packages/docs/*'
|
||||
- 'package.json'
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-22.04
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- name: Setup node
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version-file: '.nvmrc'
|
||||
- name: Install dependencies
|
||||
run: npm install
|
||||
- name: Build @maxgraph/core API docs
|
||||
working-directory: packages/core
|
||||
run: npm run docs:api
|
||||
|
|
@ -1 +0,0 @@
|
|||
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
|
||||
|
|
@ -1,155 +0,0 @@
|
|||
:root {
|
||||
--light-hl-0: #001080;
|
||||
--dark-hl-0: #9CDCFE;
|
||||
--light-hl-1: #000000;
|
||||
--dark-hl-1: #D4D4D4;
|
||||
--light-hl-2: #795E26;
|
||||
--dark-hl-2: #DCDCAA;
|
||||
--light-hl-3: #0000FF;
|
||||
--dark-hl-3: #569CD6;
|
||||
--light-hl-4: #008000;
|
||||
--dark-hl-4: #6A9955;
|
||||
--light-hl-5: #AF00DB;
|
||||
--dark-hl-5: #C586C0;
|
||||
--light-hl-6: #A31515;
|
||||
--dark-hl-6: #CE9178;
|
||||
--light-hl-7: #0070C1;
|
||||
--dark-hl-7: #4FC1FF;
|
||||
--light-hl-8: #098658;
|
||||
--dark-hl-8: #B5CEA8;
|
||||
--light-hl-9: #811F3F;
|
||||
--dark-hl-9: #D16969;
|
||||
--light-hl-10: #267F99;
|
||||
--dark-hl-10: #4EC9B0;
|
||||
--light-hl-11: #800000;
|
||||
--dark-hl-11: #808080;
|
||||
--light-hl-12: #800000;
|
||||
--dark-hl-12: #569CD6;
|
||||
--light-hl-13: #FF0000;
|
||||
--dark-hl-13: #9CDCFE;
|
||||
--light-hl-14: #000000FF;
|
||||
--dark-hl-14: #D4D4D4;
|
||||
--light-hl-15: #D16969;
|
||||
--dark-hl-15: #CE9178;
|
||||
--light-hl-16: #000000;
|
||||
--dark-hl-16: #D7BA7D;
|
||||
--light-hl-17: #EE0000;
|
||||
--dark-hl-17: #D7BA7D;
|
||||
--light-hl-18: #000000;
|
||||
--dark-hl-18: #C8C8C8;
|
||||
--light-code-background: #FFFFFF;
|
||||
--dark-code-background: #1E1E1E;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: light) { :root {
|
||||
--hl-0: var(--light-hl-0);
|
||||
--hl-1: var(--light-hl-1);
|
||||
--hl-2: var(--light-hl-2);
|
||||
--hl-3: var(--light-hl-3);
|
||||
--hl-4: var(--light-hl-4);
|
||||
--hl-5: var(--light-hl-5);
|
||||
--hl-6: var(--light-hl-6);
|
||||
--hl-7: var(--light-hl-7);
|
||||
--hl-8: var(--light-hl-8);
|
||||
--hl-9: var(--light-hl-9);
|
||||
--hl-10: var(--light-hl-10);
|
||||
--hl-11: var(--light-hl-11);
|
||||
--hl-12: var(--light-hl-12);
|
||||
--hl-13: var(--light-hl-13);
|
||||
--hl-14: var(--light-hl-14);
|
||||
--hl-15: var(--light-hl-15);
|
||||
--hl-16: var(--light-hl-16);
|
||||
--hl-17: var(--light-hl-17);
|
||||
--hl-18: var(--light-hl-18);
|
||||
--code-background: var(--light-code-background);
|
||||
} }
|
||||
|
||||
@media (prefers-color-scheme: dark) { :root {
|
||||
--hl-0: var(--dark-hl-0);
|
||||
--hl-1: var(--dark-hl-1);
|
||||
--hl-2: var(--dark-hl-2);
|
||||
--hl-3: var(--dark-hl-3);
|
||||
--hl-4: var(--dark-hl-4);
|
||||
--hl-5: var(--dark-hl-5);
|
||||
--hl-6: var(--dark-hl-6);
|
||||
--hl-7: var(--dark-hl-7);
|
||||
--hl-8: var(--dark-hl-8);
|
||||
--hl-9: var(--dark-hl-9);
|
||||
--hl-10: var(--dark-hl-10);
|
||||
--hl-11: var(--dark-hl-11);
|
||||
--hl-12: var(--dark-hl-12);
|
||||
--hl-13: var(--dark-hl-13);
|
||||
--hl-14: var(--dark-hl-14);
|
||||
--hl-15: var(--dark-hl-15);
|
||||
--hl-16: var(--dark-hl-16);
|
||||
--hl-17: var(--dark-hl-17);
|
||||
--hl-18: var(--dark-hl-18);
|
||||
--code-background: var(--dark-code-background);
|
||||
} }
|
||||
|
||||
body.light {
|
||||
--hl-0: var(--light-hl-0);
|
||||
--hl-1: var(--light-hl-1);
|
||||
--hl-2: var(--light-hl-2);
|
||||
--hl-3: var(--light-hl-3);
|
||||
--hl-4: var(--light-hl-4);
|
||||
--hl-5: var(--light-hl-5);
|
||||
--hl-6: var(--light-hl-6);
|
||||
--hl-7: var(--light-hl-7);
|
||||
--hl-8: var(--light-hl-8);
|
||||
--hl-9: var(--light-hl-9);
|
||||
--hl-10: var(--light-hl-10);
|
||||
--hl-11: var(--light-hl-11);
|
||||
--hl-12: var(--light-hl-12);
|
||||
--hl-13: var(--light-hl-13);
|
||||
--hl-14: var(--light-hl-14);
|
||||
--hl-15: var(--light-hl-15);
|
||||
--hl-16: var(--light-hl-16);
|
||||
--hl-17: var(--light-hl-17);
|
||||
--hl-18: var(--light-hl-18);
|
||||
--code-background: var(--light-code-background);
|
||||
}
|
||||
|
||||
body.dark {
|
||||
--hl-0: var(--dark-hl-0);
|
||||
--hl-1: var(--dark-hl-1);
|
||||
--hl-2: var(--dark-hl-2);
|
||||
--hl-3: var(--dark-hl-3);
|
||||
--hl-4: var(--dark-hl-4);
|
||||
--hl-5: var(--dark-hl-5);
|
||||
--hl-6: var(--dark-hl-6);
|
||||
--hl-7: var(--dark-hl-7);
|
||||
--hl-8: var(--dark-hl-8);
|
||||
--hl-9: var(--dark-hl-9);
|
||||
--hl-10: var(--dark-hl-10);
|
||||
--hl-11: var(--dark-hl-11);
|
||||
--hl-12: var(--dark-hl-12);
|
||||
--hl-13: var(--dark-hl-13);
|
||||
--hl-14: var(--dark-hl-14);
|
||||
--hl-15: var(--dark-hl-15);
|
||||
--hl-16: var(--dark-hl-16);
|
||||
--hl-17: var(--dark-hl-17);
|
||||
--hl-18: var(--dark-hl-18);
|
||||
--code-background: var(--dark-code-background);
|
||||
}
|
||||
|
||||
.hl-0 { color: var(--hl-0); }
|
||||
.hl-1 { color: var(--hl-1); }
|
||||
.hl-2 { color: var(--hl-2); }
|
||||
.hl-3 { color: var(--hl-3); }
|
||||
.hl-4 { color: var(--hl-4); }
|
||||
.hl-5 { color: var(--hl-5); }
|
||||
.hl-6 { color: var(--hl-6); }
|
||||
.hl-7 { color: var(--hl-7); }
|
||||
.hl-8 { color: var(--hl-8); }
|
||||
.hl-9 { color: var(--hl-9); }
|
||||
.hl-10 { color: var(--hl-10); }
|
||||
.hl-11 { color: var(--hl-11); }
|
||||
.hl-12 { color: var(--hl-12); }
|
||||
.hl-13 { color: var(--hl-13); }
|
||||
.hl-14 { color: var(--hl-14); }
|
||||
.hl-15 { color: var(--hl-15); }
|
||||
.hl-16 { color: var(--hl-16); }
|
||||
.hl-17 { color: var(--hl-17); }
|
||||
.hl-18 { color: var(--hl-18); }
|
||||
pre, code { background: var(--code-background); }
|
||||
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
Before Width: | Height: | Size: 9.4 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 28 KiB |
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
Before Width: | Height: | Size: 480 B |
Binary file not shown.
|
Before Width: | Height: | Size: 855 B |
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,26 +0,0 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CellPath | @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="CellPath.html">CellPath</a></li></ul><h1>Class CellPath</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>Implements a mechanism for temporary cell Ids.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CellPath</span></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"><a href="CellPath.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="CellPath.html#PATH_SEPARATOR" class="tsd-kind-icon">PATH_<wbr/>SEPARATOR</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-static"><a href="CellPath.html#compare" class="tsd-kind-icon">compare</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CellPath.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CellPath.html#getParentPath" class="tsd-kind-icon">get<wbr/>Parent<wbr/>Path</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CellPath.html#resolve" class="tsd-kind-icon">resolve</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"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Cell<wbr/>Path<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CellPath.html" class="tsd-signature-type" data-tsd-kind="Class">CellPath</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/cell/CellPath.ts#L14">view/cell/CellPath.ts:14</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="CellPath.html" class="tsd-signature-type" data-tsd-kind="Class">CellPath</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a id="PATH_SEPARATOR" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> PATH_<wbr/>SEPARATOR</h3><div class="tsd-signature tsd-kind-icon">PATH_<wbr/>SEPARATOR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = '.'</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/cell/CellPath.ts#L21">view/cell/CellPath.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Defines the separator between the path components. Default is ".".</p>
|
||||
</div></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-static"><a id="compare" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> compare</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">compare<span class="tsd-signature-symbol">(</span>p1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, p2<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-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/cell/CellPath.ts#L91">view/cell/CellPath.ts:91</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Compares the given cell paths and returns -1 if p1 is smaller, 0 if
|
||||
p1 is equal and 1 if p1 is greater than p2.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>p1: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>p2: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="create" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> create</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>cell<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/cell/CellPath.ts#L30">view/cell/CellPath.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Creates the cell path for the given cell. The cell path is a
|
||||
concatenation of the indices of all ancestors on the (finite) path to
|
||||
the root, eg. "0.0.0.1".</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cell: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Cell whose path should be returned.</p>
|
||||
</div></div></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-static"><a id="getParentPath" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr/>Parent<wbr/>Path</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">get<wbr/>Parent<wbr/>Path<span class="tsd-signature-symbol">(</span>path<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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/cell/CellPath.ts#L56">view/cell/CellPath.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns the path for the parent of the cell represented by the given
|
||||
path. Returns null if the given path has no parent.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>path: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Path whose parent path should be returned.</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">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="resolve" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> resolve</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">resolve<span class="tsd-signature-symbol">(</span>root<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, path<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><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/cell/CellPath.ts#L76">view/cell/CellPath.ts:76</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns the cell for the specified cell path using the given root as the
|
||||
root of the path.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>root: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Root cell of the path to be resolved.</p>
|
||||
</div></div></li><li><h5>path: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>String that defines the path.</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></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="CellPath.html" class="tsd-kind-icon">Cell<wbr/>Path</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CellPath.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="CellPath.html#PATH_SEPARATOR" class="tsd-kind-icon">PATH_<wbr/>SEPARATOR</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CellPath.html#compare" class="tsd-kind-icon">compare</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CellPath.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CellPath.html#getParentPath" class="tsd-kind-icon">get<wbr/>Parent<wbr/>Path</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CellPath.html#resolve" class="tsd-kind-icon">resolve</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>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,38 +0,0 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CodecRegistry | @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="CodecRegistry.html">CodecRegistry</a></li></ul><h1>Class CodecRegistry</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>Singleton class that acts as a global registry for codecs.</p>
|
||||
</div><div>
|
||||
<a href="#adding-an-" id="adding-an-" style="color: inherit; text-decoration: none;">
|
||||
<h3>Adding an <Codec>:</h3>
|
||||
</a>
|
||||
<ol>
|
||||
<li><p>Define a default codec with a new instance of the object to be handled.</p>
|
||||
<pre><code class="language-javascript"><span class="hl-3">var</span><span class="hl-1"> </span><span class="hl-0">codec</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-2">ObjectCodec</span><span class="hl-1">(</span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-2">Transactions</span><span class="hl-1">());</span>
|
||||
</code></pre>
|
||||
</li>
|
||||
<li><p>Define the functions required for encoding and decoding objects.</p>
|
||||
<pre><code class="language-javascript"><span class="hl-0">codec</span><span class="hl-1">.</span><span class="hl-2">encode</span><span class="hl-1"> = </span><span class="hl-3">function</span><span class="hl-1">(</span><span class="hl-0">enc</span><span class="hl-1">, </span><span class="hl-0">obj</span><span class="hl-1">) { ... }</span><br/><span class="hl-0">codec</span><span class="hl-1">.</span><span class="hl-2">decode</span><span class="hl-1"> = </span><span class="hl-3">function</span><span class="hl-1">(</span><span class="hl-0">dec</span><span class="hl-1">: </span><span class="hl-10">Codec</span><span class="hl-1">, </span><span class="hl-0">node</span><span class="hl-1">: </span><span class="hl-10">Element</span><span class="hl-1">, </span><span class="hl-0">into</span><span class="hl-1">: </span><span class="hl-10">any</span><span class="hl-1">): </span><span class="hl-10">any</span><span class="hl-1"> { ... }</span>
|
||||
</code></pre>
|
||||
</li>
|
||||
<li><p>Register the codec in the <CodecRegistry>.</p>
|
||||
<pre><code class="language-javascript"><span class="hl-0">CodecRegistry</span><span class="hl-1">.</span><span class="hl-2">register</span><span class="hl-1">(</span><span class="hl-0">codec</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</li>
|
||||
</ol>
|
||||
<p><a href="ObjectCodec.html#decode">ObjectCodec.decode</a> may be used to either create a new
|
||||
instance of an object or to configure an existing instance,
|
||||
in which case the into argument points to the existing
|
||||
object. In this case, we say the codec "configures" the
|
||||
object.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CodecRegistry</span></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"><a href="CodecRegistry.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="CodecRegistry.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="CodecRegistry.html#codecs" class="tsd-kind-icon">codecs</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-static"><a href="CodecRegistry.html#addAlias" class="tsd-kind-icon">add<wbr/>Alias</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CodecRegistry.html#getCodec" class="tsd-kind-icon">get<wbr/>Codec</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CodecRegistry.html#register" class="tsd-kind-icon">register</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"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Codec<wbr/>Registry<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CodecRegistry.html" class="tsd-signature-type" data-tsd-kind="Class">CodecRegistry</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="CodecRegistry.html" class="tsd-signature-type" data-tsd-kind="Class">CodecRegistry</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a id="aliases" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> aliases</h3><div class="tsd-signature tsd-kind-icon">aliases<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/CodecRegistry.ts#L49">serialization/CodecRegistry.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Maps from classnames to codecnames.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></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">any</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a id="codecs" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> codecs</h3><div class="tsd-signature tsd-kind-icon">codecs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/CodecRegistry.ts#L43">serialization/CodecRegistry.ts:43</a></li></ul></aside><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">any</span></h5></li></ul></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-static"><a id="addAlias" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> add<wbr/>Alias</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">add<wbr/>Alias<span class="tsd-signature-symbol">(</span>classname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, codecname<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">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/CodecRegistry.ts#L76">serialization/CodecRegistry.ts:76</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Adds an alias for mapping a classname to a codecname.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>classname: <span class="tsd-signature-type">string</span></h5></li><li><h5>codecname: <span class="tsd-signature-type">string</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-static"><a id="getCodec" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr/>Codec</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">get<wbr/>Codec<span class="tsd-signature-symbol">(</span>constructor_<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><a href="ObjectCodec.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectCodec</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/CodecRegistry.ts#L88">serialization/CodecRegistry.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns a codec that handles objects that are constructed
|
||||
using the given constructor.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>constructor_: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="ObjectCodec.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectCodec</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="register" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> register</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">register<span class="tsd-signature-symbol">(</span>codec<span class="tsd-signature-symbol">: </span><a href="ObjectCodec.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectCodec</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ObjectCodec.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectCodec</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/serialization/CodecRegistry.ts#L59">serialization/CodecRegistry.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Registers a new codec and associates the name of the template
|
||||
constructor in the codec with the codec object.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>static</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>codec: <a href="ObjectCodec.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectCodec</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p><a href="ObjectCodec.html">ObjectCodec</a> to be registered.</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ObjectCodec.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectCodec</a></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="CodecRegistry.html" class="tsd-kind-icon">Codec<wbr/>Registry</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CodecRegistry.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="CodecRegistry.html#aliases" class="tsd-kind-icon">aliases</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="CodecRegistry.html#codecs" class="tsd-kind-icon">codecs</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CodecRegistry.html#addAlias" class="tsd-kind-icon">add<wbr/>Alias</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CodecRegistry.html#getCodec" class="tsd-kind-icon">get<wbr/>Codec</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CodecRegistry.html#register" class="tsd-kind-icon">register</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>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,14 +0,0 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ConnectionConstraint | @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="ConnectionConstraint.html">ConnectionConstraint</a></li></ul><h1>Class ConnectionConstraint</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>Defines an object that contains the constraints about how to connect one side of an edge to its terminal.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ConnectionConstraint</span></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"><a href="ConnectionConstraint.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="ConnectionConstraint.html#dx" class="tsd-kind-icon">dx</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ConnectionConstraint.html#dy" class="tsd-kind-icon">dy</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ConnectionConstraint.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ConnectionConstraint.html#perimeter" class="tsd-kind-icon">perimeter</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ConnectionConstraint.html#point" class="tsd-kind-icon">point</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"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Connection<wbr/>Constraint<span class="tsd-signature-symbol">(</span>point<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a>, perimeter<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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>, dx<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, dy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ConnectionConstraint.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionConstraint</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/ConnectionConstraint.ts#L41">view/other/ConnectionConstraint.ts:41</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>point: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h5></li><li><h5>perimeter: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</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><span class="tsd-signature-symbol"> = null</span></h5></li><li><h5>dx: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></h5></li><li><h5>dy: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="ConnectionConstraint.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionConstraint</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="dx" class="tsd-anchor"></a><h3>dx</h3><div class="tsd-signature tsd-kind-icon">dx<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/ConnectionConstraint.ts#L34">view/other/ConnectionConstraint.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional float that specifies the horizontal offset of the constraint.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="dy" class="tsd-anchor"></a><h3>dy</h3><div class="tsd-signature tsd-kind-icon">dy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/ConnectionConstraint.ts#L39">view/other/ConnectionConstraint.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional float that specifies the vertical offset of the constraint.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">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><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/ConnectionConstraint.ts#L29">view/other/ConnectionConstraint.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional string that specifies the name of the constraint.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="perimeter" class="tsd-anchor"></a><h3>perimeter</h3><div class="tsd-signature tsd-kind-icon">perimeter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/ConnectionConstraint.ts#L24">view/other/ConnectionConstraint.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Boolean that specifies if the point should be projected onto the perimeter
|
||||
of the terminal.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="point" class="tsd-anchor"></a><h3>point</h3><div class="tsd-signature tsd-kind-icon">point<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/ConnectionConstraint.ts#L18">view/other/ConnectionConstraint.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p><a href="Point.html">Point</a> that specifies the fixed location of the connection point.</p>
|
||||
</div></div></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="ConnectionConstraint.html" class="tsd-kind-icon">Connection<wbr/>Constraint</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="ConnectionConstraint.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ConnectionConstraint.html#dx" class="tsd-kind-icon">dx</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ConnectionConstraint.html#dy" class="tsd-kind-icon">dy</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ConnectionConstraint.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ConnectionConstraint.html#perimeter" class="tsd-kind-icon">perimeter</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ConnectionConstraint.html#point" class="tsd-kind-icon">point</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>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,28 +0,0 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Dictionary | @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="Dictionary.html">Dictionary</a></li></ul><h1>Class Dictionary<T, U></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>A wrapper class for an associative array with object keys. Note: This
|
||||
implementation uses {@link ObjectIdentitiy} to turn object keys into strings.</p>
|
||||
</div><div><p>Constructor: mxEventSource</p>
|
||||
<p>Constructs a new dictionary which allows object to be used as keys.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T</h4></li><li><h4>U</h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Dictionary</span></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-has-type-parameter"><a href="Dictionary.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="Dictionary.html#map" class="tsd-kind-icon">map</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"><a href="Dictionary.html#clear" class="tsd-kind-icon">clear</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Dictionary.html#get" class="tsd-kind-icon">get</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Dictionary.html#getKeys" class="tsd-kind-icon">get<wbr/>Keys</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Dictionary.html#getValues" class="tsd-kind-icon">get<wbr/>Values</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Dictionary.html#put" class="tsd-kind-icon">put</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Dictionary.html#remove" class="tsd-kind-icon">remove</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Dictionary.html#visit" class="tsd-kind-icon">visit</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-has-type-parameter"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">new <wbr/>Dictionary<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Dictionary.html" class="tsd-signature-type" data-tsd-kind="Class">Dictionary</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/util/Dictionary.ts#L27">util/Dictionary.ts:27</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T</h4></li><li><h4>U</h4></li></ul><h4 class="tsd-returns-title">Returns <a href="Dictionary.html" class="tsd-signature-type" data-tsd-kind="Class">Dictionary</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="map" class="tsd-anchor"></a><h3>map</h3><div class="tsd-signature tsd-kind-icon">map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/util/Dictionary.ts#L34">util/Dictionary.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Stores the (key, value) pairs in this dictionary.</p>
|
||||
</div></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"><a id="clear" class="tsd-anchor"></a><h3>clear</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">clear<span class="tsd-signature-symbol">(</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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/util/Dictionary.ts#L39">util/Dictionary.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Clears the dictionary.</p>
|
||||
</div></div><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"><a id="get" class="tsd-anchor"></a><h3>get</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</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">NonNullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/util/Dictionary.ts#L46">util/Dictionary.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns the value for the given key.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</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">NonNullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getKeys" class="tsd-anchor"></a><h3>get<wbr/>Keys</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Keys<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><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/util/Dictionary.ts#L76">util/Dictionary.ts:76</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns all keys as an array.</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getValues" class="tsd-anchor"></a><h3>get<wbr/>Values</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Values<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/util/Dictionary.ts#L87">util/Dictionary.ts:87</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns all values as an array.</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="put" class="tsd-anchor"></a><h3>put</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">put<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</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">NonNullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/util/Dictionary.ts#L55">util/Dictionary.ts:55</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Stores the value under the given key and returns the previous
|
||||
value for that key.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li><li><h5>value: <span class="tsd-signature-type" data-tsd-kind="Type parameter">U</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">NonNullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="remove" class="tsd-anchor"></a><h3>remove</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">remove<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</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">NonNullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/util/Dictionary.ts#L66">util/Dictionary.ts:66</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Removes the value for the given key and returns the value that
|
||||
has been removed.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</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">NonNullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="visit" class="tsd-anchor"></a><h3>visit</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">visit<span class="tsd-signature-symbol">(</span>visitor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Visitor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">></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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/util/Dictionary.ts#L102">util/Dictionary.ts:102</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Visits all entries in the dictionary using the given function with the
|
||||
following signature: (key, value)=> where key is a string and
|
||||
value is an object.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>visitor: <span class="tsd-signature-type">Visitor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A function that takes the key and value as arguments.</p>
|
||||
</div></div></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 tsd-has-type-parameter"><a href="Dictionary.html" class="tsd-kind-icon">Dictionary</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="Dictionary.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Dictionary.html#map" class="tsd-kind-icon">map</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Dictionary.html#clear" class="tsd-kind-icon">clear</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Dictionary.html#get" class="tsd-kind-icon">get</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Dictionary.html#getKeys" class="tsd-kind-icon">get<wbr/>Keys</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Dictionary.html#getValues" class="tsd-kind-icon">get<wbr/>Values</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Dictionary.html#put" class="tsd-kind-icon">put</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Dictionary.html#remove" class="tsd-kind-icon">remove</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Dictionary.html#visit" class="tsd-kind-icon">visit</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>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,23 +0,0 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EditorKeyHandler | @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="EditorKeyHandler.html">EditorKeyHandler</a></li></ul><h1>Class EditorKeyHandler</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>Binds keycodes to actionnames in an editor. This aggregates an internal <a href="EditorKeyHandler.html#handler">handler</a> and extends the implementation of <a href="KeyHandler.html#escape">KeyHandler.escape</a> to not only cancel the editing, but also hide the properties dialog and fire an <Editor.escape> event via <a href="EditorKeyHandler.html#editor">editor</a>. An instance of this class is created by <a href="Editor.html">Editor</a> and stored in <a href="Editor.html#keyHandler">Editor.keyHandler</a>.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><p>Bind the delete key to the delete action in an existing editor.</p>
|
||||
<pre><code class="language-javascript"><span class="hl-3">var</span><span class="hl-1"> </span><span class="hl-0">keyHandler</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-2">EditorKeyHandler</span><span class="hl-1">(</span><span class="hl-0">editor</span><span class="hl-1">);</span><br/><span class="hl-0">keyHandler</span><span class="hl-1">.</span><span class="hl-2">bindAction</span><span class="hl-1">(</span><span class="hl-8">46</span><span class="hl-1">, </span><span class="hl-6">'delete'</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</dd><dt>codec</dt><dd><p>This class uses the {@link DefaultKeyHandlerCodec} to read configuration data into an existing instance. See {@link DefaultKeyHandlerCodec} for a description of the configuration format.</p>
|
||||
</dd><dt>keycodes</dt><dd><p>See <a href="KeyHandler.html">KeyHandler</a>.
|
||||
An <a href="InternalEvent.html#ESCAPE">InternalEvent.ESCAPE</a> event is fired via the editor if the escape key is pressed.</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">EditorKeyHandler</span></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"><a href="EditorKeyHandler.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="EditorKeyHandler.html#editor" class="tsd-kind-icon">editor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EditorKeyHandler.html#handler" class="tsd-kind-icon">handler</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"><a href="EditorKeyHandler.html#bindAction" class="tsd-kind-icon">bind<wbr/>Action</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorKeyHandler.html#destroy" class="tsd-kind-icon">destroy</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"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Editor<wbr/>Key<wbr/>Handler<span class="tsd-signature-symbol">(</span>editor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="EditorKeyHandler.html" class="tsd-signature-type" data-tsd-kind="Class">EditorKeyHandler</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/editor/EditorKeyHandler.ts#L34">editor/EditorKeyHandler.ts:34</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>editor: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a><span class="tsd-signature-symbol"> = null</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="EditorKeyHandler.html" class="tsd-signature-type" data-tsd-kind="Class">EditorKeyHandler</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="editor" class="tsd-anchor"></a><h3>editor</h3><div class="tsd-signature tsd-kind-icon">editor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/editor/EditorKeyHandler.ts#L55">editor/EditorKeyHandler.ts:55</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Reference to the enclosing <a href="Editor.html">Editor</a>.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="handler" class="tsd-anchor"></a><h3>handler</h3><div class="tsd-signature tsd-kind-icon">handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="KeyHandler.html" class="tsd-signature-type" data-tsd-kind="Class">KeyHandler</a><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/editor/EditorKeyHandler.ts#L60">editor/EditorKeyHandler.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Holds the <a href="KeyHandler.html">KeyHandler</a> for key event handling.</p>
|
||||
</div></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"><a id="bindAction" class="tsd-anchor"></a><h3>bind<wbr/>Action</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">bind<wbr/>Action<span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, control<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">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/editor/EditorKeyHandler.ts#L69">editor/EditorKeyHandler.ts:69</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Binds the specified keycode to the given action in <a href="EditorKeyHandler.html#editor">editor</a>. The optional control flag specifies if the control key must be pressed to trigger the action.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>code: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Integer that specifies the keycode.</p>
|
||||
</div></div></li><li><h5>action: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Name of the action to execute in <a href="EditorKeyHandler.html#editor">editor</a>.</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> control: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional boolean that specifies if control must be pressed. Default is false.</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"><a id="destroy" class="tsd-anchor"></a><h3>destroy</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/editor/EditorKeyHandler.ts#L86">editor/EditorKeyHandler.ts:86</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Destroys the <a href="EditorKeyHandler.html#handler">handler</a> associated with this object. This does normally not need to be called, the <a href="EditorKeyHandler.html#handler">handler</a> is destroyed automatically when the window unloads (in IE) by <a href="Editor.html">Editor</a>.</p>
|
||||
</div></div><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="EditorKeyHandler.html" class="tsd-kind-icon">Editor<wbr/>Key<wbr/>Handler</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="EditorKeyHandler.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EditorKeyHandler.html#editor" class="tsd-kind-icon">editor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EditorKeyHandler.html#handler" class="tsd-kind-icon">handler</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorKeyHandler.html#bindAction" class="tsd-kind-icon">bind<wbr/>Action</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorKeyHandler.html#destroy" class="tsd-kind-icon">destroy</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>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,111 +0,0 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EditorPopupMenu | @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="EditorPopupMenu.html">EditorPopupMenu</a></li></ul><h1>Class EditorPopupMenu</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>Creates popupmenus for mouse events. This object holds an XML node which is a description of the popup menu to be created. In <a href="EditorPopupMenu.html#createMenu">createMenu</a>, the configuration is applied to the context and the resulting menu items are added to the menu dynamically. See <a href="EditorPopupMenu.html#createMenu">createMenu</a> for a description of the configuration format.
|
||||
This class does not create the DOM nodes required for the popup menu, it only parses an XML description to invoke the respective methods on an {@link mxPopupMenu} each time the menu is displayed.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>codec</dt><dd><p>This class uses the {@link DefaultPopupMenuCodec} to read configuration data into an existing instance, however, the actual parsing is done by this class during program execution, so the format is described below.</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">EditorPopupMenu</span></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"><a href="EditorPopupMenu.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="EditorPopupMenu.html#config" class="tsd-kind-icon">config</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EditorPopupMenu.html#imageBasePath" class="tsd-kind-icon">image<wbr/>Base<wbr/>Path</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"><a href="EditorPopupMenu.html#addAction" class="tsd-kind-icon">add<wbr/>Action</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorPopupMenu.html#addItems" class="tsd-kind-icon">add<wbr/>Items</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorPopupMenu.html#createConditions" class="tsd-kind-icon">create<wbr/>Conditions</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorPopupMenu.html#createMenu" class="tsd-kind-icon">create<wbr/>Menu</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"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Editor<wbr/>Popup<wbr/>Menu<span class="tsd-signature-symbol">(</span>config<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="EditorPopupMenu.html" class="tsd-signature-type" data-tsd-kind="Class">EditorPopupMenu</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/editor/EditorPopupMenu.ts#L26">editor/EditorPopupMenu.ts:26</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>config: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol"> = null</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="EditorPopupMenu.html" class="tsd-signature-type" data-tsd-kind="Class">EditorPopupMenu</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="config" class="tsd-anchor"></a><h3>config</h3><div class="tsd-signature tsd-kind-icon">config<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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/editor/EditorPopupMenu.ts#L40">editor/EditorPopupMenu.ts:40</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>XML node used as the description of new menu items. This node is used in <a href="EditorPopupMenu.html#createMenu">createMenu</a> to dynamically create the menu items if their respective conditions evaluate to true for the given arguments.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="imageBasePath" class="tsd-anchor"></a><h3>image<wbr/>Base<wbr/>Path</h3><div class="tsd-signature tsd-kind-icon">image<wbr/>Base<wbr/>Path<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"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/editor/EditorPopupMenu.ts#L35">editor/EditorPopupMenu.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Base path for all icon attributes in the config. Default is null.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>null</p>
|
||||
</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"><a id="addAction" class="tsd-anchor"></a><h3>add<wbr/>Action</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Action<span class="tsd-signature-symbol">(</span>menu<span class="tsd-signature-symbol">: </span><a href="MaxPopupMenu.html" class="tsd-signature-type" data-tsd-kind="Class">MaxPopupMenu</a>, editor<span class="tsd-signature-symbol">: </span><a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a>, lab<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, icon<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>, funct<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Function</span>, action<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>, cell<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, parent<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopupMenuItem</span>, iconCls<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>, enabled<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">PopupMenuItem</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/editor/EditorPopupMenu.ts#L240">editor/EditorPopupMenu.ts:240</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Helper method to bind an action to a new menu item.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>menu: <a href="MaxPopupMenu.html" class="tsd-signature-type" data-tsd-kind="Class">MaxPopupMenu</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>{@link PopupMenu} that is used for adding items and separators.</p>
|
||||
</div></div></li><li><h5>editor: <a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Enclosing <Editor> instance.</p>
|
||||
</div></div></li><li><h5>lab: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>String that represents the label of the menu item.</p>
|
||||
</div></div></li><li><h5>icon: <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"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional URL that represents the icon of the menu item.</p>
|
||||
</div></div></li><li><h5>funct: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional function to execute before the optional action. The
|
||||
function takes an <Editor>, the <Cell> under the mouse and the
|
||||
mouse event that triggered the call.</p>
|
||||
</div></div></li><li><h5>action: <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"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional name of the action to execute in the given editor.</p>
|
||||
</div></div></li><li><h5>cell: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional <Cell> to use as an argument for the action.</p>
|
||||
</div></div></li><li><h5>parent: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopupMenuItem</span><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>DOM node that represents the parent menu item.</p>
|
||||
</div></div></li><li><h5>iconCls: <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"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional CSS class for the menu icon.</p>
|
||||
</div></div></li><li><h5>enabled: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional boolean that specifies if the menu item is enabled.
|
||||
Default is true.</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PopupMenuItem</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addItems" class="tsd-anchor"></a><h3>add<wbr/>Items</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Items<span class="tsd-signature-symbol">(</span>editor<span class="tsd-signature-symbol">: </span><a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a>, menu<span class="tsd-signature-symbol">: </span><a href="MaxPopupMenu.html" class="tsd-signature-type" data-tsd-kind="Class">MaxPopupMenu</a>, cell<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, evt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MouseEvent</span>, conditions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, item<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span>, parent<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopupMenuItem</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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/editor/EditorPopupMenu.ts#L157">editor/EditorPopupMenu.ts:157</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Recursively adds the given items and all of its children into the given menu.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>editor: <a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Enclosing <Editor> instance.</p>
|
||||
</div></div></li><li><h5>menu: <a href="MaxPopupMenu.html" class="tsd-signature-type" data-tsd-kind="Class">MaxPopupMenu</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>{@link PopupMenu} that is used for adding items and separators.</p>
|
||||
</div></div></li><li><h5>cell: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional <Cell> which is under the mousepointer.</p>
|
||||
</div></div></li><li><h5>evt: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MouseEvent</span><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional mouse event which triggered the menu.</p>
|
||||
</div></div></li><li><h5>conditions: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Array of names boolean conditions.</p>
|
||||
</div></div></li><li><h5>item: <span class="tsd-signature-type">Element</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>XML node that represents the current menu item.</p>
|
||||
</div></div></li><li><h5>parent: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PopupMenuItem</span><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>DOM node that represents the parent menu item.</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"><a id="createConditions" class="tsd-anchor"></a><h3>create<wbr/>Conditions</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Conditions<span class="tsd-signature-symbol">(</span>editor<span class="tsd-signature-symbol">: </span><a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a>, cell<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, evt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MouseEvent</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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/editor/EditorPopupMenu.ts#L270">editor/EditorPopupMenu.ts:270</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Evaluates the default conditions for the given context.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>editor: <a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a></h5></li><li><h5>cell: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol"> = null</span></h5></li><li><h5>evt: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MouseEvent</span><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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"><a id="createMenu" class="tsd-anchor"></a><h3>create<wbr/>Menu</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Menu<span class="tsd-signature-symbol">(</span>editor<span class="tsd-signature-symbol">: </span><a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a>, menu<span class="tsd-signature-symbol">: </span><a href="MaxPopupMenu.html" class="tsd-signature-type" data-tsd-kind="Class">MaxPopupMenu</a>, cell<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, evt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MouseEvent</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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/editor/EditorPopupMenu.ts#L138">editor/EditorPopupMenu.ts:138</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>This function is called from <a href="Editor.html">Editor</a> to add items to the
|
||||
given menu based on <a href="EditorPopupMenu.html#config">config</a>. The config is a sequence of
|
||||
the following nodes and attributes.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>childnodes:</dt><dd><p>add - Adds a new menu item. See below for attributes.
|
||||
separator - Adds a separator. No attributes.
|
||||
condition - Adds a custom condition. Name attribute.</p>
|
||||
<p>The add-node may have a child node that defines a function to be invoked
|
||||
before the action is executed (or instead of an action to be executed).</p>
|
||||
</dd><dt>attributes:</dt><dd><p>as - Resource key for the label (needs entry in property file).
|
||||
action - Name of the action to execute in enclosing editor.
|
||||
icon - Optional icon (relative/absolute URL).
|
||||
iconCls - Optional CSS class for the icon.
|
||||
if - Optional name of condition that must be true (see below).
|
||||
enabled-if - Optional name of condition that specifies if the menu item
|
||||
should be enabled.
|
||||
name - Name of custom condition. Only for condition nodes.</p>
|
||||
</dd><dt>conditions:</dt><dd><p>nocell - No cell under the mouse.
|
||||
ncells - More than one cell selected.
|
||||
notRoot - Drilling position is other than home.
|
||||
cell - Cell under the mouse.
|
||||
notEmpty - Exactly one cell with children under mouse.
|
||||
expandable - Exactly one expandable cell under mouse.
|
||||
collapsable - Exactly one collapsable cell under mouse.
|
||||
validRoot - Exactly one cell which is a possible root under mouse.
|
||||
swimlane - Exactly one cell which is a swimlane under mouse.</p>
|
||||
</dd><dt>example:</dt><dd><p>To add a new item for a given action to the popupmenu:</p>
|
||||
<pre><code><span class="hl-1"><</span><span class="hl-0">EditorPopupMenu</span><span class="hl-1"> </span><span class="hl-0">as</span><span class="hl-1">=</span><span class="hl-6">"popupHandler"</span><span class="hl-1">></span><br/><span class="hl-1"> <</span><span class="hl-0">add</span><span class="hl-1"> </span><span class="hl-0">as</span><span class="hl-1">=</span><span class="hl-6">"delete"</span><span class="hl-1"> </span><span class="hl-0">action</span><span class="hl-1">=</span><span class="hl-6">"delete"</span><span class="hl-1"> </span><span class="hl-0">icon</span><span class="hl-1">=</span><span class="hl-6">"images/delete.gif"</span><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1">=</span><span class="hl-6">"cell"</span><span class="hl-1">/></span><br/><span class="hl-1"></</span><span class="hl-0">EditorPopupMenu</span><span class="hl-1">></span>
|
||||
</code></pre>
|
||||
<p>To add a new item for a custom function:</p>
|
||||
<pre><code><span class="hl-1"><</span><span class="hl-0">EditorPopupMenu</span><span class="hl-1"> </span><span class="hl-0">as</span><span class="hl-1">=</span><span class="hl-6">"popupHandler"</span><span class="hl-1">></span><br/><span class="hl-1"> <</span><span class="hl-0">add</span><span class="hl-1"> </span><span class="hl-0">as</span><span class="hl-1">=</span><span class="hl-6">"action1"</span><span class="hl-1">><![</span><span class="hl-10">CDATA</span><span class="hl-1">[</span><br/><span class="hl-1"> </span><span class="hl-10">function</span><span class="hl-1"> (</span><span class="hl-0">editor</span><span class="hl-1">, </span><span class="hl-0">cell</span><span class="hl-1">, </span><span class="hl-0">evt</span><span class="hl-1">)</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-10">editor</span><span class="hl-1">.</span><span class="hl-10">execute</span><span class="hl-1">(</span><span class="hl-6">'action1'</span><span class="hl-1">, </span><span class="hl-10">cell</span><span class="hl-1">, </span><span class="hl-6">'myArg'</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> ]]></</span><span class="hl-10">add</span><span class="hl-1">></span><br/><span class="hl-1"></</span><span class="hl-0">EditorPopupMenu</span><span class="hl-1">></span>
|
||||
</code></pre>
|
||||
<p>The above example invokes action1 with an additional third argument via
|
||||
the editor instance. The third argument is passed to the function that
|
||||
defines action1. If the add-node has no action-attribute, then only the
|
||||
function defined in the text content is executed, otherwise first the
|
||||
function and then the action defined in the action-attribute is
|
||||
executed. The function in the text content has 3 arguments, namely the
|
||||
<a href="Editor.html">Editor</a> instance, the {@link mxCell} instance under the mouse, and the
|
||||
native mouse event.</p>
|
||||
<p>Custom Conditions:</p>
|
||||
<p>To add a new condition for popupmenu items:</p>
|
||||
<pre><code><span class="hl-1"><</span><span class="hl-0">condition</span><span class="hl-1"> </span><span class="hl-0">name</span><span class="hl-1">=</span><span class="hl-6">"condition1"</span><span class="hl-1">><![</span><span class="hl-10">CDATA</span><span class="hl-1">[</span><br/><span class="hl-1"> </span><span class="hl-10">function</span><span class="hl-1"> (</span><span class="hl-0">editor</span><span class="hl-1">, </span><span class="hl-0">cell</span><span class="hl-1">, </span><span class="hl-0">evt</span><span class="hl-1">)</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-10">return</span><span class="hl-1"> </span><span class="hl-0">cell</span><span class="hl-1"> != </span><span class="hl-0">null</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">]]></</span><span class="hl-10">condition</span><span class="hl-1">></span>
|
||||
</code></pre>
|
||||
<p>The new condition can then be used in any item as follows:</p>
|
||||
<pre><code><span class="hl-1"><</span><span class="hl-0">add</span><span class="hl-1"> </span><span class="hl-0">as</span><span class="hl-1">=</span><span class="hl-6">"action1"</span><span class="hl-1"> </span><span class="hl-0">action</span><span class="hl-1">=</span><span class="hl-6">"action1"</span><span class="hl-1"> </span><span class="hl-0">icon</span><span class="hl-1">=</span><span class="hl-6">"action1.gif"</span><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1">=</span><span class="hl-6">"condition1"</span><span class="hl-1">/></span>
|
||||
</code></pre>
|
||||
<p>The order in which the items and conditions appear is not significant as
|
||||
all conditions are evaluated before any items are created.</p>
|
||||
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>editor: <a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Enclosing <a href="Editor.html">Editor</a> instance.</p>
|
||||
</div></div></li><li><h5>menu: <a href="MaxPopupMenu.html" class="tsd-signature-type" data-tsd-kind="Class">MaxPopupMenu</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>{@link mxPopupMenu} that is used for adding items and separators.</p>
|
||||
</div></div></li><li><h5>cell: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional {@link mxCell} which is under the mousepointer.</p>
|
||||
</div></div></li><li><h5>evt: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MouseEvent</span><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional mouse event which triggered the menu.</p>
|
||||
</div></div></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="EditorPopupMenu.html" class="tsd-kind-icon">Editor<wbr/>Popup<wbr/>Menu</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="EditorPopupMenu.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EditorPopupMenu.html#config" class="tsd-kind-icon">config</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EditorPopupMenu.html#imageBasePath" class="tsd-kind-icon">image<wbr/>Base<wbr/>Path</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorPopupMenu.html#addAction" class="tsd-kind-icon">add<wbr/>Action</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorPopupMenu.html#addItems" class="tsd-kind-icon">add<wbr/>Items</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorPopupMenu.html#createConditions" class="tsd-kind-icon">create<wbr/>Conditions</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorPopupMenu.html#createMenu" class="tsd-kind-icon">create<wbr/>Menu</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>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,24 +0,0 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Effects | @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="Effects.html">Effects</a></li></ul><h1>Class Effects</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>Provides animation effects.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Effects</span></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"><a href="Effects.html#constructor" class="tsd-kind-icon">constructor</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-static"><a href="Effects.html#animateChanges" class="tsd-kind-icon">animate<wbr/>Changes</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Effects.html#cascadeOpacity" class="tsd-kind-icon">cascade<wbr/>Opacity</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Effects.html#fadeOut" class="tsd-kind-icon">fade<wbr/>Out</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"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Effects<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Effects.html" class="tsd-signature-type" data-tsd-kind="Class">Effects</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="Effects.html" class="tsd-signature-type" data-tsd-kind="Class">Effects</a></h4></li></ul></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-static"><a id="animateChanges" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> animate<wbr/>Changes</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">animate<wbr/>Changes<span class="tsd-signature-symbol">(</span>graph<span class="tsd-signature-symbol">: </span><a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a>, changes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">UndoableChange</span><span class="tsd-signature-symbol">[]</span>, done<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/animate/Effects.ts#L46">view/animate/Effects.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Asynchronous animated move operation. See also: <Morphing>.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-javascript"><span class="hl-0">graph</span><span class="hl-1">.</span><span class="hl-0">model</span><span class="hl-1">.</span><span class="hl-2">addListener</span><span class="hl-1">(</span><span class="hl-0">mxEvent</span><span class="hl-1">.</span><span class="hl-7">CHANGE</span><span class="hl-1">, </span><span class="hl-3">function</span><span class="hl-1">(</span><span class="hl-0">sender</span><span class="hl-1">, </span><span class="hl-0">evt</span><span class="hl-1">)</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-3">var</span><span class="hl-1"> </span><span class="hl-0">changes</span><span class="hl-1"> = </span><span class="hl-0">evt</span><span class="hl-1">.</span><span class="hl-2">getProperty</span><span class="hl-1">(</span><span class="hl-6">'edit'</span><span class="hl-1">).</span><span class="hl-0">changes</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> (</span><span class="hl-0">changes</span><span class="hl-1">.</span><span class="hl-0">length</span><span class="hl-1"> < </span><span class="hl-8">10</span><span class="hl-1">)</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">Effects</span><span class="hl-1">.</span><span class="hl-2">animateChanges</span><span class="hl-1">(</span><span class="hl-0">graph</span><span class="hl-1">, </span><span class="hl-0">changes</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
|
||||
</code></pre>
|
||||
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>graph: <a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p><a href="Graph.html">Graph</a> that received the changes.</p>
|
||||
</div></div></li><li><h5>changes: <span class="tsd-signature-type">UndoableChange</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Array of changes to be animated.</p>
|
||||
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> done: <span class="tsd-signature-type">Function</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Optional function argument that is invoked after the
|
||||
last step of the animation.</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-static"><a id="cascadeOpacity" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> cascade<wbr/>Opacity</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">cascade<wbr/>Opacity<span class="tsd-signature-symbol">(</span>graph<span class="tsd-signature-symbol">: </span><a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a>, cell<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, opacity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/animate/Effects.ts#L122">view/animate/Effects.ts:122</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Sets the opacity on the given cell and its descendants.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>graph: <a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p><a href="Graph.html">Graph</a> that contains the cells.</p>
|
||||
</div></div></li><li><h5>cell: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p><Cell> to set the opacity for.</p>
|
||||
</div></div></li><li><h5>opacity: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>New value for the opacity in %.</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-static"><a id="fadeOut" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> fade<wbr/>Out</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">fade<wbr/>Out<span class="tsd-signature-symbol">(</span>node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, from<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, remove<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, step<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, delay<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, isEnabled<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">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/animate/Effects.ts#L153">view/animate/Effects.ts:153</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Asynchronous fade-out operation.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>node: <span class="tsd-signature-type">HTMLElement</span></h5></li><li><h5>from: <span class="tsd-signature-type">number</span></h5></li><li><h5>remove: <span class="tsd-signature-type">boolean</span></h5></li><li><h5>step: <span class="tsd-signature-type">number</span></h5></li><li><h5>delay: <span class="tsd-signature-type">number</span></h5></li><li><h5>isEnabled: <span class="tsd-signature-type">boolean</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="Effects.html" class="tsd-kind-icon">Effects</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Effects.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Effects.html#animateChanges" class="tsd-kind-icon">animate<wbr/>Changes</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Effects.html#cascadeOpacity" class="tsd-kind-icon">cascade<wbr/>Opacity</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Effects.html#fadeOut" class="tsd-kind-icon">fade<wbr/>Out</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>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,29 +0,0 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EventObject | @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="EventObject.html">EventObject</a></li></ul><h1>Class EventObject</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>The mxEventObject is a wrapper for all properties of a single event.
|
||||
Additionally, it also offers functions to consume the event and check if it
|
||||
was consumed as follows:</p>
|
||||
</div><div><pre><code class="language-javascript"><span class="hl-0">evt</span><span class="hl-1">.</span><span class="hl-2">consume</span><span class="hl-1">();</span><br/><span class="hl-18">INV</span><span class="hl-1">: </span><span class="hl-0">evt</span><span class="hl-1">.</span><span class="hl-2">isConsumed</span><span class="hl-1">() == </span><span class="hl-3">true</span>
|
||||
</code></pre>
|
||||
<p>Constructor: mxEventObject</p>
|
||||
<p>Constructs a new event object with the specified name. An optional
|
||||
sequence of key, value pairs can be appended to define properties.</p>
|
||||
<p>Example:</p>
|
||||
<pre><code class="language-javascript"><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-2">mxEventObject</span><span class="hl-1">(</span><span class="hl-6">"eventName"</span><span class="hl-1">, </span><span class="hl-0">key1</span><span class="hl-1">, </span><span class="hl-0">val1</span><span class="hl-1">, .., </span><span class="hl-0">keyN</span><span class="hl-1">, </span><span class="hl-0">valN</span><span class="hl-1">)</span>
|
||||
</code></pre>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">EventObject</span></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"><a href="EventObject.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="EventObject.html#consumed" class="tsd-kind-icon">consumed</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EventObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EventObject.html#properties" class="tsd-kind-icon">properties</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"><a href="EventObject.html#consume" class="tsd-kind-icon">consume</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EventObject.html#getName" class="tsd-kind-icon">get<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EventObject.html#getProperties" class="tsd-kind-icon">get<wbr/>Properties</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EventObject.html#getProperty" class="tsd-kind-icon">get<wbr/>Property</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EventObject.html#isConsumed" class="tsd-kind-icon">is<wbr/>Consumed</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"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Event<wbr/>Object<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, <span class="tsd-signature-symbol">...</span>args<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-symbol">: </span><a href="EventObject.html" class="tsd-signature-type" data-tsd-kind="Class">EventObject</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventObject.ts#L32">view/event/EventObject.ts:32</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ''</span></h5></li><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="EventObject.html" class="tsd-signature-type" data-tsd-kind="Class">EventObject</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="consumed" class="tsd-anchor"></a><h3>consumed</h3><div class="tsd-signature tsd-kind-icon">consumed<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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventObject.ts#L64">view/event/EventObject.ts:64</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Holds the consumed state. Default is false.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventObject.ts#L54">view/event/EventObject.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Holds the name.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="properties" class="tsd-anchor"></a><h3>properties</h3><div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventProperties</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventObject.ts#L59">view/event/EventObject.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Holds the properties as an associative array.</p>
|
||||
</div></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"><a id="consume" class="tsd-anchor"></a><h3>consume</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">consume<span class="tsd-signature-symbol">(</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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventObject.ts#L97">view/event/EventObject.ts:97</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Consumes the event.</p>
|
||||
</div></div><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"><a id="getName" class="tsd-anchor"></a><h3>get<wbr/>Name</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventObject.ts#L69">view/event/EventObject.ts:69</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns <name>.</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"><a id="getProperties" class="tsd-anchor"></a><h3>get<wbr/>Properties</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Properties<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventProperties</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventObject.ts#L76">view/event/EventObject.ts:76</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns <properties>.</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventProperties</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getProperty" class="tsd-anchor"></a><h3>get<wbr/>Property</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Property<span class="tsd-signature-symbol">(</span>key<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">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventObject.ts#L83">view/event/EventObject.ts:83</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns the property for the given key.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</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"><a id="isConsumed" class="tsd-anchor"></a><h3>is<wbr/>Consumed</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Consumed<span class="tsd-signature-symbol">(</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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventObject.ts#L90">view/event/EventObject.ts:90</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns true if the event has been consumed.</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</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="EventObject.html" class="tsd-kind-icon">Event<wbr/>Object</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="EventObject.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EventObject.html#consumed" class="tsd-kind-icon">consumed</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EventObject.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EventObject.html#properties" class="tsd-kind-icon">properties</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EventObject.html#consume" class="tsd-kind-icon">consume</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EventObject.html#getName" class="tsd-kind-icon">get<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EventObject.html#getProperties" class="tsd-kind-icon">get<wbr/>Properties</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EventObject.html#getProperty" class="tsd-kind-icon">get<wbr/>Property</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EventObject.html#isConsumed" class="tsd-kind-icon">is<wbr/>Consumed</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>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,11 +0,0 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HierarchicalLayoutStage | @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="HierarchicalLayoutStage.html">HierarchicalLayoutStage</a></li></ul><h1>Class HierarchicalLayoutStage</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>The specific layout interface for hierarchical layouts. It adds a
|
||||
<code>run</code> method with a parameter for the hierarchical layout model
|
||||
that is shared between the layout stages.</p>
|
||||
</div><div><p>Constructor: mxHierarchicalLayoutStage</p>
|
||||
<p>Constructs a new hierarchical layout stage.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">HierarchicalLayoutStage</span><ul class="tsd-hierarchy"><li><a href="CoordinateAssignment.html" class="tsd-signature-type" data-tsd-kind="Class">CoordinateAssignment</a></li><li><a href="MedianHybridCrossingReduction.html" class="tsd-signature-type" data-tsd-kind="Class">MedianHybridCrossingReduction</a></li><li><a href="MinimumCycleRemover.html" class="tsd-signature-type" data-tsd-kind="Class">MinimumCycleRemover</a></li><li><a href="SwimlaneOrdering.html" class="tsd-signature-type" data-tsd-kind="Class">SwimlaneOrdering</a></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"><a href="HierarchicalLayoutStage.html#constructor" class="tsd-kind-icon">constructor</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"><a href="HierarchicalLayoutStage.html#execute" class="tsd-kind-icon">execute</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"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Hierarchical<wbr/>Layout<wbr/>Stage<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="HierarchicalLayoutStage.html" class="tsd-signature-type" data-tsd-kind="Class">HierarchicalLayoutStage</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/hierarchical/HierarchicalLayoutStage.ts#L18">view/layout/hierarchical/HierarchicalLayoutStage.ts:18</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="HierarchicalLayoutStage.html" class="tsd-signature-type" data-tsd-kind="Class">HierarchicalLayoutStage</a></h4></li></ul></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"><a id="execute" class="tsd-anchor"></a><h3>execute</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">execute<span class="tsd-signature-symbol">(</span>parent<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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/layout/hierarchical/HierarchicalLayoutStage.ts#L25">view/layout/hierarchical/HierarchicalLayoutStage.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Takes the graph detail and configuration information within the facade
|
||||
and creates the resulting laid out graph within that facade for further
|
||||
use.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>parent: <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></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="HierarchicalLayoutStage.html" class="tsd-kind-icon">Hierarchical<wbr/>Layout<wbr/>Stage</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="HierarchicalLayoutStage.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="HierarchicalLayoutStage.html#execute" class="tsd-kind-icon">execute</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>
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ImageBox | @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="ImageBox.html">ImageBox</a></li></ul><h1>Class ImageBox</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>Encapsulates the URL, width and height of an image.</p>
|
||||
</div><div><p>Constructor: mxImage</p>
|
||||
<p>Constructs a new image.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ImageBox</span></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"><a href="ImageBox.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="ImageBox.html#height" class="tsd-kind-icon">height</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ImageBox.html#src" class="tsd-kind-icon">src</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ImageBox.html#width" class="tsd-kind-icon">width</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"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Image<wbr/>Box<span class="tsd-signature-symbol">(</span>src<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ImageBox.html" class="tsd-signature-type" data-tsd-kind="Class">ImageBox</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageBox.ts#L16">view/image/ImageBox.ts:16</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>src: <span class="tsd-signature-type">string</span></h5></li><li><h5>width: <span class="tsd-signature-type">number</span></h5></li><li><h5>height: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="ImageBox.html" class="tsd-signature-type" data-tsd-kind="Class">ImageBox</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="height" class="tsd-anchor"></a><h3>height</h3><div class="tsd-signature tsd-kind-icon">height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageBox.ts#L35">view/image/ImageBox.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Integer that specifies the height of the image.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="src" class="tsd-anchor"></a><h3>src</h3><div class="tsd-signature tsd-kind-icon">src<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageBox.ts#L25">view/image/ImageBox.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>String that specifies the URL of the image.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="width" class="tsd-anchor"></a><h3>width</h3><div class="tsd-signature tsd-kind-icon">width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageBox.ts#L30">view/image/ImageBox.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Integer that specifies the width of the image.</p>
|
||||
</div></div></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="ImageBox.html" class="tsd-kind-icon">Image<wbr/>Box</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="ImageBox.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ImageBox.html#height" class="tsd-kind-icon">height</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ImageBox.html#src" class="tsd-kind-icon">src</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ImageBox.html#width" class="tsd-kind-icon">width</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>
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ImageBundle | @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="ImageBundle.html">ImageBundle</a></li></ul><h1>Class ImageBundle</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>Maps from keys to base64 encoded images or file locations. All values must
|
||||
be URLs or use the format data:image/format followed by a comma and the base64
|
||||
encoded image data, eg. "data:image/gif,XYZ", where XYZ is the base64 encoded
|
||||
image data.</p>
|
||||
</div><div><p>To add a new image bundle to an existing graph, the following code is used:</p>
|
||||
<pre><code class="language-javascript"><span class="hl-3">let</span><span class="hl-1"> </span><span class="hl-0">bundle</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-2">mxImageBundle</span><span class="hl-1">(</span><span class="hl-0">alt</span><span class="hl-1">);</span><br/><span class="hl-0">bundle</span><span class="hl-1">.</span><span class="hl-2">putImage</span><span class="hl-1">(</span><span class="hl-6">'myImage'</span><span class="hl-1">, </span><span class="hl-6">'data:image/gif,R0lGODlhEAAQAMIGAAAAAICAAICAgP'</span><span class="hl-1"> +</span><br/><span class="hl-1"> </span><span class="hl-6">'//AOzp2O3r2////////yH+FUNyZWF0ZWQgd2l0aCBUaGUgR0lNUAAh+QQBCgAHACwAAAAA'</span><span class="hl-1"> +</span><br/><span class="hl-1"> </span><span class="hl-6">'EAAQAAADTXi63AowynnAMDfjPUDlnAAJhmeBFxAEloliKltWmiYCQvfVr6lBPB1ggxN1hi'</span><span class="hl-1"> +</span><br/><span class="hl-1"> </span><span class="hl-6">'laSSASFQpIV5HJBDyHpqK2ejVRm2AAgZCdmCGO9CIBADs='</span><span class="hl-1">, </span><span class="hl-0">fallback</span><span class="hl-1">);</span><br/><span class="hl-0">bundle</span><span class="hl-1">.</span><span class="hl-2">putImage</span><span class="hl-1">(</span><span class="hl-6">'mySvgImage'</span><span class="hl-1">, </span><span class="hl-6">'data:image/svg+xml,'</span><span class="hl-1"> + </span><span class="hl-2">encodeURIComponent</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-6">'<svg xmlns="http://www.w3.org/2000/svg" width="100%" height="100%">'</span><span class="hl-1"> +</span><br/><span class="hl-1"> </span><span class="hl-6">'<linearGradient id="gradient"><stop offset="10%" stop-color="#F00"/>'</span><span class="hl-1"> +</span><br/><span class="hl-1"> </span><span class="hl-6">'<stop offset="90%" stop-color="#fcc"/></linearGradient>'</span><span class="hl-1"> +</span><br/><span class="hl-1"> </span><span class="hl-6">'<rect fill="url(#gradient)" width="100%" height="100%"/></svg>'</span><span class="hl-1">), </span><span class="hl-0">fallback</span><span class="hl-1">);</span><br/><span class="hl-0">graph</span><span class="hl-1">.</span><span class="hl-2">addImageBundle</span><span class="hl-1">(</span><span class="hl-0">bundle</span><span class="hl-1">);</span><br/><span class="hl-6">```;</span><br/><br/><span class="hl-6">Alt is an optional boolean (default is false) that specifies if the value</span><br/><span class="hl-6">or the fallback should be returned in <getImage>.</span><br/><br/><span class="hl-6">The image can then be referenced in any cell style using image=myImage.</span><br/><span class="hl-6">If you are using mxOutline, you should use the same image bundles in the</span><br/><span class="hl-6">graph that renders the outline.</span><br/><br/><span class="hl-6">The keys for images are resolved in {@link Graph#postProcessCellStyle} and</span><br/><span class="hl-6">turned into a data URI if the returned value has a short data URI format</span><br/><span class="hl-6">as specified above.</span><br/><br/><span class="hl-6">A typical value for the fallback is a MTHML link as defined in RFC 2557.</span><br/><span class="hl-6">Note that this format requires a file to be dynamically created on the</span><br/><span class="hl-6">server-side, or the page that contains the graph to be modified to contain</span><br/><span class="hl-6">the resources, this can be done by adding a comment that contains the</span><br/><span class="hl-6">resource in the HEAD section of the page after the title tag.</span><br/><br/><span class="hl-6">This type of fallback mechanism should be used in IE6 and IE7. IE8 does</span><br/><span class="hl-6">support data URIs, but the maximum size is limited to 32 KB, which means</span><br/><span class="hl-6">all data URIs should be limited to 32 KB.</span>
|
||||
</code></pre>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ImageBundle</span></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"><a href="ImageBundle.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="ImageBundle.html#alt" class="tsd-kind-icon">alt</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ImageBundle.html#images" class="tsd-kind-icon">images</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"><a href="ImageBundle.html#getImage" class="tsd-kind-icon">get<wbr/>Image</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ImageBundle.html#putImage" class="tsd-kind-icon">put<wbr/>Image</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"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Image<wbr/>Bundle<span class="tsd-signature-symbol">(</span>alt<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><a href="ImageBundle.html" class="tsd-signature-type" data-tsd-kind="Class">ImageBundle</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageBundle.ts#L59">view/image/ImageBundle.ts:59</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>alt: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="ImageBundle.html" class="tsd-signature-type" data-tsd-kind="Class">ImageBundle</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="alt" class="tsd-anchor"></a><h3>alt</h3><div class="tsd-signature tsd-kind-icon">alt<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageBundle.ts#L72">view/image/ImageBundle.ts:72</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Specifies if the fallback representation should be returned.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="images" class="tsd-anchor"></a><h3>images</h3><div class="tsd-signature tsd-kind-icon">images<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ImageMap</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageBundle.ts#L67">view/image/ImageBundle.ts:67</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Maps from keys to images.</p>
|
||||
</div></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"><a id="getImage" class="tsd-anchor"></a><h3>get<wbr/>Image</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Image<span class="tsd-signature-symbol">(</span>key<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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageBundle.ts#L87">view/image/ImageBundle.ts:87</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns the value for the given key. This returns the value
|
||||
or fallback, depending on <alt>. The fallback is returned if
|
||||
<alt> is true, the value is returned otherwise.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <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"><a id="putImage" class="tsd-anchor"></a><h3>put<wbr/>Image</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">put<wbr/>Image<span class="tsd-signature-symbol">(</span>key<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">string</span>, fallback<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">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageBundle.ts#L78">view/image/ImageBundle.ts:78</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Adds the specified entry to the map. The entry is an object with a value and
|
||||
fallback property as specified in the arguments.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5></li><li><h5>value: <span class="tsd-signature-type">string</span></h5></li><li><h5>fallback: <span class="tsd-signature-type">string</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="ImageBundle.html" class="tsd-kind-icon">Image<wbr/>Bundle</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="ImageBundle.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ImageBundle.html#alt" class="tsd-kind-icon">alt</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ImageBundle.html#images" class="tsd-kind-icon">images</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ImageBundle.html#getImage" class="tsd-kind-icon">get<wbr/>Image</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ImageBundle.html#putImage" class="tsd-kind-icon">put<wbr/>Image</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>
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ImageExport | @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="ImageExport.html">ImageExport</a></li></ul><h1>Class ImageExport</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>Creates a new image export instance to be used with an export canvas. Here
|
||||
is an example that uses this class to create an image via a backend using
|
||||
{@link XmlExportCanvas}.</p>
|
||||
</div><div><pre><code class="language-javascript"><span class="hl-3">var</span><span class="hl-1"> </span><span class="hl-0">xmlDoc</span><span class="hl-1"> = </span><span class="hl-0">mxUtils</span><span class="hl-1">.</span><span class="hl-2">createXmlDocument</span><span class="hl-1">();</span><br/><span class="hl-3">var</span><span class="hl-1"> </span><span class="hl-0">root</span><span class="hl-1"> = </span><span class="hl-0">xmlDoc</span><span class="hl-1">.</span><span class="hl-2">createElement</span><span class="hl-1">(</span><span class="hl-6">'output'</span><span class="hl-1">);</span><br/><span class="hl-0">xmlDoc</span><span class="hl-1">.</span><span class="hl-2">appendChild</span><span class="hl-1">(</span><span class="hl-0">root</span><span class="hl-1">);</span><br/><br/><span class="hl-3">var</span><span class="hl-1"> </span><span class="hl-0">xmlCanvas</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-2">mxXmlCanvas2D</span><span class="hl-1">(</span><span class="hl-0">root</span><span class="hl-1">);</span><br/><span class="hl-3">var</span><span class="hl-1"> </span><span class="hl-0">imgExport</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-2">mxImageExport</span><span class="hl-1">();</span><br/><span class="hl-0">imgExport</span><span class="hl-1">.</span><span class="hl-2">drawState</span><span class="hl-1">(</span><span class="hl-0">graph</span><span class="hl-1">.</span><span class="hl-2">getView</span><span class="hl-1">().</span><span class="hl-2">getState</span><span class="hl-1">(</span><span class="hl-0">graph</span><span class="hl-1">.</span><span class="hl-0">model</span><span class="hl-1">.</span><span class="hl-0">root</span><span class="hl-1">), </span><span class="hl-0">xmlCanvas</span><span class="hl-1">);</span><br/><br/><span class="hl-3">var</span><span class="hl-1"> </span><span class="hl-0">bounds</span><span class="hl-1"> = </span><span class="hl-0">graph</span><span class="hl-1">.</span><span class="hl-2">getGraphBounds</span><span class="hl-1">();</span><br/><span class="hl-3">var</span><span class="hl-1"> </span><span class="hl-0">w</span><span class="hl-1"> = </span><span class="hl-10">Math</span><span class="hl-1">.</span><span class="hl-2">ceil</span><span class="hl-1">(</span><span class="hl-0">bounds</span><span class="hl-1">.</span><span class="hl-0">x</span><span class="hl-1"> + </span><span class="hl-0">bounds</span><span class="hl-1">.</span><span class="hl-0">width</span><span class="hl-1">);</span><br/><span class="hl-3">var</span><span class="hl-1"> </span><span class="hl-0">h</span><span class="hl-1"> = </span><span class="hl-10">Math</span><span class="hl-1">.</span><span class="hl-2">ceil</span><span class="hl-1">(</span><span class="hl-0">bounds</span><span class="hl-1">.</span><span class="hl-0">y</span><span class="hl-1"> + </span><span class="hl-0">bounds</span><span class="hl-1">.</span><span class="hl-0">height</span><span class="hl-1">);</span><br/><br/><span class="hl-3">var</span><span class="hl-1"> </span><span class="hl-0">xml</span><span class="hl-1"> = </span><span class="hl-0">mxUtils</span><span class="hl-1">.</span><span class="hl-2">getXml</span><span class="hl-1">(</span><span class="hl-0">root</span><span class="hl-1">);</span><br/><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-2">MaxXmlRequest</span><span class="hl-1">(</span><span class="hl-6">'export'</span><span class="hl-1">, </span><span class="hl-6">'format=png&w='</span><span class="hl-1"> + </span><span class="hl-0">w</span><span class="hl-1"> +</span><br/><span class="hl-1"> </span><span class="hl-6">'&h='</span><span class="hl-1"> + </span><span class="hl-0">h</span><span class="hl-1"> + </span><span class="hl-6">'&bg=#F9F7ED&xml='</span><span class="hl-1"> + </span><span class="hl-2">encodeURIComponent</span><span class="hl-1">(</span><span class="hl-0">xml</span><span class="hl-1">))</span><br/><span class="hl-1"> .</span><span class="hl-2">simulate</span><span class="hl-1">(</span><span class="hl-0">document</span><span class="hl-1">, </span><span class="hl-6">'_blank'</span><span class="hl-1">);</span>
|
||||
</code></pre>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ImageExport</span></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"><a href="ImageExport.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="ImageExport.html#includeOverlays" class="tsd-kind-icon">include<wbr/>Overlays</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"><a href="ImageExport.html#drawCellState" class="tsd-kind-icon">draw<wbr/>Cell<wbr/>State</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ImageExport.html#drawOverlays" class="tsd-kind-icon">draw<wbr/>Overlays</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ImageExport.html#drawShape" class="tsd-kind-icon">draw<wbr/>Shape</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ImageExport.html#drawState" class="tsd-kind-icon">draw<wbr/>State</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ImageExport.html#drawText" class="tsd-kind-icon">draw<wbr/>Text</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ImageExport.html#getLinkForCellState" class="tsd-kind-icon">get<wbr/>Link<wbr/>For<wbr/>Cell<wbr/>State</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ImageExport.html#visitStatesRecursive" class="tsd-kind-icon">visit<wbr/>States<wbr/>Recursive</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"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Image<wbr/>Export<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ImageExport.html" class="tsd-signature-type" data-tsd-kind="Class">ImageExport</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageExport.ts#L40">view/image/ImageExport.ts:40</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="ImageExport.html" class="tsd-signature-type" data-tsd-kind="Class">ImageExport</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="includeOverlays" class="tsd-anchor"></a><h3>include<wbr/>Overlays</h3><div class="tsd-signature tsd-kind-icon">include<wbr/>Overlays<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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageExport.ts#L45">view/image/ImageExport.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Specifies if overlays should be included in the export. Default is false.</p>
|
||||
</div></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"><a id="drawCellState" class="tsd-anchor"></a><h3>draw<wbr/>Cell<wbr/>State</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">draw<wbr/>Cell<wbr/>State<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a>, canvas<span class="tsd-signature-symbol">: </span><a href="AbstractCanvas2D.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractCanvas2D</a><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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageExport.ts#L93">view/image/ImageExport.ts:93</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Draws the given state to the given canvas.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5></li><li><h5>canvas: <a href="AbstractCanvas2D.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractCanvas2D</a></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"><a id="drawOverlays" class="tsd-anchor"></a><h3>draw<wbr/>Overlays</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">draw<wbr/>Overlays<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a>, canvas<span class="tsd-signature-symbol">: </span><a href="AbstractCanvas2D.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractCanvas2D</a><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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageExport.ts#L144">view/image/ImageExport.ts:144</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Draws the overlays for the given state. This is called if <includeOverlays>
|
||||
is true.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5></li><li><h5>canvas: <a href="AbstractCanvas2D.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractCanvas2D</a></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"><a id="drawShape" class="tsd-anchor"></a><h3>draw<wbr/>Shape</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">draw<wbr/>Shape<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a>, canvas<span class="tsd-signature-symbol">: </span><a href="AbstractCanvas2D.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractCanvas2D</a><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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageExport.ts#L113">view/image/ImageExport.ts:113</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Draws the shape of the given state.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5></li><li><h5>canvas: <a href="AbstractCanvas2D.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractCanvas2D</a></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"><a id="drawState" class="tsd-anchor"></a><h3>draw<wbr/>State</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">draw<wbr/>State<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a>, canvas<span class="tsd-signature-symbol">: </span><a href="AbstractCanvas2D.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractCanvas2D</a><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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageExport.ts#L50">view/image/ImageExport.ts:50</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Draws the given state and all its descendants to the given canvas.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5></li><li><h5>canvas: <a href="AbstractCanvas2D.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractCanvas2D</a></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"><a id="drawText" class="tsd-anchor"></a><h3>draw<wbr/>Text</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">draw<wbr/>Text<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a>, canvas<span class="tsd-signature-symbol">: </span><a href="AbstractCanvas2D.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractCanvas2D</a><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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageExport.ts#L128">view/image/ImageExport.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Draws the text of the given state.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5></li><li><h5>canvas: <a href="AbstractCanvas2D.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractCanvas2D</a></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"><a id="getLinkForCellState" class="tsd-anchor"></a><h3>get<wbr/>Link<wbr/>For<wbr/>Cell<wbr/>State</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Link<wbr/>For<wbr/>Cell<wbr/>State<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a>, canvas<span class="tsd-signature-symbol">: </span><a href="AbstractCanvas2D.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractCanvas2D</a><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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageExport.ts#L86">view/image/ImageExport.ts:86</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns the link for the given cell state and canvas. This returns null.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5></li><li><h5>canvas: <a href="AbstractCanvas2D.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractCanvas2D</a></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"><a id="visitStatesRecursive" class="tsd-anchor"></a><h3>visit<wbr/>States<wbr/>Recursive</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">visit<wbr/>States<wbr/>Recursive<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a>, canvas<span class="tsd-signature-symbol">: </span><a href="AbstractCanvas2D.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractCanvas2D</a>, visitor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/image/ImageExport.ts#L68">view/image/ImageExport.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Visits the given state and all its descendants to the given canvas recursively.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5></li><li><h5>canvas: <a href="AbstractCanvas2D.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractCanvas2D</a></h5></li><li><h5>visitor: <span class="tsd-signature-type">Function</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="ImageExport.html" class="tsd-kind-icon">Image<wbr/>Export</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="ImageExport.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ImageExport.html#includeOverlays" class="tsd-kind-icon">include<wbr/>Overlays</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ImageExport.html#drawCellState" class="tsd-kind-icon">draw<wbr/>Cell<wbr/>State</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ImageExport.html#drawOverlays" class="tsd-kind-icon">draw<wbr/>Overlays</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ImageExport.html#drawShape" class="tsd-kind-icon">draw<wbr/>Shape</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ImageExport.html#drawState" class="tsd-kind-icon">draw<wbr/>State</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ImageExport.html#drawText" class="tsd-kind-icon">draw<wbr/>Text</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ImageExport.html#getLinkForCellState" class="tsd-kind-icon">get<wbr/>Link<wbr/>For<wbr/>Cell<wbr/>State</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="ImageExport.html#visitStatesRecursive" class="tsd-kind-icon">visit<wbr/>States<wbr/>Recursive</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>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,12 +0,0 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MarkerShape | @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="MarkerShape.html">MarkerShape</a></li></ul><h1>Class MarkerShape</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>A static class that implements all markers for VML and SVG using a registry.
|
||||
NOTE: The signatures in this class will change.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">MarkerShape</span></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"><a href="MarkerShape.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="MarkerShape.html#markers" class="tsd-kind-icon">markers</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-static"><a href="MarkerShape.html#addMarker" class="tsd-kind-icon">add<wbr/>Marker</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="MarkerShape.html#createMarker" class="tsd-kind-icon">create<wbr/>Marker</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"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Marker<wbr/>Shape<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MarkerShape.html" class="tsd-signature-type" data-tsd-kind="Class">MarkerShape</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="MarkerShape.html" class="tsd-signature-type" data-tsd-kind="Class">MarkerShape</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a id="markers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> markers</h3><div class="tsd-signature tsd-kind-icon">markers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/geometry/edge/MarkerShape.ts#L24">view/geometry/edge/MarkerShape.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Maps from markers names to functions to paint the markers.</p>
|
||||
</div><div><p>Mapping: the attribute name on the object is the marker type, the associated value is the function to paint the marker</p>
|
||||
</div></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-static"><a id="addMarker" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> add<wbr/>Marker</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">add<wbr/>Marker<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, funct<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/geometry/edge/MarkerShape.ts#L30">view/geometry/edge/MarkerShape.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Adds a factory method that updates a given endpoint and returns a
|
||||
function to paint the marker onto the given canvas.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type">string</span></h5></li><li><h5>funct: <span class="tsd-signature-type">Function</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-static"><a id="createMarker" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr/>Marker</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">create<wbr/>Marker<span class="tsd-signature-symbol">(</span>canvas<span class="tsd-signature-symbol">: </span><a href="AbstractCanvas2D.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractCanvas2D</a>, shape<span class="tsd-signature-symbol">: </span><a href="Shape.html" class="tsd-signature-type" data-tsd-kind="Class">Shape</a>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrowType</span>, pe<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a>, unitX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, unitY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, source<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, sw<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, filled<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">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/geometry/edge/MarkerShape.ts#L37">view/geometry/edge/MarkerShape.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns a function to paint the given marker.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>canvas: <a href="AbstractCanvas2D.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractCanvas2D</a></h5></li><li><h5>shape: <a href="Shape.html" class="tsd-signature-type" data-tsd-kind="Class">Shape</a></h5></li><li><h5>type: <span class="tsd-signature-type">ArrowType</span></h5></li><li><h5>pe: <a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h5></li><li><h5>unitX: <span class="tsd-signature-type">number</span></h5></li><li><h5>unitY: <span class="tsd-signature-type">number</span></h5></li><li><h5>size: <span class="tsd-signature-type">number</span></h5></li><li><h5>source: <span class="tsd-signature-type">boolean</span></h5></li><li><h5>sw: <span class="tsd-signature-type">number</span></h5></li><li><h5>filled: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</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="MarkerShape.html" class="tsd-kind-icon">Marker<wbr/>Shape</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="MarkerShape.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="MarkerShape.html#markers" class="tsd-kind-icon">markers</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="MarkerShape.html#addMarker" class="tsd-kind-icon">add<wbr/>Marker</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="MarkerShape.html#createMarker" class="tsd-kind-icon">create<wbr/>Marker</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>
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MaxForm | @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="MaxForm.html">MaxForm</a></li></ul><h1>Class MaxForm</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>A simple class for creating HTML forms.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">MaxForm</span></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"><a href="MaxForm.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="MaxForm.html#body" class="tsd-kind-icon">body</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MaxForm.html#table" class="tsd-kind-icon">table</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"><a href="MaxForm.html#addButtons" class="tsd-kind-icon">add<wbr/>Buttons</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MaxForm.html#addCheckbox" class="tsd-kind-icon">add<wbr/>Checkbox</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MaxForm.html#addCombo" class="tsd-kind-icon">add<wbr/>Combo</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MaxForm.html#addField" class="tsd-kind-icon">add<wbr/>Field</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MaxForm.html#addOption" class="tsd-kind-icon">add<wbr/>Option</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MaxForm.html#addText" class="tsd-kind-icon">add<wbr/>Text</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MaxForm.html#addTextarea" class="tsd-kind-icon">add<wbr/>Textarea</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MaxForm.html#getTable" class="tsd-kind-icon">get<wbr/>Table</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"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Max<wbr/>Form<span class="tsd-signature-symbol">(</span>className<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><a href="MaxForm.html" class="tsd-signature-type" data-tsd-kind="Class">MaxForm</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/gui/MaxForm.ts#L19">gui/MaxForm.ts:19</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>className: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="MaxForm.html" class="tsd-signature-type" data-tsd-kind="Class">MaxForm</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="body" class="tsd-anchor"></a><h3>body</h3><div class="tsd-signature tsd-kind-icon">body<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLElement</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/gui/MaxForm.ts#L36">gui/MaxForm.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Holds the DOM node that represents the tbody (table body). New rows
|
||||
can be added to this object using DOM API.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="table" class="tsd-anchor"></a><h3>table</h3><div class="tsd-signature tsd-kind-icon">table<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLTableElement</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/gui/MaxForm.ts#L30">gui/MaxForm.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Holds the DOM node that represents the table.</p>
|
||||
</div></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"><a id="addButtons" class="tsd-anchor"></a><h3>add<wbr/>Buttons</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Buttons<span class="tsd-signature-symbol">(</span>okFunct<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span>, cancelFunct<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/gui/MaxForm.ts#L49">gui/MaxForm.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Helper method to add an OK and Cancel button using the respective
|
||||
functions.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>okFunct: <span class="tsd-signature-type">Function</span></h5></li><li><h5>cancelFunct: <span class="tsd-signature-type">Function</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"><a id="addCheckbox" class="tsd-anchor"></a><h3>add<wbr/>Checkbox</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Checkbox<span class="tsd-signature-symbol">(</span>name<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">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLInputElement</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/gui/MaxForm.ts#L91">gui/MaxForm.ts:91</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Adds a checkbox for the given name and value and returns the textfield.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5></li><li><h5>value: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLInputElement</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addCombo" class="tsd-anchor"></a><h3>add<wbr/>Combo</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Combo<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, isMultiSelect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, size<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLSelectElement</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/gui/MaxForm.ts#L122">gui/MaxForm.ts:122</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Adds a combo for the given name and returns the combo.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5></li><li><h5>isMultiSelect: <span class="tsd-signature-type">boolean</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> size: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLSelectElement</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addField" class="tsd-anchor"></a><h3>add<wbr/>Field</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Field<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, input<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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/gui/MaxForm.ts#L156">gui/MaxForm.ts:156</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Adds a new row with the name and the input field in two columns and
|
||||
returns the given input.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5></li><li><h5>input: <span class="tsd-signature-type">Element</span></h5></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"><a id="addOption" class="tsd-anchor"></a><h3>add<wbr/>Option</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Option<span class="tsd-signature-symbol">(</span>combo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, label<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>, isSelected<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">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/gui/MaxForm.ts#L139">gui/MaxForm.ts:139</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Adds an option for the given label to the specified combo.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>combo: <span class="tsd-signature-type">HTMLElement</span></h5></li><li><h5>label: <span class="tsd-signature-type">string</span></h5></li><li><h5>value: <span class="tsd-signature-type">any</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> isSelected: <span class="tsd-signature-type">boolean</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"><a id="addText" class="tsd-anchor"></a><h3>add<wbr/>Text</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Text<span class="tsd-signature-symbol">(</span>name<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>, type<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">HTMLInputElement</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/gui/MaxForm.ts#L80">gui/MaxForm.ts:80</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Adds an input for the given name, type and value and returns it.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5></li><li><h5>value: <span class="tsd-signature-type">any</span></h5></li><li><h5>type: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'text'</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLInputElement</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addTextarea" class="tsd-anchor"></a><h3>add<wbr/>Textarea</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Textarea<span class="tsd-signature-symbol">(</span>name<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">string</span>, rows<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLTextAreaElement</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/gui/MaxForm.ts#L106">gui/MaxForm.ts:106</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Adds a textarea for the given name and value and returns the textarea.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5></li><li><h5>value: <span class="tsd-signature-type">string</span></h5></li><li><h5>rows: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLTextAreaElement</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getTable" class="tsd-anchor"></a><h3>get<wbr/>Table</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Table<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLTableElement</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/gui/MaxForm.ts#L41">gui/MaxForm.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Returns the table that contains this form.</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLTableElement</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="MaxForm.html" class="tsd-kind-icon">Max<wbr/>Form</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="MaxForm.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MaxForm.html#body" class="tsd-kind-icon">body</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MaxForm.html#table" class="tsd-kind-icon">table</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MaxForm.html#addButtons" class="tsd-kind-icon">add<wbr/>Buttons</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MaxForm.html#addCheckbox" class="tsd-kind-icon">add<wbr/>Checkbox</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MaxForm.html#addCombo" class="tsd-kind-icon">add<wbr/>Combo</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MaxForm.html#addField" class="tsd-kind-icon">add<wbr/>Field</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MaxForm.html#addOption" class="tsd-kind-icon">add<wbr/>Option</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MaxForm.html#addText" class="tsd-kind-icon">add<wbr/>Text</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MaxForm.html#addTextarea" class="tsd-kind-icon">add<wbr/>Textarea</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MaxForm.html#getTable" class="tsd-kind-icon">get<wbr/>Table</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>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue