28 lines
20 KiB
HTML
28 lines
20 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Perimeter | @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="Perimeter.html">Perimeter</a></li></ul><h1>Class Perimeter</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">Perimeter</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="Perimeter.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="Perimeter.html#EllipsePerimeter" class="tsd-kind-icon">Ellipse<wbr/>Perimeter</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Perimeter.html#HexagonPerimeter" class="tsd-kind-icon">Hexagon<wbr/>Perimeter</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Perimeter.html#RectanglePerimeter" class="tsd-kind-icon">Rectangle<wbr/>Perimeter</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Perimeter.html#RhombusPerimeter" class="tsd-kind-icon">Rhombus<wbr/>Perimeter</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Perimeter.html#TrianglePerimeter" class="tsd-kind-icon">Triangle<wbr/>Perimeter</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/>Perimeter<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Perimeter.html" class="tsd-signature-type" data-tsd-kind="Class">Perimeter</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="Perimeter.html" class="tsd-signature-type" data-tsd-kind="Class">Perimeter</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="EllipsePerimeter" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> Ellipse<wbr/>Perimeter</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">Ellipse<wbr/>Perimeter<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>, vertex<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a>, next<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a>, orthogonal<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/style/Perimeter.ts#L150">view/style/Perimeter.ts:150</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Describes an elliptic perimeter. See <a href="Perimeter.html#RectanglePerimeter">RectanglePerimeter</a>
|
|
for a description of the parameters.</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>vertex: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5></li><li><h5>next: <a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h5></li><li><h5>orthogonal: <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 tsd-is-static"><a id="HexagonPerimeter" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> Hexagon<wbr/>Perimeter</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">Hexagon<wbr/>Perimeter<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>, vertex<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a>, next<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a>, orthogonal<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">null</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/style/Perimeter.ts#L412">view/style/Perimeter.ts:412</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Describes a hexagon perimeter. See <a href="Perimeter.html#RectanglePerimeter">RectanglePerimeter</a>
|
|
for a description of the parameters.</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>vertex: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5></li><li><h5>next: <a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h5></li><li><h5>orthogonal: <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">null</span><span class="tsd-signature-symbol"> | </span><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 tsd-is-static"><a id="RectanglePerimeter" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> Rectangle<wbr/>Perimeter</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">Rectangle<wbr/>Perimeter<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>, vertex<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a>, next<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a>, orthogonal<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/style/Perimeter.ts#L90">view/style/Perimeter.ts:90</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Describes a rectangular perimeter for the given bounds.</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><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>{@link mxRectangle} that represents the absolute bounds of the
|
|
vertex.</p>
|
|
</div></div></li><li><h5>vertex: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="CellState.html">CellState</a> that represents the vertex.</p>
|
|
</div></div></li><li><h5>next: <a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>{@link mxPoint} that represents the nearest neighbour point on the
|
|
given edge.</p>
|
|
</div></div></li><li><h5>orthogonal: <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 if the orthogonal projection onto
|
|
the perimeter should be returned. If this is false then the intersection
|
|
of the perimeter and the line between the next and the center point is
|
|
returned.</p>
|
|
</div></div></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 tsd-is-static"><a id="RhombusPerimeter" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> Rhombus<wbr/>Perimeter</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">Rhombus<wbr/>Perimeter<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>, vertex<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a>, next<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a>, orthogonal<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">null</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/style/Perimeter.ts#L236">view/style/Perimeter.ts:236</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Describes a rhombus (aka diamond) perimeter. See <a href="Perimeter.html#RectanglePerimeter">RectanglePerimeter</a>
|
|
for a description of the parameters.</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>vertex: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5></li><li><h5>next: <a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h5></li><li><h5>orthogonal: <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">null</span><span class="tsd-signature-symbol"> | </span><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 tsd-is-static"><a id="TrianglePerimeter" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> Triangle<wbr/>Perimeter</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">Triangle<wbr/>Perimeter<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>, vertex<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a>, next<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a>, orthogonal<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">null</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/style/Perimeter.ts#L296">view/style/Perimeter.ts:296</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Describes a triangle perimeter. See <a href="Perimeter.html#RectanglePerimeter">RectanglePerimeter</a>
|
|
for a description of the parameters.</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>vertex: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5></li><li><h5>next: <a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h5></li><li><h5>orthogonal: <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">null</span><span class="tsd-signature-symbol"> | </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</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="Perimeter.html" class="tsd-kind-icon">Perimeter</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Perimeter.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Perimeter.html#EllipsePerimeter" class="tsd-kind-icon">Ellipse<wbr/>Perimeter</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Perimeter.html#HexagonPerimeter" class="tsd-kind-icon">Hexagon<wbr/>Perimeter</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Perimeter.html#RectanglePerimeter" class="tsd-kind-icon">Rectangle<wbr/>Perimeter</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Perimeter.html#RhombusPerimeter" class="tsd-kind-icon">Rhombus<wbr/>Perimeter</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Perimeter.html#TrianglePerimeter" class="tsd-kind-icon">Triangle<wbr/>Perimeter</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> |