Skip to content

@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

Constructors

new AutoAddRowsPlugin()

ts
new AutoAddRowsPlugin(revogrid: HTMLRevoGridElement, providers: PluginProviders): AutoAddRowsPlugin
Parameters
ParameterType
revogridHTMLRevoGridElement
providersPluginProviders
Returns

AutoAddRowsPlugin

Overrides

BasePlugin.constructor

Defined in

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

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
hreadonlytypeof hhBasePlugin.hsrc/plugins/base.plugin.ts:13
providerspublicPluginProvidersundefinedBasePlugin.providerssrc/plugins/base.plugin.ts:15
revogridpublicHTMLRevoGridElementundefinedBasePlugin.revogridsrc/plugins/base.plugin.ts:15
subscriptionsreadonlyRecord<string, (...args: any[]) => void>{}BasePlugin.subscriptionssrc/plugins/base.plugin.ts:14

Methods

addEventListener()

ts
addEventListener<K>(eventName: K, callback: (this: BasePlugin, e: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => void): void
Type Parameters
Type Parameter
K extends keyof HTMLRevoGridElementEventMap
Parameters
ParameterTypeDescription
eventNameKevent name to subscribe to in revo-grid component (e.g. 'beforeheaderclick')
callback(this: BasePlugin, e: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => voidcallback function for event
Returns

void

Inherited from

BasePlugin.addEventListener

Defined in

src/plugins/base.plugin.ts:21


clearSubscriptions()

ts
clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

BasePlugin.clearSubscriptions

Defined in

src/plugins/base.plugin.ts:88


destroy()

ts
destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

BasePlugin.destroy

Defined in

src/plugins/base.plugin.ts:97


emit()

ts
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 ParameterDefault type
Tany
Parameters
ParameterType
eventNamestring
detail?T
Returns

CustomEvent<T>

Inherited from

BasePlugin.emit

Defined in

src/plugins/base.plugin.ts:79


handleBeforePasteApply()

ts
handleBeforePasteApply(event: CustomEvent<{
  event: ClipboardEvent;
  parsed: string[][];
  raw: string;
 }>): void
Parameters
ParameterType
eventCustomEvent<{ event: ClipboardEvent; parsed: string[][]; raw: string; }>
Returns

void

Defined in

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


removeEventListener()

ts
removeEventListener(eventName: string): void

Remove event listener

Parameters
ParameterTypeDescription
eventNamestring
Returns

void

Inherited from

BasePlugin.removeEventListener

Defined in

src/plugins/base.plugin.ts:70


watch()

ts
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
ParameterTypeDescription
propstringproperty name
callback(arg: T) => boolean | voidcallback function
immediatePartial<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

Constructors

new AutoSizeColumnPlugin()

ts
new AutoSizeColumnPlugin(
   revogrid: HTMLRevoGridElement, 
   providers: PluginProviders, 
   config?: AutoSizeColumnConfig): AutoSizeColumnPlugin
Parameters
ParameterType
revogridHTMLRevoGridElement
providersPluginProviders
config?AutoSizeColumnConfig
Returns

AutoSizeColumnPlugin

Overrides

BasePlugin.constructor

Defined in

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

Properties

PropertyModifierTypeDefault valueDescriptionInherited fromDefined in
autoSizeColumnspublicnull | Partial<AutoSizeColumns>null--src/plugins/column.auto-size.plugin.ts:65
config?publicAutoSizeColumnConfigundefined--src/plugins/column.auto-size.plugin.ts:78
dataRejectpublicnull | Rejectnull--src/plugins/column.auto-size.plugin.ts:73
dataResolvepublicnull | Resolvenullfor edge case when no columns defined before data-src/plugins/column.auto-size.plugin.ts:72
hreadonlytypeof hh-BasePlugin.hsrc/plugins/base.plugin.ts:13
letterBlockSizereadonlynumberundefined--src/plugins/column.auto-size.plugin.ts:66
precsizeCalculationAreareadonlyHTMLElementundefinedfor config option when Precise Size enabled-src/plugins/column.auto-size.plugin.ts:69
providerspublicPluginProvidersundefined-BasePlugin.providerssrc/plugins/column.auto-size.plugin.ts:77
revogridpublicHTMLRevoGridElementundefined-BasePlugin.revogridsrc/plugins/base.plugin.ts:15
subscriptionsreadonlyRecord<string, (...args: any[]) => void>{}-BasePlugin.subscriptionssrc/plugins/base.plugin.ts:14

Methods

addEventListener()

ts
addEventListener<K>(eventName: K, callback: (this: BasePlugin, e: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => void): void
Type Parameters
Type Parameter
K extends keyof HTMLRevoGridElementEventMap
Parameters
ParameterTypeDescription
eventNameKevent name to subscribe to in revo-grid component (e.g. 'beforeheaderclick')
callback(this: BasePlugin, e: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => voidcallback function for event
Returns

void

Inherited from

BasePlugin.addEventListener

Defined in

src/plugins/base.plugin.ts:21


afterEditAll()

ts
afterEditAll(e: EditEvent): void
Parameters
ParameterType
eEditEvent
Returns

void

Defined in

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


afteredit()

ts
afteredit(e: EditEvent): void
Parameters
ParameterType
eEditEvent
Returns

void

Defined in

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


clearPromise()

ts
clearPromise(): void
Returns

void

Defined in

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


clearSubscriptions()

ts
clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

BasePlugin.clearSubscriptions

Defined in

src/plugins/base.plugin.ts:88


columnSet()

ts
columnSet(columns: Record<DimensionCols, ColumnRegular[]>): void
Parameters
ParameterType
columnsRecord<DimensionCols, ColumnRegular[]>
Returns

void

Defined in

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


destroy()

ts
destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Overrides

BasePlugin.destroy

Defined in

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


emit()

ts
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 ParameterDefault type
Tany
Parameters
ParameterType
eventNamestring
detail?T
Returns

CustomEvent<T>

Inherited from

BasePlugin.emit

Defined in

src/plugins/base.plugin.ts:79


getColumnSize()

ts
getColumnSize(index: number, type: DimensionCols): number
Parameters
ParameterType
indexnumber
typeDimensionCols
Returns

number

Defined in

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


getLength()

ts
getLength(len?: any): number
Parameters
ParameterType
len?any
Returns

number

Defined in

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


initiatePresizeElement()

ts
initiatePresizeElement(): HTMLElement
Returns

HTMLElement

Defined in

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


isRangeEdit()

ts
isRangeEdit(e: EditEvent): e is BeforeRangeSaveDataDetails
Parameters
ParameterType
eEditEvent
Returns

e is BeforeRangeSaveDataDetails

Defined in

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


removeEventListener()

ts
removeEventListener(eventName: string): void

Remove event listener

Parameters
ParameterTypeDescription
eventNamestring
Returns

void

Inherited from

BasePlugin.removeEventListener

Defined in

src/plugins/base.plugin.ts:70


setSource()

ts
setSource(source: DataType[]): Promise<void>
Parameters
ParameterType
sourceDataType[]
Returns

Promise<void>

Defined in

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


watch()

ts
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
ParameterTypeDescription
propstringproperty name
callback(arg: T) => boolean | voidcallback function
immediatePartial<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

Implements

Constructors

new BasePlugin()

ts
new BasePlugin(revogrid: HTMLRevoGridElement, providers: PluginProviders): BasePlugin
Parameters
ParameterType
revogridHTMLRevoGridElement
providersPluginProviders
Returns

BasePlugin

Defined in

src/plugins/base.plugin.ts:15

Properties

PropertyModifierTypeDefault valueDefined in
hreadonlytypeof hhsrc/plugins/base.plugin.ts:13
providerspublicPluginProvidersundefinedsrc/plugins/base.plugin.ts:15
revogridpublicHTMLRevoGridElementundefinedsrc/plugins/base.plugin.ts:15
subscriptionsreadonlyRecord<string, (...args: any[]) => void>{}src/plugins/base.plugin.ts:14

Methods

addEventListener()

ts
addEventListener<K>(eventName: K, callback: (this: BasePlugin, e: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => void): void
Type Parameters
Type Parameter
K extends keyof HTMLRevoGridElementEventMap
Parameters
ParameterTypeDescription
eventNameKevent name to subscribe to in revo-grid component (e.g. 'beforeheaderclick')
callback(this: BasePlugin, e: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => voidcallback function for event
Returns

void

Defined in

src/plugins/base.plugin.ts:21


clearSubscriptions()

ts
clearSubscriptions(): void

Clear all subscriptions

Returns

void

Defined in

src/plugins/base.plugin.ts:88


destroy()

ts
destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Implementation of

PluginBaseComponent.destroy

Defined in

src/plugins/base.plugin.ts:97


emit()

ts
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 ParameterDefault type
Tany
Parameters
ParameterType
eventNamestring
detail?T
Returns

CustomEvent<T>

Defined in

src/plugins/base.plugin.ts:79


removeEventListener()

ts
removeEventListener(eventName: string): void

Remove event listener

Parameters
ParameterTypeDescription
eventNamestring
Returns

void

Defined in

src/plugins/base.plugin.ts:70


watch()

ts
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
ParameterTypeDescription
propstringproperty name
callback(arg: T) => boolean | voidcallback function
immediatePartial<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

Constructors

new ColumnMovePlugin()

ts
new ColumnMovePlugin(revogrid: HTMLRevoGridElement, providers: PluginProviders): ColumnMovePlugin
Parameters
ParameterType
revogridHTMLRevoGridElement
providersPluginProviders
Returns

ColumnMovePlugin

Overrides

BasePlugin.constructor

Defined in

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

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
hreadonlytypeof hhBasePlugin.hsrc/plugins/base.plugin.ts:13
providerspublicPluginProvidersundefinedBasePlugin.providerssrc/plugins/moveColumn/column.drag.plugin.ts:54
revogridpublicHTMLRevoGridElementundefinedBasePlugin.revogridsrc/plugins/moveColumn/column.drag.plugin.ts:54
subscriptionsreadonlyRecord<string, (...args: any[]) => void>{}BasePlugin.subscriptionssrc/plugins/base.plugin.ts:14

Methods

addEventListener()

ts
addEventListener<K>(eventName: K, callback: (this: BasePlugin, e: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => void): void
Type Parameters
Type Parameter
K extends keyof HTMLRevoGridElementEventMap
Parameters
ParameterTypeDescription
eventNameKevent name to subscribe to in revo-grid component (e.g. 'beforeheaderclick')
callback(this: BasePlugin, e: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => voidcallback function for event
Returns

void

Inherited from

BasePlugin.addEventListener

Defined in

src/plugins/base.plugin.ts:21


clearOrder()

ts
clearOrder(): void
Returns

void

Defined in

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


clearSubscriptions()

ts
clearSubscriptions(): void

Clearing subscription

Returns

void

Overrides

BasePlugin.clearSubscriptions

Defined in

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


destroy()

ts
destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

BasePlugin.destroy

Defined in

src/plugins/base.plugin.ts:97


doMove()

ts
doMove(e: MouseEvent): void
Parameters
ParameterType
eMouseEvent
Returns

void

Defined in

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


dragStart()

ts
dragStart(__namedParameters: DragStartEventDetails): void
Parameters
ParameterType
__namedParametersDragStartEventDetails
Returns

void

Defined in

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


emit()

ts
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 ParameterDefault type
Tany
Parameters
ParameterType
eventNamestring
detail?T
Returns

CustomEvent<T>

Inherited from

BasePlugin.emit

Defined in

src/plugins/base.plugin.ts:79


move()

ts
move(e: MouseEvent): void
Parameters
ParameterType
eMouseEvent
Returns

void

Defined in

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


onMouseOut()

ts
onMouseOut(_: MouseEvent): void
Parameters
ParameterType
_MouseEvent
Returns

void

Defined in

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


onMouseUp()

ts
onMouseUp(e: MouseEvent): void
Parameters
ParameterType
eMouseEvent
Returns

void

Defined in

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


removeEventListener()

ts
removeEventListener(eventName: string): void

Remove event listener

Parameters
ParameterTypeDescription
eventNamestring
Returns

void

Inherited from

BasePlugin.removeEventListener

Defined in

src/plugins/base.plugin.ts:70


watch()

ts
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
ParameterTypeDescription
propstringproperty name
callback(arg: T) => boolean | voidcallback function
immediatePartial<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()

ts
new DataStore<T, ST>(type: ST, storeData?: DSourceState<T, ST>): DataStore<T, ST>
Parameters
ParameterType
typeST
storeData?DSourceState<T, ST>
Returns

DataStore<T, ST>

Defined in

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

Accessors

store

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

Observable<DSourceState<T, ST>>

Defined in

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

Methods

addTrimmed()

ts
addTrimmed(some: Partial<Trimmed>): void
Parameters
ParameterType
somePartial<Trimmed>
Returns

void

Defined in

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


refresh()

ts
refresh(): void
Returns

void

Defined in

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


setData()

ts
setData(input: Partial<DSourceState<T, ST>>): void
Parameters
ParameterType
inputPartial<DSourceState<T, ST>>
Returns

void

Defined in

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


setSourceData()

ts
setSourceData(items: Record<number, any>, mutate: boolean): void
Parameters
ParameterTypeDefault value
itemsRecord<number, any>undefined
mutatebooleantrue
Returns

void

Defined in

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


updateData()

ts
updateData(
   source: T[], 
   grouping?: {
  customRenderer: GroupLabelTemplateFunc;
  depth: number;
  groups: Groups;
 }, 
   silent?: boolean): void

full data source update

Parameters
ParameterTypeDefault valueDescription
sourceT[]undefineddata column/rgRow source
grouping?objectundefinedgrouping information if present
grouping.customRenderer?GroupLabelTemplateFuncundefined-
grouping.depth?numberundefined-
grouping.groups?Groupsundefined-
silent?booleanfalse-
Returns

void

Defined in

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


DimensionStore

Constructors

new DimensionStore()

ts
new DimensionStore(type: MultiDimensionType): DimensionStore
Parameters
ParameterType
typeMultiDimensionType
Returns

DimensionStore

Defined in

src/store/dimension/dimension.store.ts:56

Properties

PropertyModifierTypeDefined in
storereadonlyObservable<DimensionSettingsState>src/store/dimension/dimension.store.ts:55
typereadonlyMultiDimensionTypesrc/store/dimension/dimension.store.ts:56

Methods

dispose()

ts
dispose(): void
Returns

void

Defined in

src/store/dimension/dimension.store.ts:82


drop()

ts
drop(): void
Returns

void

Defined in

src/store/dimension/dimension.store.ts:90


getCurrentState()

ts
getCurrentState(): DimensionSettingsState
Returns

DimensionSettingsState

Defined in

src/store/dimension/dimension.store.ts:68


setDimensionSize()

ts
setDimensionSize(sizes: ViewSettingSizeProp): void

Set custom dimension sizes and overwrite old Generates new indexes based on sizes

Parameters
ParameterTypeDescription
sizesViewSettingSizePropsizes to set
Returns

void

Defined in

src/store/dimension/dimension.store.ts:99


setStore()

ts
setStore<T>(data: Partial<T>): void
Type Parameters
Type Parameter
T extends Record<string, any>
Parameters
ParameterType
dataPartial<T>
Returns

void

Defined in

src/store/dimension/dimension.store.ts:86


updateSizesPositionByIndexes()

ts
updateSizesPositionByIndexes(newItemsOrder: number[], prevItemsOrder: number[]): void
Parameters
ParameterTypeDefault value
newItemsOrdernumber[]undefined
prevItemsOrdernumber[][]
Returns

void

Defined in

src/store/dimension/dimension.store.ts:110


ExportCsv

Implements

Constructors

new ExportCsv()

ts
new ExportCsv(options: Partial<CSVFormat>): ExportCsv
Parameters
ParameterType
optionsPartial<CSVFormat>
Returns

ExportCsv

Defined in

src/plugins/export/csv.ts:26

Properties

PropertyModifierTypeDefined in
optionsreadonlyReadonly<CSVFormat>src/plugins/export/csv.ts:25

Methods

doExport()

ts
doExport(__namedParameters: DataInput): string
Parameters
ParameterType
__namedParametersDataInput
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

Constructors

new ExportFilePlugin()

ts
new ExportFilePlugin(revogrid: HTMLRevoGridElement, providers: PluginProviders): ExportFilePlugin
Parameters
ParameterType
revogridHTMLRevoGridElement
providersPluginProviders
Returns

ExportFilePlugin

Inherited from

BasePlugin.constructor

Defined in

src/plugins/base.plugin.ts:15

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
hreadonlytypeof hhBasePlugin.hsrc/plugins/base.plugin.ts:13
providerspublicPluginProvidersundefinedBasePlugin.providerssrc/plugins/base.plugin.ts:15
revogridpublicHTMLRevoGridElementundefinedBasePlugin.revogridsrc/plugins/base.plugin.ts:15
subscriptionsreadonlyRecord<string, (...args: any[]) => void>{}BasePlugin.subscriptionssrc/plugins/base.plugin.ts:14

Methods

addEventListener()

ts
addEventListener<K>(eventName: K, callback: (this: BasePlugin, e: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => void): void
Type Parameters
Type Parameter
K extends keyof HTMLRevoGridElementEventMap
Parameters
ParameterTypeDescription
eventNameKevent name to subscribe to in revo-grid component (e.g. 'beforeheaderclick')
callback(this: BasePlugin, e: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => voidcallback function for event
Returns

void

Inherited from

BasePlugin.addEventListener

Defined in

src/plugins/base.plugin.ts:21


clearSubscriptions()

ts
clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

BasePlugin.clearSubscriptions

Defined in

src/plugins/base.plugin.ts:88


destroy()

ts
destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

BasePlugin.destroy

Defined in

src/plugins/base.plugin.ts:97


emit()

ts
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 ParameterDefault type
Tany
Parameters
ParameterType
eventNamestring
detail?T
Returns

CustomEvent<T>

Inherited from

BasePlugin.emit

Defined in

src/plugins/base.plugin.ts:79


exportBlob()

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

Exports Blob

Parameters
ParameterTypeDefault value
optionsPartial<CSVFormat>{}
tExportTypesExportTypes.csv
Returns

Promise<null | Blob>

Defined in

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


exportFile()

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

Export file

Parameters
ParameterTypeDefault value
optionsPartial<CSVFormat>{}
tExportTypesExportTypes.csv
Returns

Promise<void>

Defined in

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


exportString()

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

Exports string

Parameters
ParameterTypeDefault value
optionsPartial<CSVFormat>{}
tExportTypesExportTypes.csv
Returns

Promise<null | string>

Defined in

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


getBlob()

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

Blob object

Parameters
ParameterType
formatterFormatter
Returns

Promise<null | Blob>

Defined in

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


removeEventListener()

ts
removeEventListener(eventName: string): void

Remove event listener

Parameters
ParameterTypeDescription
eventNamestring
Returns

void

Inherited from

BasePlugin.removeEventListener

Defined in

src/plugins/base.plugin.ts:70


watch()

ts
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
ParameterTypeDescription
propstringproperty name
callback(arg: T) => boolean | voidcallback function
immediatePartial<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

Constructors

new GroupingRowPlugin()

ts
new GroupingRowPlugin(revogrid: HTMLRevoGridElement, providers: PluginProviders): GroupingRowPlugin
Parameters
ParameterType
revogridHTMLRevoGridElement
providersPluginProviders
Returns

GroupingRowPlugin

Overrides

BasePlugin.constructor

Defined in

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

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
hreadonlytypeof hhBasePlugin.hsrc/plugins/base.plugin.ts:13
providerspublicPluginProvidersundefinedBasePlugin.providerssrc/plugins/groupingRow/grouping.row.plugin.ts:59
revogridpublicHTMLRevoGridElementundefinedBasePlugin.revogridsrc/plugins/groupingRow/grouping.row.plugin.ts:58
subscriptionsreadonlyRecord<string, (...args: any[]) => void>{}BasePlugin.subscriptionssrc/plugins/base.plugin.ts:14

Methods

addEventListener()

ts
addEventListener<K>(eventName: K, callback: (this: BasePlugin, e: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => void): void
Type Parameters
Type Parameter
K extends keyof HTMLRevoGridElementEventMap
Parameters
ParameterTypeDescription
eventNameKevent name to subscribe to in revo-grid component (e.g. 'beforeheaderclick')
callback(this: BasePlugin, e: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => voidcallback function for event
Returns

void

Inherited from

BasePlugin.addEventListener

Defined in

src/plugins/base.plugin.ts:21


clearGrouping()

ts
clearGrouping(): void
Returns

void

Defined in

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


clearSubscriptions()

ts
clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

BasePlugin.clearSubscriptions

Defined in

src/plugins/base.plugin.ts:88


destroy()

ts
destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

BasePlugin.destroy

Defined in

src/plugins/base.plugin.ts:97


emit()

ts
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 ParameterDefault type
Tany
Parameters
ParameterType
eventNamestring
detail?T
Returns

CustomEvent<T>

Inherited from

BasePlugin.emit

Defined in

src/plugins/base.plugin.ts:79


getStore()

ts
getStore(type: DimensionRows): Observable<DSourceState<DataType, DimensionRows>>
Parameters
ParameterTypeDefault value
typeDimensionRowsGROUPING_ROW_TYPE
Returns

Observable<DSourceState<DataType, DimensionRows>>

Defined in

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


removeEventListener()

ts
removeEventListener(eventName: string): void

Remove event listener

Parameters
ParameterTypeDescription
eventNamestring
Returns

void

Inherited from

BasePlugin.removeEventListener

Defined in

src/plugins/base.plugin.ts:70


setGrouping()

ts
setGrouping(options: GroupingOptions): void

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

Parameters
ParameterType
optionsGroupingOptions
Returns

void

Defined in

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


watch()

ts
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
ParameterTypeDescription
propstringproperty name
callback(arg: T) => boolean | voidcallback function
immediatePartial<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()

ts
new SelectionStore(): SelectionStore
Returns

SelectionStore

Defined in

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

Properties

PropertyModifierTypeDefined in
storereadonlyObservable<SelectionStoreState>src/store/selection/selection.store.ts:23

Methods

clearFocus()

ts
clearFocus(): void
Returns

void

Defined in

src/store/selection/selection.store.ts:38


clearTemp()

ts
clearTemp(): void
Returns

void

Defined in

src/store/selection/selection.store.ts:63


dispose()

ts
dispose(): void
Returns

void

Defined in

src/store/selection/selection.store.ts:91


onChange()

ts
onChange<Key>(propName: Key, cb: (newValue: SelectionStoreState[Key]) => void): void
Type Parameters
Type Parameter
Key extends keyof SelectionStoreState
Parameters
ParameterType
propNameKey
cb(newValue: SelectionStoreState[Key]) => void
Returns

void

Defined in

src/store/selection/selection.store.ts:34


setEdit()

ts
setEdit(val?: string | boolean): void
Parameters
ParameterType
val?string | boolean
Returns

void

Defined in

src/store/selection/selection.store.ts:80


setFocus()

ts
setFocus(focus: Cell, end?: Cell): void
Parameters
ParameterType
focusCell
end?Cell
Returns

void

Defined in

src/store/selection/selection.store.ts:42


setLastCell()

ts
setLastCell(lastCell: Cell): void
Parameters
ParameterType
lastCellCell
Returns

void

Defined in

src/store/selection/selection.store.ts:76


setNextFocus()

ts
setNextFocus(focus: Cell): void
Parameters
ParameterType
focusCell
Returns

void

Defined in

src/store/selection/selection.store.ts:55


setRange()

ts
setRange(start: Cell, end: Cell): void
Parameters
ParameterType
startCell
endCell
Returns

void

Defined in

src/store/selection/selection.store.ts:71


setRangeArea()

ts
setRangeArea(range: null | RangeArea): void

Can be applied from selection change or from simple keyboard change clicks

Parameters
ParameterType
rangenull | RangeArea
Returns

void

Defined in

src/store/selection/selection.store.ts:68


setTempArea()

ts
setTempArea(range: null | Nullable<TempRange>): void
Parameters
ParameterType
rangenull | 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

Constructors

new SortingPlugin()

ts
new SortingPlugin(
   revogrid: HTMLRevoGridElement, 
   providers: PluginProviders, 
   config?: SortingConfig): SortingPlugin
Parameters
ParameterType
revogridHTMLRevoGridElement
providersPluginProviders
config?SortingConfig
Returns

SortingPlugin

Overrides

BasePlugin.constructor

Defined in

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

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
hreadonlytypeof hhBasePlugin.hsrc/plugins/base.plugin.ts:13
postponeSortpublicDebouncedFunc<(order?: SortingOrder, comparison?: SortingOrderFunction, ignoreViewportUpdate?: boolean) => void>undefined-src/plugins/sorting/sorting.plugin.ts:36
providerspublicPluginProvidersundefinedBasePlugin.providerssrc/plugins/base.plugin.ts:15
revogridpublicHTMLRevoGridElementundefinedBasePlugin.revogridsrc/plugins/sorting/sorting.plugin.ts:53
sorting?publicSortingOrderundefined-src/plugins/sorting/sorting.plugin.ts:31
sortingFunc?publicSortingOrderFunctionundefined-src/plugins/sorting/sorting.plugin.ts:34
sortingPromisepublicnull | () => voidnull-src/plugins/sorting/sorting.plugin.ts:35
subscriptionsreadonlyRecord<string, (...args: any[]) => void>{}BasePlugin.subscriptionssrc/plugins/base.plugin.ts:14

Methods

addEventListener()

ts
addEventListener<K>(eventName: K, callback: (this: BasePlugin, e: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => void): void
Type Parameters
Type Parameter
K extends keyof HTMLRevoGridElementEventMap
Parameters
ParameterTypeDescription
eventNameKevent name to subscribe to in revo-grid component (e.g. 'beforeheaderclick')
callback(this: BasePlugin, e: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => voidcallback function for event
Returns

void

Inherited from

BasePlugin.addEventListener

Defined in

src/plugins/base.plugin.ts:21


clearSubscriptions()

ts
clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

BasePlugin.clearSubscriptions

Defined in

src/plugins/base.plugin.ts:88


defaultCellCompare()

ts
defaultCellCompare(
   this: {
  column: ColumnRegular;
 }, 
   prop: ColumnProp, 
   a: DataType, 
   b: DataType): -1 | 0 | 1
Parameters
ParameterType
thisobject
this.column?ColumnRegular
propColumnProp
aDataType
bDataType
Returns

-1 | 0 | 1

Defined in

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


descCellCompare()

ts
descCellCompare(cmp: CellCompareFunc): (prop: ColumnProp, a: DataType, b: DataType) => number
Parameters
ParameterType
cmpCellCompareFunc
Returns

Function

Parameters
ParameterType
propColumnProp
aDataType
bDataType
Returns

number

Defined in

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


destroy()

ts
destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

BasePlugin.destroy

Defined in

src/plugins/base.plugin.ts:97


emit()

ts
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 ParameterDefault type
Tany
Parameters
ParameterType
eventNamestring
detail?T
Returns

CustomEvent<T>

Inherited from

BasePlugin.emit

Defined in

src/plugins/base.plugin.ts:79


getComparer()

ts
getComparer(column: undefined | Partial<ColumnRegular>, order: Order): undefined | CellCompareFunc
Parameters
ParameterType
columnundefined | Partial<ColumnRegular>
orderOrder
Returns

undefined | CellCompareFunc

Defined in

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


getNextOrder()

ts
getNextOrder(currentOrder: Order): Order
Parameters
ParameterType
currentOrderOrder
Returns

Order

Defined in

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


headerclick()

ts
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
ParameterType
columnColumnRegular
indexnumber
additiveboolean
Returns

void

Defined in

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


removeEventListener()

ts
removeEventListener(eventName: string): void

Remove event listener

Parameters
ParameterTypeDescription
eventNamestring
Returns

void

Inherited from

BasePlugin.removeEventListener

Defined in

src/plugins/base.plugin.ts:70


runSorting()

ts
runSorting(
   order?: SortingOrder, 
   comparison?: SortingOrderFunction, 
   ignoreViewportUpdate?: boolean): void
Parameters
ParameterType
order?SortingOrder
comparison?SortingOrderFunction
ignoreViewportUpdate?boolean
Returns

void

Defined in

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


sort()

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

Sort items by sorting function

Parameters
ParameterTypeDefault valueDescription
sorting?SortingOrderundefinedper column sorting
sortingFunc?SortingOrderFunctionundefined-
types?DimensionRows[]rowTypes-
ignoreViewportUpdate?booleanfalse-
Returns

void

Requires

proxyItems applied to row store

Requires

source applied to row store

Defined in

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


startSorting()

ts
startSorting(
   order?: SortingOrder, 
   sortingFunc?: SortingOrderFunction, 
   ignoreViewportUpdate?: boolean): void
Parameters
ParameterType
order?SortingOrder
sortingFunc?SortingOrderFunction
ignoreViewportUpdate?boolean
Returns

void

Defined in

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


watch()

ts
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
ParameterTypeDescription
propstringproperty name
callback(arg: T) => boolean | voidcallback function
immediatePartial<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

Constructors

new StretchColumn()

ts
new StretchColumn(revogrid: HTMLRevoGridElement, providers: PluginProviders): StretchColumn
Parameters
ParameterType
revogridHTMLRevoGridElement
providersPluginProviders
Returns

StretchColumn

Overrides

BasePlugin.constructor

Defined in

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

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
hreadonlytypeof hhBasePlugin.hsrc/plugins/base.plugin.ts:13
providerspublicPluginProvidersundefinedBasePlugin.providerssrc/plugins/column.stretch.plugin.ts:28
revogridpublicHTMLRevoGridElementundefinedBasePlugin.revogridsrc/plugins/base.plugin.ts:15
subscriptionsreadonlyRecord<string, (...args: any[]) => void>{}BasePlugin.subscriptionssrc/plugins/base.plugin.ts:14

Methods

addEventListener()

ts
addEventListener<K>(eventName: K, callback: (this: BasePlugin, e: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => void): void
Type Parameters
Type Parameter
K extends keyof HTMLRevoGridElementEventMap
Parameters
ParameterTypeDescription
eventNameKevent name to subscribe to in revo-grid component (e.g. 'beforeheaderclick')
callback(this: BasePlugin, e: RevoGridCustomEvent<HTMLRevoGridElementEventMap[K]>) => voidcallback function for event
Returns

void

Inherited from

BasePlugin.addEventListener

Defined in

src/plugins/base.plugin.ts:21


applyStretch()

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

Apply stretch changes

Parameters
ParameterType
columnsRecord<DimensionCols, ColumnRegular[]>
Returns

void

Defined in

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


clearSubscriptions()

ts
clearSubscriptions(): void

Clear all subscriptions

Returns

void

Inherited from

BasePlugin.clearSubscriptions

Defined in

src/plugins/base.plugin.ts:88


destroy()

ts
destroy(): void

Destroy plugin and clear all subscriptions

Returns

void

Inherited from

BasePlugin.destroy

Defined in

src/plugins/base.plugin.ts:97


emit()

ts
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 ParameterDefault type
Tany
Parameters
ParameterType
eventNamestring
detail?T
Returns

CustomEvent<T>

Inherited from

BasePlugin.emit

Defined in

src/plugins/base.plugin.ts:79


removeEventListener()

ts
removeEventListener(eventName: string): void

Remove event listener

Parameters
ParameterTypeDescription
eventNamestring
Returns

void

Inherited from

BasePlugin.removeEventListener

Defined in

src/plugins/base.plugin.ts:70


watch()

ts
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
ParameterTypeDescription
propstringproperty name
callback(arg: T) => boolean | voidcallback function
immediatePartial<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

Constructors

new TextEditor()

ts
new TextEditor(data: ColumnDataSchemaModel, saveCallback?: SaveCallback): TextEditor
Parameters
ParameterType
dataColumnDataSchemaModel
saveCallback?SaveCallback
Returns

TextEditor

Defined in

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

Properties

PropertyModifierTypeDefault valueDefined in
datapublicColumnDataSchemaModelundefinedsrc/components/editors/text-editor.ts:27
editCell?publicEditCellundefinedsrc/components/editors/text-editor.ts:24
editInputpublicnull | HTMLInputElementnullsrc/components/editors/text-editor.ts:21
elementpublicnull | Elementnullsrc/components/editors/text-editor.ts:23

Methods

beforeDisconnect()

ts
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()

ts
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()

ts
getValue(): undefined | string

Get value from input

Returns

undefined | string

Implementation of

EditorBase.getValue

Defined in

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


onKeyDown()

ts
onKeyDown(e: KeyboardEvent): void
Parameters
ParameterType
eKeyboardEvent
Returns

void

Defined in

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


render()

ts
render(h: typeof h, _additionalData: any): VNode | VNode[]

Render method for Editor plugin. Renders input element with passed data from cell.

Parameters
ParameterTypeDescription
htypeof hh function from stencil render.
_additionalDataanyadditional 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()

ts
new ViewportStore(type: MultiDimensionType): ViewportStore
Parameters
ParameterType
typeMultiDimensionType
Returns

ViewportStore

Defined in

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

Properties

PropertyModifierTypeDefined in
storereadonlyObservable<ViewportState>src/store/vp/viewport.store.ts:49
typereadonlyMultiDimensionTypesrc/store/vp/viewport.store.ts:60

Accessors

lastCoordinate

ts
get lastCoordinate(): number
ts
set lastCoordinate(value: number): void
Parameters
ParameterType
valuenumber
Returns

number

Defined in

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

Methods

getItems()

ts
getItems(): ItemsToUpdate
Returns

ItemsToUpdate

Defined in

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


setOriginalSizes()

ts
setOriginalSizes(size: number): void

Set sizes for existing items

Parameters
ParameterType
sizenumber
Returns

void

Defined in

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


setViewPortCoordinate()

ts
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
ParameterTypeDefault value
positionnumberundefined
dimensionDimensionDataViewportundefined
forcebooleanfalse
Returns

void

Defined in

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


setViewport()

ts
setViewport(data: Partial<ViewportState>): void
Parameters
ParameterType
dataPartial<ViewportState>
Returns

void

Defined in

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


AND_OR_BUTTON

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

Defined in

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


CELL_CLASS

ts
const CELL_CLASS: "rgCell" = 'rgCell';

Defined in

src/utils/consts.ts:8


CELL_HANDLER_CLASS

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

Defined in

src/utils/consts.ts:23


DATA_COL

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

Defined in

src/utils/consts.ts:4


DATA_ROW

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

Defined in

src/utils/consts.ts:5


DISABLED_CLASS

ts
const DISABLED_CLASS: "disabled" = 'disabled';

Defined in

src/utils/consts.ts:7


DRAGGABLE_CLASS

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

Defined in

src/utils/consts.ts:16


DRAGG_TEXT

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

Defined in

src/utils/consts.ts:27


DRAG_ICON_CLASS

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

Defined in

src/utils/consts.ts:15


EDIT_INPUT_WR

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

Defined in

src/utils/consts.ts:25


FILTER_BUTTON_ACTIVE

ts
const FILTER_BUTTON_ACTIVE: "active" = 'active';

Defined in

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


FILTER_BUTTON_CLASS

ts
const FILTER_BUTTON_CLASS: "rv-filter" = 'rv-filter';

Defined in

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


FILTER_CONFIG_CHANGED_EVENT

ts
const FILTER_CONFIG_CHANGED_EVENT: "filterconfigchanged" = 'filterconfigchanged';

Defined in

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


FILTER_PROP

ts
const FILTER_PROP: "hasFilter" = 'hasFilter';

Defined in

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


FILTER_TRIMMED_TYPE

ts
const FILTER_TRIMMED_TYPE: "filter" = 'filter';

Defined in

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


FILTE_PANEL

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

Defined in

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


FOCUS_CLASS

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

Defined in

src/utils/consts.ts:18


GRID_INTERNALS

ts
const GRID_INTERNALS: "__rvgr" = '__rvgr';

Defined in

src/utils/consts.ts:28


HEADER_ACTUAL_ROW_CLASS

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

Defined in

src/utils/consts.ts:13


HEADER_CLASS

ts
const HEADER_CLASS: "rgHeaderCell" = 'rgHeaderCell';

Defined in

src/utils/consts.ts:10


HEADER_ROW_CLASS

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

Defined in

src/utils/consts.ts:12


HEADER_SORTABLE_CLASS

ts
const HEADER_SORTABLE_CLASS: "sortable" = 'sortable';

Defined in

src/utils/consts.ts:11


MIN_COL_SIZE

ts
const MIN_COL_SIZE: 30 = 30;

Defined in

src/utils/consts.ts:1


MOBILE_CLASS

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

Defined in

src/utils/consts.ts:20


RESIZE_INTERVAL

ts
const RESIZE_INTERVAL: 40 = 40;

Defined in

src/utils/consts.ts:2


REVOGRID_EVENTS

ts
const REVOGRID_EVENTS: Map<RevogridEvents, RevogridEvents>;

Defined in

src/types/events.ts:107


ROW_FOCUSED_CLASS

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

Defined in

src/utils/consts.ts:29


ROW_HEADER_TYPE

ts
const ROW_HEADER_TYPE: "rowHeaders" = 'rowHeaders';

Defined in

src/utils/consts.ts:9


SELECTION_BORDER_CLASS

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

Defined in

src/utils/consts.ts:19


TMP_SELECTION_BG_CLASS

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

Defined in

src/utils/consts.ts:21


TRASH_BUTTON

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

Defined in

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


columnTypes

ts
const columnTypes: DimensionCols[];

Defined in

src/store/index.ts:9


filterCoreFunctionsIndexedByType

ts
const filterCoreFunctionsIndexedByType: Record<FilterType, LogicFunction>;

Defined in

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


filterNames

ts
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

NameTypeDefault valueDefined in
beginsstring'Begins with'src/plugins/filter/filter.indexed.ts:44
containsstring'Contains'src/plugins/filter/filter.indexed.ts:45
emptystring'Not set'src/plugins/filter/filter.indexed.ts:39
eqstring'Equal'src/plugins/filter/filter.indexed.ts:42
eqNstring'='src/plugins/filter/filter.indexed.ts:48
gtstring'>'src/plugins/filter/filter.indexed.ts:50
gtestring'>='src/plugins/filter/filter.indexed.ts:51
ltstring'<'src/plugins/filter/filter.indexed.ts:52
ltestring'<='src/plugins/filter/filter.indexed.ts:53
neqNstring'!='src/plugins/filter/filter.indexed.ts:49
nonestring'None'src/plugins/filter/filter.indexed.ts:38
notContainsstring'Does not contain'src/plugins/filter/filter.indexed.ts:46
notEmptystring'Set'src/plugins/filter/filter.indexed.ts:40
notEqstring'Not equal'src/plugins/filter/filter.indexed.ts:43

Defined in

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


filterTypes

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

Defined in

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


rowTypes

ts
const rowTypes: DimensionRows[];

Defined in

src/store/index.ts:8


AndOrButton()

ts
function AndOrButton(__namedParameters: any): any

Parameters

ParameterType
__namedParametersany

Returns

any

Defined in

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


FilterButton()

ts
function FilterButton(__namedParameters: Props): any

Parameters

ParameterType
__namedParametersProps

Returns

any

Defined in

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


SortingSign()

ts
function SortingSign(__namedParameters: Props): any

Parameters

ParameterType
__namedParametersProps

Returns

any

Defined in

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


TrashButton()

ts
function TrashButton(): any

Returns

any

Defined in

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


addMissingItems()

ts
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

ParameterType
firstItemPositionItem
realCountnumber
virtualSizenumber
existingCollectionT
dimensionPick<DimensionSettingsState, "originItemSize" | "sizes">

Returns

VirtualPositionItem[]

Defined in

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


applyMixins()

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

Type script mixins

Parameters

ParameterType
derivedCtorany
constructorsany[]

Returns

void

Defined in

src/utils/index.ts:140


calculateDimensionData()

ts
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

ParameterType
originItemSizenumber
newSizesViewSettingSizeProp

Returns

ts
{
  indexToItem: {};
  indexes: newIndexes;
  positionIndexToItem: {};
  positionIndexes: number[];
}
NameTypeDefault valueDefined in
indexToItem{}-src/store/dimension/dimension.helpers.ts:66
indexesnumber[]newIndexessrc/store/dimension/dimension.helpers.ts:63
positionIndexToItem{}-src/store/dimension/dimension.helpers.ts:65
positionIndexesnumber[]-src/store/dimension/dimension.helpers.ts:64

Defined in

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


calculateRowHeaderSize()

ts
function calculateRowHeaderSize(
   itemsLength: number, 
   rowHeaderColumn?: RowHeaders, 
   minWidth?: number): number

Parameters

ParameterTypeDefault value
itemsLengthnumberundefined
rowHeaderColumn?RowHeadersundefined
minWidth?number50

Returns

number

Defined in

src/utils/row-header-utils.ts:4


cropCellToMax()

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

Parameters

ParameterType
cellCell
lastCellCell

Returns

Cell

Defined in

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


dispatch()

ts
function dispatch<DispatchDetail>(
   target: null | EventTarget, 
   eventName: string, 
detail?: DispatchDetail): CustomEvent<DispatchDetail>

Dispatches a custom event to a specified target element.

Type Parameters

Type ParameterDefault type
DispatchDetailany

Parameters

ParameterTypeDescription
targetnull | EventTargetThe target element to dispatch the event to.
eventNamestringThe name of the custom event.
detail?DispatchDetailOptional. The detail of the custom event.

Returns

CustomEvent<DispatchDetail>

The custom event that was dispatched.

Defined in

src/plugins/dispatcher.ts:9


dispatchByEvent()

ts
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 ParameterDefault type
DispatchDetailany

Parameters

ParameterTypeDescription
ePick<MouseEvent, "target" | "preventDefault">The original event object containing the target and preventDefault method.
eventNamestringThe name of the custom event.
detail?DispatchDetailOptional. The detail of the custom event.

Returns

CustomEvent

The custom event that was dispatched.

Defined in

src/plugins/dispatcher.ts:36


findPositionInArray()

ts
function findPositionInArray<T>(
   this: T[], 
   el: T, 
   compareFn: (el: T, el2: T) => number): number

Type Parameters

Type Parameter
T

Parameters

ParameterType
thisT[]
elT
compareFn(el: T, el2: T) => number

Returns

number

Defined in

src/utils/index.ts:22


gatherGroup()

ts
function gatherGroup<T>(
   res: T, 
   colData: ColumnGrouping, 
   collection: T, 
   level: number): T

Type Parameters

Type Parameter
T extends ColumnCollection

Parameters

ParameterTypeDefault value
resTundefined
colDataColumnGroupingundefined
collectionTundefined
levelnumber0

Returns

T

Defined in

src/utils/column.utils.ts:174


gatherGrouping()

ts
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

ParameterTypeDescription
arrayDataType[]flat data array
columnPropsColumnProp[]ids of groups
expandedExpandedOptionspotentially expanded items if present

Returns

ts
{
  childrenByGroup: pseudoGroupTest;
  depth: groupingDepth;
  oldNewIndexMap: Record<number, number>;
  sourceWithGroups: DataType[];
  trimmed: Record<number, boolean>;
}
NameTypeDefault valueDefined in
childrenByGroupRecord<string, number[]>pseudoGroupTestsrc/plugins/groupingRow/grouping.service.ts:160
depthnumbergroupingDepthsrc/plugins/groupingRow/grouping.service.ts:157
oldNewIndexMapRecord<number, number>-src/plugins/groupingRow/grouping.service.ts:159
sourceWithGroupsDataType[]-src/plugins/groupingRow/grouping.service.ts:156
trimmedRecord<number, boolean>-src/plugins/groupingRow/grouping.service.ts:158

Defined in

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


gatherTrimmedItems()

ts
function gatherTrimmedItems(trimmedItems: Trimmed): TrimmedEntity

Parameters

ParameterType
trimmedItemsTrimmed

Returns

TrimmedEntity

Defined in

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


getCellData()

ts
function getCellData(val?: any): any

Parameters

ParameterType
val?any

Returns

any

Defined in

src/utils/column.utils.ts:22


getCellDataParsed()

ts
function getCellDataParsed(model: DataType, column: ColumnRegular): any

Parameters

ParameterType
modelDataType
columnColumnRegular

Returns

any

Defined in

src/utils/column.utils.ts:39


getCellRaw()

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

Parameters

ParameterType
modelDataType
column?ColumnRegular

Returns

any

Defined in

src/utils/column.utils.ts:29


getColumnByProp()

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

Parameters

ParameterType
columnsColumnData
propColumnProp

Returns

ColumnRegular | undefined

Defined in

src/utils/column.utils.ts:239


getColumnSizes()

ts
function getColumnSizes(cols: ColumnRegular[]): ViewSettingSizeProp

Parameters

ParameterType
colsColumnRegular[]

Returns

ViewSettingSizeProp

Defined in

src/utils/column.utils.ts:81


getColumnType()

ts
function getColumnType(rgCol: ColumnRegular): DimensionCols

Get column type from column data

Parameters

ParameterType
rgColColumnRegular

Returns

DimensionCols

Defined in

src/utils/column.utils.ts:74


getColumns()

ts
function getColumns(
   columns: ColumnData, 
   level: number, 
   types?: ColumnTypes): ColumnCollection

This function is used to create a collection of columns.

Parameters

ParameterTypeDefault value
columnsColumnDataundefined
levelnumber0
types?ColumnTypesundefined

Returns

ColumnCollection

Defined in

src/utils/column.utils.ts:104


getExpanded()

ts
function getExpanded(model: DataType): any

Parameters

ParameterType
modelDataType

Returns

any

Defined in

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


getFirstItem()

ts
function getFirstItem(s: ItemsToUpdate): VirtualPositionItem

Parameters

ParameterType
sItemsToUpdate

Returns

VirtualPositionItem

Defined in

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


getGroupingName()

ts
function getGroupingName(rgRow?: DataType): any

Parameters

ParameterType
rgRow?DataType

Returns

any

Defined in

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


getItemByIndex()

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

Parameters

ParameterType
dimensionPick<DimensionIndexInput, "indexes" | "originItemSize" | "indexToItem">
indexnumber

Returns

PositionItem

Defined in

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


getItemByPosition()

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

Calculate item by position

Parameters

ParameterType
__namedParametersPick<DimensionPosition, "indexes" | "positionIndexes" | "originItemSize" | "positionIndexToItem">
posnumber

Returns

PositionItem

Defined in

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


getItems()

ts
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

ParameterTypeDefault value
optobjectundefined
opt.firstItemIndexnumberundefined
opt.firstItemStartnumberundefined
opt.maxCountnumberundefined
opt.maxSizenumberundefined
opt.origSizenumberundefined
opt.sizes?ViewSettingSizePropundefined
currentSizenumber0

Returns

VirtualPositionItem[]

Defined in

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


getLastItem()

ts
function getLastItem(s: ItemsToUpdate): VirtualPositionItem

Parameters

ParameterType
sItemsToUpdate

Returns

VirtualPositionItem

Defined in

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


getLeftRelative()

ts
function getLeftRelative(
   absoluteX: number, 
   gridPos: number, 
   offset: number): number

Parameters

ParameterType
absoluteXnumber
gridPosnumber
offsetnumber

Returns

number

Defined in

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


getParsedGroup()

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

Parameters

ParameterType
idstring

Returns

null | any[]

Defined in

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


getPhysical()

ts
function getPhysical(store: Observable<DSourceState<any, any>>, virtualIndex: number): number

get physical index by virtual

Parameters

ParameterTypeDescription
storeObservable<DSourceState<any, any>>store to process
virtualIndexnumber-

Returns

number

Defined in

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


getRange()

ts
function getRange(start?: null | Cell, end?: null | Cell): RangeArea | null

Parameters

ParameterType
start?null | Cell
end?null | Cell

Returns

RangeArea | null

Defined in

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


getScrollbarSize()

ts
function getScrollbarSize(document: Document): number

Calculate system scrollbar size

Parameters

ParameterType
documentDocument

Returns

number

Defined in

src/utils/index.ts:87


getSource()

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

Parameters

ParameterTypeDefault value
sourceDataType[]undefined
itemsnumber[]undefined
withoutGroupingbooleanfalse

Returns

Required<SourceGather>

Defined in

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


getSourceItem()

ts
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

ParameterTypeDescription
storeObservable<DSourceState<T1, T2>>store to process
virtualIndexnumbervirtual index to process

Returns

T1

Defined in

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


getSourceItemVirtualIndexByProp()

ts
function getSourceItemVirtualIndexByProp(store: Observable<DSourceState<any, any>>, prop: ColumnProp): number

Parameters

ParameterType
storeObservable<DSourceState<any, any>>
propColumnProp

Returns

number

Defined in

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


getSourcePhysicalIndex()

ts
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

ParameterType
storeObservable<DSourceState<T1, T2>>
virtualIndexnumber

Returns

number

Defined in

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


getUpdatedItemsByPosition()

ts
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

ParameterType
posnumber
itemsT
realCountnumber
virtualSizenumber
dimensionDimensionDataViewport

Returns

ItemsToUpdate

Defined in

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


getVisibleSourceItem()

ts
function getVisibleSourceItem(store: Observable<DSourceState<any, any>>): any[]

get all visible items

Parameters

ParameterTypeDescription
storeObservable<DSourceState<any, any>>store to process

Returns

any[]

Defined in

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


h()

h(sel)

ts
function h(sel: any): VNode

Parameters

ParameterType
selany

Returns

VNode

Defined in

node_modules/@stencil/core/internal/stencil-public-runtime.d.ts:553

h(sel, data)

ts
function h(sel: Node, data: null | VNodeData): VNode

Parameters

ParameterType
selNode
datanull | VNodeData

Returns

VNode

Defined in

node_modules/@stencil/core/internal/stencil-public-runtime.d.ts:554

h(sel, data)

ts
function h(sel: any, data: null | VNodeData): VNode

Parameters

ParameterType
selany
datanull | VNodeData

Returns

VNode

Defined in

node_modules/@stencil/core/internal/stencil-public-runtime.d.ts:555

h(sel, text)

ts
function h(sel: any, text: string): VNode

Parameters

ParameterType
selany
textstring

Returns

VNode

Defined in

node_modules/@stencil/core/internal/stencil-public-runtime.d.ts:556

h(sel, children)

ts
function h(sel: any, children: (undefined | null | VNode)[]): VNode

Parameters

ParameterType
selany
children(undefined | null | VNode)[]

Returns

VNode

Defined in

node_modules/@stencil/core/internal/stencil-public-runtime.d.ts:557

h(sel, data, text)

ts
function h(
   sel: any, 
   data: null | VNodeData, 
   text: string): VNode

Parameters

ParameterType
selany
datanull | VNodeData
textstring

Returns

VNode

Defined in

node_modules/@stencil/core/internal/stencil-public-runtime.d.ts:558

h(sel, data, children)

ts
function h(
   sel: any, 
   data: null | VNodeData, 
   children: (undefined | null | VNode)[]): VNode

Parameters

ParameterType
selany
datanull | VNodeData
children(undefined | null | VNode)[]

Returns

VNode

Defined in

node_modules/@stencil/core/internal/stencil-public-runtime.d.ts:559

h(sel, data, children)

ts
function h(
   sel: any, 
   data: null | VNodeData, 
   children: VNode): VNode

Parameters

ParameterType
selany
datanull | VNodeData
childrenVNode

Returns

VNode

Defined in

node_modules/@stencil/core/internal/stencil-public-runtime.d.ts:560


isActiveRange()

ts
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

ParameterType
posnumber
realSizenumber
first?PositionItem
last?PositionItem

Returns

boolean

Defined in

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


isActiveRangeOutsideLastItem()

ts
function isActiveRangeOutsideLastItem(
   pos: number, 
   virtualSize: number, 
   firstItem?: PositionItem, 
   lastItem?: PositionItem): boolean

Parameters

ParameterType
posnumber
virtualSizenumber
firstItem?PositionItem
lastItem?PositionItem

Returns

boolean

Defined in

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


isAll()

ts
function isAll(event: KeyboardEvent): boolean

Parameters

ParameterType
eventKeyboardEvent

Returns

boolean

Defined in

src/utils/key.utils.ts:95


isClear()

ts
function isClear(code: string): boolean

Parameters

ParameterType
codestring

Returns

boolean

Defined in

src/utils/key.utils.ts:62


isColGrouping()

ts
function isColGrouping(colData: ColumnRegular | ColumnGrouping): colData is ColumnGrouping

Check if column is grouping column

Parameters

ParameterType
colDataColumnRegular | ColumnGrouping

Returns

colData is ColumnGrouping

Defined in

src/utils/column.utils.ts:95


isCopy()

ts
function isCopy(event: KeyboardEvent): boolean

Parameters

ParameterType
eventKeyboardEvent

Returns

boolean

Defined in

src/utils/key.utils.ts:83


isCtrlKey()

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

Parameters

ParameterType
codenumber
platformstring

Returns

boolean

Defined in

src/utils/key.utils.ts:41


isCtrlMetaKey()

ts
function isCtrlMetaKey(code: codes): boolean

Parameters

ParameterType
codecodes

Returns

boolean

Defined in

src/utils/key.utils.ts:53


isCut()

ts
function isCut(event: KeyboardEvent): boolean

Parameters

ParameterType
eventKeyboardEvent

Returns

boolean

Defined in

src/utils/key.utils.ts:77


isEnterKeyValue()

ts
function isEnterKeyValue(key: string): boolean

Parameters

ParameterType
keystring

Returns

boolean

Defined in

src/utils/key.utils.ts:73


isFilterBtn()

ts
function isFilterBtn(e: HTMLElement): null | true | Element

Parameters

ParameterType
eHTMLElement

Returns

null | true | Element

Defined in

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


isGrouping()

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

Parameters

ParameterType
rgRow?DataType

Returns

rgRow is GroupingItem

Defined in

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


isGroupingColumn()

ts
function isGroupingColumn(column?: ColumnRegular): boolean

Parameters

ParameterType
column?ColumnRegular

Returns

boolean

Defined in

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


isHiddenStore()

ts
function isHiddenStore(pos: number): pos is -1

Parameters

ParameterType
posnumber

Returns

pos is -1

Defined in

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


isMetaKey()

ts
function isMetaKey(code: number): boolean

Parameters

ParameterType
codenumber

Returns

boolean

Defined in

src/utils/key.utils.ts:5


isPaste()

ts
function isPaste(event: KeyboardEvent): boolean

Parameters

ParameterType
eventKeyboardEvent

Returns

boolean

Defined in

src/utils/key.utils.ts:89


isRangeSingleCell()

ts
function isRangeSingleCell(a: RangeArea): boolean

Parameters

ParameterType
aRangeArea

Returns

boolean

Defined in

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


isRowType()

ts
function isRowType(type: any): type is DimensionRows

Parameters

ParameterType
typeany

Returns

type is DimensionRows

Defined in

src/store/index.ts:15


isSameGroup()

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

Parameters

ParameterType
currentGroupany[]
currentModelDataType
nextModelDataType

Returns

boolean

Defined in

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


isStretchPlugin()

ts
function isStretchPlugin(plugin: PluginBaseComponent | StretchColumn): plugin is StretchColumn

Check plugin type is Stretch

Parameters

ParameterType
pluginPluginBaseComponent | StretchColumn

Returns

plugin is StretchColumn

Defined in

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


isTab()

ts
function isTab(code: string): boolean

Parameters

ParameterType
codestring

Returns

boolean

Defined in

src/utils/key.utils.ts:66


isTabKeyValue()

ts
function isTabKeyValue(key: string): boolean

Parameters

ParameterType
keystring

Returns

boolean

Defined in

src/utils/key.utils.ts:69


measureEqualDepth()

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

Type Parameters

Type Parameter
T

Parameters

ParameterType
groupAT[]
groupBT[]

Returns

number

Defined in

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


mergeSortedArray()

ts
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

ParameterTypeDefault value
arr1T[]undefined
arr2T[]undefined
compareFn(el: T, el2: T) => booleansimpleCompare

Returns

T[]

Defined in

src/utils/index.ts:60


nextCell()

ts
function nextCell(cell: Cell, lastCell: Cell): Partial<Cell> | null

Parameters

ParameterType
cellCell
lastCellCell

Returns

Partial<Cell> | null

Defined in

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


proxyPlugin()

ts
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

ParameterType
storeObservable<State>

Returns

PluginSubscribe<State>

Defined in

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


pushSorted()

ts
function pushSorted<T>(
   arr: T[], 
   el: T, 
   fn: (el: T, el2: T) => number): T[]

Sorted push

Type Parameters

Type Parameter
T

Parameters

ParameterType
arrT[]
elT
fn(el: T, el2: T) => number

Returns

T[]

Defined in

src/utils/index.ts:47


range()

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

Parameters

ParameterTypeDefault value
sizenumberundefined
startAtnumber0

Returns

number[]

Defined in

src/utils/index.ts:12


recombineByOffset()

ts
function recombineByOffset(offset: number, data: RecombineOffsetData): ItemsToUpdate | undefined

Parameters

ParameterType
offsetnumber
dataRecombineOffsetData

Returns

ItemsToUpdate | undefined

Defined in

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


scaleValue()

ts
function scaleValue(
   value: number, 
   from: [number, number], 
   to: [number, number]): number

Parameters

ParameterType
valuenumber
from[number, number]
to[number, number]

Returns

number

Defined in

src/utils/index.ts:124


setItemSizes()

ts
function setItemSizes(
   vpItems: VirtualPositionItem[], 
   initialIndex: number, 
   size: number, 
   lastCoordinate: number): VirtualPositionItem[]

Set items sizes from start index to end

Parameters

ParameterTypeDescription
vpItemsVirtualPositionItem[]
initialIndexnumber-
sizenumber
lastCoordinatenumber

Returns

VirtualPositionItem[]

Defined in

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


setItems()

ts
function setItems<T>(store: Observable<DSourceState<T, any>>, items: number[]): void

Type Parameters

Type Parameter
T extends GDataType

Parameters

ParameterType
storeObservable<DSourceState<T, any>>
itemsnumber[]

Returns

void

Defined in

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


setSourceByPhysicalIndex()

ts
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

ParameterTypeDefault valueDescription
storeObservable<DSourceState<T, any>>undefinedstore to process
modelByIndexRecord<number, T>undefinedcollection of rows with physical indexes to setup
mutatebooleantrueif true, store will be mutated and whole viewport will be re-rendered

Returns

void

Defined in

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


setSourceByVirtualIndex()

ts
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

ParameterTypeDefault valueDescription
storeObservable<DSourceState<T, any>>undefineddata source with changes
modelByIndexRecord<number, undefined | T>undefinedcollection of rows/values with virtual indexes to setup/replace in store/data source
mutatebooleantrueif true, store will be mutated and whole viewport will be re-rendered

Returns

void

Defined in

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


setStore()

ts
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

ParameterTypeDescription
storeObservableMap<T>The store to set data on.
dataPartial<T>The data to set on the store.

Returns

void

Defined in

src/utils/store.utils.ts:13


timeout()

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

Async timeout

Parameters

ParameterTypeDefault value
delaynumber0

Returns

Promise<void>

Defined in

src/utils/index.ts:131


trimmedPlugin()

ts
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

ParameterType
storeObservable<DSourceState<T, any>>

Returns

PluginSubscribe<DSourceState<T, any>>

Defined in

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


updateMissingAndRange()

ts
function updateMissingAndRange(
   items: VirtualPositionItem[], 
   missing: VirtualPositionItem[], 
   range: Range): void

Parameters

ParameterType
itemsVirtualPositionItem[]
missingVirtualPositionItem[]
rangeRange

Returns

void

Defined in

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

Namespaces

NamespaceDescription
Components-
JSX-
hThe "h" namespace is used to import JSX types for elements and attributes. It is imported in order to avoid conflicting global JSX issues.

Enumerations

EnumerationDescription
codesLetter-
keyValues-

Interfaces

InterfaceDescription
AllDimensionTypeRepresents the mapping of dimension types to their corresponding dimension types.
ApplyFocusEventRepresents the event object that is emitted when applying focus. It includes information about the dimension type and focused cells.
BeforeCellRenderEventRepresents the event object that is emitted before cell rendering. It includes information about the dimension type, column, row, and model.
BeforeRowRenderEventRepresents the event object that is emitted before row rendering. It includes information about the dimension type, data item, item, and node.
BeforeSaveDataDetailsAdvanced column data schema model. Used for transpassing data to cell renderer and editor.
CSVFormat-
CellCell coordinates
CellTemplateInterface for custom cell renderer.
CellTemplatePropTemplate property for each cell, extends the column data schema model. Additionally, it provides access to the providers injected into the template.
ColumnGroupConfiguration for header inner template properties
ColumnPropertiesConfiguration for header inner template properties
ColumnRegularColumnRegular interface represents regular column definition. Regular column can be any column that is not a grouping column.
ColumnTemplatePropColumn template property. Contains extended properties for column.
ColumnTypeInterface for regular column definition. Regular column can be any column that is not a grouping column.
DimensionCalcObject containing information about calculated dimensions. Used for both columns and rows.
DimensionSettingsStateRepresents 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.
DragStartEventRepresents the event object that is emitted when the drag operation starts.
EditCellStoreEdit cell info for store
EditorBaseEditor interface
EditorCtrConstructibleEditor component constructible class
ElementScroll-
ExtraNodeFuncConfigExtraNodeFuncConfig is a configuration object for External nodes rendered in grid in HTMLRevogrExtraElement.
FocusAfterRenderEventRepresents the mapping of dimension types to their corresponding dimension types.
FocusRenderEventRepresents the event object that is emitted before focus rendering. It includes information about the dimension type and range area.
Formatter-
FormatterOptions-
FunctionalComponent-
Getter-
GroupConfiguration for header inner template properties
Handlers-
HyperFuncHyperFunc 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-
PluginBaseComponentInterface for plugin components
PluginServiceBase-
PositionItem-
RevoGridCustomEvent-
RevogrClipboardCustomEvent-
RevogrDataCustomEvent-
RevogrEditCustomEvent-
RevogrFilterPanelCustomEvent-
RevogrFocusCustomEvent-
RevogrHeaderCustomEvent-
RevogrOrderEditorCustomEvent-
RevogrOverlaySelectionCustomEvent-
RevogrRowHeadersCustomEvent-
RevogrScrollVirtualCustomEvent-
RevogrViewportScrollCustomEvent-
RowHeadersColumnRegular interface represents regular column definition. Regular column can be any column that is not a grouping column.
Setter-
Subscription-
ThemePackage-
VNodeA virtual DOM node
ViewportStateViewportState is an object that represents the state of a viewport.
VirtualPositionItemVirtualPositionItem is an object that represents a virtual position item in the viewport.
VnodeHtmlCustomEvent-

Type Aliases

Type aliasDescription
AfterEditEvent-
AfterRendererEventRepresents the event object that is emitted after rendering. It includes information about the dimension type.
AutoSizeColumnConfig-
BeforeEdit-
BeforeRangeSaveDataDetails-
CSVFormatter-
CellCompareFuncCellCompareFunc 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.
CellPropsAdditional properties applied to the cell. Contains properties for custom cell rendering.
ChangedRange-
ColIndex-
ColPropertiesFunc-
ColSource-
ColumnCollectionColumn collection definition. Used to access indexed data for columns. Can be accessed via different events.
ColumnData-
ColumnDataSchemaModelAdvanced column data schema model. Used for transpassing data to cell renderer and editor.
ColumnDragEventData-
ColumnFilterConfigFilter configuration for a column. This is the type of the filter property on a column.
ColumnGroupingColumnGrouping type is used to define a grouping in a column.
ColumnGroupingCollection-
ColumnItems-
ColumnProp-
ColumnPropProp-
ColumnTemplateFunc-
ColumnTypesType 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-
DimensionStoresRepresents the mapping of dimension types to their corresponding observable stores.
DimensionType-
DimensionTypeCol-
DimensionTypeRow-
DisposeEventHandler-
DragStartEventDetails-
EditCellEdit cell info for editor
EditorCtrEditor component
EditorCtrCallableEditor component callable function
EditorsAvailable editors in grid
ElementsScroll-
EventData-
ExportFormat-
ExtraField-
FilterCaptions-
FilterCollectionItem-
FilterData-
FilterItem-
FilterLocalization-
FilterType-
FocusTemplateFuncFocusTemplateFunc 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-
InitialHeaderClickInitialHeaderClick represents the information needed to handle a click event on the initial column header.
ItemsToUpdate-
LogicFunction-
LogicFunctionExtraParam-
LogicFunctionParam-
MultiDimensionType-
MultiFilterItem-
Nullable-
Observable-
OldNewRangeMapping-
Order-
PluginProvidersServices 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-
ProvidersProviders for grid which are going to be injected into each cell template
RangeRange is an object that represents a range of values.
RangeArea-
RangeAreaCss-
RangeClipboardCopyEventPropsRange copy.
RangeClipboardPasteEventRange paste.
ReadOnlyFormatThe ReadOnlyFormat type is a boolean value or a function that takes ColumnDataSchemaModel as a parameter and returns a boolean value.
ResetEventHandler-
ResizeProps-
RevogridEvents-
RowDefinitionRowDefinition is a type that represents a row definition in the viewport.
RowDrag-
RowDragStartDetails-
RowIndex-
SaveDataDetails-
ScrollCoordinateEventRepresents 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.
SelectionStoreStateRepresents 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-
VNodeResponseHyperFunc 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.
ViewPortResizeEventViewPortResizeEvent is an object that contains information about a resize event in the viewport.
ViewPortScrollEventViewPortScrollEvent is an object that contains information about a scroll event in the viewport.
ViewSettingSizePropViewSettingSizeProp is a record that maps column or row indexes to their corresponding sizes.
ViewportColumn-
ViewportData-
ViewportProperties-
ViewportProps-
ViewportStateItemsViewportStateItems is an object that represents the items in a viewport along with their corresponding range.
ViewportStoreCollection-
ViewportStoresRepresents the mapping of dimension types to their corresponding observable stores for the viewport.
WatchConfig-

Revogrid is a powerful data grid library made by Revolist OU.