Skip to content

RevoGrid Documentation v4.12.1 / JSX / RevoGrid

Interface: RevoGrid

Revogrid - High-performance, customizable grid library for managing large datasets.

Events guide

For a comprehensive events guide, check the Events API Page. All events propagate to the root level of the grid. Dependency tree.

Type definitions

Read type definition file for the full interface information. All complex property types such as ColumnRegular, ColumnProp, ColumnDataSchemaModel can be found there.

HTMLRevoGridElement

Examples

ts
data-rgCol-rgRow - main data slot. Applies extra elements in <revogr-data />.
ts
focus-rgCol-rgRow - focus layer for main data. Applies extra elements in <revogr-focus />.

Properties

PropertyTypeDescriptionDefined in
accessible?booleanEnable accessibility. If disabled, the grid will not be accessible. Default truesrc/components.d.ts:1284
additionalData?anyAdditional data to be passed to plugins, renders or editors. For example if you need to pass Vue component instance.src/components.d.ts:1288
applyOnClose?booleanApply changes in editor when closed except 'Escape' cases. If custom editor in use method getValue required. Check interfaces.d.ts EditorBase for more info.src/components.d.ts:1292
autoSizeColumn?boolean | AutoSizeColumnConfigAutosize config. Enables columns autoSize. For more details check autoSizeColumn plugin. By default disabled, hence operation is not performance efficient. true to enable with default params (double header separator click for autosize). Or define config. See AutoSizeColumnConfig for more details.src/components.d.ts:1296
canDrag?booleanDisable native drag&drop plugin.src/components.d.ts:1300
canFocus?booleanWhen true cell focus appear.src/components.d.ts:1304
canMoveColumns?booleanEnable column move plugin.src/components.d.ts:1308
colSize?numberIndicates default column size.src/components.d.ts:1312
columnTypes?{}Column Types Format. Every type represent multiple column properties. Types will be merged but can be replaced with column properties. Types were made as separate objects to be reusable per multiple columns.src/components.d.ts:1316
columns?(ColumnRegular | ColumnGrouping)[]Columns - defines an array of grid columns. Can be column or grouped column.src/components.d.ts:1320
disableVirtualX?booleanDisable lazy rendering mode for the X axis. Use when not many columns present and you don't need rerenader cells during scroll. Can be used for initial rendering performance improvement.src/components.d.ts:1324
disableVirtualY?booleanDisable lazy rendering mode for the Y axis. Use when not many rows present and you don't need rerenader cells during scroll. Can be used for initial rendering performance improvement.src/components.d.ts:1328
editors?EditorsCustom editors register.src/components.d.ts:1332
exporting?booleanEnable export plugin.src/components.d.ts:1336
filter?boolean | ColumnFilterConfigEnables filter plugin. Can be boolean. Or can be filter collection See FilterCollection for more info.src/components.d.ts:1340
focusTemplate?FocusTemplateFuncApply changes typed in editor on editor close except Escape cases. If custom editor in use method getValue required. Check interfaces.d.ts EditorBase for more info.src/components.d.ts:1344
frameSize?numberDefines how many rows/columns should be rendered outside visible area.src/components.d.ts:1348
grouping?GroupingOptionsGroup rows based on this property. Define properties to be groped by grouping plugin See GroupingOptions.src/components.d.ts:1352
hideAttribution?booleanPlease only hide the attribution if you are subscribed to Pro versionsrc/components.d.ts:1356
jobsBeforeRender?Promise<any>[]Prevent rendering until job is done. Can be used for initial rendering performance improvement. When several plugins require initial rendering this will prevent double initial rendering.src/components.d.ts:1360
onAdditionaldatachanged?(event: RevoGridCustomEvent<any>) => voidEmmited after the additional data is changedsrc/components.d.ts:1364
onAfteranysource?(event: RevoGridCustomEvent<{ source: DataType[]; type: DimensionRows; }>) => voidEmitted after each source update, whether from the pinned or main viewport. Useful for tracking all changes originating from sources in both the pinned and main viewports.src/components.d.ts:1368
onAftercolumnresize?(event: RevoGridCustomEvent<{}>) => voidEmitted after column resizing. Useful for retrieving the resized columns.src/components.d.ts:1375
onAftercolumnsset?(event: RevoGridCustomEvent<{ columns: ColumnCollection; order: Record<ColumnProp, undefined | "asc" | "desc">; }>) => voidColumn updatedsrc/components.d.ts:1381
onAfteredit?(event: RevoGridCustomEvent<AfterEditEvent>) => voidAfter data applied or range changed.src/components.d.ts:1388
onAfterfocus?(event: RevoGridCustomEvent<FocusAfterRenderEvent>) => voidAfter focus render finished. Can be used to access a focus element through event.target. This is just a duplicate of afterfocus from revogr-focus.tsx.src/components.d.ts:1392
onAftergridinit?(event: RevoGridCustomEvent<any>) => voidEmmited after the grid is initialized. Connected to the DOM.src/components.d.ts:1396
onAftergridrender?(event: RevoGridCustomEvent<any>) => voidEmmited after the grid is rendered.src/components.d.ts:1400
onAftersourceset?(event: RevoGridCustomEvent<{ source: DataType[]; type: DimensionRows; }>) => voidAfter main source/rows updatedsrc/components.d.ts:1404
onAfterthemechanged?(event: RevoGridCustomEvent<string>) => voidEmmited after the theme is changedsrc/components.d.ts:1411
onAftertrimmed?(event: RevoGridCustomEvent<any>) => voidEmitted after trimmed values have been applied. Useful for notifying when trimming of values has taken place.src/components.d.ts:1415
onBeforeanysource?(event: RevoGridCustomEvent<{ source: DataType[]; type: DimensionRows; }>) => voidBefore data apply on any source type. Can be source from pinned and main viewport. You can override data source heresrc/components.d.ts:1419
onBeforeautofill?(event: RevoGridCustomEvent<ChangedRange>) => voidBefore autofill is applied. To prevent the default behavior of applying the edit data, you can call e.preventDefault().src/components.d.ts:1426
onBeforecellfocus?(event: RevoGridCustomEvent<BeforeSaveDataDetails>) => voidBefore the cell focus is changed. To prevent the default behavior of changing the cell focus, you can call e.preventDefault().src/components.d.ts:1430
onBeforecolumnapplied?(event: RevoGridCustomEvent<ColumnCollection>) => voidEmitted before a column update is applied, after the column set is gathered and the viewport is updated. Useful for performing actions or modifications before the final application of the column update.src/components.d.ts:1434
onBeforecolumnsset?(event: RevoGridCustomEvent<ColumnCollection>) => voidEmitted before a column update is applied. Listeners can use this event to perform any necessary actions or modifications before the column update is finalized.src/components.d.ts:1438
onBeforeedit?(event: RevoGridCustomEvent<BeforeSaveDataDetails>) => voidBefore the data is edited. To prevent the default behavior of editing data and use your own implementation, call e.preventDefault(). To override the edit result with your own value, set the e.val property to your desired value.src/components.d.ts:1442
onBeforeeditstart?(event: RevoGridCustomEvent<BeforeSaveDataDetails>) => voidEmitted before editing starts. Use e.preventDefault() to prevent the default edit behavior.src/components.d.ts:1446
onBeforeexport?(event: RevoGridCustomEvent<DataInput>) => voidBefore export Use e.preventDefault() to prevent export Replace data in Event in case you want to modify it in exportsrc/components.d.ts:1450
onBeforefilterapply?(event: RevoGridCustomEvent<{ collection: Record<ColumnProp, FilterCollectionItem>; }>) => voidEmitted before applying a filter to the data source. Use e.preventDefault() to prevent cell focus change. Modify if you need to change filters.src/components.d.ts:1454
onBeforefiltertrimmed?(event: RevoGridCustomEvent<{ collection: Record<ColumnProp, FilterCollectionItem>; itemsToFilter: Record<number, boolean>; }>) => voidEmitted before applying a filter to the data source. Use e.preventDefault() to prevent the default behavior of trimming values and applying the filter. Modify the collection property if you want to change the filters. Modify the itemsToFilter property if you want to filter the indexes for trimming.src/components.d.ts:1458
onBeforefocuslost?(event: RevoGridCustomEvent<null | FocusedData>) => voidBefore the grid focus is lost. To prevent the default behavior of changing the cell focus, you can call e.preventDefault().src/components.d.ts:1465
onBeforegridrender?(event: RevoGridCustomEvent<any>) => voidEmmited before the grid is rendered.src/components.d.ts:1469
onBeforerange?(event: RevoGridCustomEvent<ChangedRange>) => voidBefore autofill is applied. Runs before beforeautofill event. Use e.preventDefault() to prevent range.src/components.d.ts:1473
onBeforerangeedit?(event: RevoGridCustomEvent<BeforeRangeSaveDataDetails>) => voidBefore applying range data, specifically when a range selection occurs. To customize the data and prevent the default edit data from being set, you can call e.preventDefault().src/components.d.ts:1477
onBeforerowdefinition?(event: RevoGridCustomEvent<{ oldVals: any; vals: any; }>) => voidEmitted before the row definition is applied. Useful for modifying or preventing the default row definition behavior.src/components.d.ts:1481
onBeforesorting?(event: RevoGridCustomEvent<{ additive: boolean; column: ColumnRegular; order: "asc" | "desc"; }>) => voidBy sorting.plugin.ts
Triggered immediately after header click.
First in sorting event sequence. Ff this event stops no other event called.
Use e.preventDefault() to prevent sorting.
src/components.d.ts:1485
onBeforesortingapply?(event: RevoGridCustomEvent<{ additive: boolean; column: ColumnRegular; order: "asc" | "desc"; }>) => voidBy sorting.plugin.ts
After beforesorting
Triggered after column data updated with new sorting order.
Use e.preventDefault() to prevent sorting data change.
src/components.d.ts:1493
onBeforesourceset?(event: RevoGridCustomEvent<{ source: DataType[]; type: DimensionRows; }>) => voidBefore main source/rows data apply. You can override data source heresrc/components.d.ts:1501
onBeforesourcesortingapply?(event: RevoGridCustomEvent<{ sorting: SortingOrder; type: DimensionRows; }>) => voidBy sorting.plugin.ts
Same as beforesorting but triggered after beforeanysource (when source is changed).
Use e.preventDefault() to prevent sorting data change.
src/components.d.ts:1508
onBeforetrimmed?(event: RevoGridCustomEvent<{ trimmed: Record<number, boolean>; trimmedType: string; type: string; }>) => voidEmitted before trimming values. Use e.preventDefault() to prevent the default behavior of trimming values. Modify the trimmed property if you want to filter the indexes for trimming.src/components.d.ts:1515
onContentsizechanged?(event: RevoGridCustomEvent<MultiDimensionType>) => voidNew content size has been applied. The size excludes the header. Currently, the event responsible for applying the new content size does not provide the actual size. To retrieve the actual content size, you can utilize the getContentSize function after the event has been triggered.src/components.d.ts:1523
onCreated?(event: RevoGridCustomEvent<any>) => voidEmmited after grid createdsrc/components.d.ts:1527
onFilterconfigchanged?(event: RevoGridCustomEvent<any>) => voidEmitted when the filter configuration is changedsrc/components.d.ts:1531
onHeaderclick?(event: RevoGridCustomEvent<ColumnRegular>) => voidOn header click.src/components.d.ts:1535
onRowdragstart?(event: RevoGridCustomEvent<RowDragStartDetails>) => voidThis event is triggered when the row order change is started. To prevent the default behavior of changing the row order, you can call e.preventDefault(). To change the item name at the start of the row order change, you can set e.text to the desired new name.src/components.d.ts:1539
onRowheaderschanged?(event: RevoGridCustomEvent<any>) => voidEmmited when the row headers are changed.src/components.d.ts:1543
onRoworderchanged?(event: RevoGridCustomEvent<{ from: number; to: number; }>) => voidBefore the order of rgRow is applied. To prevent the default behavior of changing the order of rgRow, you can call e.preventDefault().src/components.d.ts:1547
onSortingconfigchanged?(event: RevoGridCustomEvent<SortingConfig>) => voidEmitted when the sorting configuration is changedsrc/components.d.ts:1551
onViewportscroll?(event: RevoGridCustomEvent<ViewPortScrollEvent>) => voidEmitted when the viewport is scrolled. Useful for tracking viewport scrolling events.src/components.d.ts:1555
pinnedBottomSource?DataType[]Pinned bottom Source: {[T in ColumnProp]: any} - defines pinned bottom rows data source.src/components.d.ts:1559
pinnedTopSource?DataType[]Pinned top Source: {[T in ColumnProp]: any} - defines pinned top rows data source.src/components.d.ts:1563
plugins?typeof BasePlugin[]Custom grid plugins. Can be added or removed at runtime. Every plugin should be inherited from BasePlugin class. For more details check Plugin guidesrc/components.d.ts:1567
range?booleanWhen true, user can range selection.src/components.d.ts:1571
readonly?booleanWhen true, grid in read only mode.src/components.d.ts:1575
registerVNode?(VNode | (c: ExtraNodeFuncConfig) => VNode)[]Register new virtual node inside of grid. Used for additional items creation such as plugin elements. Should be set before grid render inside of plugins. Can return VNode result of h() function or a function that returns VNode. Function can be used for performance improvement and additional renders.src/components.d.ts:1579
resize?booleanWhen true, columns are resizable.src/components.d.ts:1586
rowClass?stringRow class property mapping. Map custom classes to rows from row object data. Define this property in rgRow object and this will be mapped as rgRow class.src/components.d.ts:1590
rowDefinitions?RowDefinition[]Custom row properies to be applied. See RowDefinition for more info.src/components.d.ts:1594
rowHeaders?boolean | RowHeadersExcel like functionality. Show row numbers. Also can be used for custom row header render if object provided.src/components.d.ts:1598
rowSize?numberIndicates default rgRow size. By default 0, means theme package size will be applied Alternatively you can use rowSize to reset viewportsrc/components.d.ts:1602
sorting?SortingConfigAlternative way to set sorting. {columns: [{prop: 'name', order: 'asc'}]}src/components.d.ts:1606
source?DataType[]Source - defines main data source. Can be an Object or 2 dimensional array([][]); Keys/indexes referenced from columns Prop.src/components.d.ts:1610
stretch?string | booleanStretch strategy for columns by StretchColumn plugin. For example if there are more space on the right last column size would be increased.src/components.d.ts:1614
theme?stringTheme name.src/components.d.ts:1618
trimmedRows?Record<number, boolean>Trimmed rows. Functionality which allows to hide rows from main data set. trimmedRows are physical rgRow indexes to hide.src/components.d.ts:1622
useClipboard?booleanWhen true enable clipboard.src/components.d.ts:1626