Skip to main content

foundation-comms.dataserverparams

Home > @genesislcap/foundation-comms > DataserverParams

DataserverParams type​

Parameters for a DATA_LOGON messages

Signature:

export type DataserverParams = {
    DATASOURCE_NAME?: string;
    CRITERIA_MATCH?: string;
    MAX_ROWS?: number;
    VIEW_NUMBER?: number;
    FIELDS?: string;
    MAX_VIEW?: number;
    MOVING_VIEW?: boolean;
    ORDER_BY?: string;
    REVERSE?: boolean;
};

Remarks​

  • The DATASOURCE_NAME is required for all DATA_LOGON messages. - The CRITERIA_MATCH is optional and can be used to filter the data. - The MAX_ROWS is optional and can be used to limit the number of rows returned. - The VIEW_NUMBER is optional and can be used to specify the desired page/view number. - The FIELDS is optional and can be used to specify the desired fields to be returned. - The MAX_VIEW is optional and can be used to specify the maximum view size. You can have this as 100 and MAX_ROWS as 50 for example. That way you can fetch 50 rows at a time and have a view size of 100, which is the maximum number of rows that can be displayed in the grid. - The MOVING_VIEW defines the behaviour of the front-end view when it receives new rows in real time. - The ORDER_BY is optional and can be used to specify the order of the rows. - The REVERSE is optional and can be used to specify if the order should be reversed. For more information, see the Dataserver Parameters documentation.