react-konva-grid
Version:
Declarative React Canvas Grid primitive for Data table, Pivot table, Excel Worksheets
346 lines • 17.8 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>UseSelectionOptions | 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/_hooks_useselection_.html">"hooks/useSelection"</a>
</li>
<li>
<a href="_hooks_useselection_.useselectionoptions.html">UseSelectionOptions</a>
</li>
</ul>
<h1>Interface UseSelectionOptions</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">UseSelectionOptions</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="_hooks_useselection_.useselectionoptions.html#allowdeselectselection" class="tsd-kind-icon">allow<wbr>Deselect<wbr>Selection</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_hooks_useselection_.useselectionoptions.html#allowmultipleselection" class="tsd-kind-icon">allow<wbr>Multiple<wbr>Selection</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_hooks_useselection_.useselectionoptions.html#columncount" class="tsd-kind-icon">column<wbr>Count</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_hooks_useselection_.useselectionoptions.html#gridref" class="tsd-kind-icon">grid<wbr>Ref</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_hooks_useselection_.useselectionoptions.html#initialactivecell" class="tsd-kind-icon">initial<wbr>Active<wbr>Cell</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_hooks_useselection_.useselectionoptions.html#initialselections" class="tsd-kind-icon">initial<wbr>Selections</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_hooks_useselection_.useselectionoptions.html#rowcount" class="tsd-kind-icon">row<wbr>Count</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_hooks_useselection_.useselectionoptions.html#selectionmode" class="tsd-kind-icon">selection<wbr>Mode</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="allowdeselectselection" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> allow<wbr>Deselect<wbr>Selection</h3>
<div class="tsd-signature tsd-kind-icon">allow<wbr>Deselect<wbr>Selection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/hooks/useSelection.ts#L40">src/hooks/useSelection.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Allow deselect a selected area</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="allowmultipleselection" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> allow<wbr>Multiple<wbr>Selection</h3>
<div class="tsd-signature tsd-kind-icon">allow<wbr>Multiple<wbr>Selection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/hooks/useSelection.ts#L36">src/hooks/useSelection.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Allow multiple selection</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="columncount" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> column<wbr>Count</h3>
<div class="tsd-signature tsd-kind-icon">column<wbr>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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/hooks/useSelection.ts#L28">src/hooks/useSelection.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>No of columns in the grid</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="gridref" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> grid<wbr>Ref</h3>
<div class="tsd-signature tsd-kind-icon">grid<wbr>Ref<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">React.MutableRefObject</span><span class="tsd-signature-symbol"><</span><a href="../modules/_grid_.html#gridref" class="tsd-signature-type">GridRef</a><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/hooks/useSelection.ts#L16">src/hooks/useSelection.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Access grid functions</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="initialactivecell" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> initial<wbr>Active<wbr>Cell</h3>
<div class="tsd-signature tsd-kind-icon">initial<wbr>Active<wbr>Cell<span class="tsd-signature-symbol">:</span> <a href="_grid_.cellinterface.html" class="tsd-signature-type">CellInterface</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/hooks/useSelection.ts#L24">src/hooks/useSelection.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Option to set 0,0 as initially selected cell</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="initialselections" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> initial<wbr>Selections</h3>
<div class="tsd-signature tsd-kind-icon">initial<wbr>Selections<span class="tsd-signature-symbol">:</span> <a href="_grid_.selectionarea.html" class="tsd-signature-type">SelectionArea</a><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/hooks/useSelection.ts#L20">src/hooks/useSelection.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Initial selections</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="rowcount" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> row<wbr>Count</h3>
<div class="tsd-signature tsd-kind-icon">row<wbr>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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/hooks/useSelection.ts#L32">src/hooks/useSelection.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>No of rows in the grid</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="selectionmode" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> selection<wbr>Mode</h3>
<div class="tsd-signature tsd-kind-icon">selection<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="../enums/_types_.selectionmode.html" class="tsd-signature-type">SelectionMode</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/rmdort/konva-grid/blob/41d9546/src/hooks/useSelection.ts#L44">src/hooks/useSelection.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Selection mode</p>
</div>
</div>
</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=" 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="current 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="_hooks_useselection_.selectionresults.html" class="tsd-kind-icon">Selection<wbr>Results</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="_hooks_useselection_.useselectionoptions.html" class="tsd-kind-icon">Use<wbr>Selection<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_hooks_useselection_.useselectionoptions.html#allowdeselectselection" class="tsd-kind-icon">allow<wbr>Deselect<wbr>Selection</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_hooks_useselection_.useselectionoptions.html#allowmultipleselection" class="tsd-kind-icon">allow<wbr>Multiple<wbr>Selection</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_hooks_useselection_.useselectionoptions.html#columncount" class="tsd-kind-icon">column<wbr>Count</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_hooks_useselection_.useselectionoptions.html#gridref" class="tsd-kind-icon">grid<wbr>Ref</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_hooks_useselection_.useselectionoptions.html#initialactivecell" class="tsd-kind-icon">initial<wbr>Active<wbr>Cell</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_hooks_useselection_.useselectionoptions.html#initialselections" class="tsd-kind-icon">initial<wbr>Selections</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_hooks_useselection_.useselectionoptions.html#rowcount" class="tsd-kind-icon">row<wbr>Count</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_hooks_useselection_.useselectionoptions.html#selectionmode" class="tsd-kind-icon">selection<wbr>Mode</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/_hooks_useselection_.html#empty_selection" class="tsd-kind-icon">EMPTY_<wbr>SELECTION</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/_hooks_useselection_.html#useselection" class="tsd-kind-icon">use<wbr>Selection</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>