profectus-docs/assets/api_interfaces_features_grids_grid.GridOptions.md.5d8ff64b.js

2 lines
13 KiB
JavaScript
Raw Normal View History

import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Interface: GridOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/grids/grid.GridOptions.md","lastUpdated":null}'),o={name:"api/interfaces/features/grids/grid.GridOptions.md"},i=r('<h1 id="interface-gridoptions" tabindex="-1">Interface: GridOptions <a class="header-anchor" href="#interface-gridoptions" aria-label="Permalink to &quot;Interface: GridOptions&quot;"></a></h1><p><a href="./../../../modules/features/grids/grid">features/grids/grid</a>.GridOptions</p><p>An object that configures a <a href="./../../../modules/features/grids/grid#grid">Grid</a>.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to &quot;Properties&quot;"></a></h2><h3 id="cols" tabindex="-1">cols <a class="header-anchor" href="#cols" aria-label="Permalink to &quot;cols&quot;"></a></h3><p> <strong>cols</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>number</code>&gt;</p><p>The number of columns in the grid.</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#L230" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:230</a></p><hr><h3 id="getcanclick" tabindex="-1">getCanClick <a class="header-anchor" href="#getcanclick" aria-label="Permalink to &quot;getCanClick&quot;"></a></h3><p> <code>Optional</code> <strong>getCanClick</strong>: <a href="./../../../modules/features/grids/grid#cellcomputable"><code>CellComputable</code></a>&lt;<code>boolean</code>&gt;</p><p>A computable to determine if a cell can be clicked.</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#L234" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:234</a></p><hr><h3 id="getclasses" tabindex="-1">getClasses <a class="header-anchor" href="#getclasses" aria-label="Permalink to &quot;getClasses&quot;"></a></h3><p> <code>Optional</code> <strong>getClasses</strong>: <a href="./../../../modules/features/grids/grid#cellcomputable"><code>CellComputable</code></a>&lt;<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;&gt;</p><p>A computable to get the CSS classes for a cell.</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#L240" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:240</a></p><hr><h3 id="getdisplay" tabindex="-1">getDisplay <a class="header-anchor" href="#getdisplay" aria-label="Permalink to &quot;getDisplay&quot;"></a></h3><p> <strong>getDisplay</strong>: <a href="./../../../modules/features/grids/grid#cellcomputable"><code>CellComputable</code></a>&lt;<a href="./../../../modules/features/feature#coercablecomponent"><code>CoercableComponent</code></a>&gt;</p><p>A computable to get the display component for a 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#L244" target="_blank" rel="noreferrer">profectus/src/features/grids/grid.ts:244</a></p><hr><h3 id="getstartstate" tabindex="-1">getStartState <a class="header-anchor" href="#getstartstate" aria-label="Permalink to &