@revolist/revogrid
BasePlugin
Base layer for plugins Provide minimal starting core for plugins to work Extend this class to create plugin
Implements
Constructors
new BasePlugin()
new BasePlugin(revogrid: HTMLRevoGridElement, providers: PluginProviders): BasePlugin
Parameters
Parameter | Type |
---|---|
revogrid | HTMLRevoGridElement |
providers | PluginProviders |
Returns
Defined in
Properties
Property | Modifier | Type | Default value | Defined in |
---|---|---|---|---|
h | readonly | typeof h | h | src/plugins/base.plugin.ts:12 |
providers | public | PluginProviders | undefined | src/plugins/base.plugin.ts:14 |
revogrid | public | HTMLRevoGridElement | undefined | src/plugins/base.plugin.ts:14 |
subscriptions | readonly | Record <string , (...args : any []) => void > | {} | src/plugins/base.plugin.ts:13 |
Methods
addEventListener()
addEventListener<T>(eventName: string, callback: (e: CustomEvent<T>) => void): void
Type Parameters
Type Parameter | Default type |
---|---|
T | any |
Parameters
Parameter | Type | Description |
---|---|---|
eventName | string | event name to subscribe to in revo-grid component (e.g. 'beforeheaderclick') |
callback | (e : CustomEvent <T >) => void | callback function for event |
Returns
void
Defined in
clearSubscriptions()
clearSubscriptions(): void
Clear all subscriptions
Returns
void
Defined in
destroy()
destroy(): void
Destroy plugin and clear all subscriptions
Returns
void
Implementation of
Defined in
emit()
emit<T>(eventName: string, detail?: T): CustomEvent<T>
Emit event from revo-grid component Event can be cancelled by calling event.preventDefault() in callback
Type Parameters
Type Parameter | Default type |
---|---|
T | any |
Parameters
Parameter | Type |
---|---|
eventName | string |
detail ? | T |
Returns
CustomEvent
<T
>
Defined in
removeEventListener()
removeEventListener(eventName: string): void
Remove event listener
Parameters
Parameter | Type | Description |
---|---|---|
eventName | string |
Returns
void
Defined in
watch()
watch<T>(
prop: string,
callback: (arg: T) => boolean | void,
immediate: Partial<WatchConfig>): void
Subscribe to property change in revo-grid component You can return false in callback to prevent default value set
Type Parameters
Type Parameter |
---|
T extends unknown |
Parameters
Parameter | Type | Description |
---|---|---|
prop | string | property name |
callback | (arg : T ) => boolean | void | callback function |
immediate | Partial <WatchConfig > | trigger callback immediately with current value |
Returns
void
Defined in
DataStore<T, ST>
Data store Manage the state of a data source and provide methods for updating, adding, and refreshing the data.
Type Parameters
Type Parameter |
---|
T extends GDataType |
ST extends GDimension |
Constructors
new DataStore()
new DataStore<T, ST>(type: ST, storeData?: DSourceState<T, ST>): DataStore<T, ST>
Parameters
Parameter | Type |
---|---|
type | ST |
storeData ? | DSourceState <T , ST > |
Returns
DataStore
<T
, ST
>
Defined in
src/store/dataSource/data.store.ts:44
Accessors
store
get store(): Observable<DSourceState<T, ST>>
Returns
Observable
<DSourceState
<T
, ST
>>
Defined in
src/store/dataSource/data.store.ts:41
Methods
addTrimmed()
addTrimmed(some: Partial<Trimmed>): void
Parameters
Parameter | Type |
---|---|
some | Partial <Trimmed > |
Returns
void
Defined in
src/store/dataSource/data.store.ts:99
refresh()
refresh(): void
Returns
void
Defined in
src/store/dataSource/data.store.ts:117
setData()
setData(input: Partial<DSourceState<T, ST>>): void
Parameters
Parameter | Type |
---|---|
input | Partial <DSourceState <T , ST >> |
Returns
void
Defined in
src/store/dataSource/data.store.ts:110
setSourceData()
setSourceData(items: Record<number, any>, mutate: boolean): void
Parameters
Parameter | Type | Default value |
---|---|---|
items | Record <number , any > | undefined |
mutate | boolean | true |
Returns
void
Defined in
src/store/dataSource/data.store.ts:105
updateData()
updateData(
source: T[],
grouping?: {
customRenderer: GroupLabelTemplateFunc;
depth: number;
groups: Groups;
},
silent?: boolean): void
full data source update
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
source | T [] | undefined | data column/rgRow source |
grouping ? | object | undefined | grouping information if present |
grouping.customRenderer ? | GroupLabelTemplateFunc | undefined | - |
grouping.depth ? | number | undefined | - |
grouping.groups ? | Groups | undefined | - |
silent ? | boolean | false | - |
Returns
void
Defined in
src/store/dataSource/data.store.ts:65
DimensionStore
Constructors
new DimensionStore()
new DimensionStore(type: MultiDimensionType): DimensionStore
Parameters
Parameter | Type |
---|---|
type | MultiDimensionType |
Returns
Defined in
src/store/dimension/dimension.store.ts:56
Properties
Property | Modifier | Type | Defined in |
---|---|---|---|
store | readonly | Observable <DimensionSettingsState > | src/store/dimension/dimension.store.ts:55 |
type | readonly | MultiDimensionType | src/store/dimension/dimension.store.ts:56 |
Methods
dispose()
dispose(): void
Returns
void
Defined in
src/store/dimension/dimension.store.ts:82
drop()
drop(): void
Returns
void
Defined in
src/store/dimension/dimension.store.ts:90
getCurrentState()
getCurrentState(): DimensionSettingsState
Returns
Defined in
src/store/dimension/dimension.store.ts:68
setDimensionSize()
setDimensionSize(sizes: ViewSettingSizeProp): void
Set custom dimension sizes and overwrite old Generates new indexes based on sizes
Parameters
Parameter | Type | Description |
---|---|---|
sizes | ViewSettingSizeProp | sizes to set |
Returns
void
Defined in
src/store/dimension/dimension.store.ts:99
setStore()
setStore<T>(data: Partial<T>): void
Type Parameters
Type Parameter |
---|
T extends Record <string , any > |
Parameters
Parameter | Type |
---|---|
data | Partial <T > |
Returns
void
Defined in
src/store/dimension/dimension.store.ts:86
updateSizesPositionByIndexes()
updateSizesPositionByIndexes(newItemsOrder: number[], prevItemsOrder: number[]): void
Parameters
Parameter | Type | Default value |
---|---|---|
newItemsOrder | number [] | undefined |
prevItemsOrder | number [] | [] |
Returns
void
Defined in
src/store/dimension/dimension.store.ts:110
SelectionStore
Constructors
new SelectionStore()
new SelectionStore(): SelectionStore
Returns
Defined in
src/store/selection/selection.store.ts:25
Properties
Property | Modifier | Type | Defined in |
---|---|---|---|
store | readonly | Observable <SelectionStoreState > | src/store/selection/selection.store.ts:23 |
Methods
clearFocus()
clearFocus(): void
Returns
void
Defined in
src/store/selection/selection.store.ts:38
clearTemp()
clearTemp(): void
Returns
void
Defined in
src/store/selection/selection.store.ts:63
dispose()
dispose(): void
Returns
void
Defined in
src/store/selection/selection.store.ts:91
onChange()
onChange<Key>(propName: Key, cb: (newValue: SelectionStoreState[Key]) => void): void
Type Parameters
Type Parameter |
---|
Key extends keyof SelectionStoreState |
Parameters
Parameter | Type |
---|---|
propName | Key |
cb | (newValue : SelectionStoreState [Key ]) => void |
Returns
void
Defined in
src/store/selection/selection.store.ts:34
setEdit()
setEdit(val?: string | boolean): void
Parameters
Parameter | Type |
---|---|
val ? | string | boolean |
Returns
void
Defined in
src/store/selection/selection.store.ts:80
setFocus()
setFocus(focus: Cell, end?: Cell): void
Parameters
Parameter | Type |
---|---|
focus | Cell |
end ? | Cell |
Returns
void
Defined in
src/store/selection/selection.store.ts:42
setLastCell()
setLastCell(lastCell: Cell): void
Parameters
Parameter | Type |
---|---|
lastCell | Cell |
Returns
void
Defined in
src/store/selection/selection.store.ts:76
setNextFocus()
setNextFocus(focus: Cell): void
Parameters
Parameter | Type |
---|---|
focus | Cell |
Returns
void
Defined in
src/store/selection/selection.store.ts:55
setRange()
setRange(start: Cell, end: Cell): void
Parameters
Parameter | Type |
---|---|
start | Cell |
end | Cell |
Returns
void
Defined in
src/store/selection/selection.store.ts:71
setRangeArea()
setRangeArea(range: null | RangeArea): void
Can be applied from selection change or from simple keyboard change clicks
Parameters
Parameter | Type |
---|---|
range | null | RangeArea |
Returns
void
Defined in
src/store/selection/selection.store.ts:68
setTempArea()
setTempArea(range: null | Nullable<TempRange>): void
Parameters
Parameter | Type |
---|---|
range | null | Nullable <TempRange > |
Returns
void
Defined in
src/store/selection/selection.store.ts:59
TextEditor
Editor interface
Implements
Constructors
new TextEditor()
new TextEditor(data: ColumnDataSchemaModel, saveCallback?: SaveCallback): TextEditor
Parameters
Parameter | Type |
---|---|
data | ColumnDataSchemaModel |
saveCallback ? | SaveCallback |
Returns
Defined in
src/components/editors/text-editor.ts:27
Properties
Property | Modifier | Type | Default value | Defined in |
---|---|---|---|---|
data | public | ColumnDataSchemaModel | undefined | src/components/editors/text-editor.ts:28 |
editCell? | public | EditCell | undefined | src/components/editors/text-editor.ts:25 |
editInput | public | null | HTMLInputElement | null | src/components/editors/text-editor.ts:22 |
element | public | null | Element | null | src/components/editors/text-editor.ts:24 |
Methods
beforeDisconnect()
beforeDisconnect(): void
IMPORTANT: Prevent scroll glitches when editor is closed and focus is on current input element.
Returns
void
Implementation of
Defined in
src/components/editors/text-editor.ts:62
componentDidRender()
componentDidRender(): Promise<void>
Callback triggered on cell editor render
Returns
Promise
<void
>
Implementation of
Defined in
src/components/editors/text-editor.ts:35
getValue()
getValue(): undefined | string
Get value from input
Returns
undefined
| string
Implementation of
Defined in
src/components/editors/text-editor.ts:69
onKeyDown()
onKeyDown(e: KeyboardEvent): void
Parameters
Parameter | Type |
---|---|
e | KeyboardEvent |
Returns
void
Defined in
src/components/editors/text-editor.ts:42
render()
render(h: typeof h, _additionalData: any): VNode | VNode[]
Render method for Editor plugin. Renders input element with passed data from cell.
Parameters
Parameter | Type | Description |
---|---|---|
h | typeof h | h function from stencil render. |
_additionalData | any | additional data from plugin. |
Returns
- input element.
Required
Method
Implementation of
Defined in
src/components/editors/text-editor.ts:82
ViewportStore
Viewport store class
Constructors
new ViewportStore()
new ViewportStore(type: MultiDimensionType): ViewportStore
Parameters
Parameter | Type |
---|---|
type | MultiDimensionType |
Returns
Defined in
src/store/vp/viewport.store.ts:57
Properties
Property | Modifier | Type | Defined in |
---|---|---|---|
store | readonly | Observable <ViewportState > | src/store/vp/viewport.store.ts:46 |
type | readonly | MultiDimensionType | src/store/vp/viewport.store.ts:57 |
Accessors
lastCoordinate
get lastCoordinate(): number
set lastCoordinate(value: number): void
Parameters
Parameter | Type |
---|---|
value | number |
Returns
number
Defined in
src/store/vp/viewport.store.ts:51
Methods
getItems()
getItems(): ItemsToUpdate
Returns
Defined in
src/store/vp/viewport.store.ts:193
setOriginalSizes()
setOriginalSizes(size: number): void
Set sizes for existing items
Parameters
Parameter | Type |
---|---|
size | number |
Returns
void
Defined in
src/store/vp/viewport.store.ts:175
setViewPortCoordinate()
setViewPortCoordinate(
position: number,
dimension: DimensionDataViewport,
force: boolean): void
Render viewport based on coordinate It's the main method for draw Use force if you want to re-render viewport
Parameters
Parameter | Type | Default value |
---|---|---|
position | number | undefined |
dimension | DimensionDataViewport | undefined |
force | boolean | false |
Returns
void
Defined in
src/store/vp/viewport.store.ts:66
setViewport()
setViewport(data: Partial<ViewportState>): void
Parameters
Parameter | Type |
---|---|
data | Partial <ViewportState > |
Returns
void
Defined in
src/store/vp/viewport.store.ts:201
AND_OR_BUTTON
const AND_OR_BUTTON: "and-or-button" = 'and-or-button';
Defined in
src/plugins/filter/filter.button.tsx:8
CELL_CLASS
const CELL_CLASS: "rgCell" = 'rgCell';
Defined in
CELL_HANDLER_CLASS
const CELL_HANDLER_CLASS: "autofill-handle" = 'autofill-handle';
Defined in
DATA_COL
const DATA_COL: "data-rgCol" = 'data-rgCol';
Defined in
DATA_ROW
const DATA_ROW: "data-rgRow" = 'data-rgRow';
Defined in
DISABLED_CLASS
const DISABLED_CLASS: "disabled" = 'disabled';
Defined in
DRAGGABLE_CLASS
const DRAGGABLE_CLASS: "revo-draggable" = 'revo-draggable';
Defined in
DRAGG_TEXT
const DRAGG_TEXT: "Draggable item" = 'Draggable item';
Defined in
DRAG_ICON_CLASS
const DRAG_ICON_CLASS: "revo-drag-icon" = 'revo-drag-icon';
Defined in
EDIT_INPUT_WR
const EDIT_INPUT_WR: "edit-input-wrapper" = 'edit-input-wrapper';
Defined in
FILTER_BUTTON_ACTIVE
const FILTER_BUTTON_ACTIVE: "active" = 'active';
Defined in
src/plugins/filter/filter.button.tsx:5
FILTER_BUTTON_CLASS
const FILTER_BUTTON_CLASS: "rv-filter" = 'rv-filter';
Defined in
src/plugins/filter/filter.button.tsx:4
FILTER_CONFIG_CHANGED_EVENT
const FILTER_CONFIG_CHANGED_EVENT: "filterconfigchanged" = 'filterconfigchanged';
Defined in
src/plugins/filter/filter.plugin.tsx:27
FILTER_PROP
const FILTER_PROP: "hasFilter" = 'hasFilter';
Defined in
src/plugins/filter/filter.button.tsx:7
FILTER_TRIMMED_TYPE
const FILTER_TRIMMED_TYPE: "filter" = 'filter';
Defined in
src/plugins/filter/filter.plugin.tsx:26
FILTE_PANEL
const FILTE_PANEL: "revogr-filter-panel" = 'revogr-filter-panel';
Defined in
src/plugins/filter/filter.plugin.tsx:28
FOCUS_CLASS
const FOCUS_CLASS: "focused-cell" = 'focused-cell';
Defined in
GRID_INTERNALS
const GRID_INTERNALS: "__rvgr" = '__rvgr';
Defined in
HEADER_ACTUAL_ROW_CLASS
const HEADER_ACTUAL_ROW_CLASS: "actual-rgRow" = 'actual-rgRow';
Defined in
HEADER_CLASS
const HEADER_CLASS: "rgHeaderCell" = 'rgHeaderCell';
Defined in
HEADER_ROW_CLASS
const HEADER_ROW_CLASS: "header-rgRow" = 'header-rgRow';
Defined in
HEADER_SORTABLE_CLASS
const HEADER_SORTABLE_CLASS: "sortable" = 'sortable';
Defined in
MIN_COL_SIZE
const MIN_COL_SIZE: 30 = 30;
Defined in
MOBILE_CLASS
const MOBILE_CLASS: "mobile-handler" = 'mobile-handler';
Defined in
RESIZE_INTERVAL
const RESIZE_INTERVAL: 40 = 40;
Defined in
REVOGRID_EVENTS
const REVOGRID_EVENTS: Map<RevogridEvents, RevogridEvents>;
Defined in
ROW_FOCUSED_CLASS
const ROW_FOCUSED_CLASS: "focused-rgRow" = 'focused-rgRow';
Defined in
ROW_HEADER_TYPE
const ROW_HEADER_TYPE: "rowHeaders" = 'rowHeaders';
Defined in
SELECTION_BORDER_CLASS
const SELECTION_BORDER_CLASS: "selection-border-range" = 'selection-border-range';
Defined in
TMP_SELECTION_BG_CLASS
const TMP_SELECTION_BG_CLASS: "temp-bg-range" = 'temp-bg-range';
Defined in
TRASH_BUTTON
const TRASH_BUTTON: "trash-button" = 'trash-button';
Defined in
src/plugins/filter/filter.button.tsx:9
columnTypes
const columnTypes: DimensionCols[];
Defined in
filterCoreFunctionsIndexedByType
const filterCoreFunctionsIndexedByType: Record<FilterType, LogicFunction>;
Defined in
src/plugins/filter/filter.indexed.ts:12
filterNames
const filterNames: {
begins: 'Begins with';
contains: 'Contains';
empty: 'Not set';
eq: 'Equal';
eqN: '=';
gt: '>';
gte: '>=';
lt: '<';
lte: '<=';
neqN: '!=';
none: 'None';
notContains: 'Does not contain';
notEmpty: 'Set';
notEq: 'Not equal';
};
Type declaration
Name | Type | Default value | Defined in |
---|---|---|---|
begins | string | 'Begins with' | src/plugins/filter/filter.indexed.ts:42 |
contains | string | 'Contains' | src/plugins/filter/filter.indexed.ts:43 |
empty | string | 'Not set' | src/plugins/filter/filter.indexed.ts:37 |
eq | string | 'Equal' | src/plugins/filter/filter.indexed.ts:40 |
eqN | string | '=' | src/plugins/filter/filter.indexed.ts:46 |
gt | string | '>' | src/plugins/filter/filter.indexed.ts:48 |
gte | string | '>=' | src/plugins/filter/filter.indexed.ts:49 |
lt | string | '<' | src/plugins/filter/filter.indexed.ts:50 |
lte | string | '<=' | src/plugins/filter/filter.indexed.ts:51 |
neqN | string | '!=' | src/plugins/filter/filter.indexed.ts:47 |
none | string | 'None' | src/plugins/filter/filter.indexed.ts:36 |
notContains | string | 'Does not contain' | src/plugins/filter/filter.indexed.ts:44 |
notEmpty | string | 'Set' | src/plugins/filter/filter.indexed.ts:38 |
notEq | string | 'Not equal' | src/plugins/filter/filter.indexed.ts:41 |
Defined in
src/plugins/filter/filter.indexed.ts:35
filterTypes
const filterTypes: Record<string, FilterType[]>;
Defined in
src/plugins/filter/filter.indexed.ts:30
rowTypes
const rowTypes: DimensionRows[];
Defined in
AndOrButton()
function AndOrButton(__namedParameters: any): any
Parameters
Parameter | Type |
---|---|
__namedParameters | any |
Returns
any
Defined in
src/plugins/filter/filter.button.tsx:42
FilterButton()
function FilterButton(__namedParameters: Props): any
Parameters
Parameter | Type |
---|---|
__namedParameters | Props |
Returns
any
Defined in
src/plugins/filter/filter.button.tsx:14
SortingSign()
function SortingSign(__namedParameters: Props): any
Parameters
Parameter | Type |
---|---|
__namedParameters | Props |
Returns
any
Defined in
src/plugins/sorting/sorting.sign.tsx:7
TrashButton()
function TrashButton(): any
Returns
any
Defined in
src/plugins/filter/filter.button.tsx:33
addMissingItems()
function addMissingItems<T>(
firstItem: PositionItem,
realCount: number,
virtualSize: number,
existingCollection: T,
dimension: Pick<DimensionSettingsState, "originItemSize" | "sizes">): VirtualPositionItem[]
If partial replacement this function adds items if viewport has some space left
Type Parameters
Type Parameter |
---|
T extends ItemsToUpdate |
Parameters
Parameter | Type |
---|---|
firstItem | PositionItem |
realCount | number |
virtualSize | number |
existingCollection | T |
dimension | Pick <DimensionSettingsState , "originItemSize" | "sizes" > |
Returns
Defined in
src/store/vp/viewport.helpers.ts:123
applyMixins()
function applyMixins(derivedCtor: any, constructors: any[]): void
Type script mixins
Parameters
Parameter | Type |
---|---|
derivedCtor | any |
constructors | any [] |
Returns
void
Defined in
calculateDimensionData()
function calculateDimensionData(originItemSize: number, newSizes: ViewSettingSizeProp): {
indexToItem: {};
indexes: newIndexes;
positionIndexToItem: {};
positionIndexes: number[];
}
Pre-calculation Dimension custom sizes for each cell Keeps only changed sizes, skips origin size
Parameters
Parameter | Type |
---|---|
originItemSize | number |
newSizes | ViewSettingSizeProp |
Returns
{
indexToItem: {};
indexes: newIndexes;
positionIndexToItem: {};
positionIndexes: number[];
}
Name | Type | Default value | Defined in |
---|---|---|---|
indexToItem | {} | - | src/store/dimension/dimension.helpers.ts:66 |
indexes | number [] | newIndexes | src/store/dimension/dimension.helpers.ts:63 |
positionIndexToItem | {} | - | src/store/dimension/dimension.helpers.ts:65 |
positionIndexes | number [] | - | src/store/dimension/dimension.helpers.ts:64 |
Defined in
src/store/dimension/dimension.helpers.ts:31
calculateRowHeaderSize()
function calculateRowHeaderSize(
itemsLength: number,
rowHeaderColumn?: RowHeaders,
minWidth?: number): number
Parameters
Parameter | Type | Default value |
---|---|---|
itemsLength | number | undefined |
rowHeaderColumn ? | RowHeaders | undefined |
minWidth ? | number | 50 |
Returns
number
Defined in
src/utils/row-header-utils.ts:4
cropCellToMax()
function cropCellToMax(cell: Cell, lastCell: Cell): Cell
Parameters
Parameter | Type |
---|---|
cell | Cell |
lastCell | Cell |
Returns
Defined in
src/store/selection/selection.helpers.ts:29
dispatch()
function dispatch<DispatchDetail>(
target: null | EventTarget,
eventName: string,
detail?: DispatchDetail): CustomEvent<DispatchDetail>
Dispatches a custom event to a specified target element.
Type Parameters
Type Parameter | Default type |
---|---|
DispatchDetail | any |
Parameters
Parameter | Type | Description |
---|---|---|
target | null | EventTarget | The target element to dispatch the event to. |
eventName | string | The name of the custom event. |
detail ? | DispatchDetail | Optional. The detail of the custom event. |
Returns
CustomEvent
<DispatchDetail
>
The custom event that was dispatched.
Defined in
dispatchByEvent()
function dispatchByEvent<DispatchDetail>(
e: Pick<MouseEvent, "target" | "preventDefault">,
eventName: string,
detail?: DispatchDetail): CustomEvent
Dispatches a custom event based on an existing event object and prevents the default behavior of the original event.
Type Parameters
Type Parameter | Default type |
---|---|
DispatchDetail | any |
Parameters
Parameter | Type | Description |
---|---|---|
e | Pick <MouseEvent , "target" | "preventDefault" > | The original event object containing the target and preventDefault method. |
eventName | string | The name of the custom event. |
detail ? | DispatchDetail | Optional. The detail of the custom event. |
Returns
CustomEvent
The custom event that was dispatched.
Defined in
findPositionInArray()
function findPositionInArray<T>(
this: T[],
el: T,
compareFn: (el: T, el2: T) => number): number
Type Parameters
Type Parameter |
---|
T |
Parameters
Parameter | Type |
---|---|
this | T [] |
el | T |
compareFn | (el : T , el2 : T ) => number |
Returns
number
Defined in
gatherGroup()
function gatherGroup<T>(
res: T,
colData: ColumnGrouping,
collection: T,
level: number): T
Type Parameters
Type Parameter |
---|
T extends ColumnCollection |
Parameters
Parameter | Type | Default value |
---|---|---|
res | T | undefined |
colData | ColumnGrouping | undefined |
collection | T | undefined |
level | number | 0 |
Returns
T
Defined in
gatherTrimmedItems()
function gatherTrimmedItems(trimmedItems: Trimmed): TrimmedEntity
Parameters
Parameter | Type |
---|---|
trimmedItems | Trimmed |
Returns
Defined in
src/store/dataSource/trimmed.plugin.ts:28
getCellData()
function getCellData(val?: any): any
Parameters
Parameter | Type |
---|---|
val ? | any |
Returns
any
Defined in
getCellDataParsed()
function getCellDataParsed(model: DataType, column: ColumnRegular): any
Parameters
Parameter | Type |
---|---|
model | DataType |
column | ColumnRegular |
Returns
any
Defined in
getCellRaw()
function getCellRaw(model: DataType, column?: ColumnRegular): any
Parameters
Parameter | Type |
---|---|
model | DataType |
column ? | ColumnRegular |
Returns
any
Defined in
getColumnByProp()
function getColumnByProp(columns: ColumnData, prop: ColumnProp): ColumnRegular | undefined
Parameters
Parameter | Type |
---|---|
columns | ColumnData |
prop | ColumnProp |
Returns
ColumnRegular
| undefined
Defined in
getColumnSizes()
function getColumnSizes(cols: ColumnRegular[]): ViewSettingSizeProp
Parameters
Parameter | Type |
---|---|
cols | ColumnRegular [] |
Returns
Defined in
getColumnType()
function getColumnType(rgCol: ColumnRegular): DimensionCols
Get column type from column data
Parameters
Parameter | Type |
---|---|
rgCol | ColumnRegular |
Returns
Defined in
getColumns()
function getColumns(
columns: ColumnData,
level: number,
types?: ColumnTypes): ColumnCollection
This function is used to create a collection of columns.
Parameters
Parameter | Type | Default value |
---|---|---|
columns | ColumnData | undefined |
level | number | 0 |
types ? | ColumnTypes | undefined |
Returns
Defined in
getFirstItem()
function getFirstItem(s: ItemsToUpdate): VirtualPositionItem
Parameters
Parameter | Type |
---|---|
s | ItemsToUpdate |
Returns
Defined in
src/store/vp/viewport.helpers.ts:340
getItemByIndex()
function getItemByIndex(dimension: Pick<DimensionIndexInput, "indexes" | "originItemSize" | "indexToItem">, index: number): PositionItem
Parameters
Parameter | Type |
---|---|
dimension | Pick <DimensionIndexInput , "indexes" | "originItemSize" | "indexToItem" > |
index | number |
Returns
Defined in
src/store/dimension/dimension.helpers.ts:109
getItemByPosition()
function getItemByPosition(__namedParameters: DimensionPosition, pos: number): PositionItem
Calculate item by position
Parameters
Parameter | Type |
---|---|
__namedParameters | DimensionPosition |
pos | number |
Returns
Defined in
src/store/dimension/dimension.helpers.ts:73
getItems()
function getItems(opt: {
firstItemIndex: number;
firstItemStart: number;
maxCount: number;
maxSize: number;
origSize: number;
sizes: ViewSettingSizeProp;
}, currentSize: number): VirtualPositionItem[]
Get wiewport items parameters caching position and calculating items count in viewport
Parameters
Parameter | Type | Default value |
---|---|---|
opt | object | undefined |
opt.firstItemIndex | number | undefined |
opt.firstItemStart | number | undefined |
opt.maxCount | number | undefined |
opt.maxSize | number | undefined |
opt.origSize | number | undefined |
opt.sizes ? | ViewSettingSizeProp | undefined |
currentSize | number | 0 |
Returns
Defined in
src/store/vp/viewport.helpers.ts:146
getLastItem()
function getLastItem(s: ItemsToUpdate): VirtualPositionItem
Parameters
Parameter | Type |
---|---|
s | ItemsToUpdate |
Returns
Defined in
src/store/vp/viewport.helpers.ts:346
getLeftRelative()
function getLeftRelative(
absoluteX: number,
gridPos: number,
offset: number): number
Parameters
Parameter | Type |
---|---|
absoluteX | number |
gridPos | number |
offset | number |
Returns
number
Defined in
src/plugins/moveColumn/column.drag.plugin.ts:224
getPhysical()
function getPhysical(store: Observable<DSourceState<any, any>>, virtualIndex: number): number
get physical index by virtual
Parameters
Parameter | Type | Description |
---|---|---|
store | Observable <DSourceState <any , any >> | store to process |
virtualIndex | number | - |
Returns
number
Defined in
src/store/dataSource/data.store.ts:126
getRange()
function getRange(start?: null | Cell, end?: null | Cell): RangeArea | null
Parameters
Parameter | Type |
---|---|
start ? | null | Cell |
end ? | null | Cell |
Returns
RangeArea
| null
Defined in
src/store/selection/selection.helpers.ts:44
getScrollbarSize()
function getScrollbarSize(document: Document): number
Calculate system scrollbar size
Parameters
Parameter | Type |
---|---|
document | Document |
Returns
number
Defined in
getSourceItem()
function getSourceItem<T1, T2>(store: Observable<DSourceState<T1, T2>>, virtualIndex: number): T1
get mapped item from source
Type Parameters
Type Parameter |
---|
T1 extends GDataType |
T2 extends GDimension |
Parameters
Parameter | Type | Description |
---|---|---|
store | Observable <DSourceState <T1 , T2 >> | store to process |
virtualIndex | number | virtual index to process |
Returns
T1
Defined in
src/store/dataSource/data.store.ts:150
getSourceItemVirtualIndexByProp()
function getSourceItemVirtualIndexByProp(store: Observable<DSourceState<any, any>>, prop: ColumnProp): number
Parameters
Parameter | Type |
---|---|
store | Observable <DSourceState <any , any >> |
prop | ColumnProp |
Returns
number
Defined in
src/store/dataSource/data.store.ts:219
getSourcePhysicalIndex()
function getSourcePhysicalIndex<T1, T2>(store: Observable<DSourceState<T1, T2>>, virtualIndex: number): number
Get physical index from virtual index
Type Parameters
Type Parameter |
---|
T1 extends GDataType |
T2 extends GDimension |
Parameters
Parameter | Type |
---|---|
store | Observable <DSourceState <T1 , T2 >> |
virtualIndex | number |
Returns
number
Defined in
src/store/dataSource/data.store.ts:160
getUpdatedItemsByPosition()
function getUpdatedItemsByPosition<T>(
pos: number,
items: T,
realCount: number,
virtualSize: number,
dimension: DimensionDataViewport): ItemsToUpdate
Update items based on new scroll position If viewport wasn't changed fully simple recombination of positions Otherwise rebuild viewport items
Type Parameters
Type Parameter |
---|
T extends ItemsToUpdate |
Parameters
Parameter | Type |
---|---|
pos | number |
items | T |
realCount | number |
virtualSize | number |
dimension | DimensionDataViewport |
Returns
Defined in
src/store/vp/viewport.helpers.ts:28
getVisibleSourceItem()
function getVisibleSourceItem(store: Observable<DSourceState<any, any>>): any[]
get all visible items
Parameters
Parameter | Type | Description |
---|---|---|
store | Observable <DSourceState <any , any >> | store to process |
Returns
any
[]
Defined in
src/store/dataSource/data.store.ts:138
h()
h(sel)
function h(sel: any): VNode
Parameters
Parameter | Type |
---|---|
sel | any |
Returns
Defined in
node_modules/@stencil/core/internal/stencil-public-runtime.d.ts:553
h(sel, data)
function h(sel: Node, data: null | VNodeData): VNode
Parameters
Parameter | Type |
---|---|
sel | Node |
data | null | VNodeData |
Returns
Defined in
node_modules/@stencil/core/internal/stencil-public-runtime.d.ts:554
h(sel, data)
function h(sel: any, data: null | VNodeData): VNode
Parameters
Parameter | Type |
---|---|
sel | any |
data | null | VNodeData |
Returns
Defined in
node_modules/@stencil/core/internal/stencil-public-runtime.d.ts:555
h(sel, text)
function h(sel: any, text: string): VNode
Parameters
Parameter | Type |
---|---|
sel | any |
text | string |
Returns
Defined in
node_modules/@stencil/core/internal/stencil-public-runtime.d.ts:556
h(sel, children)
function h(sel: any, children: (undefined | null | VNode)[]): VNode
Parameters
Parameter | Type |
---|---|
sel | any |
children | (undefined | null | VNode )[] |
Returns
Defined in
node_modules/@stencil/core/internal/stencil-public-runtime.d.ts:557
h(sel, data, text)
function h(
sel: any,
data: null | VNodeData,
text: string): VNode
Parameters
Parameter | Type |
---|---|
sel | any |
data | null | VNodeData |
text | string |
Returns
Defined in
node_modules/@stencil/core/internal/stencil-public-runtime.d.ts:558
h(sel, data, children)
function h(
sel: any,
data: null | VNodeData,
children: (undefined | null | VNode)[]): VNode
Parameters
Parameter | Type |
---|---|
sel | any |
data | null | VNodeData |
children | (undefined | null | VNode )[] |
Returns
Defined in
node_modules/@stencil/core/internal/stencil-public-runtime.d.ts:559
h(sel, data, children)
function h(
sel: any,
data: null | VNodeData,
children: VNode): VNode
Parameters
Parameter | Type |
---|---|
sel | any |
data | null | VNodeData |
children | VNode |
Returns
Defined in
node_modules/@stencil/core/internal/stencil-public-runtime.d.ts:560
isActiveRange()
function isActiveRange(
pos: number,
realSize: number,
first?: PositionItem,
last?: PositionItem): boolean
Verify if position is in range of the PositionItem, start and end are included
Parameters
Parameter | Type |
---|---|
pos | number |
realSize | number |
first ? | PositionItem |
last ? | PositionItem |
Returns
boolean
Defined in
src/store/vp/viewport.helpers.ts:310
isActiveRangeOutsideLastItem()
function isActiveRangeOutsideLastItem(
pos: number,
virtualSize: number,
firstItem?: PositionItem,
lastItem?: PositionItem): boolean
Parameters
Parameter | Type |
---|---|
pos | number |
virtualSize | number |
firstItem ? | PositionItem |
lastItem ? | PositionItem |
Returns
boolean
Defined in
src/store/vp/viewport.helpers.ts:327
isAll()
function isAll(event: KeyboardEvent): boolean
Parameters
Parameter | Type |
---|---|
event | KeyboardEvent |
Returns
boolean
Defined in
isClear()
function isClear(code: string): boolean
Parameters
Parameter | Type |
---|---|
code | string |
Returns
boolean
Defined in
isColGrouping()
function isColGrouping(colData: ColumnRegular | ColumnGrouping): colData is ColumnGrouping
Check if column is grouping column
Parameters
Parameter | Type |
---|---|
colData | ColumnRegular | ColumnGrouping |
Returns
colData is ColumnGrouping
Defined in
isCopy()
function isCopy(event: KeyboardEvent): boolean
Parameters
Parameter | Type |
---|---|
event | KeyboardEvent |
Returns
boolean
Defined in
isCtrlKey()
function isCtrlKey(code: number, platform: string): boolean
Parameters
Parameter | Type |
---|---|
code | number |
platform | string |
Returns
boolean
Defined in
isCtrlMetaKey()
function isCtrlMetaKey(code: codes): boolean
Parameters
Parameter | Type |
---|---|
code | codes |
Returns
boolean
Defined in
isCut()
function isCut(event: KeyboardEvent): boolean
Parameters
Parameter | Type |
---|---|
event | KeyboardEvent |
Returns
boolean
Defined in
isEnterKeyValue()
function isEnterKeyValue(key: string): boolean
Parameters
Parameter | Type |
---|---|
key | string |
Returns
boolean
Defined in
isFilterBtn()
function isFilterBtn(e: HTMLElement): null | true | Element
Parameters
Parameter | Type |
---|---|
e | HTMLElement |
Returns
null
| true
| Element
Defined in
src/plugins/filter/filter.button.tsx:46
isHiddenStore()
function isHiddenStore(pos: number): pos is -1
Parameters
Parameter | Type |
---|---|
pos | number |
Returns
pos is -1
Defined in
src/store/selection/selection.helpers.ts:4
isMetaKey()
function isMetaKey(code: number): boolean
Parameters
Parameter | Type |
---|---|
code | number |
Returns
boolean
Defined in
isPaste()
function isPaste(event: KeyboardEvent): boolean
Parameters
Parameter | Type |
---|---|
event | KeyboardEvent |
Returns
boolean
Defined in
isRangeSingleCell()
function isRangeSingleCell(a: RangeArea): boolean
Parameters
Parameter | Type |
---|---|
a | RangeArea |
Returns
boolean
Defined in
src/store/selection/selection.helpers.ts:55
isRowType()
function isRowType(type: any): type is DimensionRows
Parameters
Parameter | Type |
---|---|
type | any |
Returns
type is DimensionRows
Defined in
isStretchPlugin()
function isStretchPlugin(plugin: PluginBaseComponent | StretchColumn): plugin is StretchColumn
Check plugin type is Stretch
Parameters
Parameter | Type |
---|---|
plugin | PluginBaseComponent | StretchColumn |
Returns
plugin is StretchColumn
Defined in
src/plugins/column.stretch.plugin.ts:136
isTab()
function isTab(code: string): boolean
Parameters
Parameter | Type |
---|---|
code | string |
Returns
boolean
Defined in
isTabKeyValue()
function isTabKeyValue(key: string): boolean
Parameters
Parameter | Type |
---|---|
key | string |
Returns
boolean
Defined in
mergeSortedArray()
function mergeSortedArray<T>(
arr1: T[],
arr2: T[],
compareFn: (el: T, el2: T) => boolean): T[]
Merge sorted array helper function
Type Parameters
Type Parameter |
---|
T |
Parameters
Parameter | Type | Default value |
---|---|---|
arr1 | T [] | undefined |
arr2 | T [] | undefined |
compareFn | (el : T , el2 : T ) => boolean | simpleCompare |
Returns
T
[]
Defined in
nextCell()
function nextCell(cell: Cell, lastCell: Cell): Partial<Cell> | null
Parameters
Parameter | Type |
---|---|
cell | Cell |
lastCell | Cell |
Returns
Partial
<Cell
> | null
Defined in
src/store/selection/selection.helpers.ts:8
proxyPlugin()
function proxyPlugin(store: Observable<State>): PluginSubscribe<State>
Proxy plugin for data source. This plugin is used to sort the data source. It keeps the order of the items but does not modify the final source. It is also used to filter the items in the data source. The set
method takes a key and a new value as arguments. If the key is 'proxyItems' it will filter the items in the data source according to the new value. The new value should be an array of numbers representing the indexes of the items that should be visible. The method will return a new array of numbers with the indexes of the items that should be visible. The method will also update the 'items' property of the store with the new array.
Parameters
Parameter | Type |
---|---|
store | Observable <State > |
Returns
PluginSubscribe
<State
>
Defined in
src/store/dataSource/data.proxy.ts:17
pushSorted()
function pushSorted<T>(
arr: T[],
el: T,
fn: (el: T, el2: T) => number): T[]
Sorted push
Type Parameters
Type Parameter |
---|
T |
Parameters
Parameter | Type |
---|---|
arr | T [] |
el | T |
fn | (el : T , el2 : T ) => number |
Returns
T
[]
Defined in
range()
function range(size: number, startAt: number): number[]
Parameters
Parameter | Type | Default value |
---|---|---|
size | number | undefined |
startAt | number | 0 |
Returns
number
[]
Defined in
recombineByOffset()
function recombineByOffset(offset: number, data: RecombineOffsetData): ItemsToUpdate | undefined
Parameters
Parameter | Type |
---|---|
offset | number |
data | RecombineOffsetData |
Returns
ItemsToUpdate
| undefined
Defined in
src/store/vp/viewport.helpers.ts:189
scaleValue()
function scaleValue(
value: number,
from: [number, number],
to: [number, number]): number
Parameters
Parameter | Type |
---|---|
value | number |
from | [number , number ] |
to | [number , number ] |
Returns
number
Defined in
setItemSizes()
function setItemSizes(
vpItems: VirtualPositionItem[],
initialIndex: number,
size: number,
lastCoordinate: number): VirtualPositionItem[]
Set items sizes from start index to end
Parameters
Parameter | Type | Description |
---|---|---|
vpItems | VirtualPositionItem [] | |
initialIndex | number | - |
size | number | |
lastCoordinate | number |
Returns
Defined in
src/store/vp/viewport.helpers.ts:358
setItems()
function setItems<T>(store: Observable<DSourceState<T, any>>, items: number[]): void
Type Parameters
Type Parameter |
---|
T extends GDataType |
Parameters
Parameter | Type |
---|---|
store | Observable <DSourceState <T , any >> |
items | number [] |
Returns
void
Defined in
src/store/dataSource/data.store.ts:212
setSourceByPhysicalIndex()
function setSourceByPhysicalIndex<T>(
store: Observable<DSourceState<T, any>>,
modelByIndex: Record<number, T>,
mutate: boolean): void
set item to source
Type Parameters
Type Parameter |
---|
T extends GDataType |
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
store | Observable <DSourceState <T , any >> | undefined | store to process |
modelByIndex | Record <number , T > | undefined | collection of rows with physical indexes to setup |
mutate | boolean | true | if true, store will be mutated and whole viewport will be re-rendered |
Returns
void
Defined in
src/store/dataSource/data.store.ts:198
setSourceByVirtualIndex()
function setSourceByVirtualIndex<T>(
store: Observable<DSourceState<T, any>>,
modelByIndex: Record<number, undefined | T>,
mutate: boolean): void
Apply silently item/model/row value to data source
Type Parameters
Type Parameter |
---|
T extends GDataType |
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
store | Observable <DSourceState <T , any >> | undefined | data source with changes |
modelByIndex | Record <number , undefined | T > | undefined | collection of rows/values with virtual indexes to setup/replace in store/data source |
mutate | boolean | true | if true, store will be mutated and whole viewport will be re-rendered |
Returns
void
Defined in
src/store/dataSource/data.store.ts:174
setStore()
function setStore<T>(store: ObservableMap<T>, data: Partial<T>): void
Sets the given data on the specified store.
Type Parameters
Type Parameter |
---|
T extends Record <string , any > |
Parameters
Parameter | Type | Description |
---|---|---|
store | ObservableMap <T > | The store to set data on. |
data | Partial <T > | The data to set on the store. |
Returns
void
Defined in
timeout()
function timeout(delay: number): Promise<void>
Async timeout
Parameters
Parameter | Type | Default value |
---|---|---|
delay | number | 0 |
Returns
Promise
<void
>
Defined in
trimmedPlugin()
function trimmedPlugin<T>(store: Observable<DSourceState<T, any>>): PluginSubscribe<DSourceState<T, any>>
Hide items from main collection But keep them in store
Type Parameters
Type Parameter |
---|
T extends GDataType |
Parameters
Parameter | Type |
---|---|
store | Observable <DSourceState <T , any >> |
Returns
PluginSubscribe
<DSourceState
<T
, any
>>
Defined in
src/store/dataSource/trimmed.plugin.ts:11
updateMissingAndRange()
function updateMissingAndRange(
items: VirtualPositionItem[],
missing: VirtualPositionItem[],
range: Range): void
Parameters
Parameter | Type |
---|---|
items | VirtualPositionItem [] |
missing | VirtualPositionItem [] |
range | Range |
Returns
void
Defined in
src/store/vp/viewport.helpers.ts:103
Namespaces
Namespace | Description |
---|---|
Components | - |
JSX | - |
h | The "h" namespace is used to import JSX types for elements and attributes. It is imported in order to avoid conflicting global JSX issues. |
Enumerations
Enumeration | Description |
---|---|
codesLetter | - |
keyValues | - |
Interfaces
Interface | Description |
---|---|
AllDimensionType | Represents the mapping of dimension types to their corresponding dimension types. |
ApplyFocusEvent | Represents the event object that is emitted when applying focus. It includes information about the dimension type and focused cells. |
BeforeCellRenderEvent | Represents the event object that is emitted before cell rendering. It includes information about the dimension type, column, row, and model. |
BeforeRowRenderEvent | Represents the event object that is emitted before row rendering. It includes information about the dimension type, data item, item, and node. |
BeforeSaveDataDetails | Advanced column data schema model. Used for transpassing data to cell renderer and editor. |
Cell | Cell coordinates |
CellTemplate | Interface for custom cell renderer. |
CellTemplateProp | Template property for each cell, extends the column data schema model. Additionally, it provides access to the providers injected into the template. |
ColumnGroup | Configuration for header inner template properties |
ColumnProperties | Configuration for header inner template properties |
ColumnRegular | ColumnRegular interface represents regular column definition. Regular column can be any column that is not a grouping column. |
ColumnTemplateProp | Column template property. Contains extended properties for column. |
ColumnType | Interface for regular column definition. Regular column can be any column that is not a grouping column. |
DimensionCalc | Object containing information about calculated dimensions. Used for both columns and rows. |
DimensionSettingsState | Represents the settings state of a dimension. It extends the calculation properties of a dimension. It also includes the real size and origin item size of the dimension. |
DragStartEvent | Represents the event object that is emitted when the drag operation starts. |
EditCellStore | Edit cell info for store |
EditorBase | Editor interface |
EditorCtrConstructible | Editor component constructible class |
ElementScroll | - |
FocusAfterRenderEvent | Represents the mapping of dimension types to their corresponding dimension types. |
FocusRenderEvent | Represents the event object that is emitted before focus rendering. It includes information about the dimension type and range area. |
Getter | - |
Group | Configuration for header inner template properties |
Handlers | - |
HyperFunc | HyperFunc is a function that takes an HTML tag or component, and returns a JSX element. This function is used to create JSX elements in a context where JSX is not valid. |
ObservableMap | - |
OnChangeHandler | - |
OnHandler | - |
PluginBaseComponent | Interface for plugin components |
PositionItem | - |
RevoGridCustomEvent | - |
RevogrClipboardCustomEvent | - |
RevogrDataCustomEvent | - |
RevogrEditCustomEvent | - |
RevogrFilterPanelCustomEvent | - |
RevogrFocusCustomEvent | - |
RevogrHeaderCustomEvent | - |
RevogrOrderEditorCustomEvent | - |
RevogrOverlaySelectionCustomEvent | - |
RevogrRowHeadersCustomEvent | - |
RevogrScrollVirtualCustomEvent | - |
RevogrViewportScrollCustomEvent | - |
RowHeaders | ColumnRegular interface represents regular column definition. Regular column can be any column that is not a grouping column. |
Setter | - |
Subscription | - |
ThemePackage | - |
VNode | A virtual DOM node |
ViewportState | ViewportState is an object that represents the state of a viewport. |
VirtualPositionItem | VirtualPositionItem is an object that represents a virtual position item in the viewport. |
VnodeHtmlCustomEvent | - |
Type Aliases
Type alias | Description |
---|---|
AfterEditEvent | - |
AfterRendererEvent | Represents the event object that is emitted after rendering. It includes information about the dimension type. |
AutoSizeColumnConfig | - |
BeforeEdit | - |
BeforeRangeSaveDataDetails | - |
CellCompareFunc | CellCompareFunc is a function that takes the column property to compare, the data of the first cell, and the data of the second cell. It returns a number indicating the relative order of the two cells. |
CellProps | Additional properties applied to the cell. Contains properties for custom cell rendering. |
ChangedRange | - |
ColIndex | - |
ColPropertiesFunc | - |
ColumnCollection | Column collection definition. Used to access indexed data for columns. Can be accessed via different events. |
ColumnData | - |
ColumnDataSchemaModel | Advanced column data schema model. Used for transpassing data to cell renderer and editor. |
ColumnDragEventData | - |
ColumnFilterConfig | Filter configuration for a column. This is the type of the filter property on a column. |
ColumnGrouping | ColumnGrouping type is used to define a grouping in a column. |
ColumnGroupingCollection | - |
ColumnItems | - |
ColumnProp | - |
ColumnPropProp | - |
ColumnTemplateFunc | - |
ColumnTypes | Type that represents a collection of column types. The keys are the names of the column types and the values are the corresponding column type objects. |
DSourceState | - |
DataFormat | - |
DataInput | - |
DataLookup | - |
DataSourceState | - |
DataType | - |
DateEnum | - |
DimensionColPin | - |
DimensionCols | - |
DimensionDataViewport | - |
DimensionIndexInput | - |
DimensionPosition | - |
DimensionRowPin | - |
DimensionRows | - |
DimensionSize | - |
DimensionStoreCollection | - |
DimensionStores | Represents the mapping of dimension types to their corresponding observable stores. |
DimensionType | - |
DimensionTypeCol | - |
DimensionTypeRow | - |
DisposeEventHandler | - |
DragStartEventDetails | - |
EditCell | Edit cell info for editor |
EditorCtr | Editor component |
EditorCtrCallable | Editor component callable function |
Editors | Available editors in grid |
ElementsScroll | - |
EventData | - |
ExportFormat | - |
ExtraField | - |
FilterCaptions | - |
FilterCollection | - |
FilterData | - |
FilterItem | - |
FilterLocalization | - |
FilterType | - |
FocusTemplateFunc | FocusTemplateFunc is a function that takes an HTML tag or component, and returns a JSX element. This function is used to create JSX elements in a context where JSX is not valid. |
FocusedCells | - |
FocusedData | - |
GDataType | - |
GDimension | - |
GetEventHandler | - |
GridPlugin | - |
GroupingOptions | - |
Groups | - |
HeaderProperties | - |
HeaderRenderProps | - |
InitialHeaderClick | InitialHeaderClick represents the information needed to handle a click event on the initial column header. |
ItemsToUpdate | - |
LogicFunction | - |
LogicFunctionExtraParam | - |
LogicFunctionParam | - |
MultiDimensionType | - |
MultiFilterItem | - |
Nullable | - |
Observable | - |
OldNewRangeMapping | - |
Order | - |
PluginProviders | Services that are provided by the various plugins for use by the grid. Each plugin is responsible for providing a specific service, and the PluginProviders type collects all the services provided by the plugins. |
PluginSubscribe | - |
PropertiesFunc | - |
Providers | Providers for grid which are going to be injected into each cell template |
Range | Range is an object that represents a range of values. |
RangeArea | - |
RangeAreaCss | - |
RangeClipboardCopyEventProps | Range copy. |
RangeClipboardPasteEvent | Range paste. |
ReadOnlyFormat | The ReadOnlyFormat type is a boolean value or a function that takes ColumnDataSchemaModel as a parameter and returns a boolean value. |
ResetEventHandler | - |
ResizeProps | - |
RevogridEvents | - |
RowDefinition | RowDefinition is a type that represents a row definition in the viewport. |
RowDrag | - |
RowIndex | - |
SaveData | - |
SaveDataDetails | - |
ScrollCoordinateEvent | Represents the event object that is emitted when scrolling occurs. The type property indicates the type of dimension (row or column) being scrolled. The coordinate property represents the current scroll position in that dimension. |
SelectionStoreState | Represents the state of the selection store. It contains information about the selection range, temporary range, focused cell, editing cell, last focused cell, and next cell to focus. |
SetEventHandler | - |
ShowData | - |
SlotType | - |
SortingOrder | - |
TempRange | - |
Theme | - |
ThemeConfig | - |
Trimmed | - |
TrimmedEntity | - |
ViewPortResizeEvent | ViewPortResizeEvent is an object that contains information about a resize event in the viewport. |
ViewPortScrollEvent | ViewPortScrollEvent is an object that contains information about a scroll event in the viewport. |
ViewSettingSizeProp | ViewSettingSizeProp is a record that maps column or row indexes to their corresponding sizes. |
ViewportColumn | - |
ViewportData | - |
ViewportProperties | - |
ViewportProps | - |
ViewportStateItems | ViewportStateItems is an object that represents the items in a viewport along with their corresponding range. |
ViewportStoreCollection | - |
ViewportStores | Represents the mapping of dimension types to their corresponding observable stores for the viewport. |