Property | Attribute | Description | Type | Default |
---|---|---|---|---|
autoSizeColumn |
auto-size-column |
Autosize config Enable columns autoSize, for more details check | boolean | { mode?: ColumnAutoSizeMode; allColumns?: boolean; letterBlockSize?: number; preciseSize?: boolean; } |
false |
canFocus |
can-focus |
When true cell focus appear. | boolean |
true |
canMoveColumns |
can-move-columns |
Enables column move plugin Can be boolean | boolean |
false |
colSize |
col-size |
Indicates default column size. | number |
100 |
columnTypes |
-- | Types Every type represent multiple column properties Types will be merged but can be replaced with column properties | { [name: string]: ColumnType; } |
{} |
columns |
-- | Columns - defines an array of grid columns. Can be column or grouped column. | (ColumnRegular | ColumnGrouping)[] |
[] |
editors |
-- | Custom editors register | { [name: string]: EditorCtr; } |
{} |
exporting |
exporting |
Enables export plugin Can be boolean Can be export options | boolean |
false |
filter |
filter |
Enables filter plugin Can be boolean Can be filter collection | boolean | { collection?: FilterCollection; include?: string[]; customFilters?: Record<string, CustomFilter>; localization?: FilterLocalization; multiFilterItems?: MultiFilterItem; disableDynamicFiltering?: boolean; } |
false |
frameSize |
frame-size |
Defines how many rows/columns should be rendered outside visible area. | number |
1 |
grouping |
-- | Group models by provided properties Define properties to be groped by | { props?: ColumnProp[]; expandedAll?: boolean; groupLabelTemplate?: GroupLabelTemplateFunc; } |
undefined |
pinnedBottomSource |
-- | Pinned bottom Source: {[T in ColumnProp]: any} - defines pinned bottom rows data source. | DataType[] |
[] |
pinnedTopSource |
-- | Pinned top Source: {[T in ColumnProp]: any} - defines pinned top rows data source. | DataType[] |
[] |
plugins |
-- | Custom grid plugins Has to be predefined during first grid init Every plugin should be inherited from BasePlugin | (typeof Plugin)[] |
undefined |
range |
range |
When true, user can range selection. | boolean |
false |
readonly |
readonly |
When true, grid in read only mode. | boolean |
false |
resize |
resize |
When true, columns are resizable. | boolean |
false |
rowClass |
row-class |
Row class property Define this property in rgRow object and this will be mapped as rgRow class | string |
'' |
rowDefinitions |
-- | Row properies applied | RowDefinition[] |
[] |
rowHeaders |
row-headers |
Excel like show rgRow indexe per rgRow | RowHeaders | boolean |
undefined |
rowSize |
row-size |
Indicates default rgRow size. By default 0, means theme package size will be applied | number |
0 |
source |
-- | Source - defines main data source. Can be an Object or 2 dimensional array([][]); Keys/indexes referenced from columns Prop | DataType[] |
[] |
stretch |
stretch |
Defines stretch strategy for columns with | boolean | string |
true |
theme |
theme |
Theme name | "compact" | "darkCompact" | "darkMaterial" | "default" | "material" |
'default' |
trimmedRows |
-- | Trimmed rows Functionality which allows to hide rows from main data set | { [x: number]: boolean; } |
{} |
useClipboard |
use-clipboard |
When true enable clipboard. | boolean |
true |
Event | Description | Type |
---|---|---|
aftercolumnresize |
After column resize Get resized columns | CustomEvent<{ [x: string]: ColumnRegular; [x: number]: ColumnRegular; }> |
aftercolumnsset |
Column updated | CustomEvent<{ columns: ColumnCollection; order: Record<ColumnProp, "desc" | "asc">; }> |
afteredit |
After edit. Triggered when after data applied or Range changeged. | CustomEvent<{ data: DataLookup; models: { [rowIndex: number]: DataType; }; type: DimensionRows; } | { prop: ColumnProp; model: DataType; val?: string; rowIndex: number; type: DimensionRows; }> |
afterfocus |
Triggered after focus render finished. Can be used to access a focus element through | CustomEvent<{ model: any; column: ColumnRegular; }> |
aftersourceset |
After rows updated | CustomEvent<{ type: DimensionRows; source: DataType[]; }> |
aftertrimmed |
Notify trimmed applied | CustomEvent<any> |
beforeaange |
Before range apply. Triggered before range applied. Use e.preventDefault() to prevent range. | CustomEvent<{ type: DimensionRows; newRange: RangeArea; oldRange: RangeArea; newProps: ColumnProp[]; oldProps: ColumnProp[]; newData: { [key: number]: DataType; }; }> |
beforeautofill |
Before autofill. Triggered before autofill applied. Use e.preventDefault() to prevent edit data apply. | CustomEvent<{ type: DimensionRows; newRange: RangeArea; oldRange: RangeArea; newProps: ColumnProp[]; oldProps: ColumnProp[]; newData: { [key: number]: DataType; }; }> |
beforecellfocus |
Before cell focus changed. Use e.preventDefault() to prevent cell focus change. | CustomEvent<{ prop: ColumnProp; model: DataType; val?: string; rowIndex: number; type: DimensionRows; }> |
beforecolumnapplied |
Before column applied but after column set gathered and viewport updated | CustomEvent<{ columns: ColumnItems; columnGrouping: ColumnGrouping; maxLevel: number; sort: Record<ColumnProp, ColumnRegular>; }> |
beforecolumnsset |
Before column update | CustomEvent<{ columns: ColumnItems; columnGrouping: ColumnGrouping; maxLevel: number; sort: Record<ColumnProp, ColumnRegular>; }> |
beforeedit |
Before edit event. Triggered before edit data applied. Use e.preventDefault() to prevent edit data set and use you own. Use e.val = {your value} to replace edit result with your own. | CustomEvent<{ prop: ColumnProp; model: DataType; val?: string; rowIndex: number; type: DimensionRows; }> |
beforeeditstart |
Before edit started Use e.preventDefault() to prevent edit | CustomEvent<{ prop: ColumnProp; model: DataType; val?: string; rowIndex: number; type: DimensionRows; }> |
beforeexport |
Before export Use e.preventDefault() to prevent export Replace data in Event in case you want to modify it in export | CustomEvent<{ data: DataType[]; } & ColSource> |
beforefilterapply |
Before filter applied to data source Use e.preventDefault() to prevent cell focus change Update | CustomEvent<{ collection: FilterCollection; }> |
beforefiltertrimmed |
Before filter trimmed values Use e.preventDefault() to prevent value trimming and filter apply Update | CustomEvent<{ collection: FilterCollection; itemsToFilter: Record<number, boolean>; }> |
beforefocuslost |
Before grid focus lost happened. Use e.preventDefault() to prevent cell focus change. | CustomEvent<{ model: any; cell: Cell; colType: DimensionCols; rowType: DimensionRows; column?: ColumnRegular; }> |
beforerangeedit |
Before range edit event. Triggered before range data applied, when range selection happened. Use e.preventDefault() to prevent edit data set and use you own. | CustomEvent<{ data: DataLookup; models: { [rowIndex: number]: DataType; }; type: DimensionRows; }> |
beforesorting |
Before sorting event. Initial sorting triggered, if this event stops no other event called. Use e.preventDefault() to prevent sorting. | CustomEvent<{ column: ColumnRegular; order: "desc" | "asc"; additive: boolean; }> |
beforesortingapply |
Before sorting apply. Use e.preventDefault() to prevent sorting data change. | CustomEvent<{ column: ColumnRegular; order: "desc" | "asc"; additive: boolean; }> |
beforesourceset |
Before data apply. You can override data source here | CustomEvent<{ type: DimensionRows; source: DataType[]; }> |
beforesourcesortingapply |
Before source update sorting apply. Use this event if you intended to prevent sorting on data update. Use e.preventDefault() to prevent sorting data change during rows source update. | CustomEvent<any> |
beforetrimmed |
Before trimmed values Use e.preventDefault() to prevent value trimming Update | CustomEvent<{ trimmed: Record<number, boolean>; trimmedType: string; type: string; }> |
headerclick |
On header click. | CustomEvent<ColumnRegular> |
rowdragstart |
Row order change started. Use e.preventDefault() to prevent rgRow order change. Use e.text = 'new name' to change item name on start. | CustomEvent<{ pos: PositionItem; text: string; }> |
roworderchanged |
Before rgRow order apply. Use e.preventDefault() to prevent rgRow order change. | CustomEvent<{ from: number; to: number; }> |
viewportscroll |
Triggered when view port scrolled | CustomEvent<{ dimension: DimensionType; coordinate: number; delta?: number; }> |
addTrimmed(trimmed: Record<number, boolean>, trimmedType?: string, type?: RevoGrid.DimensionRows) => Promise<CustomEvent<{ trimmed: Record<number, boolean>; trimmedType: string; type: string; }>>
Add trimmed by type
Type: Promise<CustomEvent<{ trimmed: Record<number, boolean>; trimmedType: string; type: string; }>>
Clear current grid focus
Type: Promise<void>
Clears column sorting
Type: Promise<void>
Provides access to column internal store observer Can be used for plugin support
Type: Promise<ColumnSource>
Receive all columns in data source
Type: Promise<ColumnRegular[]>
Get the currently focused cell.
Type: Promise<FocusedData>
Get all active plugins instances
Type: Promise<Plugin[]>
Get the currently selected Range.
Type: Promise<RangeArea>
Get data from source
Type: Promise<DataType[]>
Provides access to rows internal store observer Can be used for plugin support
Type: Promise<RowSource>
Get data from visible part of source Trimmed/filtered rows will be excluded
Type: Promise<any[]>
Refreshes data viewport. Can be specific part as rgRow or pinned rgRow or 'all' by default.
Type: Promise<void>
Register new virtual node inside of grid Used for additional items creation such as plugin elements
Type: Promise<void>
Scrolls view port to specified column index
Type: Promise<void>
Scrolls view port to specified column prop
Type: Promise<void>
Scrolls view port to coordinate
Type: Promise<void>
Scrolls view port to specified rgRow index
Type: Promise<void>
setCellEdit(rgRow: number, prop: RevoGrid.ColumnProp, rowSource?: RevoGrid.DimensionRows) => Promise<void>
Bring cell to edit mode
Type: Promise<void>
updateColumnSorting(column: RevoGrid.ColumnRegular, index: number, order: 'asc' | 'desc', additive: boolean) => Promise<RevoGrid.ColumnRegular>
Update column sorting
Type: Promise<ColumnRegular>
Update columns
Type: Promise<void>
- revogr-row-headers
- revogr-scroll-virtual
- revogr-header
- revogr-overlay-selection
- revogr-data
- revogr-temp-range
- revogr-focus
- revogr-viewport-scroll
graph TD;
revo-grid --> revogr-row-headers
revo-grid --> revogr-scroll-virtual
revo-grid --> revogr-header
revo-grid --> revogr-overlay-selection
revo-grid --> revogr-data
revo-grid --> revogr-temp-range
revo-grid --> revogr-focus
revo-grid --> revogr-viewport-scroll
revogr-row-headers --> revogr-data
revogr-row-headers --> revogr-viewport-scroll
revogr-row-headers --> revogr-header
revogr-overlay-selection --> revogr-edit
revogr-overlay-selection --> revogr-order-editor
style revo-grid fill:#f9f,stroke:#333,stroke-width:4px
Built with StencilJS