Interface: BaseGrid

features/grids/grid.BaseGrid

Properties

[Component]

[Component]: DefineComponent<{ cells: { required: true = true; type: PropType<ProcessedComputable<Record<string, GridCell>>> } ; cols: { required: true = true; type: PropType<ProcessedComputable<number>> } ; rows: { required: true = true; type: PropType<ProcessedComputable<number>> } ; visibility: { required: true = true; type: PropType<ProcessedComputable<Visibility>> } }, { Visibility: typeof Visibility ; gatherCellProps: (cell: GridCell) => { canClick: boolean ; display: CoercableComponent ; id: string ; onClick: undefined | (e?: MouseEvent | TouchEvent) => void ; onHold: undefined | VoidFunction ; style: undefined | StyleValue ; title: undefined | CoercableComponent ; visibility: Visibility } ; mergeAdjacent: ComputedRef<boolean> ; unref: <T>(ref: T | Ref<T>) => T }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, Record<string, any>, string, PublicProps, Readonly<ExtractPropTypes<{ cells: { required: true = true; type: PropType<ProcessedComputable<Record<string, GridCell>>> } ; cols: { required: true = true; type: PropType<ProcessedComputable<number>> } ; rows: { required: true = true; type: PropType<ProcessedComputable<number>> } ; visibility: { required: true = true; type: PropType<ProcessedComputable<Visibility>> } }>>, {}>

Defined in

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


cellState

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

Defined in

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


cells

cells: Record<string | number, GridCell>

Defined in

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


id

id: string

Defined in

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


type

type: typeof GridType

Defined in

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

Methods

[GatherProps]

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

Returns

Record<string, unknown>

Defined in

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


getID

getID(id, state): string

Parameters

NameType
idstring | number
stateState

Returns

string

Defined in

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


getState

getState(id): State

Parameters

NameType
idstring | number

Returns

State

Defined in

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


setState

setState(id, state): void

Parameters

NameType
idstring | number
stateState

Returns

void

Defined in

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