RevoGrid Documentation v4.13.3 / JSX / RevogrOverlaySelection

Interface: RevogrOverlaySelection

Component for overlaying the grid with the selection.

Properties

Property	Type	Description	Defined in
additionalData?	any	Additional data to pass to renderer.	src/components.d.ts:2029
applyChangesOnClose?	boolean	If true applys changes when cell closes if not Escape.	src/components.d.ts:2033
canDrag?	boolean	Enable revogr-order-editor component (read more in revogr-order-editor component). Allows D&D.	src/components.d.ts:2037
colData	Observable<DSourceState<ColumnRegular, DimensionCols>>	Column data store.	src/components.d.ts:2041
dataStore	Observable<DSourceState<DataType, DimensionRows>>	Row data store.	src/components.d.ts:2045
dimensionCol	Observable<DimensionSettingsState>	Dimension settings X.	src/components.d.ts:2049
dimensionRow?	Observable<DimensionSettingsState>	Dimension settings Y.	src/components.d.ts:2053
editors?	Editors	Custom editors register.	src/components.d.ts:2057
isMobileDevice?	boolean	Is mobile view mode.	src/components.d.ts:2061
lastCell?	Cell	Last real coordinates positions + 1.	src/components.d.ts:2065
onApplyfocus?	(event: RevogrOverlaySelectionCustomEvent<FocusRenderEvent>) => void	Before cell get focused. To prevent the default behavior of applying the edit data, you can call e.preventDefault().	src/components.d.ts:2069
onBeforeapplyrange?	(event: RevogrOverlaySelectionCustomEvent<FocusRenderEvent>) => void	Before range applied. First step in triggerRangeEvent.	src/components.d.ts:2073
onBeforecellfocusinit?	(event: RevogrOverlaySelectionCustomEvent<BeforeSaveDataDetails>) => void	Before cell focus.	src/components.d.ts:2077
onBeforecellsave?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Runs before cell save. Can be used to override or cancel original save.	src/components.d.ts:2081
onBeforecopyregion?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Before clipboard copy happened. Validate data before copy. To prevent the default behavior of editing data and use your own implementation, call e.preventDefault().	src/components.d.ts:2085
onBeforeeditrender?	(event: RevogrOverlaySelectionCustomEvent<FocusRenderEvent>) => void	Before editor render.	src/components.d.ts:2089
onBeforekeydown?	(event: RevogrOverlaySelectionCustomEvent<{ original: KeyboardEvent; } & EventData>) => void	Before key up event proxy, used to prevent key up trigger. If you have some custom behaviour event, use this event to check if it wasn't processed by internal logic. Call preventDefault().	src/components.d.ts:2093
onBeforekeyup?	(event: RevogrOverlaySelectionCustomEvent<{ original: KeyboardEvent; } & EventData>) => void	Before key down event proxy, used to prevent key down trigger. If you have some custom behaviour event, use this event to check if it wasn't processed by internal logic. Call preventDefault().	src/components.d.ts:2097
onBeforenextvpfocus?	(event: RevogrOverlaySelectionCustomEvent<Cell>) => void	Fired when change of viewport happens. Usually when we switch between pinned regions.	src/components.d.ts:2101
onBeforepasteregion?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Before region paste happened.	src/components.d.ts:2105
onBeforerangecopyapply?	(event: RevogrOverlaySelectionCustomEvent<ChangedRange>) => void	Before range copy.	src/components.d.ts:2109
onBeforerangedataapply?	(event: RevogrOverlaySelectionCustomEvent<FocusRenderEvent>) => void	Range data apply.	src/components.d.ts:2113
onBeforesetrange?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Before range selection applied. Second step in triggerRangeEvent.	src/components.d.ts:2117
onBeforesettemprange?	(event: RevogrOverlaySelectionCustomEvent<{ tempRange: null | Nullable<TempRange>; } & EventData & AllDimensionType>) => void	Before set temp range area during autofill.	src/components.d.ts:2121
onCanceledit?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Cancel edit. Used for editors support when editor close requested.	src/components.d.ts:2125
onCelleditapply?	(event: RevogrOverlaySelectionCustomEvent<BeforeSaveDataDetails>) => void	Cell edit apply to the data source. Triggers datasource edit on the root level.	src/components.d.ts:2129
onClipboardrangecopy?	(event: RevogrOverlaySelectionCustomEvent<RangeClipboardCopyEventProps<any>>) => void	Range copy.	src/components.d.ts:2133
onClipboardrangepaste?	(event: RevogrOverlaySelectionCustomEvent<RangeClipboardPasteEvent>) => void	Range paste event.	src/components.d.ts:2137
onFocuscell?	(event: RevogrOverlaySelectionCustomEvent<ApplyFocusEvent & FocusRenderEvent>) => void	Cell get focused. To prevent the default behavior of applying the edit data, you can call e.preventDefault().	src/components.d.ts:2141
onRangeeditapply?	(event: RevogrOverlaySelectionCustomEvent<BeforeRangeSaveDataDetails>) => void	Range data apply. Triggers datasource edit on the root level.	src/components.d.ts:2145
onSelectall?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Select all cells from keyboard.	src/components.d.ts:2149
onSelectionchangeinit?	(event: RevogrOverlaySelectionCustomEvent<ChangedRange>) => void	Autofill data in range. First step in applyRangeWithData	src/components.d.ts:2153
onSetedit?	(event: RevogrOverlaySelectionCustomEvent<BeforeSaveDataDetails>) => void	Set edit cell.	src/components.d.ts:2157
onSetrange?	(event: RevogrOverlaySelectionCustomEvent<RangeArea & { type: MultiDimensionType; }>) => void	Set range. Third step in triggerRangeEvent.	src/components.d.ts:2161
onSettemprange?	(event: RevogrOverlaySelectionCustomEvent<null | Nullable<TempRange>>) => void	Set temp range area during autofill.	src/components.d.ts:2165
range?	boolean	Range selection allowed.	src/components.d.ts:2169
readonly?	boolean	Readonly mode.	src/components.d.ts:2173
selectionStore	Observable<SelectionStoreState>	Selection, range, focus.	src/components.d.ts:2177
useClipboard?	boolean	Enable revogr-clipboard component (read more in revogr-clipboard component). Allows copy/paste.	src/components.d.ts:2181