Skip to Content
APIAG GridGridStoreAg

GridStoreAg type

Tip

This API reference is automatically generated from the source code  of the @jsoc/vanilla-grid-ag  package.

View Declaration

export type GridStoreAg = GridStore<PluginConfigAg>;

Fields

NameTypeDefault
idstring
optionsGridStoreOptions<PluginConfigAg>
addChildSchema(origin: GridSchemaOrigin<PluginConfigAg>) => void

Adds a new child grid schema to the store.

destroy() => void

Destroys the store.

getActiveIndex() => number

Gets the active index.

getActiveSchema() => GridSchemaWithConfig<PluginConfigAg>

Gets the currently active grid schema.

getChildSchemaOrigin(row: UJSONObject, columnKey: string, parentSchema?: GridSchemaWithConfig<PluginConfigAg> | undefined) => GridSchemaOrigin<PluginConfigAg>

Builds a GridSchemaOrigin for a cell on the given parent schema (active schema by default).

getChildSchema(origin: GridSchemaOrigin<PluginConfigAg>) => GridSchemaWithConfig<PluginConfigAg> | undefined

Gets the child grid schema opened from the given cell on the parent schema.

getSchema(index: number) => GridSchemaWithConfig<PluginConfigAg>

Gets the grid schema at the given index.

getSchemas() => readonly GridSchemaWithConfig<PluginConfigAg>[]

Gets all grid schemas on the current navigation path.

getTotalSchemas() => number

Gets the number of grid schemas in the store.

getTotalChildSchemas() => number

Gets the number of child grid schemas in the store.

hasChildSchema(origin: GridSchemaOrigin<PluginConfigAg>) => boolean

Returns whether a child schema exists on the navigation path for the given parent cell.

isActiveSchema(gridSchema: GridSchemaWithConfig<PluginConfigAg>) => boolean

Checks if the given grid schema is the active schema.

removeChildSchema(childSchema?: GridSchemaWithConfig<PluginConfigAg> | undefined) => void

Removes the given child schema. If no child schema is provided, it removes the active child schema.

setActiveIndex(index: number) => void

Sets the active index.

toggleChildSchema(origin: GridSchemaOrigin<PluginConfigAg>) => void

Opens a child schema for the given cell, or closes it when already open.

subscribe(listener: GridStoreListener<PluginConfigAg>) => () => void

Adds a listener to the store. Listener is called on every state change.

ConfigGeneratorAgGridStoreOptionsAg