@genesislcap/grid-pro 14.107.1-alpha-afbc4d7.0 → 14.107.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/dist/custom-elements.json +24 -5
  2. package/dist/dts/datasource/server-side.datasource.d.ts +29 -37
  3. package/dist/dts/datasource/server-side.datasource.d.ts.map +1 -1
  4. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts +31 -51
  5. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
  6. package/dist/dts/grid-pro.d.ts +35 -39
  7. package/dist/dts/grid-pro.d.ts.map +1 -1
  8. package/dist/dts/tsdoc-metadata.json +1 -1
  9. package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +14 -2
  10. package/dist/esm/grid-pro.js +1 -20
  11. package/dist/grid-pro.api.json +2 -598
  12. package/dist/grid-pro.d.ts +95 -126
  13. package/docs/api/grid-pro.gridpro.enablerowflashing.md +0 -5
  14. package/docs/api/grid-pro.md +0 -7
  15. package/docs/api-report.md +0 -2
  16. package/package.json +9 -9
  17. package/docs/api/grid-pro.formatdateextra.md +0 -34
  18. package/docs/api/grid-pro.getcolumntype.md +0 -33
  19. package/docs/api/grid-pro.getfilterbyfieldtype.md +0 -33
  20. package/docs/api/grid-pro.getfilterparamsbyfieldtype.md +0 -33
  21. package/docs/api/grid-pro.gridproserversidedatasource.md +0 -30
  22. package/docs/api/grid-pro.gridproserversidedatasource.pagination.md +0 -14
  23. package/docs/api/grid-pro.gridproserversidedatasource.params.md +0 -14
  24. package/docs/api/grid-pro.gridproserversidedatasource.rowid.md +0 -14
  25. package/docs/api/grid-pro.streamdatasource._constructor_.md +0 -23
  26. package/docs/api/grid-pro.streamdatasource.auth.md +0 -14
  27. package/docs/api/grid-pro.streamdatasource.connect.md +0 -14
  28. package/docs/api/grid-pro.streamdatasource.dataserverstream.md +0 -14
  29. package/docs/api/grid-pro.streamdatasource.md +0 -34
  30. package/docs/api/grid-pro.streamdatasource.resourceparams.md +0 -14
  31. package/docs/api/grid-pro.streamdatasource.streamsourceref.md +0 -14
  32. package/docs/api/grid-pro.streamdatasourceoptions.md +0 -31
