RevoGrid Documentation v4.15.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:2048
applyChangesOnClose?	boolean	If true applys changes when cell closes if not Escape.	src/components.d.ts:2052
canDrag?	boolean	Enable revogr-order-editor component (read more in revogr-order-editor component). Allows D&D.	src/components.d.ts:2056
colData	Observable<DSourceState<ColumnRegular, DimensionCols>>	Column data store.	src/components.d.ts:2060
dataStore	Observable<DSourceState<DataType, DimensionRows>>	Row data store.	src/components.d.ts:2064
dimensionCol	Observable<DimensionSettingsState>	Dimension settings X.	src/components.d.ts:2068
dimensionRow?	Observable<DimensionSettingsState>	Dimension settings Y.	src/components.d.ts:2072
editors?	Editors	Custom editors register.	src/components.d.ts:2076
isMobileDevice?	boolean	Is mobile view mode.	src/components.d.ts:2080
lastCell?	Cell	Last real coordinates positions + 1.	src/components.d.ts:2084
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:2088
onBeforeapplyrange?	(event: RevogrOverlaySelectionCustomEvent<FocusRenderEvent>) => void	Before range applied. First step in triggerRangeEvent.	src/components.d.ts:2092
onBeforecellfocusinit?	(event: RevogrOverlaySelectionCustomEvent<BeforeSaveDataDetails>) => void	Before cell focus.	src/components.d.ts:2096
onBeforecellsave?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Runs before cell save. Can be used to override or cancel original save.	src/components.d.ts:2100
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:2104
onBeforeeditrender?	(event: RevogrOverlaySelectionCustomEvent<FocusRenderEvent>) => void	Before editor render.	src/components.d.ts:2108
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:2112
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:2116
onBeforenextvpfocus?	(event: RevogrOverlaySelectionCustomEvent<Cell>) => void	Fired when change of viewport happens. Usually when we switch between pinned regions.	src/components.d.ts:2120
onBeforepasteregion?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Before region paste happened.	src/components.d.ts:2124
onBeforerangecopyapply?	(event: RevogrOverlaySelectionCustomEvent<ChangedRange>) => void	Before range copy.	src/components.d.ts:2128
onBeforerangedataapply?	(event: RevogrOverlaySelectionCustomEvent<FocusRenderEvent>) => void	Range data apply.	src/components.d.ts:2132
onBeforesetrange?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Before range selection applied. Second step in triggerRangeEvent.	src/components.d.ts:2136
onBeforesettemprange?	(event: RevogrOverlaySelectionCustomEvent<{ tempRange: null | Nullable<TempRange>; } & EventData & AllDimensionType>) => void	Before set temp range area during autofill.	src/components.d.ts:2140
onCanceledit?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Cancel edit. Used for editors support when editor close requested.	src/components.d.ts:2144
onCelledit?	(event: RevogrOverlaySelectionCustomEvent<SaveDataDetails>) => void	Runs when edit finished save started, first in chain event	src/components.d.ts:2148
onCelleditapply?	(event: RevogrOverlaySelectionCustomEvent<BeforeSaveDataDetails>) => void	Cell edit apply to the data source. Triggers datasource edit on the root level.	src/components.d.ts:2152
onClipboardrangecopy?	(event: RevogrOverlaySelectionCustomEvent<RangeClipboardCopyEventProps<any>>) => void	Range copy.	src/components.d.ts:2156
onClipboardrangepaste?	(event: RevogrOverlaySelectionCustomEvent<RangeClipboardPasteEvent>) => void	Range paste event.	src/components.d.ts:2160
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:2164
onRangeeditapply?	(event: RevogrOverlaySelectionCustomEvent<BeforeRangeSaveDataDetails>) => void	Range data apply. Triggers datasource edit on the root level.	src/components.d.ts:2168
onSelectall?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Select all cells from keyboard.	src/components.d.ts:2172
onSelectionchangeinit?	(event: RevogrOverlaySelectionCustomEvent<ChangedRange>) => void	Autofill data in range. First step in applyRangeWithData	src/components.d.ts:2176
onSetedit?	(event: RevogrOverlaySelectionCustomEvent<BeforeSaveDataDetails>) => void	Set edit cell.	src/components.d.ts:2180
onSetrange?	(event: RevogrOverlaySelectionCustomEvent<RangeArea & { type: MultiDimensionType; }>) => void	Set range. Third step in triggerRangeEvent.	src/components.d.ts:2184
onSettemprange?	(event: RevogrOverlaySelectionCustomEvent<null | Nullable<TempRange>>) => void	Set temp range area during autofill.	src/components.d.ts:2188
range?	boolean	Range selection allowed.	src/components.d.ts:2192
readonly?	boolean	Readonly mode.	src/components.d.ts:2196
selectionStore	Observable<SelectionStoreState>	Selection, range, focus.	src/components.d.ts:2200
useClipboard?	boolean	Enable revogr-clipboard component (read more in revogr-clipboard component). Allows copy/paste.	src/components.d.ts:2204