@revolist/revogrid

AutoAddRowsPlugin

Automatically adds new rows when pasted data is larger than current rows newRows - is triggered when new rows are added. Data of new rows can be filled with default values. If the event is prevented, no rows will be added. Event data:

Extends

• BasePlugin

Constructors

new AutoAddRowsPlugin()

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

Parameters

Parameter	Type
revogrid	HTMLRevoGridElement
providers	PluginProviders

Returns

AutoAddRowsPlugin

Overrides

BasePlugin.constructor

Defined in

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

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: RevoGridCustomEvent<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: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => void	callback function for event

Returns

void

Inherited from

BasePlugin.addEventListener

Defined in

src/plugins/base.plugin.ts:21

---

clearSubscriptions()

clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

BasePlugin.clearSubscriptions

Defined in

src/plugins/base.plugin.ts:88

---

destroy()

destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

BasePlugin.destroy

Defined in

src/plugins/base.plugin.ts:97

---

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

BasePlugin.emit

Defined in

src/plugins/base.plugin.ts:79

---

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

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

---

removeEventListener()

removeEventListener(eventName: string): void

Remove event listener

Parameters

Parameter	Type	Description
eventName	string

Returns

void

Inherited from

BasePlugin.removeEventListener

Defined in

src/plugins/base.plugin.ts:70

---

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

BasePlugin.watch

Defined in

src/plugins/base.plugin.ts:37

---

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

BasePlugin.constructor

Defined in

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

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 Precise Size 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: RevoGridCustomEvent<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: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => void	callback function for event

Returns

void

Inherited from

BasePlugin.addEventListener

Defined in

src/plugins/base.plugin.ts:21

---

afterEditAll()

afterEditAll(e: EditEvent): void

Parameters

Parameter	Type
e	EditEvent

Returns

void

Defined in

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

---

afteredit()

afteredit(e: EditEvent): void

Parameters

Parameter	Type
e	EditEvent

Returns

void

Defined in

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

---

clearPromise()

clearPromise(): void

Returns

void

Defined in

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

---

clearSubscriptions()

clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

BasePlugin.clearSubscriptions

Defined in

src/plugins/base.plugin.ts:88

---

columnSet()

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

Parameters

Parameter	Type
columns	Record<DimensionCols, ColumnRegular[]>

Returns

void

Defined in

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

---

destroy()

destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Overrides

BasePlugin.destroy

Defined in

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

---

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

BasePlugin.emit

Defined in

src/plugins/base.plugin.ts:79

---

getColumnSize()

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

Parameters

Parameter	Type
index	number
type	DimensionCols

Returns

number

Defined in

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

---

getLength()

getLength(len?: any): number

Parameters

Parameter	Type
len?	any

Returns

number

Defined in

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

---

initiatePresizeElement()

initiatePresizeElement(): HTMLElement

Returns

HTMLElement

Defined in

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

---

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

---

removeEventListener()

removeEventListener(eventName: string): void

Remove event listener

Parameters

Parameter	Type	Description
eventName	string

Returns

void

Inherited from

BasePlugin.removeEventListener

Defined in

src/plugins/base.plugin.ts:70

---

setSource()

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

Parameters

Parameter	Type
source	DataType[]

Returns

Promise<void>

Defined in

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

---

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

BasePlugin.watch

Defined in

src/plugins/base.plugin.ts:37

---

BasePlugin

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

Extended by

• AutoSizeColumnPlugin
• StretchColumn
• ExportFilePlugin
• GroupingRowPlugin
• ColumnMovePlugin
• SortingPlugin
• AutoAddRowsPlugin

Implements

• PluginBaseComponent

Constructors

new BasePlugin()

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

Parameters

Parameter	Type
revogrid	HTMLRevoGridElement
providers	PluginProviders

Returns

BasePlugin

Defined in

src/plugins/base.plugin.ts:15

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: RevoGridCustomEvent<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: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => void	callback function for event

Returns

void

Defined in

src/plugins/base.plugin.ts:21

---

clearSubscriptions()

clearSubscriptions(): void

Clear all subscriptions

Returns

void

Defined in

src/plugins/base.plugin.ts:88

---

destroy()

destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Implementation of

PluginBaseComponent.destroy

Defined in

src/plugins/base.plugin.ts:97

---

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

src/plugins/base.plugin.ts:79

---

removeEventListener()

removeEventListener(eventName: string): void

Remove event listener

Parameters

Parameter	Type	Description
eventName	string

Returns

void

Defined in

src/plugins/base.plugin.ts:70

---

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

