zcy
/
maxGraph
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
maxGraph/docs/api/classes/Guide.html

49 lines
34 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Guide | @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="Guide.html">Guide</a></li></ul><h1>Class Guide</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 the alignment of selection cells to other cells in the graph.</p>
</div><div><p>Constructor: mxGuide</p>
<p>Constructs a new guide object.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Guide</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="Guide.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="Guide.html#graph" class="tsd-kind-icon">graph</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Guide.html#guideX" class="tsd-kind-icon">guideX</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Guide.html#guideY" class="tsd-kind-icon">guideY</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Guide.html#horizontal" class="tsd-kind-icon">horizontal</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Guide.html#rounded" class="tsd-kind-icon">rounded</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Guide.html#states" class="tsd-kind-icon">states</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Guide.html#tolerance" class="tsd-kind-icon">tolerance</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Guide.html#vertical" class="tsd-kind-icon">vertical</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="Guide.html#createGuideShape" class="tsd-kind-icon">create<wbr/>Guide<wbr/>Shape</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#getDelta" class="tsd-kind-icon">get<wbr/>Delta</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#getGuideColor" class="tsd-kind-icon">get<wbr/>Guide<wbr/>Color</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#getGuideTolerance" class="tsd-kind-icon">get<wbr/>Guide<wbr/>Tolerance</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#hide" class="tsd-kind-icon">hide</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#isEnabledForEvent" class="tsd-kind-icon">is<wbr/>Enabled<wbr/>For<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#isStateIgnored" class="tsd-kind-icon">is<wbr/>State<wbr/>Ignored</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#move" class="tsd-kind-icon">move</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#setStates" class="tsd-kind-icon">set<wbr/>States</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#setVisible" class="tsd-kind-icon">set<wbr/>Visible</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/>Guide<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>, states<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Guide.html" class="tsd-signature-type" data-tsd-kind="Class">Guide</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/Guide.ts#L24">view/other/Guide.ts:24</a></li></ul></aside><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></li><li><h5>states: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Guide.html" class="tsd-signature-type" data-tsd-kind="Class">Guide</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="graph" class="tsd-anchor"></a><h3>graph</h3><div class="tsd-signature tsd-kind-icon">graph<span class="tsd-signature-symbol">:</span> <a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Guide.ts#L32">view/other/Guide.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Reference to the enclosing <a href="Graph.html">Graph</a> instance.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="guideX" class="tsd-anchor"></a><h3>guideX</h3><div class="tsd-signature tsd-kind-icon">guideX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Shape.html" class="tsd-signature-type" data-tsd-kind="Class">Shape</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/view/other/Guide.ts#L52">view/other/Guide.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Holds the <a href="Shape.html">Shape</a> for the horizontal guide.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="guideY" class="tsd-anchor"></a><h3>guideY</h3><div class="tsd-signature tsd-kind-icon">guideY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Shape.html" class="tsd-signature-type" data-tsd-kind="Class">Shape</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/view/other/Guide.ts#L57">view/other/Guide.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Holds the <a href="Shape.html">Shape</a> for the vertical guide.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="horizontal" class="tsd-anchor"></a><h3>horizontal</h3><div class="tsd-signature tsd-kind-icon">horizontal<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/Guide.ts#L42">view/other/Guide.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specifies if horizontal guides are enabled. Default is true.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="rounded" class="tsd-anchor"></a><h3>rounded</h3><div class="tsd-signature tsd-kind-icon">rounded<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/other/Guide.ts#L62">view/other/Guide.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specifies if rounded coordinates should be used. Default is false.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="states" class="tsd-anchor"></a><h3>states</h3><div class="tsd-signature tsd-kind-icon">states<span class="tsd-signature-symbol">:</span> <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a><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/other/Guide.ts#L37">view/other/Guide.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Contains the {@link CellStates} that are used for alignment.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="tolerance" class="tsd-anchor"></a><h3>tolerance</h3><div class="tsd-signature tsd-kind-icon">tolerance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 2</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Guide.ts#L67">view/other/Guide.ts:67</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Default tolerance in px if grid is disabled. Default is 2.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="vertical" class="tsd-anchor"></a><h3>vertical</h3><div class="tsd-signature tsd-kind-icon">vertical<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/Guide.ts#L47">view/other/Guide.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specifies if vertical guides are enabled. Default is true.</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="createGuideShape" class="tsd-anchor"></a><h3>create<wbr/>Guide<wbr/>Shape</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Guide<wbr/>Shape<span class="tsd-signature-symbol">(</span>horizontal<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="PolylineShape.html" class="tsd-signature-type" data-tsd-kind="Class">PolylineShape</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/Guide.ts#L100">view/other/Guide.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns the mxShape to be used for painting the respective guide. This
implementation returns a new, dashed and crisp {@link Polyline} using
{@link Constants#GUIDE_COLOR} and {@link Constants#GUIDE_STROKEWIDTH} as the format.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>horizontal: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Boolean that specifies which guide should be created.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="PolylineShape.html" class="tsd-signature-type" data-tsd-kind="Class">PolylineShape</a></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/view/other/Guide.ts#L371">view/other/Guide.ts:371</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Destroys all resources that this object uses.</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="getDelta" class="tsd-anchor"></a><h3>get<wbr/>Delta</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Delta<span class="tsd-signature-symbol">(</span>bounds<span class="tsd-signature-symbol">: </span><a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a>, stateX<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a>, dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, stateY<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a>, 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="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</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/Guide.ts#L325">view/other/Guide.ts:325</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Rounds to pixels for virtual states (eg. page guides)</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>bounds: <a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a></h5></li><li><h5>stateX: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a><span class="tsd-signature-symbol"> = null</span></h5></li><li><h5>dx: <span class="tsd-signature-type">number</span></h5></li><li><h5>stateY: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a><span class="tsd-signature-symbol"> = null</span></h5></li><li><h5>dy: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getGuideColor" class="tsd-anchor"></a><h3>get<wbr/>Guide<wbr/>Color</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Guide<wbr/>Color<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>, horizontal<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">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/other/Guide.ts#L345">view/other/Guide.ts:345</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Hides all current guides.</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>horizontal: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getGuideTolerance" class="tsd-anchor"></a><h3>get<wbr/>Guide<wbr/>Tolerance</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Guide<wbr/>Tolerance<span class="tsd-signature-symbol">(</span>gridEnabled<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">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/other/Guide.ts#L87">view/other/Guide.ts:87</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns the tolerance for the guides. Default value is gridSize / 2.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>gridEnabled: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</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"><a id="hide" class="tsd-anchor"></a><h3>hide</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">hide<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/other/Guide.ts#L352">view/other/Guide.ts:352</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Hides all current guides.</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="isEnabledForEvent" class="tsd-anchor"></a><h3>is<wbr/>Enabled<wbr/>For<wbr/>Event</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Enabled<wbr/>For<wbr/>Event<span class="tsd-signature-symbol">(</span>evt<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">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/other/Guide.ts#L80">view/other/Guide.ts:80</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns true if the guide should be enabled for the given native event. This
implementation always returns true.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>evt: <span class="tsd-signature-type">MouseEvent</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isStateIgnored" class="tsd-anchor"></a><h3>is<wbr/>State<wbr/>Ignored</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>State<wbr/>Ignored<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><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/other/Guide.ts#L111">view/other/Guide.ts:111</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns true if the given state should be ignored.</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><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="move" class="tsd-anchor"></a><h3>move</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">move<span class="tsd-signature-symbol">(</span>bounds<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a>, delta<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a>, gridEnabled<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, clone<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="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</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/Guide.ts#L118">view/other/Guide.ts:118</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Moves the <bounds> by the given <a href="Point.html">Point</a> and returnt the snapped point.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>bounds: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a><span class="tsd-signature-symbol"> = null</span></h5></li><li><h5>delta: <a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h5></li><li><h5>gridEnabled: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li><li><h5>clone: <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="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setStates" class="tsd-anchor"></a><h3>set<wbr/>States</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>States<span class="tsd-signature-symbol">(</span>states<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a><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/other/Guide.ts#L72">view/other/Guide.ts:72</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Sets the {@link CellStates} that should be used for alignment.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>states: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a><span class="tsd-signature-symbol">[]</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="setVisible" class="tsd-anchor"></a><h3>set<wbr/>Visible</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Visible<span class="tsd-signature-symbol">(</span>visible<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/other/Guide.ts#L359">view/other/Guide.ts:359</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Shows or hides the current guides.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>visible: <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="Guide.html" class="tsd-kind-icon">Guide</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Guide.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Guide.html#graph" class="tsd-kind-icon">graph</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Guide.html#guideX" class="tsd-kind-icon">guideX</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Guide.html#guideY" class="tsd-kind-icon">guideY</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Guide.html#horizontal" class="tsd-kind-icon">horizontal</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Guide.html#rounded" class="tsd-kind-icon">rounded</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Guide.html#states" class="tsd-kind-icon">states</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Guide.html#tolerance" class="tsd-kind-icon">tolerance</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Guide.html#vertical" class="tsd-kind-icon">vertical</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#createGuideShape" class="tsd-kind-icon">create<wbr/>Guide<wbr/>Shape</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#getDelta" class="tsd-kind-icon">get<wbr/>Delta</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#getGuideColor" class="tsd-kind-icon">get<wbr/>Guide<wbr/>Color</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#getGuideTolerance" class="tsd-kind-icon">get<wbr/>Guide<wbr/>Tolerance</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#hide" class="tsd-kind-icon">hide</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#isEnabledForEvent" class="tsd-kind-icon">is<wbr/>Enabled<wbr/>For<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#isStateIgnored" class="tsd-kind-icon">is<wbr/>State<wbr/>Ignored</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#move" class="tsd-kind-icon">move</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#setStates" class="tsd-kind-icon">set<wbr/>States</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Guide.html#setVisible" class="tsd-kind-icon">set<wbr/>Visible</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>
Reference in New Issue View Git Blame Copy Permalink