@revolist/revogrid / 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:1962
applyChangesOnClose?	boolean	If true applys changes when cell closes if not Escape.	src/components.d.ts:1966
canDrag?	boolean	Enable revogr-order-editor component (read more in revogr-order-editor component). Allows D&D.	src/components.d.ts:1970
colData?	Observable<DSourceState<ColumnRegular, DimensionCols>>	Column data store.	src/components.d.ts:1974
dataStore?	Observable<DSourceState<DataType, DimensionRows>>	Row data store.	src/components.d.ts:1978
dimensionCol	Observable<DimensionSettingsState>	Dimension settings X.	src/components.d.ts:1982
dimensionRow?	Observable<DimensionSettingsState>	Dimension settings Y.	src/components.d.ts:1986
editors?	Editors	Custom editors register.	src/components.d.ts:1990
isMobileDevice?	boolean	Is mobile view mode.	src/components.d.ts:1994
lastCell?	Cell	Last real coordinates positions + 1.	src/components.d.ts:1998
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:2002
onBeforeapplyrange?	(event: RevogrOverlaySelectionCustomEvent<FocusRenderEvent>) => void	Before range applied. First step in triggerRangeEvent.	src/components.d.ts:2006
onBeforecellfocusinit?	(event: RevogrOverlaySelectionCustomEvent<BeforeSaveDataDetails>) => void	Before cell focus.	src/components.d.ts:2010
onBeforecellsave?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Runs before cell save. Can be used to override or cancel original save.	src/components.d.ts:2014
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:2018
onBeforeeditrender?	(event: RevogrOverlaySelectionCustomEvent<FocusRenderEvent>) => void	Before editor render.	src/components.d.ts:2022
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:2026
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:2030
onBeforenextvpfocus?	(event: RevogrOverlaySelectionCustomEvent<Cell>) => void	Fired when change of viewport happens. Usually when we switch between pinned regions.	src/components.d.ts:2034
onBeforepasteregion?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Before region paste happened.	src/components.d.ts:2038
onBeforerangecopyapply?	(event: RevogrOverlaySelectionCustomEvent<ChangedRange>) => void	Before range copy.	src/components.d.ts:2042
onBeforerangedataapply?	(event: RevogrOverlaySelectionCustomEvent<FocusRenderEvent>) => void	Range data apply.	src/components.d.ts:2046
onBeforesetrange?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Before range selection applied. Second step in triggerRangeEvent.	src/components.d.ts:2050
onBeforesettemprange?	(event: RevogrOverlaySelectionCustomEvent<{ tempRange: null | Nullable<TempRange>; } & EventData & AllDimensionType>) => void	Before set temp range area during autofill.	src/components.d.ts:2054
onCanceledit?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Used for editors support when editor close requested.	src/components.d.ts:2058
onCelleditapply?	(event: RevogrOverlaySelectionCustomEvent<BeforeSaveDataDetails>) => void	Cell edit apply to the data source. Triggers datasource edit on the root level.	src/components.d.ts:2062
onClipboardrangecopy?	(event: RevogrOverlaySelectionCustomEvent<RangeClipboardCopyEventProps>) => void	Range copy.	src/components.d.ts:2066
onClipboardrangepaste?	(event: RevogrOverlaySelectionCustomEvent<RangeClipboardPasteEvent>) => void	Range paste event.	src/components.d.ts:2070
onFocuscell?	(event: RevogrOverlaySelectionCustomEvent<ApplyFocusEvent>) => void	Cell get focused. To prevent the default behavior of applying the edit data, you can call e.preventDefault().	src/components.d.ts:2074
onRangeeditapply?	(event: RevogrOverlaySelectionCustomEvent<BeforeRangeSaveDataDetails>) => void	Range data apply. Triggers datasource edit on the root level.	src/components.d.ts:2078
onSelectall?	(event: RevogrOverlaySelectionCustomEvent<any>) => void	Select all.	src/components.d.ts:2082
onSelectionchangeinit?	(event: RevogrOverlaySelectionCustomEvent<ChangedRange>) => void	Selection range changed.	src/components.d.ts:2086
onSetedit?	(event: RevogrOverlaySelectionCustomEvent<BeforeSaveDataDetails>) => void	Set edit cell.	src/components.d.ts:2090
onSetrange?	(event: RevogrOverlaySelectionCustomEvent<RangeArea & { type: MultiDimensionType; }>) => void	Set range.	src/components.d.ts:2094
onSettemprange?	(event: RevogrOverlaySelectionCustomEvent<null | Nullable<TempRange>>) => void	Set temp range area during autofill.	src/components.d.ts:2098
range?	boolean	Range selection allowed.	src/components.d.ts:2102
readonly?	boolean	Readonly mode.	src/components.d.ts:2106
selectionStore?	Observable<SelectionStoreState>	Selection, range, focus.	src/components.d.ts:2110
useClipboard?	boolean	Enable revogr-clipboard component (read more in revogr-clipboard component). Allows copy/paste.	src/components.d.ts:2114