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.gridpro.md DELETED Viewed

@@ -1,1254 +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; [GridPro](./grid-pro.gridpro.md)
-## GridPro class
-The Grid Pro element.
-**Signature:**
-```typescript
-export declare class GridPro extends GridPro_base
-```
-**Extends:** GridPro\_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.gridpro._constructor_.md)
-</td><td>
-</td><td>
-Constructs a new instance of the `GridPro` 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>
-[addIndex](./grid-pro.gridpro.addindex.md)
-</td><td>
-</td><td>
-number
-</td><td>
-The index to add new rows to when using `applyTransaction` or `applyTransactionAsync`
-</td></tr>
-<tr><td>
-[agAttributes](./grid-pro.gridpro.agattributes.md)
-</td><td>
-`protected`
-</td><td>
-Record&lt;string, string&gt;
-</td><td>
-</td></tr>
-<tr><td>
-[agGrid](./grid-pro.gridpro.aggrid.md)
-</td><td>
-</td><td>
-Grid
-</td><td>
-</td></tr>
-<tr><td>
-[agGridOptions](./grid-pro.gridpro.aggridoptions.md)
-</td><td>
-`protected`
-</td><td>
-GridOptions
-</td><td>
-</td></tr>
-<tr><td>
-[agPropertiesMap](./grid-pro.gridpro.agpropertiesmap.md)
-</td><td>
-`protected`
-</td><td>
-Record&lt;string, string&gt;
-</td><td>
-</td></tr>
-<tr><td>
-[asyncAdd](./grid-pro.gridpro.asyncadd.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Whether to use the `applyTransactionAsync` function for \*add\* transactions
-</td></tr>
-<tr><td>
-[asyncRemove](./grid-pro.gridpro.asyncremove.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Whether to use the `applyTransactionAsync` function for \*remove\* transactions
-</td></tr>
-<tr><td>
-[asyncUpdate](./grid-pro.gridpro.asyncupdate.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Whether to use the `applyTransactionAsync` function for \*update\* transactions
-</td></tr>
-<tr><td>
-[autoCellRendererByType](./grid-pro.gridpro.autocellrendererbytype.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-</td></tr>
-<tr><td>
-[classNames](./grid-pro.gridpro.classnames.md)
-</td><td>
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[columnApi](./grid-pro.gridpro.columnapi.md)
-</td><td>
-</td><td>
-ColumnApi
-</td><td>
-</td></tr>
-<tr><td>
-[columnComponentName](./grid-pro.gridpro.columncomponentname.md)
-</td><td>
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[customErrorHandlerTemplate?](./grid-pro.gridpro.customerrorhandlertemplate.md)
-</td><td>
-</td><td>
-(prefix: string, gridErrorItems: [GridProErrorItem](./grid-pro.gridproerroritem.md)<!-- -->&lt;any&gt;\[\]) =&gt; ViewTemplate
-</td><td>
-_(Optional)_ Custom error handler dialog template function.
-</td></tr>
-<tr><td>
-[defaultColumnConfig](./grid-pro.gridpro.defaultcolumnconfig.md)
-</td><td>
-</td><td>
-ColDef\[\]
-</td><td>
-The default column config to reset to when deleteColumnState is called.
-</td></tr>
-<tr><td>
-[enableCellFlashing](./grid-pro.gridpro.enablecellflashing.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef
-</td></tr>
-<tr><td>
-[enabledRowFlashing](./grid-pro.gridpro.enabledrowflashing.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-</td></tr>
-<tr><td>
-[enableRowFlashing](./grid-pro.gridpro.enablerowflashing.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-If true, will enable row flashing for all rows for `add` async transactions
-</td></tr>
-<tr><td>
-[eventsAndCallbacks](./grid-pro.gridpro.eventsandcallbacks.md)
-</td><td>
-</td><td>
-[GridProEventsAndCallbacks](./grid-pro.gridproeventsandcallbacks.md)
-</td><td>
-</td></tr>
-<tr><td>
-[gridApi](./grid-pro.gridpro.gridapi.md)
-</td><td>
-</td><td>
-GridApi
-</td><td>
-</td></tr>
-<tr><td>
-[gridAutosizingEnabled](./grid-pro.gridpro.gridautosizingenabled.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-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.gridpro.gridcomponents.md)
-</td><td>
-</td><td>
-{ \[componentName: string\]: any; }
-</td><td>
-</td></tr>
-<tr><td>
-[gridErrorItems](./grid-pro.gridpro.griderroritems.md)
-</td><td>
-</td><td>
-[GridProErrorItem](./grid-pro.gridproerroritem.md)<!-- -->&lt;[GridProErrorEvent](./grid-pro.gridproerrorevent.md)<!-- -->\['detail'\]&gt;\[\]
-</td><td>
-</td></tr>
-<tr><td>
-[gridFontFace](./grid-pro.gridpro.gridfontface.md)
-</td><td>
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[gridOptions](./grid-pro.gridpro.gridoptions.md)
-</td><td>
-</td><td>
-GridOptions
-</td><td>
-</td></tr>
-<tr><td>
-[gridOptionsConfig](./grid-pro.gridpro.gridoptionsconfig.md)
-</td><td>
-</td><td>
-[GridOptionsConfig](./grid-pro.gridoptionsconfig.md)
-</td><td>
-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.gridpro.gridparams.md)
-</td><td>
-`readonly`
-</td><td>
-GridParams
-</td><td>
-</td></tr>
-<tr><td>
-[gridProDatasource](./grid-pro.gridpro.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.gridpro.gridslot.md)
-</td><td>
-</td><td>
-HTMLSlotElement
-</td><td>
-</td></tr>
-<tr><td>
-[headerCaseType](./grid-pro.gridpro.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.gridpro.headerheight.md)
-</td><td>
-</td><td>
-number
-</td><td>
-</td></tr>
-<tr><td>
-[initialised](./grid-pro.gridpro.initialised.md)
-</td><td>
-`protected`
-</td><td>
-boolean
-</td><td>
-</td></tr>
-<tr><td>
-[isServerSide](./grid-pro.gridpro.isserverside.md)
-</td><td>
-`readonly`
-</td><td>
-boolean
-</td><td>
-</td></tr>
-<tr><td>
-[observedAttributes](./grid-pro.gridpro.observedattributes.md)
-</td><td>
-`readonly`
-</td><td>
-string\[\]
-</td><td>
-</td></tr>
-<tr><td>
-[onlyTemplateColDefs](./grid-pro.gridpro.onlytemplatecoldefs.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-</td></tr>
-<tr><td>
-[pagination](./grid-pro.gridpro.pagination.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Enable pagination for the grid.
-</td></tr>
-<tr><td>
-[paginationPageSize](./grid-pro.gridpro.paginationpagesize.md)
-</td><td>
-</td><td>
-number
-</td><td>
-Number of rows per page when pagination is enabled.
-</td></tr>
-<tr><td>
-[persistColumnStateKey](./grid-pro.gridpro.persistcolumnstatekey.md)
-</td><td>
-</td><td>
-string
-</td><td>
-The key to use for persisting the column state in local browser or KV storage.
-</td></tr>
-<tr><td>
-[persistFilterModelKey](./grid-pro.gridpro.persistfiltermodelkey.md)
-</td><td>
-</td><td>
-string
-</td><td>
-The key to use for persisting the filter model in local browser or KV storage.
-</td></tr>
-<tr><td>
-[rowData](./grid-pro.gridpro.rowdata.md)
-</td><td>
-</td><td>
-any\[\]
-</td><td>
-The row data to display in the grid.
-</td></tr>
-<tr><td>
-[rowHeight](./grid-pro.gridpro.rowheight.md)
-</td><td>
-</td><td>
-number
-</td><td>
-</td></tr>
-<tr><td>
-[sizeColumnsToContent](./grid-pro.gridpro.sizecolumnstocontent.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Boolean attribute to control whether the grid automatically sizes columns to fit their content. This will call AG Grid's autoSizeColumns() method to automatically adjust column widths based on content.
-</td></tr>
-<tr><td>
-[sizeColumnsToFit](./grid-pro.gridpro.sizecolumnstofit.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Boolean attribute to adjust the size of columns to fit the available horizontal space. This will call AG Grid's sizeColumnsToFit() method.
-</td></tr>
-<tr><td>
-[statePersistence](./grid-pro.gridpro.statepersistence.md)
-</td><td>
-</td><td>
-[StatePersistence](./grid-pro.statepersistence.md)
-</td><td>
-</td></tr>
-<tr><td>
-[statusBarConfig](./grid-pro.gridpro.statusbarconfig.md)
-</td><td>
-</td><td>
-[GridProStatusBarConfig](./grid-pro.gridprostatusbarconfig.md)
-</td><td>
-Configuration for the grid status bar components.
-</td></tr>
-<tr><td>
-[theme](./grid-pro.gridpro.theme.md)
-</td><td>
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[themeMode](./grid-pro.gridpro.thememode.md)
-</td><td>
-</td><td>
-'light' \| 'dark'
-</td><td>
-</td></tr>
-<tr><td>
-[withStatusBar](./grid-pro.gridpro.withstatusbar.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-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.gridpro.addeventlistener.md)
-</td><td>
-</td><td>
-Adds an event listener to the grid element.
-</td></tr>
-<tr><td>
-[agAttributeChangedCallback(attName, oldValue, newValue)](./grid-pro.gridpro.agattributechangedcallback.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[applyTemplateDefinitions(columnDefs, deferredColumnDefsOrState)](./grid-pro.gridpro.applytemplatedefinitions.md)
-</td><td>
-</td><td>
-Will merge templated column definitions with `columnDefs` plus localStorage's column state or `deferredColumnStates`<!-- -->.
-</td></tr>
-<tr><td>
-[cacheFilterConfig()](./grid-pro.gridpro.cachefilterconfig.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[clearLocalGridOptions()](./grid-pro.gridpro.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.gridpro.combineallgridcomponents.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[connectedCallback()](./grid-pro.gridpro.connectedcallback.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[deleteColumnState(resetToDefault)](./grid-pro.gridpro.deletecolumnstate.md)
-</td><td>
-</td><td>
-Deletes the saved column state for the current grid
-</td></tr>
-<tr><td>
-[disconnectedCallback()](./grid-pro.gridpro.disconnectedcallback.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[getfilterModel()](./grid-pro.gridpro.getfiltermodel.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[getSavedColumnState()](./grid-pro.gridpro.getsavedcolumnstate.md)
-</td><td>
-</td><td>
-Gets the saved grid ColumnState\[\] from storage
-</td></tr>
-<tr><td>
-[getSelectedRows()](./grid-pro.gridpro.getselectedrows.md)
-</td><td>
-</td><td>
-Gets the currently selected rows from the grid
-</td></tr>
-<tr><td>
-[globalEventListener(eventType, event)](./grid-pro.gridpro.globaleventlistener.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[hasSelectedRows()](./grid-pro.gridpro.hasselectedrows.md)
-</td><td>
-</td><td>
-Checks if any rows are currently selected
-</td></tr>
-<tr><td>
-[hideDatasourceError()](./grid-pro.gridpro.hidedatasourceerror.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[mergeAllColumnDefsAndStates(columnDefs, deferredColumnDefsOrState)](./grid-pro.gridpro.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.gridpro.restorecachedfilterconfig.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[rowDataChanged(\_, rowData)](./grid-pro.gridpro.rowdatachanged.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[setFilterModel(value)](./grid-pro.gridpro.setfiltermodel.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[setupPaginationAndStatusBar(gridOptions)](./grid-pro.gridpro.setuppaginationandstatusbar.md)
-</td><td>
-`protected`
-</td><td>
-</td></tr>
-<tr><td>
-[statePersistanceEnabled()](./grid-pro.gridpro.statepersistanceenabled.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[themeChanged(oldValue, newValue)](./grid-pro.gridpro.themechanged.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[updateLabelValueStatusBar(params)](./grid-pro.gridpro.updatelabelvaluestatusbar.md)
-</td><td>
-</td><td>
-Updates the label-value status bar component with new label and value
-</td></tr>
-</tbody></table>