Interface: BaseGrid ​

features/grids/grid.BaseGrid

The properties that are added onto a processed BoardOptions to create a Board.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

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

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

▸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

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

cellState ​

• cellState: Persistent<Record<string | number, State>>

The persistent state of this grid, which is a dictionary of cell states.

Defined in ​

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

cells ​

• cells: Record<string | number, GridCell>

A dictionary of cells within this grid.

Defined in ​

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

getID ​

• getID: (id: string | number, state: State) => string

Type declaration ​

▸ (id, state): string

Get the auto-generated ID for identifying a specific cell of this grid that appears in the DOM. Will not persist between refreshes or updates.

Parameters ​

Returns ​

string

Defined in ​

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

getState ​

• getState: (id: string | number) => State

Type declaration ​

▸ (id): State

Get the persistent state of the given cell.

Parameters ​

Returns ​

State

Defined in ​

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

id ​

• id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in ​

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

setState ​

• setState: (id: string | number, state: State) => void

Type declaration ​

▸ (id, state): void

Set the persistent state of the given cell.

Parameters ​

Returns ​

void

Defined in ​

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

type ​

• type: typeof GridType

A symbol that helps identify features of the same type.

Defined in ​

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