https://docs.genesis.global/docs/assets/js/e2ba9e39.4739cd11.js

1"use strict";(globalThis.webpackChunk_genesislcap_docs=globalThis.webpackChunk_genesislcap_docs||[]).push([[1208],{349439(e,r,i){i.r(r),i.d(r,{assets:()=>d,contentTitle:()=>a,default:()=>l,frontMatter:()=>n,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"develop/client-capabilities/grids/grid-pro/docs/api/grid-pro.serversidedatasourceoptions","title":"grid-pro.serversidedatasourceoptions","description":"Home &gt; @genesislcap/grid-pro &gt; ServerSideDatasourceOptions","source":"@site/docs/001_develop/03_client-capabilities/005_grids/003_grid-pro/docs/api/grid-pro.serversidedatasourceoptions.md","sourceDirName":"001_develop/03_client-capabilities/005_grids/003_grid-pro/docs/api","slug":"/develop/client-capabilities/grids/grid-pro/docs/api/grid-pro.serversidedatasourceoptions","permalink":"/docs/develop/client-capabilities/grids/grid-pro/docs/api/grid-pro.serversidedatasourceoptions","draft":false,"unlisted":false,"editUrl":"https://github.com/genesiscommunitysuccess/docs/edit/master/docs/001_develop/03_client-capabilities/005_grids/003_grid-pro/docs/api/grid-pro.serversidedatasourceoptions.md","tags":[],"version":"current","frontMatter":{"format":"md"},"sidebar":"developSidebar","previous":{"title":"grid-pro.selectrendereroptions.tooltip","permalink":"/docs/develop/client-capabilities/grids/grid-pro/docs/api/grid-pro.selectrendereroptions.tooltip"},"next":{"title":"grid-pro.sizechangedeventdetail","permalink":"/docs/develop/client-capabilities/grids/grid-pro/docs/api/grid-pro.sizechangedeventdetail"}}');var o=i(474848),t=i(28453);const n={format:"md"},a=void 0,d={},c=[{value:"ServerSideDatasourceOptions type",id:"serversidedatasourceoptions-type",level:2},{value:"Remarks",id:"remarks",level:2}];function p(e){const r={a:"a",blockquote:"blockquote",code:"code",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(r.p,{children:[(0,o.jsx)(r.a,{href:"/docs/develop/client-capabilities/grids/grid-pro/docs/api/",children:"Home"})," > ",(0,o.jsx)(r.a,{href:"/docs/develop/client-capabilities/grids/grid-pro/docs/api/grid-pro",children:"@genesislcap/grid-pro"})," > ",(0,o.jsx)(r.a,{href:"/docs/develop/client-capabilities/grids/grid-pro/docs/api/grid-pro.serversidedatasourceoptions",children:"ServerSideDatasourceOptions"})]}),"\n",(0,o.jsx)(r.h2,{id:"serversidedatasourceoptions-type",children:"ServerSideDatasourceOptions type"}),"\n",(0,o.jsxs)(r.blockquote,{children:["\n",(0,o.jsx)(r.p,{children:"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."}),"\n"]}),"\n",(0,o.jsx)(r.p,{children:"Type definition for configuration options used for streams."}),"\n",(0,o.jsx)(r.p,{children:(0,o.jsx)(r.strong,{children:"Signature:"})}),"\n",(0,o.jsx)(r.pre,{children:(0,o.jsx)(r.code,{className:"language-typescript",children:"export type ServerSideDatasourceOptions = {\r\n    createDataserverStreamFunc?: (existingParams?: any) => Promise<SocketObservable<FilteredDataServerResult>>;\r\n    createReqRepRequestFunc?: (existingParams?: any) => Promise<RequestServerResult>;\r\n    createReqRepStreamFunc?: (params?: any) => Promise<{\r\n        stream: SocketObservable<RequestServerResult>;\r\n        datasource: Datasource;\r\n    }>;\r\n    onPollingUpdateFunc?: (result: RequestServerResult) => void;\r\n    resetPreviousPollResultFunc?: () => void;\r\n    reloadResourceDataFunc?: (params: any) => Promise<void>;\r\n    errorHandlerFunc?: (message: string, type: string) => void;\r\n    resourceName: string;

1\r\n    resourceParams?: DataserverParams | RequestParams;\r\n    resourceIndexes?: Map<string, [string]>;\r\n    resourceColDefs?: MetadataDetail[];\r\n    maxRows?: number;\r\n    maxView?: number;\r\n    rowId?: string;\r\n    pagination?: boolean;\r\n    zeroBasedViewNumber?: boolean;\r\n    pagingMode?: PagingMode | undefined;\r\n    criteriaOnlyRequest?: boolean;\r\n    usePolling?: boolean;\r\n};\n"})}),"\n",(0,o.jsxs)(r.p,{children:[(0,o.jsx)(r.strong,{children:"References:"})," ",(0,o.jsx)(r.a,{href:"/docs/develop/client-capabilities/grids/grid-pro/docs/api/grid-pro.pagingmode",children:"PagingMode"})]}),"\n",(0,o.jsx)(r.h2,{id:"remarks",children:"Remarks"}),"\n",(0,o.jsxs)(r.p,{children:["Used by ",(0,o.jsx)(r.a,{href:"/docs/develop/client-capabilities/grids/grid-pro/docs/api/grid-pro.gridproserversidedatasource",children:"GridProServerSideDatasource"})," constructor to configure options for the stream."]})]})}function l(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,o.jsx)(r,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},28453(e,r,i){i.d(r,{R:()=>n,x:()=>a});var s=i(296540);const o={},t=s.createContext(o);function n(e){const r=s.useContext(t);return s.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:n(e.components),s.createElement(t.Provider,{value:r},e.children)}}}]);