@genesislcap/grid-pro 14.393.3 → 14.393.4

package/docs/api/grid-pro.datasourceevent.md

@@ -0,0 +1,57 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [DatasourceEvent](./grid-pro.datasourceevent.md)
+
+## DatasourceEvent interface
+
+Generic datasource event interface
+
+**Signature:**
+
+```typescript
+export interface DatasourceEvent<T = DatasourceEventDetail> extends CustomEvent<T> 
+```
+**Extends:** CustomEvent&lt;T&gt;
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[type](./grid-pro.datasourceevent.type.md)
+
+
+</td><td>
+
+
+</td><td>
+
+keyof typeof [datasourceEventNames](./grid-pro.datasourceeventnames.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/grid-pro.datasourceevent.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [DatasourceEvent](./grid-pro.datasourceevent.md) &gt; [type](./grid-pro.datasourceevent.type.md)
+
+## DatasourceEvent.type property
+
+**Signature:**
+
+```typescript
+type: keyof typeof datasourceEventNames;
+```

package/docs/api/grid-pro.datasourceeventdetail.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [DatasourceEventDetail](./grid-pro.datasourceeventdetail.md)
+
+## DatasourceEventDetail type
+
+Union type for all datasource event details
+
+**Signature:**
+
+```typescript
+export type DatasourceEventDetail = InitializeEventDetail | DataLoadedEventDetail | DataChangedEventDetail | SchemaUpdatedEventDetail | MoreDataAvailableEventDetail | SizeChangedEventDetail | DataClearedEventDetail | DatasourceErrorEventDetail;
+```
+**References:** [InitializeEventDetail](./grid-pro.initializeeventdetail.md)<!-- -->, [DataLoadedEventDetail](./grid-pro.dataloadedeventdetail.md)<!-- -->, [DataChangedEventDetail](./grid-pro.datachangedeventdetail.md)<!-- -->, [SchemaUpdatedEventDetail](./grid-pro.schemaupdatedeventdetail.md)<!-- -->, [MoreDataAvailableEventDetail](./grid-pro.moredataavailableeventdetail.md)<!-- -->, [SizeChangedEventDetail](./grid-pro.sizechangedeventdetail.md)<!-- -->, [DataClearedEventDetail](./grid-pro.dataclearedeventdetail.md)<!-- -->, [DatasourceErrorEventDetail](./grid-pro.datasourceerroreventdetail.md)
+

package/docs/api/grid-pro.datasourceeventnames.md

@@ -0,0 +1,34 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [datasourceEventNames](./grid-pro.datasourceeventnames.md)
+
+## datasourceEventNames variable
+
+Event names for datasource-grid communication These represent datasource operations, not grid-specific actions
+
+**Signature:**
+
+```typescript
+datasourceEventNames: {
+    readonly initialize: "datasource-initialize";
+    readonly ready: "datasource-ready";
+    readonly dataLoaded: "datasource-data-loaded";
+    readonly dataChanged: "datasource-data-changed";
+    readonly dataCleared: "datasource-data-cleared";
+    readonly schemaUpdated: "datasource-schema-updated";
+    readonly loadingStarted: "datasource-loading-started";
+    readonly loadingFinished: "datasource-loading-finished";
+    readonly noDataAvailable: "datasource-no-data-available";
+    readonly moreDataAvailable: "datasource-more-data-available";
+    readonly filtersRestored: "datasource-filters-restored";
+    readonly error: "datasource-error";
+    readonly destroy: "datasource-destroy";
+    readonly sizeChanged: "datasource-size-changed";
+    readonly cacheFilterConfig: "cache-filter-config";
+    readonly refreshServerSide: "refresh-server-side";
+    readonly setServerSideDatasource: "set-server-side-datasource";
+    readonly addGridCssClass: "add-grid-css-class";
+    readonly removeGridCssClass: "remove-grid-css-class";
+    readonly applyServerSideTransaction: "apply-server-side-transaction";
+}
+```

package/docs/api/grid-pro.genesisgriddatasourceelement.handleerrors.md

@@ -53,7 +53,7 @@ type
 
 </td><td>
 
-BaseDatasourceErrorEventDetail\['type'\]
+[BaseDatasourceErrorEventDetail](./grid-pro.basedatasourceerroreventdetail.md)<!-- -->\['type'\]
 
 
 </td><td>

package/docs/api/grid-pro.initializeeventdetail.keepcoldefsonclearrowdata.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [InitializeEventDetail](./grid-pro.initializeeventdetail.md) &gt; [keepColDefsOnClearRowData](./grid-pro.initializeeventdetail.keepcoldefsonclearrowdata.md)
+
+## InitializeEventDetail.keepColDefsOnClearRowData property
+
+**Signature:**
+
+```typescript
+keepColDefsOnClearRowData: boolean;
+```

package/docs/api/grid-pro.initializeeventdetail.md

@@ -0,0 +1,73 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [InitializeEventDetail](./grid-pro.initializeeventdetail.md)
+
+## InitializeEventDetail interface
+
+Event detail for datasource initialization
+
+**Signature:**
+
+```typescript
+export interface InitializeEventDetail 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[keepColDefsOnClearRowData](./grid-pro.initializeeventdetail.keepcoldefsonclearrowdata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[options](./grid-pro.initializeeventdetail.options.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ getRowId?: (params: any) =&gt; string; columnDefs?: ColDef\[\]; \[key: string\]: any; }
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/grid-pro.initializeeventdetail.options.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [InitializeEventDetail](./grid-pro.initializeeventdetail.md) &gt; [options](./grid-pro.initializeeventdetail.options.md)
+
+## InitializeEventDetail.options property
+
+**Signature:**
+
+```typescript
+options: {
+        getRowId?: (params: any) => string;
+        columnDefs?: ColDef[];
+        [key: string]: any;
+    };
+```

package/docs/api/grid-pro.md

@@ -904,6 +904,61 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[DataChangedEventDetail](./grid-pro.datachangedeventdetail.md)
+
+
+</td><td>
+
+Event detail for data changes
+
+
+</td></tr>
+<tr><td>
+
+[DataClearedEventDetail](./grid-pro.dataclearedeventdetail.md)
+
+
+</td><td>
+
+Event detail for data clearing
+
+
+</td></tr>
+<tr><td>
+
+[DataLoadedEventDetail](./grid-pro.dataloadedeventdetail.md)
+
+
+</td><td>
+
+Event detail for data loading
+
+
+</td></tr>
+<tr><td>
+
+[DatasourceErrorEventDetail](./grid-pro.datasourceerroreventdetail.md)
+
+
+</td><td>
+
+Event detail for error events
+
+
+</td></tr>
+<tr><td>
+
+[DatasourceEvent](./grid-pro.datasourceevent.md)
+
+
+</td><td>
+
+Generic datasource event interface
+
+
+</td></tr>
+<tr><td>
+
 [DateEditorParams](./grid-pro.dateeditorparams.md)
 
 
@@ -978,6 +1033,28 @@ Configuration options for load more status bar component
 Configuration options for reload status bar component
 
 
+</td></tr>
+<tr><td>
+
+[InitializeEventDetail](./grid-pro.initializeeventdetail.md)
+
+
+</td><td>
+
+Event detail for datasource initialization
+
+
+</td></tr>
+<tr><td>
+
+[MoreDataAvailableEventDetail](./grid-pro.moredataavailableeventdetail.md)
+
+
+</td><td>
+
+Event detail for more data availability
+
+
 </td></tr>
 <tr><td>
 
@@ -1000,6 +1077,17 @@ Parameters used to configure [MultiselectEditor](./grid-pro.multiselecteditor.md
 Parameters used to configure [NumberEditor](./grid-pro.numbereditor.md)
 
 
+</td></tr>
+<tr><td>
+
+[SchemaUpdatedEventDetail](./grid-pro.schemaupdatedeventdetail.md)
+
+
+</td><td>
+
+Event detail for schema updates
+
+
 </td></tr>
 <tr><td>
 
@@ -1033,6 +1121,17 @@ Parameters used to configure [SelectEditor](./grid-pro.selecteditor.md)
 The interface for each select renderer option
 
 
+</td></tr>
+<tr><td>
+
+[SizeChangedEventDetail](./grid-pro.sizechangedeventdetail.md)
+
+
+</td><td>
+
+Event detail for size changes
+
+
 </td></tr>
 <tr><td>
 
@@ -1301,6 +1400,17 @@ Font Face map with all the font faces for each theme.
 AG Material Theme (no fonts) CSS.
 
 
+</td></tr>
+<tr><td>
+
+[baseDatasourceEventNames](./grid-pro.basedatasourceeventnames.md)
+
+
+</td><td>
+
+Base datasource error event names.
+
+
 </td></tr>
 <tr><td>
 
@@ -1356,6 +1466,17 @@ The join for the criteria string.
 Allows secure export of CSV https://owasp.org/www-community/attacks/CSV\_Injection
 
 
+</td></tr>
+<tr><td>
+
+[datasourceEventNames](./grid-pro.datasourceeventnames.md)
+
+
+</td><td>
+
+Event names for datasource-grid communication These represent datasource operations, not grid-specific actions
+
+
 </td></tr>
 <tr><td>
 
@@ -1585,6 +1706,28 @@ Parameters for the [GridPro](./grid-pro.gridpro.md) action renderer.
 Type for mapping of a [AgGridTheme](./grid-pro.aggridtheme.md) to a font face.
 
 
+</td></tr>
+<tr><td>
+
+[BaseDatasourceErrorEvent](./grid-pro.basedatasourceerrorevent.md)
+
+
+</td><td>
+
+Base datasource error event.
+
+
+</td></tr>
+<tr><td>
+
+[BaseDatasourceErrorEventDetail](./grid-pro.basedatasourceerroreventdetail.md)
+
+
+</td><td>
+
+Base datasource error event detail.
+
+
 </td></tr>
 <tr><td>
 
@@ -1596,6 +1739,17 @@ Type for mapping of a [AgGridTheme](./grid-pro.aggridtheme.md) to a font face.
 Parameters for the [GridPro](./grid-pro.gridpro.md) boolean renderer.
 
 
+</td></tr>
+<tr><td>
+
+[DatasourceEventDetail](./grid-pro.datasourceeventdetail.md)
+
+
+</td><td>
+
+Union type for all datasource event details
+
+
 </td></tr>
 <tr><td>
 
@@ -1750,6 +1904,17 @@ Available paging modes for server-side datasources
 The parameters for the reload status bar component.
 
 
+</td></tr>
+<tr><td>
+
+[ServerSideDatasourceOptions](./grid-pro.serversidedatasourceoptions.md)
+
+
+</td><td>
+
+**_(ALPHA)_** Type definition for configuration options used for streams.
+
+
 </td></tr>
 <tr><td>
 

package/docs/api/grid-pro.moredataavailableeventdetail.hasmoredata.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [MoreDataAvailableEventDetail](./grid-pro.moredataavailableeventdetail.md) &gt; [hasMoreData](./grid-pro.moredataavailableeventdetail.hasmoredata.md)
+
+## MoreDataAvailableEventDetail.hasMoreData property
+
+**Signature:**
+
+```typescript
+hasMoreData: boolean;
+```

package/docs/api/grid-pro.moredataavailableeventdetail.md

@@ -0,0 +1,73 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [MoreDataAvailableEventDetail](./grid-pro.moredataavailableeventdetail.md)
+
+## MoreDataAvailableEventDetail interface
+
+Event detail for more data availability
+
+**Signature:**
+
+```typescript
+export interface MoreDataAvailableEventDetail 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[hasMoreData](./grid-pro.moredataavailableeventdetail.hasmoredata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[sourceRef](./grid-pro.moredataavailableeventdetail.sourceref.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/grid-pro.moredataavailableeventdetail.sourceref.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [MoreDataAvailableEventDetail](./grid-pro.moredataavailableeventdetail.md) &gt; [sourceRef](./grid-pro.moredataavailableeventdetail.sourceref.md)
+
+## MoreDataAvailableEventDetail.sourceRef property
+
+**Signature:**
+
+```typescript
+sourceRef: string;
+```

package/docs/api/grid-pro.schemaupdatedeventdetail.md

@@ -0,0 +1,75 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [SchemaUpdatedEventDetail](./grid-pro.schemaupdatedeventdetail.md)
+
+## SchemaUpdatedEventDetail interface
+
+Event detail for schema updates
+
+**Signature:**
+
+```typescript
+export interface SchemaUpdatedEventDetail 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[metadata?](./grid-pro.schemaupdatedeventdetail.metadata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+FieldMetadata\[\]
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[schema](./grid-pro.schemaupdatedeventdetail.schema.md)
+
+
+</td><td>
+
+
+</td><td>
+
+ColDef\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/grid-pro.schemaupdatedeventdetail.metadata.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [SchemaUpdatedEventDetail](./grid-pro.schemaupdatedeventdetail.md) &gt; [metadata](./grid-pro.schemaupdatedeventdetail.metadata.md)
+
+## SchemaUpdatedEventDetail.metadata property
+
+**Signature:**
+
+```typescript
+metadata?: FieldMetadata[];
+```

package/docs/api/grid-pro.schemaupdatedeventdetail.schema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [SchemaUpdatedEventDetail](./grid-pro.schemaupdatedeventdetail.md) &gt; [schema](./grid-pro.schemaupdatedeventdetail.schema.md)
+
+## SchemaUpdatedEventDetail.schema property
+
+**Signature:**
+
+```typescript
+schema: ColDef[];
+```

package/docs/api/grid-pro.serversidedatasourceoptions.md

@@ -0,0 +1,45 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [ServerSideDatasourceOptions](./grid-pro.serversidedatasourceoptions.md)
+
+## 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:**
+
+```typescript
+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](./grid-pro.pagingmode.md)
+
+## Remarks
+
+Used by [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) constructor to configure options for the stream.
+