47 lines
23 KiB
HTML
47 lines
23 KiB
HTML
|
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Clipboard | @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="Clipboard.html">Clipboard</a></li></ul><h1>Class Clipboard</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Clipboard</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="Clipboard.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="Clipboard.html#STEPSIZE" class="tsd-kind-icon">STEPSIZE</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#cells" class="tsd-kind-icon">cells</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#insertCount" class="tsd-kind-icon">insert<wbr/>Count</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="Clipboard.html#copy" class="tsd-kind-icon">copy</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#cut" class="tsd-kind-icon">cut</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#getCells" class="tsd-kind-icon">get<wbr/>Cells</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#isEmpty" class="tsd-kind-icon">is<wbr/>Empty</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#paste" class="tsd-kind-icon">paste</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#removeCells" class="tsd-kind-icon">remove<wbr/>Cells</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#setCells" clas
|
||
|
|
<p>Defines the step size to offset the cells after each paste operation.
|
||
|
|
Default is 10.</p>
|
||
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a id="cells" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> cells</h3><div class="tsd-signature tsd-kind-icon">cells<span class="tsd-signature-symbol">:</span> <a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/util/Clipboard.ts#L96">util/Clipboard.ts:96</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Holds the array of {@link mxCell} currently in the clipboard.</p>
|
||
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a id="insertCount" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> insert<wbr/>Count</h3><div class="tsd-signature tsd-kind-icon">insert<wbr/>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/util/Clipboard.ts#L91">util/Clipboard.ts:91</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Counts the number of times the clipboard data has been inserted.</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="copy" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> copy</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">copy<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>, cells<span class="tsd-signature-symbol">?: </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</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/util/Clipboard.ts#L155">util/Clipboard.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Copies the given array of {@link mxCell} from the specified
|
||
|
|
graph to <a href="Clipboard.html#cells">cells</a>. Returns the original array of cells that has
|
||
|
|
been cloned. Descendants of cells in the array are ignored.</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>{@link graph} that contains the cells to be copied.</p>
|
||
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> cells: <a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Optional array of {@link mxCell} to be copied.</p>
|
||
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="cut" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> cut</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">cut<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>, cells<span class="tsd-signature-symbol">?: </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</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/util/Clipboard.ts#L127">util/Clipboard.ts:127</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Cuts the given array of {@link mxCell} from the specified graph.
|
||
|
|
If cells is null then the selection cells of the graph will
|
||
|
|
be used. Returns the cells that have been cut from the graph.</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>{@link graph} that contains the cells to be cut.</p>
|
||
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> cells: <a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Optional array of {@link mxCell} to be cut.</p>
|
||
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="getCells" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr/>Cells</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">get<wbr/>Cells<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</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/util/Clipboard.ts#L108">util/Clipboard.ts:108</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Returns the cells in the clipboard.</p>
|
||
|
|
</div></div><h4 class="tsd-returns-title">Returns <a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="isEmpty" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr/>Empty</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">is<wbr/>Empty<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/util/Clipboard.ts#L115">util/Clipboard.ts:115</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Returns true if the clipboard currently has not data stored.</p>
|
||
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="paste" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> paste</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">paste<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><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="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</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/util/Clipboard.ts#L175">util/Clipboard.ts:175</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Pastes the <a href="Clipboard.html#cells">cells</a> into the specified graph restoring
|
||
|
|
the relation to {@link parents}, if possible. If the parents
|
||
|
|
are no longer in the graph or invisible then the
|
||
|
|
cells are added to the graph's default or into the
|
||
|
|
swimlane under the cell's new location if one exists.
|
||
|
|
The cells are added to the graph using {@link graph.importCells}
|
||
|
|
and returned.</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>{@link graph} to paste the <a href="Clipboard.html#cells">cells</a> into.</p>
|
||
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="removeCells" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> remove<wbr/>Cells</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">remove<wbr/>Cells<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>, cells<span class="tsd-signature-symbol">: </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</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/util/Clipboard.ts#L142">util/Clipboard.ts:142</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Hook to remove the given cells from the given graph after
|
||
|
|
a cut operation.</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>{@link graph} that contains the cells to be cut.</p>
|
||
|
|
</div></div></li><li><h5>cells: <a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Array of {@link mxCell} to be cut.</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="setCells" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr/>Cells</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">set<wbr/>Cells<span class="tsd-signature-symbol">(</span>cells<span class="tsd-signature-symbol">: </span><a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</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/util/Clipboard.ts#L101">util/Clipboard.ts:101</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Sets the cells in the clipboard. Fires a {@link mxEvent.CHANGE} event.</p>
|
||
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cells: <a href="CellArray.html" class="tsd-signature-type" data-tsd-kind="Class">CellArray</a></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="Clipboard.html" class="tsd-kind-icon">Clipboard</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Clipboard.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#STEPSIZE" class="tsd-kind-icon">STEPSIZE</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#cells" class="tsd-kind-icon">cells</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#insertCount" class="tsd-kind-icon">insert<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#copy" class="tsd-kind-icon">copy</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#cut" class="tsd-kind-icon">cut</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#getCells" class="tsd-kind-icon">get<wbr/>Cells</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#isEmpty" class="tsd-kind-icon">is<wbr/>Empty</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#paste" class="tsd-kind-icon">paste</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#removeCells" class="tsd-kind-icon">remove<wbr/>Cells</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Clipboard.html#setCells" class="tsd-kind-icon">set<wbr/>Cells</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
|