grid-pro.genesisgriddatasourceelement
Home > @genesislcap/grid-pro > GenesisGridDatasourceElement
GenesisGridDatasourceElement class
The base datasource element for the grid-pro element.
Signature:
export declare class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_base
Extends: GenesisGridDatasourceElement_base
Properties
|
Property |
Modifiers |
Type |
Description |
|---|---|---|---|
|
Connect | |||
|
string |
Groovy expression to perform filters on the query server; these remain active for the life of the subscription. | ||
|
|
Map<string, string> | ||
|
Datasource | |||
|
|
string | ||
|
ColumnState[] | |||
|
GridOptions | |||
|
boolean |
Disables polling if set to true (data updates for the grid will not be fetched automatically). | ||
|
string |
Optional parameter that allows you to select a subset of fields from the query if the client is not interested in receiving all of them. | ||
|
|
boolean | ||
|
boolean |
Request a snapshot from the server. | ||
|
number |
Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages. | ||
|
number |
Maximum number of rows to track as part of a client "view". | ||
|
boolean |
If true, when the maximum number of rows defined in max-view is reached, the Data Server will start discarding the oldest rows (in terms of timestamp) and sending newer rows. | ||
|
number |
The offset for pagination in REQUEST_SERVER scenarios. | ||
|
string |
Option to select a Data Server index (defined in the Data Server query), which is especially useful if you want the data to be sorted in a specific way. | ||
|
number |
Custom polling frequency (in milliseconds) for a Request Server resource. | ||
|
string[] |
Array of event names that will trigger a poll when received as commit responses. | ||
|
any |
Similar to fields but for Request Server scenarios. This optional parameter enables you to specify request fields, which can include wildcards. | ||
|
boolean |
Attribute to set whether the REQUEST object should be automatically set up. | ||
|
string |
The name of the target Data Server query or Request Server requestReply. | ||
|
boolean |
Attribute to set whether the datasource should restart when it reconnects. | ||
|
boolean |
Option that changes the Data Server index iteration. | ||
|
Function |
Allows grid data updates to be processed via and external function before applying in grid | ||
|
any |
Attribute to set an unique identifier for the row. Defaults to | ||
|
|
BehaviorSubject<Map<string, string>> | ||
|
number |
The desired view/page you want data from. |
Methods
|
Method |
Modifiers |
Description |
|---|---|---|
|
Clears error state and emits connected event. | ||
|
| ||
|
Handles errors and emits appropriate error events. | ||