profectus-docs/assets/api_interfaces_features_grids_grid.GridOptions.md.dcb941e1.js

1 line
11 KiB
JavaScript

import{_ as e,c as t,o as r,a}from"./app.ab34650d.js";const p=JSON.parse('{"title":"Interface: GridOptions","description":"","frontmatter":{"editLink":false},"headers":[{"level":2,"title":"Properties","slug":"properties"},{"level":3,"title":"cols","slug":"cols"},{"level":3,"title":"getCanClick","slug":"getcanclick"},{"level":3,"title":"getClasses","slug":"getclasses"},{"level":3,"title":"getDisplay","slug":"getdisplay"},{"level":3,"title":"getStartState","slug":"getstartstate"},{"level":3,"title":"getStyle","slug":"getstyle"},{"level":3,"title":"getTitle","slug":"gettitle"},{"level":3,"title":"getVisibility","slug":"getvisibility"},{"level":3,"title":"onClick","slug":"onclick"},{"level":3,"title":"onHold","slug":"onhold"},{"level":3,"title":"rows","slug":"rows"},{"level":3,"title":"visibility","slug":"visibility"}],"relativePath":"api/interfaces/features/grids/grid.GridOptions.md","lastUpdated":null}'),d={name:"api/interfaces/features/grids/grid.GridOptions.md"},i=a('<h1 id="interface-gridoptions" tabindex="-1">Interface: GridOptions <a class="header-anchor" href="#interface-gridoptions" aria-hidden="true">#</a></h1><p><a href="./../../../modules/features/grids/grid.html">features/grids/grid</a>.GridOptions</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-hidden="true">#</a></h2><h3 id="cols" tabindex="-1">cols <a class="header-anchor" href="#cols" aria-hidden="true">#</a></h3><p>\u2022 <strong>cols</strong>: <a href="./../../../modules/util/computed.html#computable"><code>Computable</code></a>&lt;<code>number</code>&gt;</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/grids/grid.ts#L189" target="_blank" rel="noopener noreferrer">profectus/src/features/grids/grid.ts:189</a></p><hr><h3 id="getcanclick" tabindex="-1">getCanClick <a class="header-anchor" href="#getcanclick" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>getCanClick</strong>: <a href="./../../../modules/features/grids/grid.html#cellcomputable"><code>CellComputable</code></a>&lt;<code>boolean</code>&gt;</p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/grids/grid.ts#L191" target="_blank" rel="noopener noreferrer">profectus/src/features/grids/grid.ts:191</a></p><hr><h3 id="getclasses" tabindex="-1">getClasses <a class="header-anchor" href="#getclasses" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>getClasses</strong>: <a href="./../../../modules/features/grids/grid.html#cellcomputable"><code>CellComputable</code></a>&lt;<code>Record</code>&lt;<code>string</code>, <code>boolean</code>&gt;&gt;</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/grids/grid.ts#L194" target="_blank" rel="noopener noreferrer">profectus/src/features/grids/grid.ts:194</a></p><hr><h3 id="getdisplay" tabindex="-1">getDisplay <a class="header-anchor" href="#getdisplay" aria-hidden="true">#</a></h3><p>\u2022 <strong>getDisplay</strong>: <a href="./../../../modules/features/grids/grid.html#cellcomputable"><code>CellComputable</code></a>&lt;<a href="./../../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a>&gt;</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/grids/grid.ts#L196" target="_blank" rel="noopener noreferrer">profectus/src/features/grids/grid.ts:196</a></p><hr><h3 id="getstartstate" tabindex="-1">getStartState <a class="header-anchor" href="#getstartstate" aria-hidden="true">#</a></h3><p>\u2022 <strong>getStartState</strong>: <a href="./../../../modules/util/computed.html#computable"><code>Computable</code></a>&lt;<a href="./../../../modules/game/persistence.html#state"><code>State</code></a>&gt; | (<code>id</code>: <code>string</code> | <code>number</code>) =&gt; <a href="./../../../modules/game/persistence.html#state"><code>State</code></a></p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/grids/grid.ts#L192" target="_blank" rel="noopener noreferrer">profectus/src/features/grids/grid.ts:192</a></p><hr><h3 id="getstyle" tabindex="-1">getStyle <a class="header-anchor" href="#getstyle" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>getStyle</strong>: <a href="./../../../modules/features/grids/grid.html#cellcomputable"><code>CellComputable</code></a>&lt;<a href="./../../../modules/features/feature.html#stylevalue"><code>StyleValue</code></a>&gt;</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/grids/grid.ts#L193" target="_blank" rel="noopener noreferrer">profectus/src/features/grids/grid.ts:193</a></p><hr><h3 id="gettitle" tabindex="-1">getTitle <a class="header-anchor" href="#gettitle" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>getTitle</strong>: <a href="./../../../modules/features/grids/grid.html#cellcomputable"><code>CellComputable</code></a>&lt;<a href="./../../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a>&gt;</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/grids/grid.ts#L195" target="_blank" rel="noopener noreferrer">profectus/src/features/grids/grid.ts:195</a></p><hr><h3 id="getvisibility" tabindex="-1">getVisibility <a class="header-anchor" href="#getvisibility" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>getVisibility</strong>: <a href="./../../../modules/features/grids/grid.html#cellcomputable"><code>CellComputable</code></a>&lt;<a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>&gt;</p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/grids/grid.ts#L190" target="_blank" rel="noopener noreferrer">profectus/src/features/grids/grid.ts:190</a></p><hr><h3 id="onclick" tabindex="-1">onClick <a class="header-anchor" href="#onclick" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>onClick</strong>: (<code>id</code>: <code>string</code> | <code>number</code>, <code>state</code>: <a href="./../../../modules/game/persistence.html#state"><code>State</code></a>, <code>e?</code>: <code>MouseEvent</code> | <code>TouchEvent</code>) =&gt; <code>void</code></p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-hidden="true">#</a></h4><p>\u25B8 (<code>id</code>, <code>state</code>, <code>e?</code>): <code>void</code></p><h5 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-hidden="true">#</a></h5><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>id</code></td><td style="text-align:left;"><code>string</code> | <code>number</code></td></tr><tr><td style="text-align:left;"><code>state</code></td><td style="text-align:left;"><a href="./../../../modules/game/persistence.html#state"><code>State</code></a></td></tr><tr><td style="text-align:left;"><code>e?</code></td><td style="text-align:left;"><code>MouseEvent</code> | <code>TouchEvent</code></td></tr></tbody></table><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-hidden="true">#</a></h5><p><code>void</code></p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/grids/grid.ts#L197" target="_blank" rel="noopener noreferrer">profectus/src/features/grids/grid.ts:197</a></p><hr><h3 id="onhold" tabindex="-1">onHold <a class="header-anchor" href="#onhold" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>onHold</strong>: (<code>id</code>: <code>string</code> | <code>number</code>, <code>state</code>: <a href="./../../../modules/game/persistence.html#state"><code>State</code></a>) =&gt; <code>void</code></p><h4 id="type-declaration-1" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration-1" aria-hidden="true">#</a></h4><p>\u25B8 (<code>id</code>, <code>state</code>): <code>void</code></p><h5 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-hidden="true">#</a></h5><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>id</code></td><td style="text-align:left;"><code>string</code> | <code>number</code></td></tr><tr><td style="text-align:left;"><code>state</code></td><td style="text-align:left;"><a href="./../../../modules/game/persistence.html#state"><code>State</code></a></td></tr></tbody></table><h5 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-hidden="true">#</a></h5><p><code>void</code></p><h4 id="defined-in-9" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-9" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/grids/grid.ts#L198" target="_blank" rel="noopener noreferrer">profectus/src/features/grids/grid.ts:198</a></p><hr><h3 id="rows" tabindex="-1">rows <a class="header-anchor" href="#rows" aria-hidden="true">#</a></h3><p>\u2022 <strong>rows</strong>: <a href="./../../../modules/util/computed.html#computable"><code>Computable</code></a>&lt;<code>number</code>&gt;</p><h4 id="defined-in-10" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-10" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/grids/grid.ts#L188" target="_blank" rel="noopener noreferrer">profectus/src/features/grids/grid.ts:188</a></p><hr><h3 id="visibility" tabindex="-1">visibility <a class="header-anchor" href="#visibility" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>visibility</strong>: <a href="./../../../modules/util/computed.html#computable"><code>Computable</code></a>&lt;<a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>&gt;</p><h4 id="defined-in-11" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-11" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/grids/grid.ts#L187" target="_blank" rel="noopener noreferrer">profectus/src/features/grids/grid.ts:187</a></p>',74),o=[i];function s(n,c,l,h,f,g){return r(),t("div",null,o)}var b=e(d,[["render",s]]);export{p as __pageData,b as default};