grid-pro

Home > @genesislcap/grid-pro

grid-pro package

Classes

Class	Description
ActionRenderer	The AG Action Renderer element.
ActionsMenuRenderer	The Actions Menu Renderer element.
AgTextFieldRenderer	The AG Text Field Renderer element.
AgTextRenderer
BooleanRenderer	The AG Boolean Renderer element.
DateEditor	The AG Date Editor element.
EditableRenderer	The AG Editable Renderer element.
GenesisGridDatasourceElement	The base datasource element for the grid-pro element.
GridPro	The Grid Pro element.
GridProBaseDatasource
GridProCell	The Grid Pro Cell element.
GridProClientSideDatasource	The Genesis Datasource element, for client-side | CSRM-compatible data fetching and used exclusively by the GridPro element.
GridProColumn	The Grid Pro Column element.
GridProGenesisDatasource	The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element.
GridProServerSideDatasource	(BETA) A Genesis Datasource element, for server-side | SSRM-compatible data fetching and used exclusively by the GridPro element.
KVStorageStatePersistence	Implementation for the KV Storage State Persistence interface.
LabelValueStatusBarComponent	Label Value Status Bar Component
LoadMoreStatusBarComponent	A status bar component that shows a "Load More" button when more rows are available
LocalStorageStatePersistence	Implementation for the Local Storage State Persistence interface.
MultiselectEditor	The AG Multiselect Editor element.
NumberEditor	The AG Number Editor element.
PaginationStatusBarComponent	Pagination Status Bar Component for AG Grid Displays pagination controls and information about current page and total rows
ReloadStatusBarComponent	A status bar component that shows a refresh icon to reload the grid data
SelectEditor	The AG Select Editor element.
SelectRenderer	The AG Select Renderer element.
StatusPillRenderer	The AG Status Pill Renderer element.
StringEditor	The AG String Editor element.

Enumerations

Enumeration	Description
AgGridCSSVars	All official AG CSS variables
AgGridTheme	The available Grid Pro themes.
GridProCaseType	The available Grid Pro header case types
GridProRendererTypes	The available Grid Pro Renderer Types
GridProStatusBarTypes	The available Grid Pro Status Bar Types

Functions

Function	Description
agThemeFontsId(themeName)	Generates the id name for custom Grid Pro fonts.
agThemeTokenMapClassname(themeName)	Generates the class name for a given Grid Pro theme name.
agThemeTokenMapCSS(themeName, tokenMap)	Generates the CSS for a given GridPro theme name and token map
convertToKebabCase(value)	Convert string values from 'camelCase' to 'kebab-case'
dateTimeValueFormatter({ value })	Returns a formatted date time value from the Grid Pro cell value.
dateValueFormatter({ value })	Returns a formatted date value from the Grid Pro cell value.
formatDateExtra(epoch)	(ALPHA) Returns a formatted date value from an epoch number.
foundationAgBooleanRenderer(overrideDefinition)	A function that returns a Foundation Boolean Renderer registration for configuring the component with a DesignSystem.
foundationAgEditableRenderer(overrideDefinition)	A function that returns a Foundation Editable Renderer registration for configuring the component with a DesignSystem.
foundationAgSelectRenderer(overrideDefinition)	A function that returns a Foundation Select Renderer registration for configuring the component with a DesignSystem.
foundationAgTextFieldRenderer(overrideDefinition)	A function that returns a Foundation Text Field Renderer registration for configuring the component with a DesignSystem.
foundationAgTextRenderer(overrideDefinition)	A function that returns a Foundation Text Renderer registration for configuring the component with a DesignSystem.
foundationDateEditor(overrideDefinition)
foundationGridPro(overrideDefinition)	A function that returns a Foundation Grid Pro registration for configuring the component with a DesignSystem.
foundationGridProActionRenderer(overrideDefinition)	A function that returns a Foundation Action Renderer for configuring the component with a DesignSystem.
foundationGridProActionsMenuRenderer(overrideDefinition)	A function that returns a Foundation Actions Menu for configuring the component with a DesignSystem.
foundationMultiselectEditor(overrideDefinition)
foundationNumberEditor(overrideDefinition)
foundationSelectEditor(overrideDefinition)
foundationStatusPillRenderer(overrideDefinition)	A function that returns a Foundation Status Pill Renderer registration for configuring the component with a DesignSystem.
foundationStringEditor(overrideDefinition)
getActionsMenuDef(actions, overrideDef, customActionsOpenerName, isVertical, buttonAppearance)	Helper function to get ColDef https://www.ag-grid.com/javascript-data-grid/column-properties/ for Actions Menu Renderer. Will take the parameter values for a base ColDef and merge them with the overrideDef (if specified).
getAgBooleanRendererTemplate(designSystem)	Get a Design System prefixed Checkbox template.
getAgEditableRendererTemplate(designSystem)	Get a Design System prefixed Checkbox template.
getAvailableIndexes(data)	Get the keys of the Metadata indexes map
getAvailableIndexFields(data)	Get the values of the Metadata indexes map
getColumnType(metadataType)	(ALPHA) Return a column type base on each field's metadata from the selected resource.
getDateEditorTemplate(prefix)	Get a Design System prefixed Select template.
getFilterByFieldType(type)	(ALPHA) Returns a filter type based on the Grid Pro field/column type.
getGridProTemplate(prefix)	Get a Design System prefixed The Grid Pro template.
getMultiselectEditorTemplate(designSystem)	Get a Design System prefixed Select template.
getNumberEditorTemplate(designSystem)	Get a Design System prefixed Select template.
getSelectEditorTemplate(designSystem)	Get a Design System prefixed Select template.
getSelectRendererTemplate(designSystem)	Get a Design System prefixed Select template.
getStatusPillRendererTemplate(designSystem)	Get a Design System prefixed Status Pill template.
getStringEditorTemplate(designSystem)	Get a Design System prefixed String template.
getTextFieldRendererTemplate(designSystem)	Get a Design System prefixed Text Field template.
getTextRendererTemplate(designSystem)
gridProColumns(itemsBinding, includeRenderers)	A directive that renders a set of grid-pro-column elements from a given input binding
mergeAndDedupColDefWithColumnState(colDefs, columnStates)	Merges two arrays, one of ColDef and one of ColumnState, and deduplicates them.

