@genesislcap/grid-pro 14.348.0 → 14.350.0

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

@@ -0,0 +1,1008 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProV34](./grid-pro.gridprov34.md)
+
+## GridProV34 class
+
+> 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.
+> 
+
+The Grid Pro element (AG Grid v34 compatible).
+
+**Signature:**
+
+```typescript
+export declare class GridProV34 extends GridProV34_base 
+```
+**Extends:** GridProV34\_base
+
+## Remarks
+
+Grid Pro is a Web Component wrapper around the AG Grid Community library.
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)()](./grid-pro.gridprov34._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Constructs a new instance of the `GridProV34` class
+
+
+</td></tr>
+</tbody></table>
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[agGrid](./grid-pro.gridprov34.aggrid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+GridApi
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[agGridOptions](./grid-pro.gridprov34.aggridoptions.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+GridOptions
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[autoCellRendererByType](./grid-pro.gridprov34.autocellrendererbytype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[classNames](./grid-pro.gridprov34.classnames.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[columnComponentName](./grid-pro.gridprov34.columncomponentname.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[customErrorHandlerTemplate?](./grid-pro.gridprov34.customerrorhandlertemplate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(prefix: string, gridErrorItems: [GridProErrorItem](./grid-pro.gridproerroritem.md)<!-- -->&lt;any&gt;\[\]) =&gt; ViewTemplate
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Custom error handler dialog template function.
+
+
+</td></tr>
+<tr><td>
+
+[enableCellFlashing](./grid-pro.gridprov34.enablecellflashing.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef
+
+
+</td></tr>
+<tr><td>
+
+[enableRowFlashing](./grid-pro.gridprov34.enablerowflashing.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** If true, will enable row flashing for all rows for `add` async transactions
+
+
+</td></tr>
+<tr><td>
+
+[eventsAndCallbacks](./grid-pro.gridprov34.eventsandcallbacks.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[GridProEventsAndCallbacks](./grid-pro.gridproeventsandcallbacks.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[gridApi](./grid-pro.gridprov34.gridapi.md)
+
+
+</td><td>
+
+
+</td><td>
+
+GridApi
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[gridAutosizingEnabled](./grid-pro.gridprov34.gridautosizingenabled.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** 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`<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[gridComponents](./grid-pro.gridprov34.gridcomponents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ \[componentName: string\]: any; }
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[gridErrorItems](./grid-pro.gridprov34.griderroritems.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[GridProErrorItem](./grid-pro.gridproerroritem.md)<!-- -->&lt;[GridProErrorEvent](./grid-pro.gridproerrorevent.md)<!-- -->\['detail'\]&gt;\[\]
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[gridOptions](./grid-pro.gridprov34.gridoptions.md)
+
+
+</td><td>
+
+
+</td><td>
+
+GridOptions
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[gridOptionsConfig](./grid-pro.gridprov34.gridoptionsconfig.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[GridOptionsConfig](./grid-pro.gridoptionsconfig.md)
+
+
+</td><td>
+
+**_(BETA)_** 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.
+
+
+</td></tr>
+<tr><td>
+
+[gridParams](./grid-pro.gridprov34.gridparams.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+GridParams
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[gridProDatasource](./grid-pro.gridprov34.gridprodatasource.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[GridProBaseDatasource](./grid-pro.gridprobasedatasource.md)
+
+
+</td><td>
+
+Get the datasource element.
+
+
+</td></tr>
+<tr><td>
+
+[gridSlot](./grid-pro.gridprov34.gridslot.md)
+
+
+</td><td>
+
+
+</td><td>
+
+HTMLSlotElement
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[headerCaseType](./grid-pro.gridprov34.headercasetype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[GridProCaseType](./grid-pro.gridprocasetype.md)
+
+
+</td><td>
+
+The case type to use for the header names. If not set, the default CONSTANT\_CASE will be used.
+
+
+</td></tr>
+<tr><td>
+
+[headerHeight](./grid-pro.gridprov34.headerheight.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[initialised](./grid-pro.gridprov34.initialised.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[isServerSide](./grid-pro.gridprov34.isserverside.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[onlyTemplateColDefs](./grid-pro.gridprov34.onlytemplatecoldefs.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[pagination](./grid-pro.gridprov34.pagination.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** Enable pagination for the grid.
+
+
+</td></tr>
+<tr><td>
+
+[paginationPageSize](./grid-pro.gridprov34.paginationpagesize.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+**_(BETA)_** Number of rows per page when pagination is enabled.
+
+
+</td></tr>
+<tr><td>
+
+[persistColumnStateKey](./grid-pro.gridprov34.persistcolumnstatekey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** The key to use for persisting the column state in local browser or KV storage.
+
+
+</td></tr>
+<tr><td>
+
+[persistFilterModelKey](./grid-pro.gridprov34.persistfiltermodelkey.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** The key to use for persisting the filter model in local browser or KV storage.
+
+
+</td></tr>
+<tr><td>
+
+[provider](./grid-pro.gridprov34.provider.md)
+
+
+</td><td>
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[rowData](./grid-pro.gridprov34.rowdata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+any\[\]
+
+
+</td><td>
+
+The row data to display in the grid.
+
+
+</td></tr>
+<tr><td>
+
+[rowHeight](./grid-pro.gridprov34.rowheight.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[statePersistence](./grid-pro.gridprov34.statepersistence.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[StatePersistence](./grid-pro.statepersistence.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[statusBarConfig](./grid-pro.gridprov34.statusbarconfig.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[GridProStatusBarConfig](./grid-pro.gridprostatusbarconfig.md)
+
+
+</td><td>
+
+**_(BETA)_** Configuration for the grid status bar components.
+
+
+</td></tr>
+<tr><td>
+
+[themeMode](./grid-pro.gridprov34.thememode.md)
+
+
+</td><td>
+
+
+</td><td>
+
+'light' \| 'dark'
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[withStatusBar](./grid-pro.gridprov34.withstatusbar.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** Enables or disables the grid status bar.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[addEventListener(eventType, listener, options)](./grid-pro.gridprov34.addeventlistener.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Adds an event listener to the grid element.
+
+
+</td></tr>
+<tr><td>
+
+[cacheFilterConfig()](./grid-pro.gridprov34.cachefilterconfig.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[clearLocalGridOptions()](./grid-pro.gridprov34.clearlocalgridoptions.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Clears the local grid options, this is used to clear the grid options when the grid is restarted.
+
+
+</td></tr>
+<tr><td>
+
+[combineAllGridComponents(gridOptionsComponents)](./grid-pro.gridprov34.combineallgridcomponents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[connectedCallback()](./grid-pro.gridprov34.connectedcallback.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[disconnectedCallback()](./grid-pro.gridprov34.disconnectedcallback.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[getfilterModel()](./grid-pro.gridprov34.getfiltermodel.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[getSavedColumnState()](./grid-pro.gridprov34.getsavedcolumnstate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the saved grid ColumnState\[\] from storage
+
+
+</td></tr>
+<tr><td>
+
+[getSelectedRows()](./grid-pro.gridprov34.getselectedrows.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the currently selected rows from the grid
+
+
+</td></tr>
+<tr><td>
+
+[globalEventListener(eventType, event)](./grid-pro.gridprov34.globaleventlistener.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[hasSelectedRows()](./grid-pro.gridprov34.hasselectedrows.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Checks if any rows are currently selected
+
+
+</td></tr>
+<tr><td>
+
+[hideDatasourceError()](./grid-pro.gridprov34.hidedatasourceerror.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[mergeAllColumnDefsAndStates(columnDefs, deferredColumnDefsOrState)](./grid-pro.gridprov34.mergeallcolumndefsandstates.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Will merge templated column definitions with `columnDefs` plus localStorage's column state or `deferredColumnStates`<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[restoreCachedFilterConfig()](./grid-pro.gridprov34.restorecachedfilterconfig.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[rowDataChanged(\_, rowData)](./grid-pro.gridprov34.rowdatachanged.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[setFilterModel(value)](./grid-pro.gridprov34.setfiltermodel.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[setupPaginationAndStatusBar(gridOptions)](./grid-pro.gridprov34.setuppaginationandstatusbar.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[statePersistanceEnabled()](./grid-pro.gridprov34.statepersistanceenabled.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+</tbody></table>
+