Class RevHorizontalScrollDimension<BGS, BCS, SF>

Type Parameters

Hierarchy (View Summary)

RevScrollDimension<BGS>
- RevHorizontalScrollDimension

Constructors

constructor

new RevHorizontalScrollDimension<
    BGS extends RevBehavioredGridSettings,
    BCS extends RevBehavioredColumnSettings,
    SF extends RevSchemaField,
>(
    gridSettings: RevOnlyGridSettings,
    canvas: RevCanvas<BGS>,
    _columnsManager: RevColumnsManager<BCS, SF>,
): RevHorizontalScrollDimension<BGS, BCS, SF>
Type Parameters
- BGS extends RevBehavioredGridSettings
- BCS extends RevBehavioredColumnSettings
- SF extends RevSchemaField
Parameters
- gridSettings: RevOnlyGridSettings
- canvas: RevCanvas<BGS>
- _columnsManager: RevColumnsManager<BCS, SF>
Returns RevHorizontalScrollDimension<BGS, BCS, SF>
Overrides RevScrollDimension.constructor

Properties

changedEventer

changedEventer: ChangedEventer

computedEventer

computedEventer: ComputedEventer

eventBehaviorTargettedViewportStartChangedEventer

eventBehaviorTargettedViewportStartChangedEventer: ViewportStartChangedEventer

`Readonly`horizontalVertical

horizontalVertical: AxisId

scrollerTargettedViewportStartChangedEventer

scrollerTargettedViewportStartChangedEventer: ViewportStartChangedEventer

Accessors

after

get after(): number
Returns number
Inherited from RevScrollDimension.after

finish

get finish(): number
Returns number
Inherited from RevScrollDimension.finish

finishScrollAnchorLimitIndex

get finishScrollAnchorLimitIndex(): number
Returns number
Inherited from RevScrollDimension.finishScrollAnchorLimitIndex

finishScrollAnchorLimitOffset

get finishScrollAnchorLimitOffset(): number
Returns number
Inherited from RevScrollDimension.finishScrollAnchorLimitOffset

scrollable

get scrollable(): boolean
Returns boolean
Inherited from RevScrollDimension.scrollable

size

get size(): number
Returns number
Inherited from RevScrollDimension.size

start

get start(): number
Returns number
Inherited from RevScrollDimension.start

startScrollAnchorLimitIndex

get startScrollAnchorLimitIndex(): number
Returns number
Inherited from RevScrollDimension.startScrollAnchorLimitIndex

startScrollAnchorLimitOffset

get startScrollAnchorLimitOffset(): number
Returns number
Inherited from RevScrollDimension.startScrollAnchorLimitOffset

viewportCoverageExtent

get viewportCoverageExtent(): ViewportCoverageExtent
Returns ViewportCoverageExtent
Inherited from RevScrollDimension.viewportCoverageExtent

viewportFinish

get viewportFinish(): number
Returns number
Inherited from RevScrollDimension.viewportFinish

viewportSize

get viewportSize(): number
Returns number
Inherited from RevScrollDimension.viewportSize

viewportSizeExactMultiple

get viewportSizeExactMultiple(): boolean
Returns boolean
Inherited from RevScrollDimension.viewportSizeExactMultiple

viewportStart

get viewportStart(): undefined | number
Returns undefined | number
Inherited from RevScrollDimension.viewportStart

Methods

calculateColumnScrollAnchorToScrollIntoView

calculateColumnScrollAnchorToScrollIntoView(
activeColumnIndex: number,
gridRightAligned: boolean,
): Anchor
Calculate the scroll anchor to bring a column just but fully into the view. Note, only use when column is on the opposite side of scroll anchor
Parameters
- activeColumnIndex: number
  index of column to bring into view
- gridRightAligned: boolean
Returns Anchor
Scroll Anchor which will ensure the column is displayed

calculateHorizontalScrollableLeft

calculateHorizontalScrollableLeft(
columnScrollAnchorIndex: number,
columnScrollAnchorOffset: number,
): number
Parameters
- columnScrollAnchorIndex: number
- columnScrollAnchorOffset: number
Returns number

calculateLimitedScrollAnchor

calculateLimitedScrollAnchor(index: number, offset: number): Anchor
Parameters
- index: number
- offset: number
Returns Anchor
Inherited from RevScrollDimension.calculateLimitedScrollAnchor

calculateLimitedScrollAnchorFromViewportStart

calculateLimitedScrollAnchorFromViewportStart(viewportStart: number): Anchor
Parameters
- viewportStart: number
Returns Anchor

calculateLimitedScrollAnchorIfRequired

calculateLimitedScrollAnchorIfRequired(
    index: number,
    offset: number,
    gridRightAlignedPossible: boolean,
): undefined | Anchor
Parameters
- index: number
- offset: number
- gridRightAlignedPossible: boolean
Returns undefined | Anchor
Inherited from RevScrollDimension.calculateLimitedScrollAnchorIfRequired

ensureComputedInsideAnimationFrame

ensureComputedInsideAnimationFrame(): boolean
Returns boolean
Inherited from RevScrollDimension.ensureComputedInsideAnimationFrame

ensureComputedOutsideAnimationFrame

ensureComputedOutsideAnimationFrame(): boolean
Returns boolean
Inherited from RevScrollDimension.ensureComputedOutsideAnimationFrame

invalidate

invalidate(): void
Returns void
Inherited from RevScrollDimension.invalidate

isScrollAnchorWithinFinishLimit

isScrollAnchorWithinFinishLimit(index: number, offset: number): boolean
Parameters
- index: number
- offset: number
Returns boolean
Inherited from RevScrollDimension.isScrollAnchorWithinFinishLimit

isScrollAnchorWithinStartLimit

isScrollAnchorWithinStartLimit(index: number, offset: number): boolean
Parameters
- index: number
- offset: number
Returns boolean
Inherited from RevScrollDimension.isScrollAnchorWithinStartLimit

reset

reset(): void
Returns void
Inherited from RevScrollDimension.reset

setViewportStart

setViewportStart(value: undefined | number, withinAnimationFrame: boolean): void
Parameters
- value: undefined | number
- withinAnimationFrame: boolean
Returns void
Inherited from RevScrollDimension.setViewportStart