src/plugins/base.plugin.ts:37

---

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

BasePlugin.constructor

Defined in

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

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/moveColumn/column.drag.plugin.ts:54
revogrid	public	HTMLRevoGridElement	undefined	BasePlugin.revogrid	src/plugins/moveColumn/column.drag.plugin.ts:54
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: RevoGridCustomEvent<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: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => void	callback function for event

Returns

void

Inherited from

BasePlugin.addEventListener

Defined in

src/plugins/base.plugin.ts:21

---

clearOrder()

clearOrder(): void

Returns

void

Defined in

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

---

clearSubscriptions()

clearSubscriptions(): void

Clearing subscription

Returns

void

Overrides

BasePlugin.clearSubscriptions

Defined in

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

---

destroy()

destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

BasePlugin.destroy

Defined in

src/plugins/base.plugin.ts:97

---

doMove()

doMove(e: MouseEvent): void

Parameters

Parameter	Type
e	MouseEvent

Returns

void

Defined in

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

---

dragStart()

dragStart(__namedParameters: DragStartEventDetails): void

Parameters

Parameter	Type
__namedParameters	DragStartEventDetails

Returns

void

Defined in

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

---

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

BasePlugin.emit

Defined in

src/plugins/base.plugin.ts:79

---

move()

move(e: MouseEvent): void

Parameters

Parameter	Type
e	MouseEvent

Returns

void

Defined in

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

---

onMouseOut()

onMouseOut(_: MouseEvent): void

Parameters

Parameter	Type
_	MouseEvent

Returns

void

Defined in

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

---

onMouseUp()

onMouseUp(e: MouseEvent): void

Parameters

Parameter	Type
e	MouseEvent

Returns

void

Defined in

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

---

removeEventListener()

removeEventListener(eventName: string): void

Remove event listener

Parameters

Parameter	Type	Description
eventName	string

Returns

void

Inherited from

BasePlugin.removeEventListener

Defined in

src/plugins/base.plugin.ts:70

---

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

BasePlugin.watch

Defined in

src/plugins/base.plugin.ts:37

---

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

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

---

refresh()

refresh(): void

Returns

void

Defined in

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

---

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

---

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

---

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

---

DimensionStore

Constructors

new DimensionStore()

new DimensionStore(type: MultiDimensionType): DimensionStore

Parameters

Parameter	Type
type	MultiDimensionType

Returns

DimensionStore

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

DimensionSettingsState

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

---

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

BasePlugin.constructor

Defined in

src/plugins/base.plugin.ts:15

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: RevoGridCustomEvent<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: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => void	callback function for event

Returns

void

Inherited from

BasePlugin.addEventListener

Defined in

src/plugins/base.plugin.ts:21

---

clearSubscriptions()

clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

BasePlugin.clearSubscriptions

Defined in

src/plugins/base.plugin.ts:88

---

destroy()

destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

BasePlugin.destroy

Defined in

src/plugins/base.plugin.ts:97

---

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

BasePlugin.emit

Defined in

src/plugins/base.plugin.ts:79

---

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

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

---

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

BasePlugin.removeEventListener

Defined in

src/plugins/base.plugin.ts:70

---

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

BasePlugin.watch

Defined in

src/plugins/base.plugin.ts:37

---

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

BasePlugin.constructor

Defined in

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

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/groupingRow/grouping.row.plugin.ts:59
revogrid	public	HTMLRevoGridElement	undefined	BasePlugin.revogrid	src/plugins/groupingRow/grouping.row.plugin.ts:58
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: RevoGridCustomEvent<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: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => void	callback function for event

Returns

void

Inherited from

BasePlugin.addEventListener

Defined in

src/plugins/base.plugin.ts:21

---

clearGrouping()

clearGrouping(): void

Returns

void

Defined in

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

---

clearSubscriptions()

clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

BasePlugin.clearSubscriptions

Defined in

src/plugins/base.plugin.ts:88

---

destroy()

destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

BasePlugin.destroy

Defined in

src/plugins/base.plugin.ts:97

---

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

BasePlugin.emit

Defined in

src/plugins/base.plugin.ts:79

---

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

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

---

removeEventListener()

removeEventListener(eventName: string): void

Remove event listener

Parameters

Parameter	Type	Description
eventName	string

Returns

void

Inherited from

BasePlugin.removeEventListener

Defined in

src/plugins/base.plugin.ts:70

---

setGrouping()

setGrouping(options: GroupingOptions): void

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

Parameters

Parameter	Type
options	GroupingOptions

Returns

void

Defined in

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

---

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

BasePlugin.watch

