grid-pro.gridprobeta

Home > @genesislcap/grid-pro > GridProBeta

GridProBeta 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 v35 compatible).

Signature:

export declare class GridProBeta extends GridProBeta_base 

Extends: GridProBeta_base

Remarks

Re-emits AG Grid public API events when listeners are registered via addEventListener (event names match AG Grid public event strings). The same AG Grid events are also dispatched as native Events with lowercased type and payload on agGridDetails (for example addEventListener('columnresized', ...)).

Constructors

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

Properties

Property	Modifiers	Type	Description
agAttributes	protected	Record<string, any>	(BETA)
agGrid		GridApi	(BETA)
agGridOptions	protected	GridOptions	(BETA)
agPropertiesMap	protected	Record<string, string>	(BETA)
autoCellRendererByType		boolean	(BETA)
classNames		string	(BETA)
columnComponentName		string	(BETA)
customErrorHandlerTemplate?		(prefix: string, gridErrorItems: GridProErrorItem<any>[]) => ViewTemplate	(BETA) (Optional) Custom error handler dialog template function.
enableCellFlashing		boolean	(BETA) If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef
enableRowFlashing		boolean	(BETA) If true, will enable row flashing for all rows for add async transactions
eventsAndCallbacks		GridProEventsAndCallbacks	(BETA)
gridApi		GridApi	(BETA)
gridAutosizingEnabled		boolean	(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.
gridComponents		{ [componentName: string]: any; }	(BETA)
gridErrorItems		GridProErrorItem<GridProErrorEvent['detail']>[]	(BETA)
gridOptions		GridOptions
gridOptionsConfig		GridOptionsConfig	(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.
gridParams	readonly	GridParams
gridProDatasource	readonly	GridProBaseDatasource	Get the datasource element.
gridSlot		HTMLSlotElement	(BETA)
headerCaseType		GridProCaseType	The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.
headerHeight		number	(BETA)
initialised	protected	boolean	(BETA)
isServerSide	readonly	boolean
observedAttributes	readonly	string[]	(BETA)
onlyTemplateColDefs		boolean	(BETA)
pagination		boolean	(BETA) Enable pagination for the grid.
paginationPageSize		number	(BETA) Number of rows per page when pagination is enabled.
persistColumnStateKey		string	(BETA) The key to use for persisting the column state in local browser or KV storage.
persistFilterModelKey		string	(BETA) The key to use for persisting the filter model in local browser or KV storage.
provider		any	(BETA)
rowData		any[]	The row data to display in the grid.
rowHeight		number	(BETA)
statePersistence		StatePersistence	(BETA)
statusBarConfig		GridProStatusBarConfig	(BETA) Configuration for the grid status bar components.
themeMode		'light' | 'dark'	(BETA)
withStatusBar		boolean	(BETA) Enables or disables the grid status bar.

Methods

Method	Modifiers	Description
addEventListener(eventType, listener, options)		(BETA) Adds an event listener to the grid element.
agAttributeChangedCallback(attName, oldValue, newValue)		(BETA)
cacheFilterConfig()		(BETA)
clearLocalGridOptions()		Clears the local grid options, this is used to clear the grid options when the grid is restarted.
combineAllGridComponents(gridOptionsComponents)		(BETA)
connectedCallback()		(BETA)
disconnectedCallback()		(BETA)
getfilterModel()		(BETA)
getSavedColumnState()		Gets the saved grid ColumnState[] from storage
getSelectedRows()		Gets the currently selected rows from the grid
globalEventListener(eventType, event)		(BETA)
hasSelectedRows()		Checks if any rows are currently selected
hideDatasourceError()		(BETA)
mergeAllColumnDefsAndStates(columnDefs, deferredColumnDefsOrState)		Will merge templated column definitions with columnDefs plus localStorage's column state or deferredColumnStates.
restoreCachedFilterConfig()		(BETA)
rowDataChanged(_, rowData)		(BETA)
setFilterModel(value)		(BETA)
setupPaginationAndStatusBar(gridOptions)	protected	(BETA)
statePersistanceEnabled()		(BETA)
updateLabelValueStatusBar(params)		Updates the label-value status bar component with new label and value