profectus-docs/assets/api_interfaces_features_grids_grid.GridCell.md.62ff3806.js

import{_ as e,c as r,o as a,N as t}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Interface: GridCell","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/grids/grid.GridCell.md","lastUpdated":null}'),i={name:"api/interfaces/features/grids/grid.GridCell.md"},o=t('<h1 id="interface-gridcell" tabindex="-1">Interface: GridCell <a class="header-anchor" href="#interface-gridcell" aria-label="Permalink to &quot;Interface: GridCell&quot;">​</a></h1><p><a href="./../../../modules/features/grids/grid">features/grids/grid</a>.GridCell</p><p>Represents a cell within a grid. These properties will typically be accessed via a cell proxy that calls functions on the grid to get the properties for a specific cell.</p><p><strong><code>See</code></strong></p><p>createGridProxy</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to &quot;Properties&quot;">​</a></h2><h3 id="canclick" tabindex="-1">canClick <a class="header-anchor" href="#canclick" aria-label="Permalink to &quot;canClick&quot;">​</a></h3><p>• <strong>canClick</strong>: <code>boolean</code></p><p>Whether this cell can be clicked.</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L202" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:202</a></p><hr><h3 id="classes" tabindex="-1">classes <a class="header-anchor" href="#classes" aria-label="Permalink to &quot;classes&quot;">​</a></h3><p>• <code>Optional</code> <strong>classes</strong>: <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a>&lt;<code>string</code>, <code>boolean</code>&gt;</p><p>Dictionary of CSS classes to apply to this feature.</p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L210" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:210</a></p><hr><h3 id="display" tabindex="-1">display <a class="header-anchor" href="#display" aria-label="Permalink to &quot;display&quot;">​</a></h3><p>• <strong>display</strong>: <a href="./../../../modules/features/feature#coercablecomponent"><code>CoercableComponent</code></a></p><p>The main text that appears in the display.</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L214" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:214</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to &quot;id&quot;">​</a></h3><p>• <strong>id</strong>: <code>string</code></p><p>A unique identifier for the grid cell.</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L198" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:198</a></p><hr><h3 id="onclick" tabindex="-1">onClick <a class="header-anchor" href="#onclick" aria-label="Permalink to &quot;onClick&quot;">​</a></h3><p>• <code>Optional</code> <strong>onClick</strong>: (<code>e?</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent" target="_blank" rel="noreferrer"><code>MouseEvent</code></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent" target="_blank" rel="noreferrer"><code>TouchEvent</code></a>) =&gt; <code>void</code></p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-label="Permalink to &quot;Type declaration&quot;">​</a></h4><p>▸ (<code>e?</code>): <code>void</code></p><p>A function that is called when the cell is clicked.</p><h5 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;">​</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>e?</code></td><td style="text-align:left;"><a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent" target="_blank" rel="noreferrer"><code>MouseEvent</code></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent" target="_blank" rel="noreferrer"><code>TouchEvent</code></a></td></tr></tbody></table><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;">​</a></h5><p><code>void</code></p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L216" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:216</a></p><hr><h3 id="onhold" tabindex="-1">onHold <a class="header-anchor" href="#onhold" aria-label="Permalink to &quot;onHold&quot;">​</a></h3><p>• <code>Optional</code> <strong>onHold</strong>: <code>VoidFunction</code></p><p>A function that is called when the cell is held down.</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L218" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:218</a></p><hr><h3 id="startstate" tabindex="-1">startState <a class="header-anchor" href="#startstate" aria-label="Permalink to &quot;startState&quot;">​</a></h3><p>• <strong>startState</strong>: <a href="./../../../modules/game/persistence#state"><code>State</code></a></p><p>The initial persistent state of this cell.</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L204" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:204</a></p><hr><h3 id="state" tabindex="-1">state <a class="header-anchor" href="#state" aria-label="Permalink to &quot;state&quot;">​</a></h3><p>• <strong>state</strong>: <a href="./../../../modules/game/persistence#state"><code>State</code></a></p><p>The persistent state of this cell.</p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L206" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:206</a></p><hr><h3 id="style" tabindex="-1">style <a class="header-anchor" href="#style" aria-label="Permalink to &quot;style&quot;">​</a></h3><p>• <code>Optional</code> <strong>style</strong>: <a href="./../../../modules/features/feature#stylevalue"><code>StyleValue</code></a></p><p>CSS to apply to this feature.</p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L208" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:208</a></p><hr><h3 id="title" tabindex="-1">title <a class="header-anchor" href="#title" aria-label="Permalink to &quot;title&quot;">​</a></h3><p>• <code>Optional</code> <strong>title</strong>: <a href="./../../../modules/features/feature#coercablecomponent"><code>CoercableComponent</code></a></p><p>A header to appear at the top of the display.</p><h4 id="defined-in-9" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-9" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L212" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:212</a></p><hr><h3 id="visibility" tabindex="-1">visibility <a class="header-anchor" href="#visibility" aria-label="Permalink to &quot;visibility&quot;">​</a></h3><p>• <strong>visibility</strong>: <code>boolean</code> | <a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a></p><p>Whether this cell should be visible.</p><h4 id="defined-in-10" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-10" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/grids/grid.ts#L200" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:200</a></p>',77),s=[o];function n(d,l,c,h,f,p){return a(),r("div",null,s)}const b=e(i,[["render",n]]);export{g as __pageData,b as default};