RevoGrid Documentation v4.23.6

Defined in

clearSubscriptions()

clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

Defined in

destroy()

destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

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>

Inherited from

Defined in

src/plugins/add-rows-on-paste.plugin.ts:16

handleBeforePasteApply()

handleBeforePasteApply(event: CustomEvent<{
  event: ClipboardEvent;
  parsed: string[][];
  raw: string;
 }>): void

Parameters

Parameter	Type
`event`	`CustomEvent`<{ `event`: `ClipboardEvent`; `parsed`: `string`[][]; `raw`: `string`; }>

Returns

void

Defined in

removeEventListener()

removeEventListener(eventName: string): void

Remove event listener

Parameters

Parameter	Type	Description
`eventName`	`string`

Returns

void

Inherited from

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

Inherited from

Defined in

AutoSizeColumnPlugin

Base layer for plugins Provide minimal starting core for plugins to work Extend this class to create plugin

Extends

BasePlugin

Constructors

new AutoSizeColumnPlugin()

new AutoSizeColumnPlugin(
   revogrid: HTMLRevoGridElement, 
   providers: PluginProviders, 
   config?: AutoSizeColumnConfig): AutoSizeColumnPlugin

Parameters

Parameter	Type
`revogrid`	`HTMLRevoGridElement`
`providers`	`PluginProviders`
`config`?	`AutoSizeColumnConfig`

Returns

AutoSizeColumnPlugin

Overrides

src/plugins/column.auto-size.plugin.ts:75

Defined in

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
`autoSizeColumns`	`public`	`null` \| `Partial`<`AutoSizeColumns`>	`null`	-	-	src/plugins/column.auto-size.plugin.ts:65
`config?`	`public`	`AutoSizeColumnConfig`	`undefined`	-	-	src/plugins/column.auto-size.plugin.ts:78
`dataReject`	`public`	`null` \| `Reject`	`null`	-	-	src/plugins/column.auto-size.plugin.ts:73
`dataResolve`	`public`	`null` \| `Resolve`	`null`	for edge case when no columns defined before data	-	src/plugins/column.auto-size.plugin.ts:72
`h`	`readonly`	typeof `h`	`h`	-	`BasePlugin`.`h`	src/plugins/base.plugin.ts:13
`letterBlockSize`	`readonly`	`number`	`undefined`	-	-	src/plugins/column.auto-size.plugin.ts:66
`precsizeCalculationArea`	`readonly`	`HTMLElement`	`undefined`	for config option when preciseSize enabled	-	src/plugins/column.auto-size.plugin.ts:69
`providers`	`public`	`PluginProviders`	`undefined`	-	`BasePlugin`.`providers`	src/plugins/column.auto-size.plugin.ts:77
`revogrid`	`public`	`HTMLRevoGridElement`	`undefined`	-	`BasePlugin`.`revogrid`	src/plugins/base.plugin.ts:15
`subscriptions`	`readonly`	`Record`<`string`, (...`args`: `any`[]) => `void`>	`{}`	-	`BasePlugin`.`subscriptions`	src/plugins/base.plugin.ts:14

Methods

addEventListener()

addEventListener<K>(eventName: K, callback: (this: BasePlugin, e: CustomEvent<HTMLRevoGridElementEventMap[K]>) => void): void

Type Parameters

Type Parameter
`K` extends keyof `HTMLRevoGridElementEventMap`

Parameters

Parameter	Type	Description
`eventName`	`K`	event name to subscribe to in revo-grid component (e.g. 'beforeheaderclick')
`callback`	(`this`: `BasePlugin`, `e`: `CustomEvent`<`HTMLRevoGridElementEventMap`[`K`]>) => `void`	callback function for event

Returns

void

Inherited from

Defined in

src/plugins/column.auto-size.plugin.ts:216

afterEditAll()

afterEditAll(e: EditEvent): void

Parameters

Parameter	Type
`e`	`EditEvent`

Returns

void

Defined in

afteredit()

afteredit(e: EditEvent): void

Parameters

Parameter	Type
`e`	`EditEvent`

Returns

void

Defined in

src/plugins/column.auto-size.plugin.ts:184

clearPromise()

clearPromise(): void

Returns

void

Defined in

src/plugins/column.auto-size.plugin.ts:287

clearSubscriptions()

clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

Defined in

src/plugins/column.auto-size.plugin.ts:260

columnSet()

columnSet(columns: Record<DimensionCols, ColumnRegular<ColumnProp, DataType<any, ColumnProp>>[]>): void

Parameters

Parameter	Type
`columns`	`Record`<`DimensionCols`, `ColumnRegular`<`ColumnProp`, `DataType`<`any`, `ColumnProp`>>[]>

Returns

void

Defined in

destroy()

destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Overrides

src/plugins/column.auto-size.plugin.ts:316

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>

Inherited from

Defined in

src/plugins/column.auto-size.plugin.ts:238

getColumnSize()

getColumnSize(index: number, type: DimensionCols): number

Parameters

Parameter	Type
`index`	`number`
`type`	`DimensionCols`

Returns

number

Defined in

getLength()

getLength(len?: any): number

Parameters

Parameter	Type
`len`?	`any`

Returns

number

Defined in

src/plugins/column.auto-size.plugin.ts:165

initiatePresizeElement()

initiatePresizeElement(): HTMLElement

Returns

HTMLElement

Defined in

src/plugins/column.auto-size.plugin.ts:296

isRangeEdit()

isRangeEdit(e: EditEvent): e is BeforeRangeSaveDataDetails

Parameters

Parameter	Type
`e`	`EditEvent`

Returns

e is BeforeRangeSaveDataDetails

Defined in

src/plugins/column.auto-size.plugin.ts:292

removeEventListener()

removeEventListener(eventName: string): void

Remove event listener

Parameters

Parameter	Type	Description
`eventName`	`string`

Returns

void

Inherited from

Defined in

src/plugins/column.auto-size.plugin.ts:131

setSource()

setSource(source: DataType[]): Promise<void>

Parameters

Parameter	Type
`source`	`DataType`[]

Returns

Promise<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

Inherited from

Defined in

src/plugins/base.plugin.ts:15

BasePlugin

Base layer for plugins Provide minimal starting core for plugins to work Extend this class to create plugin

Extended by

Implements

PluginBaseComponent

Constructors

new BasePlugin()

new BasePlugin(revogrid: HTMLRevoGridElement, providers: PluginProviders): BasePlugin

Parameters

Parameter	Type
`revogrid`	`HTMLRevoGridElement`
`providers`	`PluginProviders`

Returns

BasePlugin

Defined in

Properties

Property	Modifier	Type	Default value	Defined in
`h`	`readonly`	typeof `h`	`h`	src/plugins/base.plugin.ts:13
`providers`	`public`	`PluginProviders`	`undefined`	src/plugins/base.plugin.ts:15
`revogrid`	`public`	`HTMLRevoGridElement`	`undefined`	src/plugins/base.plugin.ts:15
`subscriptions`	`readonly`	`Record`<`string`, (...`args`: `any`[]) => `void`>	`{}`	src/plugins/base.plugin.ts:14

Methods

addEventListener()

addEventListener<K>(eventName: K, callback: (this: BasePlugin, e: CustomEvent<HTMLRevoGridElementEventMap[K]>) => void): void

Type Parameters

Type Parameter
`K` extends keyof `HTMLRevoGridElementEventMap`

Parameters

