Skip to main content

grid-tabulator.gridtabulatorclientsidedatasource

Home > @genesislcap/grid-tabulator > GridTabulatorClientSideDatasource

GridTabulatorClientSideDatasource class​

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The Genesis Datasource element, for client-side data fetching and used exclusively by the GridTabulator element.

Signature:

export declare class GridTabulatorClientSideDatasource extends GridTabulatorClientSideDatasource_base 

Extends: GridTabulatorClientSideDatasource_base

Properties​

Property

Modifiers

Type

Description

auth

Auth

(ALPHA)

connect

Connect

(ALPHA)

criteria

string

(ALPHA)

datasource

Datasource

(ALPHA)

deferredColumnStates

any[]

(ALPHA) Allows storing column layouts between datasource initializations

deferredGridOptions

Options

(ALPHA)

fields

string

(ALPHA)

isSnapshot

boolean

(ALPHA)

keepColDefsOnClearRowData

boolean

(ALPHA) Whether to keep column definitions when clearing row data

maxRows

number

(ALPHA)

maxView

number

(ALPHA)

movingView

boolean

(ALPHA)

orderBy

string

(ALPHA)

pollingInterval

number

(ALPHA)

request

any

(ALPHA)

resourceName

string

(ALPHA)

restartOnReconnection

boolean

(ALPHA)

reverse

boolean

(ALPHA)

rowDataMapper

Function

(ALPHA) Allows grid data updates to be processed via and external function before applying in grid

rowIdAttr

any

(ALPHA) Attribute to set an unique identifier for the row.

Defaults to ROW_REF or RECORD_ID depending on the resource type.

Methods​

Method

Modifiers

Description

destroy()

Destroys the datasource, resetting it to its initial state.

init()

Initializes the datasource.

restart()

Restarts the datasource, uses deinit and init in sequence.