package/docs/api/grid-pro.getfilterbyfieldtype.md DELETED
@@ -1,33 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [getFilterByFieldType](./grid-pro.getfilterbyfieldtype.md)
4
-
5
- ## getFilterByFieldType() function
6
-
7
- > 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.
8
- >
9
-
10
- Returns a filter type based on the Grid Pro field/column type.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export declare function getFilterByFieldType(type: string): string;
16
- ```
17
-
18
- ## Parameters
19
-
20
- | Parameter | Type | Description |
21
- | --- | --- | --- |
22
- | type | string | The type of the field/column |
23
-
24
- **Returns:**
25
-
26
- string
27
-
28
- The ag-grid filter type
29
-
30
- ## Remarks
31
-
32
- Currently only returns agTextColumnFilter
33
-
package/docs/api/grid-pro.getfilterparamsbyfieldtype.md DELETED
@@ -1,33 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [getFilterParamsByFieldType](./grid-pro.getfilterparamsbyfieldtype.md)
4
-
5
- ## getFilterParamsByFieldType() function
6
-
7
- > 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.
8
- >
9
-
10
- Returns the filter params based on the Grid Pro field/column type.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export declare function getFilterParamsByFieldType(type: string): any;
16
- ```
17
-
18
- ## Parameters
19
-
20
- | Parameter | Type | Description |
21
- | --- | --- | --- |
22
- | type | string | The type of the field/column |
23
-
24
- **Returns:**
25
-
26
- any
27
-
28
- the filter params for the specified field type
29
-
30
- ## Remarks
31
-
32
- Currently only returns a default filter params object, for all field types
33
-
package/docs/api/grid-pro.gridproserversidedatasource.md DELETED
@@ -1,30 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md)
4
-
5
- ## GridProServerSideDatasource class
6
-
7
- > 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.
8
- >
9
-
10
- A Genesis Datasource element, for server-side \| SSRM-compatible data fetching and used exclusively by the GridPro element.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export declare class GridProServerSideDatasource extends GridProServerSideDatasource_base
16
- ```
17
- **Extends:** GridProServerSideDatasource\_base
18
-
19
- ## Remarks
20
-
21
- Only supports Server-Side Row Model. Requires `@ag-grid-enterprise/server-side-row-model` setup and valid AG Grid Enterprise license.
22
-
23
- ## Properties
24
-
25
- | Property | Modifiers | Type | Description |
26
- | --- | --- | --- | --- |
27
- | [pagination](./grid-pro.gridproserversidedatasource.pagination.md) | | boolean | **_(ALPHA)_** |
28
- | [params](./grid-pro.gridproserversidedatasource.params.md) | <code>readonly</code> | any | **_(ALPHA)_** |
29
- | [rowId](./grid-pro.gridproserversidedatasource.rowid.md) | | string | **_(ALPHA)_** |
30
-
package/docs/api/grid-pro.gridproserversidedatasource.pagination.md DELETED
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) &gt; [pagination](./grid-pro.gridproserversidedatasource.pagination.md)
4
-
5
- ## GridProServerSideDatasource.pagination property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- pagination: boolean;
14
- ```
package/docs/api/grid-pro.gridproserversidedatasource.params.md DELETED
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) &gt; [params](./grid-pro.gridproserversidedatasource.params.md)
4
-
5
- ## GridProServerSideDatasource.params property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- get params(): any;
14
- ```
package/docs/api/grid-pro.gridproserversidedatasource.rowid.md DELETED
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) &gt; [rowId](./grid-pro.gridproserversidedatasource.rowid.md)
4
-
5
- ## GridProServerSideDatasource.rowId property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- rowId: string;
14
- ```
package/docs/api/grid-pro.streamdatasource._constructor_.md DELETED
@@ -1,23 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [(constructor)](./grid-pro.streamdatasource._constructor_.md)
4
-
5
- ## StreamDatasource.(constructor)
6
-
7
- > 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.
8
- >
9
-
10
- Constructs a new instance of the `StreamDatasource` class
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- constructor(options: StreamDatasourceOptions);
16
- ```
17
-
18
- ## Parameters
19
-
20
- | Parameter | Type | Description |
21
- | --- | --- | --- |
22
- | options | [StreamDatasourceOptions](./grid-pro.streamdatasourceoptions.md) | |
23
-
package/docs/api/grid-pro.streamdatasource.auth.md DELETED
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [auth](./grid-pro.streamdatasource.auth.md)
4
-
5
- ## StreamDatasource.auth property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- auth: Auth;
14
- ```
package/docs/api/grid-pro.streamdatasource.connect.md DELETED
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [connect](./grid-pro.streamdatasource.connect.md)
4
-
5
- ## StreamDatasource.connect property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- connect: Connect;
14
- ```
package/docs/api/grid-pro.streamdatasource.dataserverstream.md DELETED
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [dataserverStream](./grid-pro.streamdatasource.dataserverstream.md)
4
-
5
- ## StreamDatasource.dataserverStream property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- dataserverStream: SocketObservable<FilteredDataServerResult>;
14
- ```
package/docs/api/grid-pro.streamdatasource.md DELETED
@@ -1,34 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md)
4
-
5
- ## StreamDatasource class
6
-
7
- > 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.
8
- >
9
-
10
- The IServerSideDatasource implementation, used for SSRM (Server-Side Row Model) in the grid.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export declare class StreamDatasource implements IServerSideDatasource
16
- ```
17
- **Implements:** IServerSideDatasource
18
-
19
- ## Constructors
20
-
21
- | Constructor | Modifiers | Description |
22
- | --- | --- | --- |
23
- | [(constructor)(options)](./grid-pro.streamdatasource._constructor_.md) | | **_(ALPHA)_** Constructs a new instance of the <code>StreamDatasource</code> class |
24
-
25
- ## Properties
26
-
27
- | Property | Modifiers | Type | Description |
28
- | --- | --- | --- | --- |
29
- | [auth](./grid-pro.streamdatasource.auth.md) | | Auth | **_(ALPHA)_** |
30
- | [connect](./grid-pro.streamdatasource.connect.md) | | Connect | **_(ALPHA)_** |
31
- | [dataserverStream](./grid-pro.streamdatasource.dataserverstream.md) | | SocketObservable&lt;FilteredDataServerResult&gt; | **_(ALPHA)_** |
32
- | [resourceParams](./grid-pro.streamdatasource.resourceparams.md) | | any | **_(ALPHA)_** |
33
- | [streamSourceRef](./grid-pro.streamdatasource.streamsourceref.md) | | string | **_(ALPHA)_** |
34
-
package/docs/api/grid-pro.streamdatasource.resourceparams.md DELETED
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [resourceParams](./grid-pro.streamdatasource.resourceparams.md)
4
-
5
- ## StreamDatasource.resourceParams property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- resourceParams: any;
14
- ```
package/docs/api/grid-pro.streamdatasource.streamsourceref.md DELETED
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [streamSourceRef](./grid-pro.streamdatasource.streamsourceref.md)
4
-
5
- ## StreamDatasource.streamSourceRef property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- streamSourceRef: string;
14
- ```
package/docs/api/grid-pro.streamdatasourceoptions.md DELETED
@@ -1,31 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasourceOptions](./grid-pro.streamdatasourceoptions.md)
4
-
5
- ## StreamDatasourceOptions type
6
-
7
- > 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.
8
- >
9
-
10
- Type definition for configuration options used for streams.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export type StreamDatasourceOptions = {
16
- stream: SocketObservable<FilteredDataServerResult>;
17
- resourceName: string;
18
- resourceParams?: any;
19
- resourceIndexes?: Map<string, [string]>;
20
- resourceColDefs?: MetadataDetail[];
21
- maxRows?: number;
22
- maxView?: number;
23
- rowId?: string;
24
- pagination?: boolean;
25
- };
26
- ```
27
-
28
- ## Remarks
29
-
30
- Used by [StreamDatasource](./grid-pro.streamdatasource.md) constructor to configure options for the stream.
31
-