Skip to content

Overview

Viewport scroll component for RevoGrid

Properties

PropertyAttributeDescriptionTypeDefault
colType (required)col-type"colPinEnd" | "colPinStart" | "rgCol" | "rowHeaders"undefined
contentHeightcontent-heightHeight of inner contentnumber0
contentWidthcontent-widthWidth of inner contentnumber0
rowHeaderrow-headerEnable row headerbooleanundefined

Events

EventDescriptionType
resizeviewportViewport resizeCustomEvent<{ dimension: DimensionType; size: number; rowHeader?: boolean | undefined; }>
scrollchangeTriggered on scroll change, can be used to get information about scroll visibilityCustomEvent<{ type: DimensionType; hasScroll: boolean; }>
scrollviewportBefore scroll eventCustomEvent<{ dimension: DimensionType; coordinate: number; delta?: number | undefined; outside?: boolean | undefined; }>
scrollviewportsilentSilently scroll to coordinate Made to align negative coordinates for mobile devicesCustomEvent<{ dimension: DimensionType; coordinate: number; delta?: number | undefined; outside?: boolean | undefined; }>

Methods

applyScroll(type: DimensionType, e: UIEvent) => Promise<void>

Extra layer for scroll event monitoring, where MouseWheel event is not passing We need to trigger scroll event in case there is no mousewheel event

Parameters

NameTypeDescription
type"rgCol" | "rgRow"
eUIEvent

Returns

Type: Promise<void>

changeScroll(e: ViewPortScrollEvent, silent?: boolean) => Promise<ViewPortScrollEvent | undefined>

update on delta in case we don't know existing position or external change

Parameters

NameTypeDescription
e{ dimension: DimensionType; coordinate: number; delta?: number | undefined; outside?: boolean | undefined; }
silentboolean

Returns

Type: Promise<ViewPortScrollEvent | undefined>

setScroll(e: ViewPortScrollEvent) => Promise<void>

Parameters

NameTypeDescription
e{ dimension: DimensionType; coordinate: number; delta?: number | undefined; outside?: boolean | undefined; }

Returns

Type: Promise<void>

Slots

SlotDescription
content
"footer"footer
"header"header

Dependencies

Used by

Graph


Built with ❤️ by Revolist OU

Revogrid is a MIT-licensed open source library made by Revolist OU.