Defined in

src/plugins/base.plugin.ts:37

---

SelectionStore

Constructors

new SelectionStore()

new SelectionStore(): SelectionStore

Returns

SelectionStore

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

---

SortingPlugin

Lifecycle

1. 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.

Method

updateColumnSorting - Updates the column sorting icon on the grid and the column itself, but the data remains untouched. 3. 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. 4. 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

BasePlugin.constructor

Defined in

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

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
h	readonly	typeof h	h	BasePlugin.h	src/plugins/base.plugin.ts:13
postponeSort	public	DebouncedFunc<(order?: SortingOrder, comparison?: SortingOrderFunction, ignoreViewportUpdate?: boolean) => void>	undefined	-	src/plugins/sorting/sorting.plugin.ts:36
providers	public	PluginProviders	undefined	BasePlugin.providers	src/plugins/base.plugin.ts:15
revogrid	public	HTMLRevoGridElement	undefined	BasePlugin.revogrid	src/plugins/sorting/sorting.plugin.ts:53
sorting?	public	SortingOrder	undefined	-	src/plugins/sorting/sorting.plugin.ts:31
sortingFunc?	public	SortingOrderFunction	undefined	-	src/plugins/sorting/sorting.plugin.ts:34
sortingPromise	public	null | () => void	null	-	src/plugins/sorting/sorting.plugin.ts:35
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: RevoGridCustomEvent<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: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => void	callback function for event

Returns

void

Inherited from

BasePlugin.addEventListener

Defined in

src/plugins/base.plugin.ts:21

---

clearSubscriptions()

clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

BasePlugin.clearSubscriptions

Defined in

src/plugins/base.plugin.ts:88

---

defaultCellCompare()

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

Parameters

Parameter	Type
this	object
this.column?	ColumnRegular
prop	ColumnProp
a	DataType
b	DataType

Returns

-1 | 0 | 1

Defined in

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

---

descCellCompare()

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.plugin.ts:289

---

destroy()

destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

BasePlugin.destroy

Defined in

src/plugins/base.plugin.ts:97

---

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

BasePlugin.emit

Defined in

src/plugins/base.plugin.ts:79

---

getComparer()

getComparer(column: undefined | Partial<ColumnRegular>, order: Order): undefined | CellCompareFunc

Parameters

Parameter	Type
column	undefined | Partial<ColumnRegular>
order	Order

Returns

undefined | CellCompareFunc

Defined in

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

---

getNextOrder()

getNextOrder(currentOrder: Order): Order

Parameters

Parameter	Type
currentOrder	Order

Returns

Order

Defined in

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

---

headerclick()

headerclick(
   column: ColumnRegular, 
   index: number, 
   additive: boolean): void

Apply sorting to data on header click If additive - add to existing sorting, multiple columns can be sorted

Parameters

Parameter	Type
column	ColumnRegular
index	number
additive	boolean

Returns

void

Defined in

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

---

removeEventListener()

removeEventListener(eventName: string): void

Remove event listener

Parameters

Parameter	Type	Description
eventName	string

Returns

void

Inherited from

BasePlugin.removeEventListener

Defined in

src/plugins/base.plugin.ts:70

---

runSorting()

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

Parameters

Parameter	Type
order?	SortingOrder
comparison?	SortingOrderFunction
ignoreViewportUpdate?	boolean

Returns

void

Defined in

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

---

sort()

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

Sort items by sorting function

Parameters

Parameter	Type	Default value	Description
sorting?	SortingOrder	undefined	per column sorting
sortingFunc?	SortingOrderFunction	undefined	-
types?	DimensionRows[]	rowTypes	-
ignoreViewportUpdate?	boolean	false	-

Returns

void

Requires

proxyItems applied to row store

Requires

source applied to row store

Defined in

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

---

startSorting()

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

Parameters

Parameter	Type
order?	SortingOrder
sortingFunc?	SortingOrderFunction
ignoreViewportUpdate?	boolean

Returns

void

Defined in

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

---

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

BasePlugin.watch

Defined in

src/plugins/base.plugin.ts:37

---

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

BasePlugin.constructor

Defined in

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

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: RevoGridCustomEvent<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: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => void	callback function for event

Returns

void

Inherited from

BasePlugin.addEventListener

Defined in

src/plugins/base.plugin.ts:21

---

applyStretch()

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

Apply stretch changes

Parameters

Parameter	Type
columns	Record<DimensionCols, ColumnRegular[]>

Returns

void

Defined in

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

---

clearSubscriptions()

clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

BasePlugin.clearSubscriptions

Defined in