Parameter	Type	Description
`eventName`	`K`	event name to subscribe to in revo-grid component (e.g. 'beforeheaderclick')
`callback`	(`this`: `BasePlugin`, `e`: `CustomEvent`<`HTMLRevoGridElementEventMap`[`K`]>) => `void`	callback function for event

Returns

void

Defined in

clearSubscriptions()

clearSubscriptions(): void

Clear all subscriptions

Returns

void

Defined in

PluginBaseComponent.destroy

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

ColumnMovePlugin

Base layer for plugins Provide minimal starting core for plugins to work Extend this class to create plugin

Extends

BasePlugin

Constructors

new ColumnMovePlugin()

new ColumnMovePlugin(revogrid: HTMLRevoGridElement, providers: PluginProviders): ColumnMovePlugin

Parameters

Parameter	Type
`revogrid`	`HTMLRevoGridElement`
`providers`	`PluginProviders`

Returns

ColumnMovePlugin

Overrides

src/plugins/moveColumn/column.drag.plugin.ts:90

Defined in

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`h`	`readonly`	typeof `h`	`h`	`BasePlugin`.`h`	src/plugins/base.plugin.ts:13
`localSubscriptions`	`readonly`	`LocalSubscriptions`	`{}`	-	src/plugins/moveColumn/column.drag.plugin.ts:88
`orderUi`	`readonly`	`ColumnOrderHandler`	`undefined`	-	src/plugins/moveColumn/column.drag.plugin.ts:87
`providers`	`public`	`PluginProviders`	`undefined`	`BasePlugin`.`providers`	src/plugins/base.plugin.ts:15
`revogrid`	`public`	`HTMLRevoGridElement`	`undefined`	`BasePlugin`.`revogrid`	src/plugins/base.plugin.ts:15
`subscriptions`	`readonly`	`Record`<`string`, (...`args`: `any`[]) => `void`>	`{}`	`BasePlugin`.`subscriptions`	src/plugins/base.plugin.ts:14

Methods

addEventListener()

addEventListener<K>(eventName: K, callback: (this: BasePlugin, e: CustomEvent<HTMLRevoGridElementEventMap[K]>) => void): void

Type Parameters

Type Parameter
`K` extends keyof `HTMLRevoGridElementEventMap`

Parameters

Parameter	Type	Description
`eventName`	`K`	event name to subscribe to in revo-grid component (e.g. 'beforeheaderclick')
`callback`	(`this`: `BasePlugin`, `e`: `CustomEvent`<`HTMLRevoGridElementEventMap`[`K`]>) => `void`	callback function for event

Returns

void

Inherited from

Defined in

src/plugins/moveColumn/column.drag.plugin.ts:262

clearOrder()

clearOrder(): void

Returns

void

Defined in

clearSubscriptions()

clearSubscriptions(): void

Clearing subscription

Returns

void

Overrides

src/plugins/moveColumn/column.drag.plugin.ts:271

Defined in

destroy()

destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

Defined in

src/plugins/moveColumn/column.drag.plugin.ts:169

doMove()

doMove(e: MouseEvent): void

Parameters

Parameter	Type
`e`	`MouseEvent`

Returns

void

Defined in

dragStart()

dragStart(__namedParameters: DragStartEventDetails): void

Parameters

Parameter	Type
`__namedParameters`	`DragStartEventDetails`

Returns

void

Defined in

src/plugins/moveColumn/column.drag.plugin.ts:114

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>

Inherited from

Defined in

src/plugins/moveColumn/column.drag.plugin.ts:202

move()

move(e: MouseEvent): void

Parameters

Parameter	Type
`e`	`MouseEvent`

Returns

void

Defined in

onMouseOut()

onMouseOut(_: MouseEvent): void

Parameters

Parameter	Type
`_`	`MouseEvent`

Returns

void

Defined in

src/plugins/moveColumn/column.drag.plugin.ts:207

onMouseUp()

onMouseUp(e: MouseEvent): void

Parameters

Parameter	Type
`e`	`MouseEvent`

Returns

void

Defined in

src/plugins/moveColumn/column.drag.plugin.ts:210

removeEventListener()

removeEventListener(eventName: string): void

Remove event listener

Parameters

Parameter	Type	Description
`eventName`	`string`

Returns

void

Inherited from

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

Inherited from

Defined in

src/store/dataSource/data.store.ts:45

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

Accessors

store

get store(): Observable<DSourceState<T, ST>>

Returns

Observable<DSourceState<T, ST>>

Defined in

src/store/dataSource/data.store.ts:42

Methods

addTrimmed()

addTrimmed(some: Partial<Trimmed>): void

Parameters

Parameter	Type
`some`	`Partial`<`Trimmed`>

Returns

void

Defined in

src/store/dataSource/data.store.ts:115

refresh()

refresh(): void

Returns

void

Defined in

src/store/dataSource/data.store.ts:133

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:126

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:121

updateData()

