Profectus
On this page

Interface: GridCell ​

features/grids/grid.GridCell

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.

See

createGridProxy

Properties ​

canClick ​

• canClick: boolean

Whether this cell can be clicked.

Defined in ​

profectus/src/features/grids/grid.ts:202

classes ​

• Optional classes: Record<string, boolean>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/grids/grid.ts:210

display ​

• display: CoercableComponent

The main text that appears in the display.

Defined in ​

profectus/src/features/grids/grid.ts:214

id ​

• id: string

A unique identifier for the grid cell.

Defined in ​

profectus/src/features/grids/grid.ts:198

onClick ​

• Optional onClick: (e?: MouseEvent | TouchEvent) => void

Type declaration ​

▸ (e?): void

A function that is called when the cell is clicked.

Parameters ​
NameType
e?MouseEvent | TouchEvent
Returns ​

void

Defined in ​

profectus/src/features/grids/grid.ts:216

onHold ​

• Optional onHold: VoidFunction

A function that is called when the cell is held down.

Defined in ​

profectus/src/features/grids/grid.ts:218

startState ​

• startState: State

The initial persistent state of this cell.

Defined in ​

profectus/src/features/grids/grid.ts:204

state ​

• state: State

The persistent state of this cell.

Defined in ​

profectus/src/features/grids/grid.ts:206

style ​

• Optional style: StyleValue

CSS to apply to this feature.

Defined in ​

profectus/src/features/grids/grid.ts:208

title ​

• Optional title: CoercableComponent

A header to appear at the top of the display.

Defined in ​

profectus/src/features/grids/grid.ts:212

visibility ​

• visibility: boolean | Visibility

Whether this cell should be visible.

Defined in ​

profectus/src/features/grids/grid.ts:200