npm - @genesislcap/grid-pro - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/grid-pro 14.408.0 → 14.409.0

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 (677) hide show

package/docs/api/grid-pro.gridprobeta.agattributes.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [agAttributes](./grid-pro.gridprobeta.agattributes.md)
-## GridProBeta.agAttributes property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-protected agAttributes: Record<string, any>;
-```

package/docs/api/grid-pro.gridprobeta.aggrid.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [agGrid](./grid-pro.gridprobeta.aggrid.md)
-## GridProBeta.agGrid property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-agGrid: GridApi;
-```

package/docs/api/grid-pro.gridprobeta.aggridoptions.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [agGridOptions](./grid-pro.gridprobeta.aggridoptions.md)
-## GridProBeta.agGridOptions property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-protected agGridOptions: GridOptions;
-```

package/docs/api/grid-pro.gridprobeta.agpropertiesmap.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [agPropertiesMap](./grid-pro.gridprobeta.agpropertiesmap.md)
-## GridProBeta.agPropertiesMap property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-protected agPropertiesMap: Record<string, string>;
-```

package/docs/api/grid-pro.gridprobeta.autocellrendererbytype.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [autoCellRendererByType](./grid-pro.gridprobeta.autocellrendererbytype.md)
-## GridProBeta.autoCellRendererByType property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-autoCellRendererByType: boolean;
-```

package/docs/api/grid-pro.gridprobeta.cachefilterconfig.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [cacheFilterConfig](./grid-pro.gridprobeta.cachefilterconfig.md)
-## GridProBeta.cacheFilterConfig() method
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-cacheFilterConfig(): void;
-```
-**Returns:**
-void

package/docs/api/grid-pro.gridprobeta.classnames.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [classNames](./grid-pro.gridprobeta.classnames.md)
-## GridProBeta.classNames property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-classNames: string;
-```

package/docs/api/grid-pro.gridprobeta.clearlocalgridoptions.md DELETED Viewed

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [clearLocalGridOptions](./grid-pro.gridprobeta.clearlocalgridoptions.md)
-## GridProBeta.clearLocalGridOptions() method
-Clears the local grid options, this is used to clear the grid options when the grid is restarted.
-**Signature:**
-```typescript
-clearLocalGridOptions(): void;
-```
-**Returns:**
-void

package/docs/api/grid-pro.gridprobeta.columncomponentname.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [columnComponentName](./grid-pro.gridprobeta.columncomponentname.md)
-## GridProBeta.columnComponentName property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-columnComponentName: string;
-```

package/docs/api/grid-pro.gridprobeta.combineallgridcomponents.md DELETED Viewed

@@ -1,53 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [combineAllGridComponents](./grid-pro.gridprobeta.combineallgridcomponents.md)
-## GridProBeta.combineAllGridComponents() method
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-combineAllGridComponents(gridOptionsComponents: GridComponents): GridComponents;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-gridOptionsComponents
-</td><td>
-[GridComponents](./grid-pro.gridcomponents.md)
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-[GridComponents](./grid-pro.gridcomponents.md)

package/docs/api/grid-pro.gridprobeta.connectedcallback.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [connectedCallback](./grid-pro.gridprobeta.connectedcallback.md)
-## GridProBeta.connectedCallback() method
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-connectedCallback(): void;
-```
-**Returns:**
-void

package/docs/api/grid-pro.gridprobeta.customerrorhandlertemplate.md DELETED Viewed

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [customErrorHandlerTemplate](./grid-pro.gridprobeta.customerrorhandlertemplate.md)
-## GridProBeta.customErrorHandlerTemplate property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-Custom error handler dialog template function.
-**Signature:**
-```typescript
-customErrorHandlerTemplate?: (prefix: string, gridErrorItems: GridProErrorItem<any>[]) => ViewTemplate;
-```
-## Remarks
-When provided, this function will be used to render custom error dialogs instead of the default error handler. The function should accept a prefix string and an array of grid error items and return a ViewTemplate. If not provided, the default error handler dialog template will be used.

package/docs/api/grid-pro.gridprobeta.disconnectedcallback.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [disconnectedCallback](./grid-pro.gridprobeta.disconnectedcallback.md)
-## GridProBeta.disconnectedCallback() method
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-disconnectedCallback(): void;
-```
-**Returns:**
-void

package/docs/api/grid-pro.gridprobeta.enablecellflashing.md DELETED Viewed

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [enableCellFlashing](./grid-pro.gridprobeta.enablecellflashing.md)
-## GridProBeta.enableCellFlashing property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef
-**Signature:**
-```typescript
-enableCellFlashing: boolean;
-```
-## Remarks
-Defaults to true

package/docs/api/grid-pro.gridprobeta.enablerowflashing.md DELETED Viewed

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [enableRowFlashing](./grid-pro.gridprobeta.enablerowflashing.md)
-## GridProBeta.enableRowFlashing property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-If true, will enable row flashing for all rows for `add` async transactions
-**Signature:**
-```typescript
-enableRowFlashing: boolean;
-```

package/docs/api/grid-pro.gridprobeta.eventsandcallbacks.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [eventsAndCallbacks](./grid-pro.gridprobeta.eventsandcallbacks.md)
-## GridProBeta.eventsAndCallbacks property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-eventsAndCallbacks: GridProEventsAndCallbacks;
-```

package/docs/api/grid-pro.gridprobeta.getfiltermodel.md DELETED Viewed

@@ -1,20 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [getfilterModel](./grid-pro.gridprobeta.getfiltermodel.md)
-## GridProBeta.getfilterModel() method
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-getfilterModel(): Promise<{
-        [key: string]: any;
-    }>;
-```
-**Returns:**
-Promise&lt;{ \[key: string\]: any; }&gt;

