warp-grid
Version:
Create a complex grid, warped in 2D space and access data about its lines and cells
41 lines (40 loc) • 29.7 kB
HTML
<html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WarpGrid | warp-grid</title><meta name="description" content="Documentation for warp-grid"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">warp-grid</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">WarpGrid</a></li></ul><h1>Interface WarpGrid</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Complete grid interface combining manipulation methods with model access.</p>
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">WarpGrid</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#getpoint">getPoint</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="GetPointProps.html" class="tsd-signature-type tsd-kind-interface">GetPointProps</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="Point.html" class="tsd-signature-type tsd-kind-interface">Point</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getintersections">getIntersections</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a href="Point.html" class="tsd-signature-type tsd-kind-interface">Point</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getlinesxaxis">getLinesXAxis</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a href="Curve.html" class="tsd-signature-type tsd-kind-interface">Curve</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getlinesyaxis">getLinesYAxis</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a href="Curve.html" class="tsd-signature-type tsd-kind-interface">Curve</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getlines">getLines</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a href="LinesByAxis.html" class="tsd-signature-type tsd-kind-interface">LinesByAxis</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getcellbounds">getCellBounds</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">columnIdx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">rowIdx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?:</span> <a href="GetCellBoundsConfig.html" class="tsd-signature-type tsd-kind-interface">GetCellBoundsConfig</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="BoundingCurves.html" class="tsd-signature-type tsd-kind-interface">BoundingCurves</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getallcellbounds">getAllCellBounds</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">?:</span> <a href="GetAllCellBoundsProps.html" class="tsd-signature-type tsd-kind-interface">GetAllCellBoundsProps</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="BoundingCurves.html" class="tsd-signature-type tsd-kind-interface">BoundingCurves</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#model">model</a><span class="tsd-signature-symbol">:</span> <a href="GridModel.html" class="tsd-signature-type tsd-kind-interface">GridModel</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="136"><h4>Hierarchy (<a href="../hierarchy.html#WarpGrid">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="GridApi.html" class="tsd-signature-type tsd-kind-interface">GridApi</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">WarpGrid</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Undistraction/warp-grid/blob/a885d63c38a4c9c4866e26f6db999146927e13fa/src/types.ts#L257">src/types.ts:257</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#getpoint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Point</span></a>
<a href="#getintersections" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Intersections</span></a>
<a href="#getlinesxaxis" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Lines<wbr/>X<wbr/>Axis</span></a>
<a href="#getlinesyaxis" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Lines<wbr/>Y<wbr/>Axis</span></a>
<a href="#getlines" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Lines</span></a>
<a href="#getcellbounds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Cell<wbr/>Bounds</span></a>
<a href="#getallcellbounds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>All<wbr/>Cell<wbr/>Bounds</span></a>
<a href="#model" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getpoint"><span>get<wbr/>Point</span><a href="#getpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getPoint</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="GetPointProps.html" class="tsd-signature-type tsd-kind-interface">GetPointProps</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="Point.html" class="tsd-signature-type tsd-kind-interface">Point</a></div><div class="tsd-comment tsd-typography"><p>Returns a point at the specified grid coordinates. Results are memoized for
performance.</p>
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="GetPointProps.html" class="tsd-signature-type tsd-kind-interface">GetPointProps</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="Point.html" class="tsd-signature-type tsd-kind-interface">Point</a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">params</span>: <a href="GetPointProps.html" class="tsd-signature-type tsd-kind-interface">GetPointProps</a></span><div class="tsd-comment tsd-typography"><p>The grid coordinates and options.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Point.html" class="tsd-signature-type tsd-kind-interface">Point</a></h4><p>The calculated grid point.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>ValidationError When coordinates are outside valid range.</p>
</div></div><aside class="tsd-sources"><p>Inherited from <a href="GridApi.html">GridApi</a>.<a href="GridApi.html#getpoint">getPoint</a></p><ul><li>Defined in <a href="https://github.com/Undistraction/warp-grid/blob/a885d63c38a4c9c4866e26f6db999146927e13fa/src/types.ts#L70">src/types.ts:70</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getintersections"><span>get<wbr/>Intersections</span><a href="#getintersections" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getIntersections</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a href="Point.html" class="tsd-signature-type tsd-kind-interface">Point</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Returns all points where grid lines intersect. Results are memoized for
performance.</p>
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="Point.html" class="tsd-signature-type tsd-kind-interface">Point</a><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="Point.html" class="tsd-signature-type tsd-kind-interface">Point</a><span class="tsd-signature-symbol">[]</span></h4><p>Array of intersection points.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="GridApi.html">GridApi</a>.<a href="GridApi.html#getintersections">getIntersections</a></p><ul><li>Defined in <a href="https://github.com/Undistraction/warp-grid/blob/a885d63c38a4c9c4866e26f6db999146927e13fa/src/types.ts#L77">src/types.ts:77</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getlinesxaxis"><span>get<wbr/>Lines<wbr/>X<wbr/>Axis</span><a href="#getlinesxaxis" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getLinesXAxis</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a href="Curve.html" class="tsd-signature-type tsd-kind-interface">Curve</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Returns horizontal grid lines organized in rows from top to bottom. Each
array element represents a row containing Bézier curves that form the
horizontal grid structure. Lines include top and bottom bounds. Results are
memoized for performance.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="GridApi.html">GridApi</a>.<a href="GridApi.html#getlinesxaxis">getLinesXAxis</a></p><ul><li>Defined in <a href="https://github.com/Undistraction/warp-grid/blob/a885d63c38a4c9c4866e26f6db999146927e13fa/src/types.ts#L85">src/types.ts:85</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getlinesyaxis"><span>get<wbr/>Lines<wbr/>Y<wbr/>Axis</span><a href="#getlinesyaxis" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getLinesYAxis</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a href="Curve.html" class="tsd-signature-type tsd-kind-interface">Curve</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Returns vertical grid lines organized in rows from top to bottom. Each
array element represents a column containing Bézier curves that form the
vertical grid structure. Lines include left and right bounds. Results are
memoized for performance.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="GridApi.html">GridApi</a>.<a href="GridApi.html#getlinesyaxis">getLinesYAxis</a></p><ul><li>Defined in <a href="https://github.com/Undistraction/warp-grid/blob/a885d63c38a4c9c4866e26f6db999146927e13fa/src/types.ts#L93">src/types.ts:93</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getlines"><span>get<wbr/>Lines</span><a href="#getlines" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getLines</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a href="LinesByAxis.html" class="tsd-signature-type tsd-kind-interface">LinesByAxis</a></div><div class="tsd-comment tsd-typography"><p>Returns all grid lines organized by axis. The returned object contains
arrays of Bézier curves representing horizontal lines (xAxis) and vertical
lines (yAxis). Results are memoized for performance.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="GridApi.html">GridApi</a>.<a href="GridApi.html#getlines">getLines</a></p><ul><li>Defined in <a href="https://github.com/Undistraction/warp-grid/blob/a885d63c38a4c9c4866e26f6db999146927e13fa/src/types.ts#L100">src/types.ts:100</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getcellbounds"><span>get<wbr/>Cell<wbr/>Bounds</span><a href="#getcellbounds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getCellBounds</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">columnIdx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">rowIdx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?:</span> <a href="GetCellBoundsConfig.html" class="tsd-signature-type tsd-kind-interface">GetCellBoundsConfig</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="BoundingCurves.html" class="tsd-signature-type tsd-kind-interface">BoundingCurves</a></div><div class="tsd-comment tsd-typography"><p>Returns the bounding curves for a specific cell. Results are memoized for
performance.</p>
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">columnIdx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">rowIdx</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?:</span> <a href="GetCellBoundsConfig.html" class="tsd-signature-type tsd-kind-interface">GetCellBoundsConfig</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="BoundingCurves.html" class="tsd-signature-type tsd-kind-interface">BoundingCurves</a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">columnIdx</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Zero-based column index.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">rowIdx</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Zero-based row index.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">config</span>: <a href="GetCellBoundsConfig.html" class="tsd-signature-type tsd-kind-interface">GetCellBoundsConfig</a></span><div class="tsd-comment tsd-typography"><p>Optional configuration.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BoundingCurves.html" class="tsd-signature-type tsd-kind-interface">BoundingCurves</a></h4><p>The cell's bounding curves.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>ValidationError When indices are out of bounds.</p>
</div></div><aside class="tsd-sources"><p>Inherited from <a href="GridApi.html">GridApi</a>.<a href="GridApi.html#getcellbounds">getCellBounds</a></p><ul><li>Defined in <a href="https://github.com/Undistraction/warp-grid/blob/a885d63c38a4c9c4866e26f6db999146927e13fa/src/types.ts#L111">src/types.ts:111</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getallcellbounds"><span>get<wbr/>All<wbr/>Cell<wbr/>Bounds</span><a href="#getallcellbounds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getAllCellBounds</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">?:</span> <a href="GetAllCellBoundsProps.html" class="tsd-signature-type tsd-kind-interface">GetAllCellBoundsProps</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="BoundingCurves.html" class="tsd-signature-type tsd-kind-interface">BoundingCurves</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Returns bounding curves for all cells in the grid. Results are memoized for
performance.</p>
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">?:</span> <a href="GetAllCellBoundsProps.html" class="tsd-signature-type tsd-kind-interface">GetAllCellBoundsProps</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="BoundingCurves.html" class="tsd-signature-type tsd-kind-interface">BoundingCurves</a><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">params</span>: <a href="GetAllCellBoundsProps.html" class="tsd-signature-type tsd-kind-interface">GetAllCellBoundsProps</a></span><div class="tsd-comment tsd-typography"><p>Optional configuration.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BoundingCurves.html" class="tsd-signature-type tsd-kind-interface">BoundingCurves</a><span class="tsd-signature-symbol">[]</span></h4><p>Array of cell bounds.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="GridApi.html">GridApi</a>.<a href="GridApi.html#getallcellbounds">getAllCellBounds</a></p><ul><li>Defined in <a href="https://github.com/Undistraction/warp-grid/blob/a885d63c38a4c9c4866e26f6db999146927e13fa/src/types.ts#L123">src/types.ts:123</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="model"><span>model</span><a href="#model" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">model</span><span class="tsd-signature-symbol">:</span> <a href="GridModel.html" class="tsd-signature-type tsd-kind-interface">GridModel</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Undistraction/warp-grid/blob/a885d63c38a4c9c4866e26f6db999146927e13fa/src/types.ts#L258">src/types.ts:258</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#getpoint"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Point</span></a><a href="#getintersections"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Intersections</span></a><a href="#getlinesxaxis"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Lines<wbr/>X<wbr/>Axis</span></a><a href="#getlinesyaxis"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Lines<wbr/>Y<wbr/>Axis</span></a><a href="#getlines"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Lines</span></a><a href="#getcellbounds"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Cell<wbr/>Bounds</span></a><a href="#getallcellbounds"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>All<wbr/>Cell<wbr/>Bounds</span></a><a href="#model"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">warp-grid</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>