RevoGrid Documentation v4.25.0 / 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:2226
applyChangesOnClose?	boolean	If true applys changes when cell closes if not Escape. Default false	src/components.d.ts:2231
canDrag?	boolean	Enable revogr-order-editor component (read more in revogr-order-editor component). Allows D&D.	src/components.d.ts:2235
colData	Observable<DSourceState<ColumnRegular<ColumnProp, DataType<any, ColumnProp>>, DimensionCols>>	Column data store.	src/components.d.ts:2239
dataStore	Observable<DSourceState<DataType, DimensionRows>>	Row data store.	src/components.d.ts:2243
dimensionCol	Observable<DimensionSettingsState>	Dimension settings X.	src/components.d.ts:2247
dimensionRow?	Observable<DimensionSettingsState>	Dimension settings Y.	src/components.d.ts:2251
editors?	Editors	Custom editors register.	src/components.d.ts:2255
isMobileDevice?	boolean	Is mobile view mode.	src/components.d.ts:2259
lastCell?	Cell	Last real coordinates positions + 1.	src/components.d.ts:2263
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:2267
onBeforeapplyrange?	(event: RevogrOverlaySelectionCustomEvent<FocusRenderEvent>) => void	Before range applied. First step in triggerRangeEvent.	src/components.d.ts:2271
onBeforecellfocusinit?	(event: RevogrOverlaySelectionCustomEvent<BeforeSaveDataDetails<DataType, ColumnRegular<ColumnProp, DataType<any, ColumnProp>>>>) => void	Before cell focus.	src/components.d.ts:2275
onBeforecellsave?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Runs before cell save. Can be used to override or cancel original save.	src/components.d.ts:2279
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:2283
onBeforeeditrender?	(event: RevogrOverlaySelectionCustomEvent<FocusRenderEvent>) => void	Before editor render.	src/components.d.ts:2287
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:2291
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:2295
onBeforenextvpfocus?	(event: RevogrOverlaySelectionCustomEvent<Cell>) => void	Fired when change of viewport happens. Usually when we switch between pinned regions.	src/components.d.ts:2299
onBeforepasteregion?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Before region paste happened.	src/components.d.ts:2303
onBeforerangecopyapply?	(event: RevogrOverlaySelectionCustomEvent<ChangedRange>) => void	Before range copy.	src/components.d.ts:2307
onBeforerangedataapply?	(event: RevogrOverlaySelectionCustomEvent<FocusRenderEvent>) => void	Range data apply.	src/components.d.ts:2311
onBeforesetrange?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Before range selection applied. Second step in triggerRangeEvent.	src/components.d.ts:2315
onBeforesettemprange?	(event: RevogrOverlaySelectionCustomEvent<{ tempRange: null | Nullable<TempRange>; } & EventData & AllDimensionType>) => void	Before set temp range area during autofill.	src/components.d.ts:2319
onCanceledit?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Cancel edit. Used for editors support when editor close requested.	src/components.d.ts:2323
onCelledit?	(event: RevogrOverlaySelectionCustomEvent<SaveDataDetails>) => void	Runs when edit finished save started, first in chain event	src/components.d.ts:2327
onCelleditapply?	(event: RevogrOverlaySelectionCustomEvent<BeforeSaveDataDetails<DataType, ColumnRegular<ColumnProp, DataType<any, ColumnProp>>>>) => void	Cell edit apply to the data source. Triggers datasource edit on the root level.	src/components.d.ts:2331
onClipboardrangecopy?	(event: RevogrOverlaySelectionCustomEvent<RangeClipboardCopyEventProps<any>>) => void	Range copy.	src/components.d.ts:2335
onClipboardrangepaste?	(event: RevogrOverlaySelectionCustomEvent<RangeClipboardPasteEvent<DataType<any, ColumnProp>>>) => void	Range paste event.	src/components.d.ts:2339
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:2343
onRangeeditapply?	(event: RevogrOverlaySelectionCustomEvent<BeforeRangeSaveDataDetails>) => void	Range data apply. Triggers datasource edit on the root level.	src/components.d.ts:2347
onSelectall?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Select all cells from keyboard.	src/components.d.ts:2351
onSelectionchangeinit?	(event: RevogrOverlaySelectionCustomEvent<ChangedRange>) => void	Autofill data in range. First step in applyRangeWithData	src/components.d.ts:2355
onSetedit?	(event: RevogrOverlaySelectionCustomEvent<BeforeEdit>) => void	Set edit cell.	src/components.d.ts:2359
onSetrange?	(event: RevogrOverlaySelectionCustomEvent<RangeArea & { type: MultiDimensionType; }>) => void	Set range. Third step in triggerRangeEvent.	src/components.d.ts:2363
onSettemprange?	(event: RevogrOverlaySelectionCustomEvent<null | Nullable<TempRange>>) => void	Set temp range area during autofill.	src/components.d.ts:2367
range?	boolean	Range selection allowed.	src/components.d.ts:2371
readonly?	boolean	Readonly mode.	src/components.d.ts:2375
selectionStore	Observable<SelectionStoreState>	Selection, range, focus.	src/components.d.ts:2379
useClipboard?	boolean | ClipboardConfig	Enable revogr-clipboard component (read more in revogr-clipboard component). Allows copy/paste. Can be boolean or clipboard config.	src/components.d.ts:2383