grid-pro.gridpro

Home > @genesislcap/grid-pro > GridPro

GridPro class

The Grid Pro element.

Signature:

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

Constructor	Modifiers	Description
(constructor)()		Constructs a new instance of the GridPro class

Properties

Property	Modifiers	Type	Description
addIndex		number	The index to add new rows to when using applyTransaction or applyTransactionAsync
agAttributes	protected	Record<string, string>
agGrid		Grid
agGridOptions	protected	GridOptions
agPropertiesMap	protected	Record<string, string>
asyncAdd		boolean	Whether to use the applyTransactionAsync function for *add* transactions
asyncRemove		boolean	Whether to use the applyTransactionAsync function for *remove* transactions
asyncUpdate		boolean	Whether to use the applyTransactionAsync function for *update* transactions
autoCellRendererByType		boolean
classNames		string
columnApi		ColumnApi
columnComponentName		string
enableCellFlashing		boolean	If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef
enabledRowFlashing		boolean
enableRowFlashing		boolean	If true, will enable row flashing for all rows for add async transactions
eventsAndCallbacks		GridProEventsAndCallbacks
gridApi		GridApi
gridAutosizingEnabled		boolean	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.
gridComponents		{ [componentName: string]: any; }
gridErrorItems		GridProErrorItem<GridProErrorEvent['detail']>[]
gridFontFace		string
gridOptions		GridOptions
gridOptionsConfig		GridOptionsConfig	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.
gridParams	readonly	GridParams
gridProDatasource	readonly	GridProBaseDatasource	Get the datasource element.
gridSlot		HTMLSlotElement
headerCaseType		GridProCaseType	The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.
headerHeight		number
initialised	protected	boolean
isServerSide	readonly	boolean
observedAttributes	readonly	string[]
onlyTemplateColDefs		boolean
pagination		boolean	Enable pagination for the grid.
paginationPageSize		number	Number of rows per page when pagination is enabled.
persistColumnStateKey		string	The key to use for persisting the column state in local browser or KV storage.
persistFilterModelKey		string	The key to use for persisting the filter model in local browser or KV storage.
rowData		any[]	The row data to display in the grid.
rowHeight		number
statePersistence		StatePersistence
statusBarConfig		GridProStatusBarConfig	Configuration for the grid status bar components.
theme		string
withStatusBar		boolean	Enables or disables the grid status bar.

Methods

Method	Modifiers	Description
addEventListener(eventType, listener, options)		Adds an event listener to the grid element.
agAttributeChangedCallback(attName, oldValue, newValue)
applyTemplateDefinitions(columnDefs, deferredColumnDefsOrState)		Will merge templated column definitions with columnDefs plus localStorage's column state or deferredColumnStates.
cacheFilterConfig()
clearLocalGridOptions()		Clears the local grid options, this is used to clear the grid options when the grid is restarted.
combineAllGridComponents(gridOptionsComponents)
connectedCallback()
disconnectedCallback()
getfilterModel()
getSavedColumnState()		Gets the saved grid ColumnState[] from storage
globalEventListener(eventType, event)
hideDatasourceError()
mergeAllColumnDefsAndStates(columnDefs, deferredColumnDefsOrState)		Will merge templated column definitions with columnDefs plus localStorage's column state or deferredColumnStates.
restoreCachedFilterConfig()
rowDataChanged(_, rowData)
setFilterModel(value)
setupPaginationAndStatusBar(gridOptions)	protected
statePersistanceEnabled()
themeChanged(oldValue, newValue)