src/plugins/base.plugin.ts:88

---

destroy()

destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

BasePlugin.destroy

Defined in

src/plugins/base.plugin.ts:97

---

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

BasePlugin.emit

Defined in

src/plugins/base.plugin.ts:79

---

removeEventListener()

removeEventListener(eventName: string): void

Remove event listener

Parameters

Parameter	Type	Description
eventName	string

Returns

void

Inherited from

BasePlugin.removeEventListener

Defined in

src/plugins/base.plugin.ts:70

---

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

BasePlugin.watch

Defined in

src/plugins/base.plugin.ts:37

---

TextEditor

Editor interface

Implements

• EditorBase

Constructors

new TextEditor()

new TextEditor(data: ColumnDataSchemaModel, saveCallback?: SaveCallback): TextEditor

Parameters

Parameter	Type
data	ColumnDataSchemaModel
saveCallback?	SaveCallback

Returns

TextEditor

Defined in

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

Properties

Property	Modifier	Type	Default value	Defined in
data	public	ColumnDataSchemaModel	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.

Required

Method

Implementation of

EditorBase.render

Defined in

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

---

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

Properties

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

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

Methods

getItems()

getItems(): ItemsToUpdate

Returns

ItemsToUpdate

Defined in

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

---

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

---

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

---

setViewport()

setViewport(data: Partial<ViewportState>): void

Parameters

Parameter	Type
data	Partial<ViewportState>

Returns

void

Defined in

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

---

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

src/utils/consts.ts:8

---

CELL_HANDLER_CLASS

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

Defined in

src/utils/consts.ts:23

---

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

---

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

---

FILTE_PANEL

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

Defined in

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

---

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

---

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

---

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

---

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

---

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

VirtualPositionItem[]

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

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

---

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

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

---

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

src/utils/column.utils.ts:174

---

gatherGrouping()

function gatherGrouping(
   array: DataType[], 
   columnProps: ColumnProp[], 
   expanded: ExpandedOptions): {
  childrenByGroup: pseudoGroupTest;
  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

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

Name	Type	Default value	Defined in
childrenByGroup	Record<string, number[]>	pseudoGroupTest	src/plugins/groupingRow/grouping.service.ts:160
depth	number	groupingDepth	src/plugins/groupingRow/grouping.service.ts:157
oldNewIndexMap	Record<number, number>	-	src/plugins/groupingRow/grouping.service.ts:159
sourceWithGroups	DataType[]	-	src/plugins/groupingRow/grouping.service.ts:156
trimmed	Record<number, boolean>	-	src/plugins/groupingRow/grouping.service.ts:158

Defined in

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

---

gatherTrimmedItems()

function gatherTrimmedItems(trimmedItems: Trimmed): TrimmedEntity

Parameters

Parameter	Type
trimmedItems	Trimmed

Returns

TrimmedEntity

Defined in

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

---

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): any

Parameters

Parameter	Type
model	DataType
column	ColumnRegular

Returns

any

Defined in

src/utils/column.utils.ts:39

---

getCellRaw()

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

Parameters

Parameter	Type
model	DataType
column?	ColumnRegular

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

---

getColumnSizes()

function getColumnSizes(cols: ColumnRegular[]): ViewSettingSizeProp

Parameters

Parameter	Type
cols	ColumnRegular[]

Returns

ViewSettingSizeProp

Defined in

src/utils/column.utils.ts:81

---

getColumnType()

function getColumnType(rgCol: ColumnRegular): DimensionCols

Get column type from column data

Parameters

Parameter	Type
rgCol	ColumnRegular

Returns

DimensionCols

Defined in

src/utils/column.utils.ts:74

---

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

ColumnCollection

Defined in

src/utils/column.utils.ts:104

---

getExpanded()

function getExpanded(model: DataType): any

Parameters

Parameter	Type
model	DataType

Returns

any

Defined in

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

---

getFirstItem()

function getFirstItem(s: ItemsToUpdate): VirtualPositionItem

Parameters

Parameter	Type
s	ItemsToUpdate

Returns

VirtualPositionItem

Defined in

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

---

getGroupingName()

function getGroupingName(rgRow?: DataType): any

Parameters

Parameter	Type
rgRow?	DataType

Returns

any

Defined in

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

---

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

---

getLastItem()

function getLastItem(s: ItemsToUpdate): VirtualPositionItem

Parameters

Parameter	Type
s	ItemsToUpdate

Returns

VirtualPositionItem

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

---

getParsedGroup()

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

Parameters

Parameter	Type
id	string

Returns

null | any[]

Defined in

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