Interfaces

Interface	Description
DateEditorParams	Parameters used to configure SelectEditor
GridOptionsConfig	Grid options config used to configure grids across the application
GridProErrorItem	Grid Pro Error Item
GridProStatusBarConfig	Configuration options for the grid status bar components
GridProStatusBarLoadMoreConfig	Configuration options for load more status bar component
GridProStatusBarReloadConfig	Configuration options for reload status bar component
MultiselectEditorParams	Parameters used to configure MultiselectEditor
NumberEditorParams	Parameters used to configure NumberEditor
SelectCellRendererParams	The interface for the select renderer parameters
SelectEditorParams	Parameters used to configure SelectEditor
SelectRendererOptions	The interface for each select renderer option
StatePersistence	Represents a state persistence and its capabilities. Provides methods to set and get columns from the storage.
StringEditorParams	Parameters used to configure StringEditor

Variables

Variable	Description
actionHeightMultiplier	The base height multiplier for the action renderer.
agActionRendererStyles	The AG Action Renderer Styles.
agBooleanRendererStyles	The AG Boolean Renderer Styles.
agDateEditorStyles	The AG Select Renderer Styles.
agEditableRendererStyles	The AG Editable Renderer Styles.
agExternalStockStyles	All External AG Grid Stock in one CSS.
agGridAlpineFontFace	The AG Alpine font face used on ag-theme-alpine/ag-theme-alpine-dark Grid Pro themes.
agGridBalhamFontFace	The AG Balham font face used on ag-theme-balham/ag-theme-balham-dark Grid Pro themes.
agGridCSS	AG Grid core CSS.
agGridMaterialFontFace	The AG Material font face used on ag-theme-material Grid Pro theme.
agHeadCSS	Custom Drag n Drop CSS for Grid Pro.
agMultiselectEditorStyles	The AG Select Renderer Styles.
agNumberEditorStyles	The AG Number Editor Styles.
agSelectEditorStyles	The AG Select Renderer Styles.
agSelectRendererStyles	The AG Select Renderer Styles.
agStatusPillRendererStyles	The Status Pill Renderer Styles.
agStringEditorStyles	The AG String Renderer Styles.
agThemeAlpineNofontsCSS	AG Alpine Theme (no fonts) CSS.
agThemeBalhamNofontsCSS	AG Balham Theme (no fonts) CSS.
agThemeFontFaceMap	Font Face map with all the font faces for each theme.
agThemeMaterialNofontsCSS	AG Material Theme (no fonts) CSS.
CellTemplate	The Grid Pro Cell Template.
ColumnTemplate	The Grid Pro Column Template.
criteriaDelimiter	The delimiter for the criteria string.
criteriaJoin	The join for the criteria string.
csvExportParams	Allows secure export of CSV https://owasp.org/www-community/attacks/CSV\_Injection
DEFAULT_STATUS_BAR_CONFIG	Default status bar configuration
defaultAgGridFontFace	The default font face for Grid Pro (agGridAlpine).
defaultGridOptionsConfig	Default grid options
defaultGridProConfig	Grid Pro default configuration.
EDITED_COLUMN_FIELD	Key used to store currently edited column when it being synced with server side data
ERROR_COLUMN_FIELD	Key used to store error details (column, message) when inline edit fails sync with server side data
foundationGridComponents	The Grid Pro Components.
foundationGridProShadowOptions	GridPro shadow root options.
foundationGridProStyles	The Grid Pro styles.
GRID_READY_EVENT	Event fired when grid is ready
gridProErrorNames	The error names for the Grid Pro component.
gridProEventNames	The event names for the Grid Pro component.
gridProGenesisDatasourceEventNames	The Genesis Datasource events names.
gridProTemplate
logger	Logger for the grid-pro package
textFieldRendererStyles	The AG Text Field Renderer Styles.
textRendererStyles

Type Aliases

Type Alias	Description
ActionRendererParams	Parameters for the GridPro action renderer.
AgThemeFontFaceMap	Type for mapping of a AgGridTheme to a font face.
BooleanRendererParams	Parameters for the GridPro boolean renderer.
DatasourceType	Available datasource types
GridComponents	Grid Pro Components type, used to define the custom components that will be registered in the grid
GridProErrorEvent	Grid Pro possible error events
GridProErrorTypes	Grid Pro Error Types
GridProEventsAndCallbacks	Grid Pro Events and Callbacks
GridProGenesisDatasourceErrorEvent	The error event grid pro genesis datasource.
GridProGenesisDatasourceErrorEventDetail	The event detail for the grid pro genesis datasource error event.
GrigProGenesisDatasourceSizeChangedEvent	The change size event grid pro genesis datasource.
GrigProGenesisDatasourceSizeChangedEventDetail	The event detail for the grid pro genesis datasource sizeChanged event.
LabelValueStatusBarParams	Label Value Status Bar Component
LoadMoreStatusBarParams	The parameters for the load more status bar component.
MoreRowsDetail	The Genesis Datasource event payload types.
ReloadStatusBarParams	The parameters for the reload status bar component.
StatusPillRendererParams	Parameters used to configure StatusPillRenderer