package/docs/api/grid-pro.gridprobeta.getsavedcolumnstate.md DELETED Viewed

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [getSavedColumnState](./grid-pro.gridprobeta.getsavedcolumnstate.md)
-## GridProBeta.getSavedColumnState() method
-Gets the saved grid ColumnState\[\] from storage
-**Signature:**
-```typescript
-getSavedColumnState(): Promise<ColumnState[]>;
-```
-**Returns:**
-Promise&lt;ColumnState\[\]&gt;
-## Remarks
-This is used to restore the grid state when the grid is rehydrated

package/docs/api/grid-pro.gridprobeta.getselectedrows.md DELETED Viewed

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [getSelectedRows](./grid-pro.gridprobeta.getselectedrows.md)
-## GridProBeta.getSelectedRows() method
-Gets the currently selected rows from the grid
-**Signature:**
-```typescript
-getSelectedRows(): any[];
-```
-**Returns:**
-any\[\]
-Array of selected row data

package/docs/api/grid-pro.gridprobeta.globaleventlistener.md DELETED Viewed

@@ -1,67 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [globalEventListener](./grid-pro.gridprobeta.globaleventlistener.md)
-## GridProBeta.globalEventListener() method
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-globalEventListener(eventType: any, event: any): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-eventType
-</td><td>
-any
-</td><td>
-</td></tr>
-<tr><td>
-event
-</td><td>
-any
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/grid-pro.gridprobeta.gridapi.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [gridApi](./grid-pro.gridprobeta.gridapi.md)
-## GridProBeta.gridApi property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-gridApi: GridApi;
-```

package/docs/api/grid-pro.gridprobeta.gridautosizingenabled.md DELETED Viewed

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [gridAutosizingEnabled](./grid-pro.gridprobeta.gridautosizingenabled.md)
-## GridProBeta.gridAutosizingEnabled property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-Boolean attribute to control whether the grid autosizes the columns upon interaction. This will disable the column widths from being manually set, and doesn't save the widths in local storage if you are using `persist-column-state-key`<!-- -->.
-**Signature:**
-```typescript
-gridAutosizingEnabled: boolean;
-```

package/docs/api/grid-pro.gridprobeta.gridcomponents.md DELETED Viewed

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [gridComponents](./grid-pro.gridprobeta.gridcomponents.md)
-## GridProBeta.gridComponents property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-gridComponents: {
-        [componentName: string]: any;
-    };
-```

package/docs/api/grid-pro.gridprobeta.griderroritems.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [gridErrorItems](./grid-pro.gridprobeta.griderroritems.md)
-## GridProBeta.gridErrorItems property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-gridErrorItems: GridProErrorItem<GridProErrorEvent['detail']>[];
-```

package/docs/api/grid-pro.gridprobeta.gridoptions.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [gridOptions](./grid-pro.gridprobeta.gridoptions.md)
-## GridProBeta.gridOptions property
-**Signature:**
-```typescript
-get gridOptions(): GridOptions;
-set gridOptions(options: GridOptions);
-```

package/docs/api/grid-pro.gridprobeta.gridoptionsconfig.md DELETED Viewed

@@ -1,28 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [gridOptionsConfig](./grid-pro.gridprobeta.gridoptionsconfig.md)
-## GridProBeta.gridOptionsConfig property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-Injectable config that allows to change grid options on an app level basis To modify options, register instance of the config in DOM container that is above the grid or on the top level of the application, so it applies to all grids.
-**Signature:**
-```typescript
-gridOptionsConfig: GridOptionsConfig;
-```
-## Example
-```
-DI.getOrCreateDOMContainer().register([
-      Registration.instance<GridOptionsConfig>(GridOptionsConfig, {
-        headerHeight: 50,
-      }),
-    ]);
-```

package/docs/api/grid-pro.gridprobeta.gridparams.md DELETED Viewed

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [gridParams](./grid-pro.gridprobeta.gridparams.md)
-## GridProBeta.gridParams property
-**Signature:**
-```typescript
-get gridParams(): GridParams;
-```

package/docs/api/grid-pro.gridprobeta.gridprodatasource.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [gridProDatasource](./grid-pro.gridprobeta.gridprodatasource.md)
-## GridProBeta.gridProDatasource property
-Get the datasource element.
-**Signature:**
-```typescript
-get gridProDatasource(): GridProBaseDatasource;
-```
-## Remarks
-This will return the first datasource element found in the light DOM, wrapping all concrete datasource implementations.

package/docs/api/grid-pro.gridprobeta.gridslot.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [gridSlot](./grid-pro.gridprobeta.gridslot.md)
-## GridProBeta.gridSlot property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-gridSlot: HTMLSlotElement;
-```

package/docs/api/grid-pro.gridprobeta.hasselectedrows.md DELETED Viewed

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [hasSelectedRows](./grid-pro.gridprobeta.hasselectedrows.md)
-## GridProBeta.hasSelectedRows() method
-Checks if any rows are currently selected
-**Signature:**
-```typescript
-hasSelectedRows(): boolean;
-```
-**Returns:**
-boolean
-True if rows are selected, false otherwise

package/docs/api/grid-pro.gridprobeta.headercasetype.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [headerCaseType](./grid-pro.gridprobeta.headercasetype.md)
-## GridProBeta.headerCaseType property
-The case type to use for the header names. If not set, the default CONSTANT\_CASE will be used.
-**Signature:**
-```typescript
-headerCaseType: GridProCaseType;
-```
-## Remarks
-Can be one of the following: camelCase, capitalCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase.

package/docs/api/grid-pro.gridprobeta.headerheight.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBeta](./grid-pro.gridprobeta.md) &gt; [headerHeight](./grid-pro.gridprobeta.headerheight.md)
-## GridProBeta.headerHeight property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-headerHeight: number;
-```