UNPKG

react-konva-grid

Version:

Declarative React Canvas Grid primitive for Data table, Pivot table, Excel Worksheets

440 lines 21.4 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>KeyCodes | 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/_types_.html">&quot;types&quot;</a> </li> <li> <a href="_types_.keycodes.html">KeyCodes</a> </li> </ul> <h1>Enumeration KeyCodes</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <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>Enumeration members</h3> <ul class="tsd-index-list"> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#a" class="tsd-kind-icon">A</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#alt" class="tsd-kind-icon">ALT</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#backspace" class="tsd-kind-icon">Back<wbr>Space</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#c" class="tsd-kind-icon">C</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#delete" class="tsd-kind-icon">Delete</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#down" class="tsd-kind-icon">Down</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#end" class="tsd-kind-icon">End</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#enter" class="tsd-kind-icon">Enter</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#escape" class="tsd-kind-icon">Escape</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#home" class="tsd-kind-icon">Home</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#left" class="tsd-kind-icon">Left</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#meta" class="tsd-kind-icon">Meta</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#pagedown" class="tsd-kind-icon">Page<wbr>Down</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#pageup" class="tsd-kind-icon">Page<wbr>Up</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#right" class="tsd-kind-icon">Right</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#space" class="tsd-kind-icon">SPACE</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#tab" class="tsd-kind-icon">Tab</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_types_.keycodes.html#up" class="tsd-kind-icon">Up</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Enumeration members</h2> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="a" class="tsd-anchor"></a> <h3>A</h3> <div class="tsd-signature tsd-kind-icon">A<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 65</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L12">src/types.ts:12</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="alt" class="tsd-anchor"></a> <h3>ALT</h3> <div class="tsd-signature tsd-kind-icon">ALT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 18</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L14">src/types.ts:14</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="backspace" class="tsd-anchor"></a> <h3>Back<wbr>Space</h3> <div class="tsd-signature tsd-kind-icon">Back<wbr>Space<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 8</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L10">src/types.ts:10</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="c" class="tsd-anchor"></a> <h3>C</h3> <div class="tsd-signature tsd-kind-icon">C<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 67</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L15">src/types.ts:15</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="delete" class="tsd-anchor"></a> <h3>Delete</h3> <div class="tsd-signature tsd-kind-icon">Delete<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 9</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L9">src/types.ts:9</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="down" class="tsd-anchor"></a> <h3>Down</h3> <div class="tsd-signature tsd-kind-icon">Down<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 40</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L5">src/types.ts:5</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="end" class="tsd-anchor"></a> <h3>End</h3> <div class="tsd-signature tsd-kind-icon">End<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 35</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L17">src/types.ts:17</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="enter" class="tsd-anchor"></a> <h3>Enter</h3> <div class="tsd-signature tsd-kind-icon">Enter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 13</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L11">src/types.ts:11</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="escape" class="tsd-anchor"></a> <h3>Escape</h3> <div class="tsd-signature tsd-kind-icon">Escape<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 27</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L6">src/types.ts:6</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="home" class="tsd-anchor"></a> <h3>Home</h3> <div class="tsd-signature tsd-kind-icon">Home<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 36</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L16">src/types.ts:16</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="left" class="tsd-anchor"></a> <h3>Left</h3> <div class="tsd-signature tsd-kind-icon">Left<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 37</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L3">src/types.ts:3</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="meta" class="tsd-anchor"></a> <h3>Meta</h3> <div class="tsd-signature tsd-kind-icon">Meta<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 91</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L8">src/types.ts:8</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="pagedown" class="tsd-anchor"></a> <h3>Page<wbr>Down</h3> <div class="tsd-signature tsd-kind-icon">Page<wbr>Down<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 34</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L18">src/types.ts:18</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="pageup" class="tsd-anchor"></a> <h3>Page<wbr>Up</h3> <div class="tsd-signature tsd-kind-icon">Page<wbr>Up<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 33</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L19">src/types.ts:19</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="right" class="tsd-anchor"></a> <h3>Right</h3> <div class="tsd-signature tsd-kind-icon">Right<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 39</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L2">src/types.ts:2</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="space" class="tsd-anchor"></a> <h3>SPACE</h3> <div class="tsd-signature tsd-kind-icon">SPACE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 32</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L13">src/types.ts:13</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="tab" class="tsd-anchor"></a> <h3>Tab</h3> <div class="tsd-signature tsd-kind-icon">Tab<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 9</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L7">src/types.ts:7</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"> <a name="up" class="tsd-anchor"></a> <h3>Up</h3> <div class="tsd-signature tsd-kind-icon">Up<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 38</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/types.ts#L4">src/types.ts:4</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">&quot;<wbr>Cell&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_grid_.html">&quot;<wbr>Grid&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_helpers_.html">&quot;helpers&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_hooks_useautosizer_.html">&quot;hooks/use<wbr>Auto<wbr>Sizer&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_hooks_usecopypaste_.html">&quot;hooks/use<wbr>Copy<wbr>Paste&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_hooks_useeditable_.html">&quot;hooks/use<wbr>Editable&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_hooks_usepagination_.html">&quot;hooks/use<wbr>Pagination&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_hooks_useselection_.html">&quot;hooks/use<wbr>Selection&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_hooks_usetooltip_.html">&quot;hooks/use<wbr>Tooltip&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_index_.html">&quot;index&quot;</a> </li> <li class="current tsd-kind-module"> <a href="../modules/_types_.html">&quot;types&quot;</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_utils_.html">&quot;utils&quot;</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-enum tsd-parent-kind-module"> <a href="_types_.direction.html" class="tsd-kind-icon">Direction</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-enum tsd-parent-kind-module"> <a href="_types_.keycodes.html" class="tsd-kind-icon">Key<wbr>Codes</a> <ul> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#a" class="tsd-kind-icon">A</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#alt" class="tsd-kind-icon">ALT</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#backspace" class="tsd-kind-icon">Back<wbr>Space</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#c" class="tsd-kind-icon">C</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#delete" class="tsd-kind-icon">Delete</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#down" class="tsd-kind-icon">Down</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#end" class="tsd-kind-icon">End</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#enter" class="tsd-kind-icon">Enter</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#escape" class="tsd-kind-icon">Escape</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#home" class="tsd-kind-icon">Home</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#left" class="tsd-kind-icon">Left</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#meta" class="tsd-kind-icon">Meta</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#pagedown" class="tsd-kind-icon">Page<wbr>Down</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#pageup" class="tsd-kind-icon">Page<wbr>Up</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#right" class="tsd-kind-icon">Right</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#space" class="tsd-kind-icon">SPACE</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#tab" class="tsd-kind-icon">Tab</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum"> <a href="_types_.keycodes.html#up" class="tsd-kind-icon">Up</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-enum tsd-parent-kind-module"> <a href="_types_.mimetype.html" class="tsd-kind-icon">Mime<wbr>Type</a> </li> <li class=" tsd-kind-enum tsd-parent-kind-module"> <a href="_types_.movement.html" class="tsd-kind-icon">Movement</a> </li> <li class=" tsd-kind-enum tsd-parent-kind-module"> <a href="_types_.selectionmode.html" class="tsd-kind-icon">Selection<wbr>Mode</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-enum"><span class="tsd-kind-icon">Enumeration</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</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>