---

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

---

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

src/utils/index.ts:87

---

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

---

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

---

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

---

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

---

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

---

h()

h(sel)

function h(sel: any): VNode

Parameters

Parameter	Type
sel	any

Returns

VNode

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

VNode

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

VNode

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

VNode

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

VNode

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

VNode

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

VNode

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

VNode

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

src/utils/key.utils.ts:95

---

isClear()

function isClear(code: string): boolean

Parameters

Parameter	Type
code	string

Returns

boolean

Defined in

src/utils/key.utils.ts:62

---

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

src/utils/column.utils.ts:95

---

isCopy()

function isCopy(event: KeyboardEvent): boolean

Parameters

Parameter	Type
event	KeyboardEvent

Returns

boolean

Defined in

src/utils/key.utils.ts:83

---

isCtrlKey()

function isCtrlKey(code: number, platform: string): boolean

Parameters

Parameter	Type
code	number
platform	string

Returns

boolean

Defined in

src/utils/key.utils.ts:41

---

isCtrlMetaKey()

function isCtrlMetaKey(code: codes): boolean

Parameters

Parameter	Type
code	codes

Returns

boolean

Defined in

src/utils/key.utils.ts:53

---

isCut()

function isCut(event: KeyboardEvent): boolean

Parameters

Parameter	Type
event	KeyboardEvent

Returns

boolean

Defined in

src/utils/key.utils.ts:77

---

isEnterKeyValue()

function isEnterKeyValue(key: string): boolean

Parameters

Parameter	Type
key	string

Returns

boolean

Defined in

src/utils/key.utils.ts:73

---

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

---

isGrouping()

function isGrouping(rgRow?: DataType): rgRow is GroupingItem

Parameters

Parameter	Type
rgRow?	DataType

Returns

rgRow is GroupingItem

Defined in

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

---

isGroupingColumn()

function isGroupingColumn(column?: ColumnRegular): boolean

Parameters

Parameter	Type
column?	ColumnRegular

Returns

boolean

Defined in

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

---

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

src/utils/key.utils.ts:5

---

isPaste()

function isPaste(event: KeyboardEvent): boolean

Parameters

Parameter	Type
event	KeyboardEvent

Returns

boolean

Defined in

src/utils/key.utils.ts:89

---

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

src/store/index.ts:15

---

isSameGroup()

function isSameGroup(
   currentGroup: any[], 
   currentModel: DataType, 
   nextModel: DataType): boolean

Parameters

Parameter	Type
currentGroup	any[]
currentModel	DataType
nextModel	DataType

Returns

boolean

Defined in

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

---

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

src/utils/key.utils.ts:66

---

isTabKeyValue()

function isTabKeyValue(key: string): boolean

Parameters

Parameter	Type
key	string

Returns

boolean

Defined in

src/utils/key.utils.ts:69

---

measureEqualDepth()

function measureEqualDepth<T>(groupA: T[], groupB: T[]): number

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
groupA	T[]
groupB	T[]

Returns

number

Defined in

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

---

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

src/utils/index.ts:60

---

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 keep sortint in the data source, even when trimming is applied sorting has to be preserved.

Parameters

Parameter	Type
store	Observable<State>

Returns

PluginSubscribe<State>

Defined in

src/store/dataSource/data.proxy.ts:16

---

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

src/utils/index.ts:47

---

range()

function range(size: number, startAt: number): number[]

Parameters

Parameter	Type	Default value
size	number	undefined
startAt	number	0

Returns

number[]

Defined in

src/utils/index.ts:12

---

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

src/utils/index.ts:124

---

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

VirtualPositionItem[]

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

---

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

---

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

---

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

src/utils/store.utils.ts:13

---

timeout()

function timeout(delay: number): Promise<void>

Async timeout

Parameters

Parameter	Type	Default value
delay	number	0

Returns

Promise<void>

Defined in

src/utils/index.ts:131

---

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.
CSVFormat	-
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	-
ExtraNodeFuncConfig	ExtraNodeFuncConfig is a configuration object for External nodes rendered in grid in HTMLRevogrExtraElement.
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.
Formatter	-
FormatterOptions	-
FunctionalComponent	-
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
PluginServiceBase	-
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	-
CSVFormatter	-
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	-
ColSource	-
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.
CustomFilter	-
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	-
FilterCollectionItem	-
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	-
RowDragStartDetails	-
RowIndex	-
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	-
SortingConfig	-
TempRange	-
Theme	-
ThemeConfig	-
Trimmed	-
TrimmedEntity	-
VNodeResponse	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.
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.
WatchConfig	-