Skip to main content

grid-pro.serversidedatasourceoptions

Home > @genesislcap/grid-pro > ServerSideDatasourceOptions

ServerSideDatasourceOptions type​

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.

Type definition for configuration options used for streams.

Signature:

export type ServerSideDatasourceOptions = {
    createDataserverStreamFunc?: (existingParams?: any) => Promise<SocketObservable<FilteredDataServerResult>>;
    createReqRepRequestFunc?: (existingParams?: any) => Promise<RequestServerResult>;
    createReqRepStreamFunc?: (params?: any) => Promise<{
        stream: SocketObservable<RequestServerResult>;
        datasource: Datasource;
    }>;
    onPollingUpdateFunc?: (result: RequestServerResult) => void;
    resetPreviousPollResultFunc?: () => void;
    reloadResourceDataFunc?: (params: any) => Promise<void>;
    errorHandlerFunc?: (message: string, type: string) => void;
    resourceName: string;
    resourceParams?: DataserverParams | RequestParams;
    resourceIndexes?: Map<string, [string]>;
    resourceColDefs?: MetadataDetail[];
    maxRows?: number;
    maxView?: number;
    rowId?: string;
    pagination?: boolean;
    zeroBasedViewNumber?: boolean;
    pagingMode?: PagingMode | undefined;
    criteriaOnlyRequest?: boolean;
    usePolling?: boolean;
};

References: PagingMode

Remarks​

Used by GridProServerSideDatasource constructor to configure options for the stream.