react-konva-grid

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>InstanceInterface | react-konva-grid</title> <meta name="description" content="Documentation for react-konva-grid"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </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">react-konva-grid</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> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a> </li> <li> <a href="../modules/_grid_.html">"Grid"</a> </li> <li> <a href="_grid_.instanceinterface.html">InstanceInterface</a> </li> </ul> <h1>Interface InstanceInterface</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">InstanceInterface</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>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_grid_.instanceinterface.html#columnmetadatamap" class="tsd-kind-icon">column<wbr>Metadata<wbr>Map</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_grid_.instanceinterface.html#estimatedcolumnwidth" class="tsd-kind-icon">estimated<wbr>Column<wbr>Width</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_grid_.instanceinterface.html#estimatedrowheight" class="tsd-kind-icon">estimated<wbr>Row<wbr>Height</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_grid_.instanceinterface.html#lastmeasuredcolumnindex" class="tsd-kind-icon">last<wbr>Measured<wbr>Column<wbr>Index</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_grid_.instanceinterface.html#lastmeasuredrowindex" class="tsd-kind-icon">last<wbr>Measured<wbr>Row<wbr>Index</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_grid_.instanceinterface.html#recalccolumnindices" class="tsd-kind-icon">recalc<wbr>Column<wbr>Indices</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_grid_.instanceinterface.html#recalcrowindices" class="tsd-kind-icon">recalc<wbr>Row<wbr>Indices</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_grid_.instanceinterface.html#rowmetadatamap" class="tsd-kind-icon">row<wbr>Metadata<wbr>Map</a></li> </ul> </section> </div> </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-interface"> <a name="columnmetadatamap" class="tsd-anchor"></a> <h3>column<wbr>Metadata<wbr>Map</h3> <div class="tsd-signature tsd-kind-icon">column<wbr>Metadata<wbr>Map<span class="tsd-signature-symbol">:</span> <a href="../modules/_grid_.html#cellmetadatamap" class="tsd-signature-type">CellMetaDataMap</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/Grid.tsx#L236">src/Grid.tsx:236</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="estimatedcolumnwidth" class="tsd-anchor"></a> <h3>estimated<wbr>Column<wbr>Width</h3> <div class="tsd-signature tsd-kind-icon">estimated<wbr>Column<wbr>Width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/Grid.tsx#L241">src/Grid.tsx:241</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="estimatedrowheight" class="tsd-anchor"></a> <h3>estimated<wbr>Row<wbr>Height</h3> <div class="tsd-signature tsd-kind-icon">estimated<wbr>Row<wbr>Height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/Grid.tsx#L240">src/Grid.tsx:240</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="lastmeasuredcolumnindex" class="tsd-anchor"></a> <h3>last<wbr>Measured<wbr>Column<wbr>Index</h3> <div class="tsd-signature tsd-kind-icon">last<wbr>Measured<wbr>Column<wbr>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/Grid.tsx#L238">src/Grid.tsx:238</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="lastmeasuredrowindex" class="tsd-anchor"></a> <h3>last<wbr>Measured<wbr>Row<wbr>Index</h3> <div class="tsd-signature tsd-kind-icon">last<wbr>Measured<wbr>Row<wbr>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/Grid.tsx#L239">src/Grid.tsx:239</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="recalccolumnindices" class="tsd-anchor"></a> <h3>recalc<wbr>Column<wbr>Indices</h3> <div class="tsd-signature tsd-kind-icon">recalc<wbr>Column<wbr>Indices<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/Grid.tsx#L242">src/Grid.tsx:242</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="recalcrowindices" class="tsd-anchor"></a> <h3>recalc<wbr>Row<wbr>Indices</h3> <div class="tsd-signature tsd-kind-icon">recalc<wbr>Row<wbr>Indices<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/Grid.tsx#L243">src/Grid.tsx:243</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="rowmetadatamap" class="tsd-anchor"></a> <h3>row<wbr>Metadata<wbr>Map</h3> <div class="tsd-signature tsd-kind-icon">row<wbr>Metadata<wbr>Map<span class="tsd-signature-symbol">:</span> <a href="../modules/_grid_.html#cellmetadatamap" class="tsd-signature-type">CellMetaDataMap</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/Grid.tsx#L237">src/Grid.tsx:237</a></li> </ul> </aside> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class=" tsd-kind-module"> <a href="../modules/_cell_.html">"<wbr>Cell"</a> </li> <li class="current tsd-kind-module"> <a href="../modules/_grid_.html">"<wbr>Grid"</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_helpers_.html">"helpers"</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_hooks_useautosizer_.html">"hooks/use<wbr>Auto<wbr>Sizer"</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_hooks_usecopypaste_.html">"hooks/use<wbr>Copy<wbr>Paste"</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_hooks_useeditable_.html">"hooks/use<wbr>Editable"</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_hooks_usepagination_.html">"hooks/use<wbr>Pagination"</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_hooks_useselection_.html">"hooks/use<wbr>Selection"</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_hooks_usetooltip_.html">"hooks/use<wbr>Tooltip"</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_index_.html">"index"</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_types_.html">"types"</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_utils_.html">"utils"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_grid_.areaprops.html" class="tsd-kind-icon">Area<wbr>Props</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_grid_.areastyle.html" class="tsd-kind-icon">Area<wbr>Style</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_grid_.cellinterface.html" class="tsd-kind-icon">Cell<wbr>Interface</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_grid_.cellposition.html" class="tsd-kind-icon">Cell<wbr>Position</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_grid_.gridprops.html" class="tsd-kind-icon">Grid<wbr>Props</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-module"> <a href="_grid_.instanceinterface.html" class="tsd-kind-icon">Instance<wbr>Interface</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_grid_.instanceinterface.html#columnmetadatamap" class="tsd-kind-icon">column<wbr>Metadata<wbr>Map</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_grid_.instanceinterface.html#estimatedcolumnwidth" class="tsd-kind-icon">estimated<wbr>Column<wbr>Width</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_grid_.instanceinterface.html#estimatedrowheight" class="tsd-kind-icon">estimated<wbr>Row<wbr>Height</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_grid_.instanceinterface.html#lastmeasuredcolumnindex" class="tsd-kind-icon">last<wbr>Measured<wbr>Column<wbr>Index</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_grid_.instanceinterface.html#lastmeasuredrowindex" class="tsd-kind-icon">last<wbr>Measured<wbr>Row<wbr>Index</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_grid_.instanceinterface.html#recalccolumnindices" class="tsd-kind-icon">recalc<wbr>Column<wbr>Indices</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_grid_.instanceinterface.html#recalcrowindices" class="tsd-kind-icon">recalc<wbr>Row<wbr>Indices</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_grid_.instanceinterface.html#rowmetadatamap" class="tsd-kind-icon">row<wbr>Metadata<wbr>Map</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_grid_.optionalcellinterface.html" class="tsd-kind-icon">Optional<wbr>Cell<wbr>Interface</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_grid_.rendererprops.html" class="tsd-kind-icon">Renderer<wbr>Props</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_grid_.scrollstate.html" class="tsd-kind-icon">Scroll<wbr>State</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_grid_.selectionarea.html" class="tsd-kind-icon">Selection<wbr>Area</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_grid_.selectionprops.html" class="tsd-kind-icon">Selection<wbr>Props</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_grid_.snapcolumnprops.html" class="tsd-kind-icon">Snap<wbr>Column<wbr>Props</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_grid_.snaprowprops.html" class="tsd-kind-icon">Snap<wbr>Row<wbr>Props</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_grid_.viewportprops.html" class="tsd-kind-icon">View<wbr>Port<wbr>Props</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_grid_.html#cellmetadata" class="tsd-kind-icon">Cell<wbr>Meta<wbr>Data</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_grid_.html#cellmetadatamap" class="tsd-kind-icon">Cell<wbr>Meta<wbr>Data<wbr>Map</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_grid_.html#gridref" class="tsd-kind-icon">Grid<wbr>Ref</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_grid_.html#itemsizer" class="tsd-kind-icon">Item<wbr>Sizer</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_grid_.html#mergedcellmap" class="tsd-kind-icon">Merged<wbr>Cell<wbr>Map</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"> <a href="../modules/_grid_.html#optional" class="tsd-kind-icon">Optional</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_grid_.html#optionalscrollcoords" class="tsd-kind-icon">Optional<wbr>Scroll<wbr>Coords</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_grid_.html#refattribute" class="tsd-kind-icon">Ref<wbr>Attribute</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_grid_.html#rendercomponent" class="tsd-kind-icon">Render<wbr>Component</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_grid_.html#scrollcoords" class="tsd-kind-icon">Scroll<wbr>Coords</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_grid_.html#stylingprops" class="tsd-kind-icon">Styling<wbr>Props</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"> <a href="../modules/_grid_.html#default_estimated_item_size" class="tsd-kind-icon">DEFAULT_<wbr>ESTIMATED_<wbr>ITEM_<wbr>SIZE</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/_grid_.html#grid" class="tsd-kind-icon">Grid</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"> <a href="../modules/_grid_.html#reset_scroll_events_debounce_interval" class="tsd-kind-icon">RESET_<wbr>SCROLL_<wbr>EVENTS_<wbr>DEBOUNCE_<wbr>INTERVAL</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"> <a href="../modules/_grid_.html#defaultcolumnwidth" class="tsd-kind-icon">default<wbr>Column<wbr>Width</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"> <a href="../modules/_grid_.html#defaultrowheight" class="tsd-kind-icon">default<wbr>Row<wbr>Height</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"> <a href="../modules/_grid_.html#defaultselectionrenderer" class="tsd-kind-icon">default<wbr>Selection<wbr>Renderer</a> </li> <li class=" tsd-kind-object-literal tsd-parent-kind-module tsd-is-not-exported"> <a href="../modules/_grid_.html#defaultshadowsettings" class="tsd-kind-icon">default<wbr>Shadow<wbr>Settings</a> </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-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> </ul> </div> </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/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>