Overview
This component is responsible for rendering data Rows, columns, groups and cells
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
additionalData | additional-data | Additional data to pass to renderer Used in plugins such as vue or react to pass root app entity to cells | any | undefined |
colData (required) | -- | Column source | "colPinEnd" | "colPinStart" | "rgCol" | ColumnRegular | undefined |
colType (required) | col-type | Column data type | "colPinEnd" | "colPinStart" | "rgCol" | "rowHeaders" | undefined |
dataStore (required) | -- | Data rows source | "rgRow" | "rowPinEnd" | "rowPinStart" | D | undefined |
dimensionRow (required) | -- | Dimension settings Y | 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>))[] | [] |
range | range | Range allowed | boolean | undefined |
readonly | readonly | Readonly mode | boolean | undefined |
rowClass | row-class | Defines property from which to read row class | string | undefined |
rowSelectionStore (required) | -- | Selection, range, focus for row selection | { range: RangeArea | null; tempRange: RangeArea | null; tempRangeType: string | null; focus: Cell | null; edit: EditCellStore | null; lastCell: Cell | null; nextFocus: Cell | null; } | undefined |
type (required) | type | Row data type | "rgRow" | "rowPinEnd" | "rowPinStart" | undefined |
viewportCol (required) | -- | Viewport X | ViewportState | undefined |
viewportRow (required) | -- | Viewport Y | ViewportState | undefined |
Events
| Event | Description | Type |
|---|---|---|
afterrender | When data render finished for the designated type | CustomEvent<{ type: DimensionRows; }> |
beforecellrender | Before each cell render function. Allows to override cell properties | CustomEvent<BeforeCellRenderEvent<CellTemplateProp>> |
beforedatarender | Before data render | CustomEvent<AllDimensionType> |
beforerowrender | Before each row render | CustomEvent<BeforeRowRenderEvent<any>> |
dragstartcell | Event emitted on cell drag start | CustomEvent<DragStartEvent> |
Methods
updateCell(e: { row: number; col: number; }) => Promise<void>
Pointed cell update.
Parameters
| Name | Type | Description |
|---|---|---|
e | { row: number; col: number; } |
Returns
Type: Promise<void>
Dependencies
Used by
Depends on
- vnode-html
Graph
Built with ❤️ by Revolist OU