Skip to content

Overview

This component is responsible for rendering data Rows, columns, groups and cells

Properties

PropertyAttributeDescriptionTypeDefault
additionalDataadditional-dataAdditional data to pass to renderer Used in plugins such as vue or react to pass root app entity to cellsanyundefined
colData (required)--Column sourceObservableMap<DSourceState<ColumnRegular, DimensionCols>>undefined
colType (required)col-typeColumn data type"colPinEnd" | "colPinStart" | "rgCol" | "rowHeaders"undefined
dataStore (required)--Data rows sourceObservableMap<DSourceState<DataType, DimensionRows>>undefined
dimensionRow (required)--Dimension settings YObservableMap<DimensionSettingsState>undefined
jobsBeforeRender--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.(Promise<any> | (() => Promise<any>))[][]
rangerangeRange allowedbooleanundefined
readonlyreadonlyReadonly modebooleanundefined
rowClassrow-classDefines property from which to read row classstringundefined
rowSelectionStore (required)--Selection, range, focus for row selectionObservableMap<SelectionStoreState>undefined
type (required)typeRow data type"rgRow" | "rowPinEnd" | "rowPinStart"undefined
viewportCol (required)--Viewport XObservableMap<ViewportState>undefined
viewportRow (required)--Viewport YObservableMap<ViewportState>undefined

Events

EventDescriptionType
afterrenderWhen data render finished for the designated typeCustomEvent<{ type: DimensionRows; }>
beforecellrenderBefore each cell render function. Allows to override cell propertiesCustomEvent<BeforeCellRenderEvent<CellTemplateProp>>
beforedatarenderBefore data renderCustomEvent<AllDimensionType>
beforerowrenderBefore each row renderCustomEvent<BeforeRowRenderEvent<any>>
dragstartcellEvent emitted on cell drag startCustomEvent<DragStartEvent>

Methods

updateCell(e: { row: number; col: number; }) => Promise<void>

Pointed cell update.

Parameters

NameTypeDescription
e{ row: number; col: number; }

Returns

Type: Promise<void>

Dependencies

Used by

Depends on

  • vnode-html

Graph


Built with ❤️ by Revolist OU

Revogrid is a MIT-licensed open source library made by Revolist OU.