updateData(
   source: T[], 
   grouping?: {
  customRenderer: GroupLabelTemplateFunc;
  depth: number;
  groups: Groups;
 }, 
   silent?: boolean, 
   preserveTrimmed?: 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`	if true, store will be updated without resetting trimmed state
`preserveTrimmed`?	`boolean`	`false`	if true, current trimmed indexes will be re-applied to the new source, use with caution because physical indexes may change across full data refreshes

Returns

void

Defined in

src/store/dataSource/data.store.ts:68

DimensionStore

Constructors

new DimensionStore()

new DimensionStore(type: MultiDimensionType): DimensionStore

Parameters

Parameter	Type
`type`	`MultiDimensionType`

Returns

DimensionStore

Defined in

src/store/dimension/dimension.store.ts:59

Properties

Property	Modifier	Type	Defined in
`store`	`readonly`	`Observable`<`DimensionSettingsState`>	src/store/dimension/dimension.store.ts:58
`type`	`readonly`	`MultiDimensionType`	src/store/dimension/dimension.store.ts:59

Methods

dispose()

dispose(): void

Returns

void

Defined in

src/store/dimension/dimension.store.ts:85

drop()

drop(): void

Returns

void

Defined in

src/store/dimension/dimension.store.ts:93

getCurrentState()

getCurrentState(): DimensionSettingsState

Returns

DimensionSettingsState

Defined in

src/store/dimension/dimension.store.ts:71

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:105

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:89

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:116

ExportCsv

Implements

Formatter

Constructors

new ExportCsv()

new ExportCsv(options: Partial<CSVFormat>): ExportCsv

Parameters

Parameter	Type
`options`	`Partial`<`CSVFormat`>

Returns

ExportCsv

Defined in

src/plugins/export/csv.ts:26

Properties

Property	Modifier	Type	Defined in
`options`	`readonly`	`Readonly`<`CSVFormat`>	src/plugins/export/csv.ts:25

Methods

doExport()

doExport(__namedParameters: DataInput): string

Parameters

Parameter	Type
`__namedParameters`	`DataInput`

Returns

string

Implementation of

Formatter.doExport

Defined in

src/plugins/export/csv.ts:30

ExportFilePlugin

Base layer for plugins Provide minimal starting core for plugins to work Extend this class to create plugin

Extends

BasePlugin

Constructors

new ExportFilePlugin()

new ExportFilePlugin(revogrid: HTMLRevoGridElement, providers: PluginProviders): ExportFilePlugin

Parameters

Parameter	Type
`revogrid`	`HTMLRevoGridElement`
`providers`	`PluginProviders`

Returns

ExportFilePlugin

Inherited from

src/plugins/base.plugin.ts:15

Defined in

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`h`	`readonly`	typeof `h`	`h`	`BasePlugin`.`h`	src/plugins/base.plugin.ts:13
`providers`	`public`	`PluginProviders`	`undefined`	`BasePlugin`.`providers`	src/plugins/base.plugin.ts:15
`revogrid`	`public`	`HTMLRevoGridElement`	`undefined`	`BasePlugin`.`revogrid`	src/plugins/base.plugin.ts:15
`subscriptions`	`readonly`	`Record`<`string`, (...`args`: `any`[]) => `void`>	`{}`	`BasePlugin`.`subscriptions`	src/plugins/base.plugin.ts:14

Methods

addEventListener()

addEventListener<K>(eventName: K, callback: (this: BasePlugin, e: CustomEvent<HTMLRevoGridElementEventMap[K]>) => void): void

Type Parameters

Type Parameter
`K` extends keyof `HTMLRevoGridElementEventMap`

Parameters

Parameter	Type	Description
`eventName`	`K`	event name to subscribe to in revo-grid component (e.g. 'beforeheaderclick')
`callback`	(`this`: `BasePlugin`, `e`: `CustomEvent`<`HTMLRevoGridElementEventMap`[`K`]>) => `void`	callback function for event

Returns

void

Inherited from

Defined in

clearSubscriptions()

clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

Defined in

destroy()

destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

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>

Inherited from

Defined in

src/plugins/export/export.plugin.ts:30

exportBlob()

exportBlob(options: Partial<CSVFormat>, t: ExportTypes): Promise<null | Blob>

Exports Blob

Parameters

Parameter	Type	Default value
`options`	`Partial`<`CSVFormat`>	`{}`
`t`	`ExportTypes`	`ExportTypes.csv`

Returns

Promise<null | Blob>

Defined in

exportFile()

exportFile(options: Partial<CSVFormat>, t: ExportTypes): Promise<void>

Export file

Parameters

Parameter	Type	Default value
`options`	`Partial`<`CSVFormat`>	`{}`
`t`	`ExportTypes`	`ExportTypes.csv`

Returns

Promise<void>

Defined in

src/plugins/export/export.plugin.ts:35

exportString()

exportString(options: Partial<CSVFormat>, t: ExportTypes): Promise<null | string>

Exports string

Parameters

Parameter	Type	Default value
`options`	`Partial`<`CSVFormat`>	`{}`
`t`	`ExportTypes`	`ExportTypes.csv`

Returns

Promise<null | string>

Defined in

src/plugins/export/export.plugin.ts:21

getBlob()

getBlob(formatter: Formatter): Promise<null | Blob>

Blob object

Parameters

Parameter	Type
`formatter`	`Formatter`

Returns

Promise<null | Blob>

Defined in

src/plugins/export/export.plugin.ts:61

removeEventListener()

removeEventListener(eventName: string): void

Remove event listener

Parameters

Parameter	Type	Description
`eventName`	`string`

Returns

void

Inherited from

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

Inherited from

Defined in

GroupingRowPlugin

Base layer for plugins Provide minimal starting core for plugins to work Extend this class to create plugin

Extends

BasePlugin

Constructors

new GroupingRowPlugin()

new GroupingRowPlugin(revogrid: HTMLRevoGridElement, providers: PluginProviders): GroupingRowPlugin

Parameters

Parameter	Type
`revogrid`	`HTMLRevoGridElement`
`providers`	`PluginProviders`

Returns

GroupingRowPlugin

Overrides

src/plugins/groupingRow/grouping.row.plugin.ts:62

Defined in

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`h`	`readonly`	typeof `h`	`h`	`BasePlugin`.`h`	src/plugins/base.plugin.ts:13
`providers`	`public`	`PluginProviders`	`undefined`	`BasePlugin`.`providers`	src/plugins/base.plugin.ts:15
`revogrid`	`public`	`HTMLRevoGridElement`	`undefined`	`BasePlugin`.`revogrid`	src/plugins/base.plugin.ts:15
`subscriptions`	`readonly`	`Record`<`string`, (...`args`: `any`[]) => `void`>	`{}`	`BasePlugin`.`subscriptions`	src/plugins/base.plugin.ts:14

Methods

addEventListener()

addEventListener<K>(eventName: K, callback: (this: BasePlugin, e: CustomEvent<HTMLRevoGridElementEventMap[K]>) => void): void

Type Parameters

Type Parameter
`K` extends keyof `HTMLRevoGridElementEventMap`

Parameters

Parameter	Type	Description
`eventName`	`K`	event name to subscribe to in revo-grid component (e.g. 'beforeheaderclick')
`callback`	(`this`: `BasePlugin`, `e`: `CustomEvent`<`HTMLRevoGridElementEventMap`[`K`]>) => `void`	callback function for event

Returns

void

Inherited from

Defined in

src/plugins/groupingRow/grouping.row.plugin.ts:345

clearGrouping()

clearGrouping(): void

Returns

void

Defined in

clearSubscriptions()

clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

Defined in

destroy()

destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

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>

Inherited from

Defined in

src/plugins/groupingRow/grouping.row.plugin.ts:56

getStore()

getStore(type: DimensionRows): Observable<DSourceState<DataType, DimensionRows>>

Parameters

Parameter	Type	Default value
`type`	`DimensionRows`	`GROUPING_ROW_TYPE`

Returns

Observable<DSourceState<DataType, DimensionRows>>

Defined in

removeEventListener()

removeEventListener(eventName: string): void

Remove event listener

Parameters

Parameter	Type	Description
`eventName`	`string`

Returns

void

Inherited from

Defined in

src/plugins/groupingRow/grouping.row.plugin.ts:262

setGrouping()

setGrouping(options: GroupingOptions): void

External call to apply grouping. Called by revogrid when prop changed.

Parameters

Parameter	Type
`options`	`GroupingOptions`

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

Inherited from

Defined in

src/store/selection/selection.store.ts:25

SelectionStore

Constructors

new SelectionStore()

new SelectionStore(): SelectionStore

Returns

SelectionStore

Defined in

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

SortingPlugin

Lifecycle

beforesorting - Triggered when sorting just starts. Nothing has happened yet. This can be triggered from a column or from the source. If the type is from rows, the column will be undefined.
beforesourcesortingapply - Triggered before the sorting data is applied to the data source. You can prevent this event, and the data will not be sorted.
beforesortingapply - Triggered before the sorting data is applied to the data source. You can prevent this event, and the data will not be sorted. This event is only called from a column sorting click.
aftersortingapply - Triggered after sorting has been applied and completed. This event occurs for both row and column sorting.

Note: If you prevent an event, it will not proceed to the subsequent steps.

Extends

BasePlugin

Constructors

new SortingPlugin()

new SortingPlugin(
   revogrid: HTMLRevoGridElement, 
   providers: PluginProviders, 
   config?: SortingConfig): SortingPlugin

Parameters

Parameter	Type
`revogrid`	`HTMLRevoGridElement`
`providers`	`PluginProviders`
`config`?	`SortingConfig`

Returns

SortingPlugin

Overrides

src/plugins/sorting/sorting.plugin.ts:128

Defined in

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
`h`	`readonly`	typeof `h`	`h`	-	`BasePlugin`.`h`	src/plugins/base.plugin.ts:13
`postponeSort`	`public`	`DebouncedFunc`<(`order`?: `SortingOrder`, `comparison`?: `SortingOrderFunction`, `sortingColumns`?: `SortingColumnMap`, `sortingOrder`?: `SortingColumnOrder`, `ignoreViewportUpdate`?: `boolean`) => `void`>	`undefined`	Debounced sorting entry point. Sorting can be requested by column changes, source changes, and header clicks in quick succession, so the actual sort is delayed and coalesced.	-	src/plugins/sorting/sorting.plugin.ts:117
`providers`	`public`	`PluginProviders`	`undefined`	-	`BasePlugin`.`providers`	src/plugins/base.plugin.ts:15
`revogrid`	`public`	`HTMLRevoGridElement`	`undefined`	-	`BasePlugin`.`revogrid`	src/plugins/sorting/sorting.plugin.ts:129
`sorting?`	`public`	`SortingOrder`	`undefined`	Current sorting order per column property.	-	src/plugins/sorting/sorting.plugin.ts:81
`sortingFunc?`	`public`	`SortingOrderFunction`	`undefined`	Comparator functions indexed by column property. Multiple columns can be sorted at the same time.	-	src/plugins/sorting/sorting.plugin.ts:88
`sortingPromise`	`public`	`null` \| () => `void`	`null`	Delayed sorting promise registered in the grid render job queue.	-	src/plugins/sorting/sorting.plugin.ts:109
`subscriptions`	`readonly`	`Record`<`string`, (...`args`: `any`[]) => `void`>	`{}`	-	`BasePlugin`.`subscriptions`	src/plugins/base.plugin.ts:14

Methods

addEventListener()

addEventListener<K>(eventName: K, callback: (this: BasePlugin, e: CustomEvent<HTMLRevoGridElementEventMap[K]>) => void): void

Type Parameters

Type Parameter
`K` extends keyof `HTMLRevoGridElementEventMap`

Parameters

Parameter	Type	Description
`eventName`	`K`	event name to subscribe to in revo-grid component (e.g. 'beforeheaderclick')
`callback`	(`this`: `BasePlugin`, `e`: `CustomEvent`<`HTMLRevoGridElementEventMap`[`K`]>) => `void`	callback function for event

Returns

void

Inherited from

Defined in

clearSubscriptions()

clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

Defined in

destroy()

destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

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>

Inherited from

Defined in

src/plugins/sorting/sorting.plugin.ts:352

headerclick()

headerclick(column: ColumnRegular<ColumnProp, DataType<any, ColumnProp>>, additive: boolean): void

Applies sorting requested by a sortable header click.

Parameters

Parameter	Type	Description
`column`	`ColumnRegular`<`ColumnProp`, `DataType`<`any`, `ColumnProp`>>	Column that initiated sorting.
`additive`	`boolean`	If true, add/remove this column from the current multi-sort state.

Returns

void

Defined in

removeEventListener()

removeEventListener(eventName: string): void

Remove event listener

Parameters

Parameter	Type	Description
`eventName`	`string`

Returns

void

Inherited from

Defined in

src/plugins/sorting/sorting.plugin.ts:418

runSorting()

runSorting(order, comparison, ignoreViewportUpdate)

runSorting(
   order?: SortingOrder, 
   comparison?: SortingOrderFunction, 
   ignoreViewportUpdate?: boolean): void

Runs a scheduled sort and resolves the render-blocking sorting promise.

Parameters

Parameter	Type	Description
`order`?	`SortingOrder`	Active sorting order by column property.
`comparison`?	`SortingOrderFunction`	Comparator functions by column property.
`ignoreViewportUpdate`?	`boolean`	Skips dimension position recalculation when true.

Returns

void

Defined in

runSorting(order, comparison, sortingColumns, sortingOrder, ignoreViewportUpdate)

runSorting(
   order?: SortingOrder, 
   comparison?: SortingOrderFunction, 
   sortingColumns?: SortingColumnMap, 
   sortingOrder?: SortingColumnOrder, 
   ignoreViewportUpdate?: boolean): void

Parameters

Parameter	Type
`order`?	`SortingOrder`
`comparison`?	`SortingOrderFunction`
`sortingColumns`?	`SortingColumnMap`
`sortingOrder`?	`SortingColumnOrder`
`ignoreViewportUpdate`?	`boolean`

Returns

void

Defined in

src/plugins/sorting/sorting.plugin.ts:423

sort()

sort(sorting, sortingFunc, types, ignoreViewportUpdate)

sort(
   sorting?: SortingOrder, 
   sortingFunc?: SortingOrderFunction, 
   types?: DimensionRows[], 
   ignoreViewportUpdate?: boolean): void

Sorts row proxy indexes by sorting functions.

Parameters

Parameter	Type	Description
`sorting`?	`SortingOrder`	per column sorting
`sortingFunc`?	`SortingOrderFunction`	Comparator functions by column property.
`types`?	`DimensionRows`[]	Row stores to sort.
`ignoreViewportUpdate`?	`boolean`	Skips dimension position recalculation when true.

Returns

void

Requires

proxyItems applied to row store

Requires

source applied to row store

Defined in

src/plugins/sorting/sorting.plugin.ts:461

sort(sorting, sortingFunc, sortingColumns, sortingOrder, types, ignoreViewportUpdate)

sort(
   sorting?: SortingOrder, 
   sortingFunc?: SortingOrderFunction, 
   sortingColumns?: SortingColumnMap, 
   sortingOrder?: SortingColumnOrder, 
   types?: DimensionRows[], 
   ignoreViewportUpdate?: boolean): void

Parameters

Parameter	Type
`sorting`?	`SortingOrder`
`sortingFunc`?	`SortingOrderFunction`
`sortingColumns`?	`SortingColumnMap`
`sortingOrder`?	`SortingColumnOrder`
`types`?	`DimensionRows`[]
`ignoreViewportUpdate`?	`boolean`

Returns

void

Defined in

src/plugins/sorting/sorting.plugin.ts:467

startSorting()

startSorting(order, sortingFunc, ignoreViewportUpdate)

startSorting(
   order?: SortingOrder, 
   sortingFunc?: SortingOrderFunction, 
   ignoreViewportUpdate?: boolean): void

Schedules sorting before the next render.

Parameters

Parameter	Type	Description
`order`?	`SortingOrder`	Active sorting order by column property.
`sortingFunc`?	`SortingOrderFunction`	Comparator functions by column property.
`ignoreViewportUpdate`?	`boolean`	Skips dimension position recalculation when true.

Returns

void

Defined in

src/plugins/sorting/sorting.plugin.ts:311

startSorting(order, sortingFunc, sortingColumns, sortingOrder, ignoreViewportUpdate)

startSorting(
   order?: SortingOrder, 
   sortingFunc?: SortingOrderFunction, 
   sortingColumns?: SortingColumnMap, 
   sortingOrder?: SortingColumnOrder, 
   ignoreViewportUpdate?: boolean): void

Parameters

Parameter	Type
`order`?	`SortingOrder`
`sortingFunc`?	`SortingOrderFunction`
`sortingColumns`?	`SortingColumnMap`
`sortingOrder`?	`SortingColumnOrder`
`ignoreViewportUpdate`?	`boolean`

Returns

void

Defined in

src/plugins/sorting/sorting.plugin.ts:316

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

Inherited from

Defined in

StretchColumn

Base layer for plugins Provide minimal starting core for plugins to work Extend this class to create plugin

Extends

BasePlugin

Constructors

new StretchColumn()

new StretchColumn(revogrid: HTMLRevoGridElement, providers: PluginProviders): StretchColumn

Parameters

Parameter	Type
`revogrid`	`HTMLRevoGridElement`
`providers`	`PluginProviders`

Returns

StretchColumn

Overrides

src/plugins/column.stretch.plugin.ts:26

Defined in

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`h`	`readonly`	typeof `h`	`h`	`BasePlugin`.`h`	src/plugins/base.plugin.ts:13
`providers`	`public`	`PluginProviders`	`undefined`	`BasePlugin`.`providers`	src/plugins/column.stretch.plugin.ts:28
`revogrid`	`public`	`HTMLRevoGridElement`	`undefined`	`BasePlugin`.`revogrid`	src/plugins/base.plugin.ts:15
`subscriptions`	`readonly`	`Record`<`string`, (...`args`: `any`[]) => `void`>	`{}`	`BasePlugin`.`subscriptions`	src/plugins/base.plugin.ts:14

Methods

addEventListener()

addEventListener<K>(eventName: K, callback: (this: BasePlugin, e: CustomEvent<HTMLRevoGridElementEventMap[K]>) => void): void

Type Parameters

Type Parameter
`K` extends keyof `HTMLRevoGridElementEventMap`

Parameters

Parameter	Type	Description
`eventName`	`K`	event name to subscribe to in revo-grid component (e.g. 'beforeheaderclick')
`callback`	(`this`: `BasePlugin`, `e`: `CustomEvent`<`HTMLRevoGridElementEventMap`[`K`]>) => `void`	callback function for event

Returns

void

Inherited from

Defined in

src/plugins/column.stretch.plugin.ts:86

applyStretch()

applyStretch(columns: Record<DimensionCols, ColumnRegular<ColumnProp, DataType<any, ColumnProp>>[]>): void

Apply stretch changes

Parameters

Parameter	Type
`columns`	`Record`<`DimensionCols`, `ColumnRegular`<`ColumnProp`, `DataType`<`any`, `ColumnProp`>>[]>

Returns

void

Defined in

clearSubscriptions()

clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

Defined in

destroy()

destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

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>

Inherited from

Defined in

removeEventListener()

removeEventListener(eventName: string): void

Remove event listener

Parameters

Parameter	Type	Description
`eventName`	`string`

Returns

void

Inherited from

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

Inherited from

Defined in

src/components/editors/text-editor.ts:26

TextEditor

Editor interface

Implements

EditorBase

Constructors

new TextEditor()

new TextEditor(data: ColumnDataSchemaModel<DataType<any, ColumnProp>, ColumnRegular<ColumnProp, DataType<any, ColumnProp>>, ColumnProp>, saveCallback?: SaveCallback): TextEditor

Parameters

Parameter	Type
`data`	`ColumnDataSchemaModel`<`DataType`<`any`, `ColumnProp`>, `ColumnRegular`<`ColumnProp`, `DataType`<`any`, `ColumnProp`>>, `ColumnProp`>
`saveCallback`?	`SaveCallback`

Returns

TextEditor

Defined in

Properties

Property	Modifier	Type	Default value	Defined in
`data`	`public`	`ColumnDataSchemaModel`<`DataType`<`any`, `ColumnProp`>, `ColumnRegular`<`ColumnProp`, `DataType`<`any`, `ColumnProp`>>, `ColumnProp`>	`undefined`	src/components/editors/text-editor.ts:27
`editCell?`	`public`	`EditCell`	`undefined`	src/components/editors/text-editor.ts:24
`editInput`	`public`	`null` \| `HTMLInputElement`	`null`	src/components/editors/text-editor.ts:21
`element`	`public`	`null` \| `Element`	`null`	src/components/editors/text-editor.ts:23

Methods

beforeDisconnect()

beforeDisconnect(): void

IMPORTANT: Prevent scroll glitches when editor is closed and focus is on current input element.

Returns

void

Implementation of

EditorBase.beforeDisconnect

Defined in

src/components/editors/text-editor.ts:61

componentDidRender()

componentDidRender(): Promise<void>

Callback triggered on cell editor render

Returns

Promise<void>

Implementation of

EditorBase.componentDidRender

Defined in

src/components/editors/text-editor.ts:34

getValue()

getValue(): undefined | string

Get value from input

Returns

undefined | string

Implementation of

EditorBase.getValue

Defined in

src/components/editors/text-editor.ts:68

onKeyDown()

onKeyDown(e: KeyboardEvent): void

Parameters

Parameter	Type
`e`	`KeyboardEvent`

Returns

void

Defined in

src/components/editors/text-editor.ts:41

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

VNode | VNode[]

input element.

Implementation of

EditorBase.render

Defined in

src/components/editors/text-editor.ts:79

ViewportStore

Viewport store class

Constructors

new ViewportStore()

new ViewportStore(type: MultiDimensionType): ViewportStore

Parameters

Parameter	Type
`type`	`MultiDimensionType`

Returns

ViewportStore

Defined in

src/store/vp/viewport.store.ts:65

Properties

Property	Modifier	Type	Defined in
`store`	`readonly`	`Observable`<`ViewportState`>	src/store/vp/viewport.store.ts:54
`type`	`readonly`	`MultiDimensionType`	src/store/vp/viewport.store.ts:65

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:59

Methods

getItems()

getItems(): ItemsToUpdate

Returns

ItemsToUpdate

Defined in

src/store/vp/viewport.store.ts:197

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:179

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:74

setViewport()

setViewport(data: Partial<ViewportState>): void

Parameters

Parameter	Type
`data`	`Partial`<`ViewportState`>

Returns

void

Defined in

src/store/vp/viewport.store.ts:205

AND_OR_BUTTON

const AND_OR_BUTTON: "and-or-button" = 'and-or-button';

Defined in

src/plugins/filter/filter.button.tsx:8

BEFORE_COLUMN_DRAG_END_EVENT

const BEFORE_COLUMN_DRAG_END_EVENT: "beforecolumndragend" = 'beforecolumndragend';

Defined in

src/plugins/moveColumn/column.drag.plugin.ts:26

CELL_CLASS

const CELL_CLASS: "rgCell" = 'rgCell';

Defined in

src/utils/consts.ts:8

CELL_HANDLER_CLASS

const CELL_HANDLER_CLASS: "autofill-handle" = 'autofill-handle';

Defined in

src/utils/consts.ts:23

COLUMN_DRAG_END_EVENT

const COLUMN_DRAG_END_EVENT: "columndragend" = 'columndragend';

Defined in

src/plugins/moveColumn/column.drag.plugin.ts:25

COLUMN_DRAG_MOVE_EVENT

const COLUMN_DRAG_MOVE_EVENT: "columndragmousemove" = 'columndragmousemove';

Defined in

src/plugins/moveColumn/column.drag.plugin.ts:24

COLUMN_DRAG_START_EVENT

const COLUMN_DRAG_START_EVENT: "columndragstart" = 'columndragstart';

Defined in

src/plugins/moveColumn/column.drag.plugin.ts:29

DATA_COL

const DATA_COL: "data-rgCol" = 'data-rgCol';

Defined in

src/utils/consts.ts:4

DATA_ROW

const DATA_ROW: "data-rgRow" = 'data-rgRow';

Defined in

src/utils/consts.ts:5

DISABLED_CLASS

const DISABLED_CLASS: "disabled" = 'disabled';

Defined in

src/utils/consts.ts:7

DRAGGABLE_CLASS

const DRAGGABLE_CLASS: "revo-draggable" = 'revo-draggable';

Defined in

src/utils/consts.ts:16

DRAGG_TEXT

const DRAGG_TEXT: "Draggable item" = 'Draggable item';

Defined in

src/utils/consts.ts:27

DRAG_ICON_CLASS

const DRAG_ICON_CLASS: "revo-drag-icon" = 'revo-drag-icon';

Defined in

src/utils/consts.ts:15

EDIT_INPUT_WR

const EDIT_INPUT_WR: "edit-input-wrapper" = 'edit-input-wrapper';

Defined in

src/utils/consts.ts:25

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:35

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:34

FILTE_PANEL

const FILTE_PANEL: "revogr-filter-panel" = 'revogr-filter-panel';

Defined in

src/plugins/filter/filter.plugin.tsx:36

FOCUS_CLASS

const FOCUS_CLASS: "focused-cell" = 'focused-cell';

Defined in

src/utils/consts.ts:18

GRID_INTERNALS

const GRID_INTERNALS: "__rvgr" = '__rvgr';

Defined in

src/utils/consts.ts:28

GROUPING_ROW_TYPE

const GROUPING_ROW_TYPE: DimensionRows = 'rgRow';

Defined in

src/plugins/groupingRow/grouping.const.ts:14

GROUP_COLUMN_PROP

const GROUP_COLUMN_PROP: "__rvgr-prop";

Defined in

src/plugins/groupingRow/grouping.const.ts:10

GROUP_DEPTH

const GROUP_DEPTH: "__rvgr-depth";

Defined in

src/plugins/groupingRow/grouping.const.ts:4

GROUP_EXPANDED

const GROUP_EXPANDED: "__rvgr-expanded";

Defined in

src/plugins/groupingRow/grouping.const.ts:9

GROUP_EXPAND_BTN

const GROUP_EXPAND_BTN: "group-expand";

Defined in

src/plugins/groupingRow/grouping.const.ts:12

GROUP_EXPAND_EVENT

const GROUP_EXPAND_EVENT: "groupexpandclick";

Defined in

src/plugins/groupingRow/grouping.const.ts:13

GROUP_ORIGINAL_INDEX

const GROUP_ORIGINAL_INDEX: "__rvgr-original-index";

Defined in

src/plugins/groupingRow/grouping.const.ts:11

HEADER_ACTUAL_ROW_CLASS

const HEADER_ACTUAL_ROW_CLASS: "actual-rgRow" = 'actual-rgRow';

Defined in

src/utils/consts.ts:13

HEADER_CLASS

const HEADER_CLASS: "rgHeaderCell" = 'rgHeaderCell';

Defined in

src/utils/consts.ts:10

HEADER_ROW_CLASS

const HEADER_ROW_CLASS: "header-rgRow" = 'header-rgRow';

Defined in

src/utils/consts.ts:12

HEADER_SORTABLE_CLASS

const HEADER_SORTABLE_CLASS: "sortable" = 'sortable';

Defined in

src/utils/consts.ts:11

MIN_COL_SIZE

const MIN_COL_SIZE: 30 = 30;

Defined in

src/utils/consts.ts:1

MOBILE_CLASS

const MOBILE_CLASS: "mobile-handler" = 'mobile-handler';

Defined in

src/utils/consts.ts:20

PSEUDO_GROUP_COLUMN

const PSEUDO_GROUP_COLUMN: "__rvgr-column";

Defined in

src/plugins/groupingRow/grouping.const.ts:8

PSEUDO_GROUP_ITEM

const PSEUDO_GROUP_ITEM: "__rvgr-name";

Defined in

src/plugins/groupingRow/grouping.const.ts:5

PSEUDO_GROUP_ITEM_ID

const PSEUDO_GROUP_ITEM_ID: "__rvgr-id";

Defined in

src/plugins/groupingRow/grouping.const.ts:6

PSEUDO_GROUP_ITEM_VALUE

const PSEUDO_GROUP_ITEM_VALUE: "__rvgr-value";

Defined in

src/plugins/groupingRow/grouping.const.ts:7

RESIZE_INTERVAL

const RESIZE_INTERVAL: 40 = 40;

Defined in

src/utils/consts.ts:2

REVOGRID_EVENTS

const REVOGRID_EVENTS: Map<RevogridEvents, RevogridEvents>;

Defined in

src/types/events.ts:115

ROW_FOCUSED_CLASS

const ROW_FOCUSED_CLASS: "focused-rgRow" = 'focused-rgRow';

Defined in

src/utils/consts.ts:29

ROW_HEADER_TYPE

const ROW_HEADER_TYPE: "rowHeaders" = 'rowHeaders';

Defined in

src/utils/consts.ts:9

SELECTION_BORDER_CLASS

const SELECTION_BORDER_CLASS: "selection-border-range" = 'selection-border-range';

Defined in

src/utils/consts.ts:19

TMP_SELECTION_BG_CLASS

const TMP_SELECTION_BG_CLASS: "temp-bg-range" = 'temp-bg-range';

Defined in

src/utils/consts.ts:21

TRASH_BUTTON

const TRASH_BUTTON: "trash-button" = 'trash-button';

Defined in

src/plugins/filter/filter.button.tsx:9

columnTypes

const columnTypes: DimensionCols[];

Defined in

src/store/index.ts:9

filterCoreFunctionsIndexedByType

const filterCoreFunctionsIndexedByType: Record<FilterType, LogicFunction>;

Defined in

src/plugins/filter/filter.indexed.ts:14

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:44
`contains`	`string`	'Contains'	src/plugins/filter/filter.indexed.ts:45
`empty`	`string`	'Not set'	src/plugins/filter/filter.indexed.ts:39
`eq`	`string`	'Equal'	src/plugins/filter/filter.indexed.ts:42
`eqN`	`string`	'='	src/plugins/filter/filter.indexed.ts:48
`gt`	`string`	'>'	src/plugins/filter/filter.indexed.ts:50
`gte`	`string`	'>='	src/plugins/filter/filter.indexed.ts:51
`lt`	`string`	'<'	src/plugins/filter/filter.indexed.ts:52
`lte`	`string`	'<='	src/plugins/filter/filter.indexed.ts:53
`neqN`	`string`	'!='	src/plugins/filter/filter.indexed.ts:49
`none`	`string`	'None'	src/plugins/filter/filter.indexed.ts:38
`notContains`	`string`	'Does not contain'	src/plugins/filter/filter.indexed.ts:46
`notEmpty`	`string`	'Set'	src/plugins/filter/filter.indexed.ts:40
`notEq`	`string`	'Not equal'	src/plugins/filter/filter.indexed.ts:43

Defined in

src/plugins/filter/filter.indexed.ts:37

filterTypes

const filterTypes: Record<string, FilterType[]>;

Defined in

src/plugins/filter/filter.indexed.ts:32

rowTypes

const rowTypes: DimensionRows[];

Defined in

src/store/index.ts:8

AndOrButton()

function AndOrButton(__namedParameters: any): any

Parameters

Parameter	Type
`__namedParameters`	`any`

Returns

any

Defined in

src/plugins/filter/filter.button.tsx:42

CellRenderer()

function CellRenderer(__namedParameters: {
  cellProps: any;
  renderProps: RenderProps;
 }): VNode

Parameters

Parameter	Type
`__namedParameters`	`object`
`__namedParameters.cellProps`	`any`
`__namedParameters.renderProps`	`RenderProps`

Returns

src/components/data/cell-renderer.tsx:69

Defined in

FilterButton()

function FilterButton(__namedParameters: Props): any

Parameters

Parameter	Type
`__namedParameters`	`Props`

Returns

any

Defined in

src/plugins/filter/filter.button.tsx:14

GroupingRowRenderer()

function GroupingRowRenderer(props: RowGroupingProps): any

Parameters

Parameter	Type
`props`	`RowGroupingProps`

Returns

any

Defined in

src/plugins/groupingRow/grouping.row.renderer.tsx:29

SortingSign()

function SortingSign(__namedParameters: Props): any

Renders sorting direction and optional additive sorting rank.

Parameters

Parameter	Type
`__namedParameters`	`Props`

Returns

any

Defined in

src/plugins/sorting/sorting.sign.tsx:12

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

VirtualPositionItem[]

Defined in

src/store/vp/viewport.helpers.ts:173

applyMixins()

function applyMixins(derivedCtor: any, constructors: any[]): void

Type script mixins

Parameters

Parameter	Type
`derivedCtor`	`any`
`constructors`	`any`[]

Returns

void

Defined in

src/utils/index.ts:140

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

clampViewportCoordinate()

function clampViewportCoordinate(
   coordinate: number, 
   dimension: Pick<DimensionSettingsState, "originItemSize" | "realSize">, 
   viewportSize: number, 
   frameOffset: number): number

Clamp the viewport coordinate within the valid range. Given a scroll position, pick a safe starting point for rendering visible items.

Do not use it when you need the exact scroll position for positioning math.

It does two things:

If the coordinate is below 0, use 0.
If the coordinate is too close to the very end, pull it back a bit.

Example:

content height: 1000px viewport height: 200px row height: 30px The real max scroll is:

1000 - 200 = 800 But clampViewportCoordinate may clamp to:

1000 - 200 - 30 = 770 Ask for 800 -> it returns 770.

Parameters

Parameter	Type	Default value
`coordinate`	`number`	`undefined`
`dimension`	`Pick`<`DimensionSettingsState`, `"originItemSize"` \| `"realSize"`>	`undefined`
`viewportSize`	`number`	`undefined`
`frameOffset`	`number`	`1`

Returns

number

Defined in

src/store/vp/viewport.helpers.ts:61

cropCellToMax()

function cropCellToMax(cell: Cell, lastCell: Cell): Cell

Parameters

Parameter	Type
`cell`	`Cell`
`lastCell`	`Cell`

Returns

Cell

Defined in

src/store/selection/selection.helpers.ts:24

defaultCellCompare()

function defaultCellCompare(
   this: {
  column: ColumnRegular<ColumnProp, DataType<any, ColumnProp>>;
 }, 
   prop: ColumnProp, 
   a: DataType, 
   b: DataType): -1 | 0 | 1

Parameters

Parameter	Type
`this`	`object`
`this.column`?	`ColumnRegular`<`ColumnProp`, `DataType`<`any`, `ColumnProp`>>
`prop`	`ColumnProp`
`a`	`DataType`
`b`	`DataType`

Returns

-1 | 0 | 1

Defined in

src/plugins/sorting/sorting.func.ts:276

descCellCompare()

function descCellCompare(cmp: CellCompareFunc): (prop: ColumnProp, a: DataType, b: DataType) => number

Parameters

Parameter	Type
`cmp`	`CellCompareFunc`

Returns

Function

Parameters

Parameter	Type
`prop`	`ColumnProp`
`a`	`DataType`
`b`	`DataType`

Returns

number

Defined in

src/plugins/sorting/sorting.func.ts:284

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

src/plugins/dispatcher.ts:9

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

src/plugins/dispatcher.ts:36

doCollapse()

function doCollapse(pIndex: number, source: DataType[]): {
  trimmed: Record<number, boolean>;
}

Parameters

Parameter	Type
`pIndex`	`number`
`source`	`DataType`[]

Returns

{
  trimmed: Record<number, boolean>;
}

Name	Type	Defined in
`trimmed`	`Record`<`number`, `boolean`>	src/plugins/groupingRow/grouping.row.expand.service.ts:24

Defined in

src/plugins/groupingRow/grouping.row.expand.service.ts:6

doExpand()

function doExpand(
   vIndex: number, 
   source: DataType[], 
   rowItemsIndexes: number[]): {
  items: number[];
  trimmed: Record<number, boolean>;
}

Parameters

Parameter	Type	Description
`vIndex`	`number`	virtual index, need to update item collection
`source`	`DataType`[]	data source
`rowItemsIndexes`	`number`[]	rgRow indexes

Returns

{
  items: number[];
  trimmed: Record<number, boolean>;
}

Name	Type	Defined in
`items`	`number`[]	src/plugins/groupingRow/grouping.row.expand.service.ts:73
`trimmed`	`Record`<`number`, `boolean`>	src/plugins/groupingRow/grouping.row.expand.service.ts:72

Defined in

src/plugins/groupingRow/grouping.row.expand.service.ts:34

expandEvent()

function expandEvent(
   e: MouseEvent, 
   model: DataType, 
   virtualIndex: number): void

Parameters

Parameter	Type
`e`	`MouseEvent`
`model`	`DataType`
`virtualIndex`	`number`

Returns

void

Defined in

src/plugins/groupingRow/grouping.row.renderer.tsx:13

expandSvgIconVNode()

function expandSvgIconVNode(expanded: boolean): any

Parameters

Parameter	Type	Default value
`expanded`	`boolean`	`false`

Returns

any

Defined in

src/plugins/groupingRow/grouping.row.renderer.tsx:66

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

src/utils/index.ts:22

gatherGroup()

function gatherGroup<T>(
   res: T, 
   colData: ColumnGrouping<any>, 
   collection: T, 
   existingColumnsByType?: Record<DimensionCols, ColumnRegular<ColumnProp, DataType<any, ColumnProp>>[]>, 
   level?: number): T

Type Parameters

Type Parameter
`T` extends `ColumnCollection`

Parameters

Parameter	Type	Default value
`res`	`T`	`undefined`
`colData`	`ColumnGrouping`<`any`>	`undefined`
`collection`	`T`	`undefined`
`existingColumnsByType`?	`Record`<`DimensionCols`, `ColumnRegular`<`ColumnProp`, `DataType`<`any`, `ColumnProp`>>[]>	`undefined`
`level`?	`number`	`0`

Returns

T

Defined in

src/utils/column.utils.ts:176

gatherGrouping()

function gatherGrouping(
   array: DataType[], 
   columnProps: ColumnProp[], 
   expanded: ExpandedOptions): {
  depth: groupingDepth;
  oldNewIndexMap: Record<number, number>;
  sourceWithGroups: DataType[];
  trimmed: Record<number, boolean>;
}

Gather data for grouping

Parameters

Parameter	Type	Description
`array`	`DataType`[]	flat data array
`columnProps`	`ColumnProp`[]	ids of groups
`expanded`	`ExpandedOptions`	potentially expanded items if present

Returns

{
  depth: groupingDepth;
  oldNewIndexMap: Record<number, number>;
  sourceWithGroups: DataType[];
  trimmed: Record<number, boolean>;
}

Name	Type	Default value	Defined in
`depth`	`number`	groupingDepth	src/plugins/groupingRow/grouping.service.ts:204
`oldNewIndexMap`	`Record`<`number`, `number`>	-	src/plugins/groupingRow/grouping.service.ts:206
`sourceWithGroups`	`DataType`[]	-	src/plugins/groupingRow/grouping.service.ts:203
`trimmed`	`Record`<`number`, `boolean`>	-	src/plugins/groupingRow/grouping.service.ts:205

Defined in

src/plugins/groupingRow/grouping.service.ts:154

gatherTrimmedItems()

function gatherTrimmedItems(trimmedItems: Trimmed): TrimmedEntity

Parameters

Parameter	Type
`trimmedItems`	`Trimmed`

Returns

TrimmedEntity

Defined in

src/store/dataSource/trimmed.plugin.ts:32

getCellData()

function getCellData(val?: any): any

Parameters

Parameter	Type
`val`?	`any`

Returns

any

Defined in

src/utils/column.utils.ts:22

getCellDataParsed()

function getCellDataParsed(model: DataType, column: ColumnRegular<ColumnProp, DataType<any, ColumnProp>>): any

Parameters

Parameter	Type
`model`	`DataType`
`column`	`ColumnRegular`<`ColumnProp`, `DataType`<`any`, `ColumnProp`>>

Returns

any

Defined in

src/utils/column.utils.ts:39

getCellRaw()

function getCellRaw(model: DataType, column?: ColumnRegular<ColumnProp, DataType<any, ColumnProp>>): any

Parameters

Parameter	Type
`model`	`DataType`
`column`?	`ColumnRegular`<`ColumnProp`, `DataType`<`any`, `ColumnProp`>>

Returns

any

Defined in

src/utils/column.utils.ts:29

getColumnByProp()

function getColumnByProp(columns: ColumnData, prop: ColumnProp): ColumnRegular | undefined

Parameters

Parameter	Type
`columns`	`ColumnData`
`prop`	`ColumnProp`

Returns

ColumnRegular | undefined

Defined in

src/utils/column.utils.ts:249

getColumnSizes()

function getColumnSizes(cols: ColumnRegular<ColumnProp, DataType<any, ColumnProp>>[]): ViewSettingSizeProp

Parameters

Parameter	Type
`cols`	`ColumnRegular`<`ColumnProp`, `DataType`<`any`, `ColumnProp`>>[]

Returns

ViewSettingSizeProp

Defined in

src/utils/column.utils.ts:81

getColumnType()

function getColumnType(rgCol: ColumnRegular<ColumnProp, DataType<any, ColumnProp>>): DimensionCols

Get column type from column data

Parameters

Parameter	Type
`rgCol`	`ColumnRegular`<`ColumnProp`, `DataType`<`any`, `ColumnProp`>>

Returns

DimensionCols

Defined in

src/utils/column.utils.ts:74

getColumns()

function getColumns(
   columns: ColumnData, 
   level: number, 
   types?: ColumnTypes, 
   resFromRoot?: Partial<ColumnCollection>): 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`
`resFromRoot`?	`Partial`<`ColumnCollection`>	`undefined`

Returns

ColumnCollection

Defined in

src/utils/column.utils.ts:104

getComparer()

function getComparer(column: undefined | Partial<ColumnRegular<ColumnProp, DataType<any, ColumnProp>>>, order: Order): CellCompareFunc | undefined

Parameters

Parameter	Type
`column`	`undefined` \| `Partial`<`ColumnRegular`<`ColumnProp`, `DataType`<`any`, `ColumnProp`>>>
`order`	`Order`

Returns

CellCompareFunc | undefined

Defined in

src/plugins/sorting/sorting.func.ts:302

getExpanded()

function getExpanded(model: DataType): any

Parameters

Parameter	Type
`model`	`DataType`

Returns

any

Defined in

src/plugins/groupingRow/grouping.service.ts:65

getFirstItem()

function getFirstItem(s: ItemsToUpdate): VirtualPositionItem

Parameters

Parameter	Type
`s`	`ItemsToUpdate`

Returns

VirtualPositionItem

Defined in

src/store/vp/viewport.helpers.ts:390

getGroupingName()

function getGroupingName(rgRow?: DataType): any

Parameters

Parameter	Type
`rgRow`?	`DataType`

Returns

any

Defined in

src/plugins/groupingRow/grouping.service.ts:210

getItemByIndex()

function getItemByIndex(dimension: Pick<DimensionIndexInput, "indexes" | "originItemSize" | "indexToItem">, index: number): PositionItem

Parameters

Parameter	Type
`dimension`	`Pick`<`DimensionIndexInput`, `"indexes"` \| `"originItemSize"` \| `"indexToItem"`>
`index`	`number`

Returns

PositionItem

Defined in

src/store/dimension/dimension.helpers.ts:109

getItemByPosition()

function getItemByPosition(__namedParameters: Pick<DimensionPosition, "indexes" | "positionIndexes" | "originItemSize" | "positionIndexToItem">, pos: number): PositionItem

Calculate item by position

Parameters

Parameter	Type
`__namedParameters`	`Pick`<`DimensionPosition`, `"indexes"` \| `"positionIndexes"` \| `"originItemSize"` \| `"positionIndexToItem"`>
`pos`	`number`

Returns

PositionItem

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

VirtualPositionItem[]

Defined in

src/store/vp/viewport.helpers.ts:196

getLastItem()

function getLastItem(s: ItemsToUpdate): VirtualPositionItem

Parameters

Parameter	Type
`s`	`ItemsToUpdate`

Returns

VirtualPositionItem

Defined in

src/store/vp/viewport.helpers.ts:396

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:298

getNextOrder()

function getNextOrder(currentOrder: Order): Order

Parameters

Parameter	Type
`currentOrder`	`Order`

Returns

Order

Defined in

src/plugins/sorting/sorting.func.ts:290

getParsedGroup()

function getParsedGroup(id: string): null | any[]

Parameters

Parameter	Type
`id`	`string`

Returns

null | any[]

Defined in

src/plugins/groupingRow/grouping.service.ts:241

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:142

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:39

getScrollbarSize()

function getScrollbarSize(document: Document): number

Calculate system scrollbar size

Parameters

Parameter	Type
`document`	`Document`

Returns

number

Defined in

src/utils/index.ts:87

getSortingIndex()

function getSortingIndex(
   sorting: undefined | SortingOrder, 
   prop: ColumnProp, 
   sortingOrder?: SortingColumnOrder): SortingColumnRender["sortIndex"]

Returns one-based additive sorting rank for a column.

A single active sort does not need a visible rank, so it returns undefined.

Parameters

Parameter	Type
`sorting`	`undefined` \| `SortingOrder`
`prop`	`ColumnProp`
`sortingOrder`?	`SortingColumnOrder`

Returns

SortingColumnRender["sortIndex"]

Defined in

src/plugins/sorting/sorting.func.ts:58

getSource()

function getSource(
   source: DataType[], 
   items: number[], 
withoutGrouping: boolean): Required<SourceGather>

Parameters

Parameter	Type	Default value
`source`	`DataType`[]	`undefined`
`items`	`number`[]	`undefined`
`withoutGrouping`	`boolean`	`false`

Returns

Required<SourceGather>

Defined in

src/plugins/groupingRow/grouping.service.ts:30

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:166

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:235

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:176

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

ItemsToUpdate

Defined in

src/store/vp/viewport.helpers.ts:78

getViewportMaxCoordinate()

function getViewportMaxCoordinate(
   dimension: Pick<DimensionSettingsState, "originItemSize" | "realSize">, 
   viewportSize: number, 
   frameOffset: number): number

Parameters

Parameter	Type	Default value
`dimension`	`Pick`<`DimensionSettingsState`, `"originItemSize"` \| `"realSize"`>	`undefined`
`viewportSize`	`number`	`undefined`
`frameOffset`	`number`	`1`

Returns

number

Defined in

src/store/vp/viewport.helpers.ts:24

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:154

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:689

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:690

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:691

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:692

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:693

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:694

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:695

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:696

h(sel, data, children)

function h(
   sel: any, 
   data: null | VNodeData, ...
   children: (string | number | VNode)[]): VNode

Parameters

Parameter	Type
`sel`	`any`
`data`	`null` \| `VNodeData`
...`children`	(`string` \| `number` \| `VNode`)[]

Returns