DataGridXL - API

DataStore

Description

The DataStore stores your original data set. It also stores rows, columns and cells by ID.

Usage

Your DataGridXL instance contains a property dataStore.

javascript
// create DataGridXL instance
const grid = new DataGridXL(...);
// work with the DataStore instance
grid.dataStore.getRowIds();
grid.dataStore.events.on('changecellvalue', ...);
NOTE: You don't need to create a DataStore instance yourself — it is provided by the grid automatically.

Properties

data
Array
Array storing grid data rows.
cols
Array
Array storing column structures.
rows
Array
Array storing row structures.
cells
Array
Array storing individual cells.
defaultColumnSettings
Object
Default settings applied to columns.
totalRowAmount
number
Total number of rows, updated dynamically.
events
EventDispatcher
Event system for dispatching events.

Methods

add(data)

Add data to store

Arguments

data
arrayAn array of objects or a 2D array containing data grid records
Fires$add
addInBatches(data, batchSize?)

Add data in batches Designed to support large data sets

Arguments

data
arrayAn array of objects or a 2D array containing data grid records
batchSize?
numberdefault 5000Amount of records to add per batch
Fires$add$batchinsertstart$batchinsertcomplete
addInStreamingBatches(data, batchSize?)

Add data in batches (streaming) Designed to support even larger data sets

Arguments

data
arrayAn array of objects or a 2D array containing data grid records
batchSize?
numberdefault 5000Amount of records to add per batch
getColIds(): array<ColId>

Get all column IDs

Returnsarray<ColId>Array of column IDs
getRowIds(): array<RowId>

Get all row IDs

Returnsarray<RowId>Array of row IDs
setColWidths(ids, widths)

Set column widths

Arguments

ids
array<ColId>Array of column IDs
widths
array<number>Matching array of column widths (in pixels)
storeEmptyCols(amount): array<ColId>

Store empty columns

Arguments

amount
numberAmount of empty columns to store
Returnsarray<ColId>Array of newly added column IDs
storeEmptyRows(amount): array<RowId>

Store empty rows

Arguments

amount
numberAmount of empty rows to store
Returnsarray<RowId>Array of newly added row IDs

Events

addDataStoreAddEvent

Payload

type
string
Always `"add"`
target
DataStore
Instance that fired the event
payload
DataStoreAddEventPayload
Structured event data
batchinsertcompleteDataStoreBatchInsertEvent

Payload

type
string
Either `"batchinsertstart"` or `"batchinsertcomplete"`
payload
DataStoreBatchInsertEventPayload
Structured event data
target
DataStore
Instance that fired the event
batchinsertstartDataStoreBatchInsertEvent

Payload

type
string
Either `"batchinsertstart"` or `"batchinsertcomplete"`
payload
DataStoreBatchInsertEventPayload
Structured event data
target
DataStore
Instance that fired the event