TimelineScroll
Mixin

Functions for scrolling to events, dates etc.

Note: the mixin applies TimelineZoomable mixin if it's not applied yet.

// Scroll to a specific date with animation
scheduler.scrollToDate(new Date(2024, 5, 15), {
    block   : 'center',
    animate : true
});

Configs

Configs are options you supply in a configuration object when creating an instance of this class

bufferCoef : Number5

ADVANCED

This config defines the size of the start and end invisible parts of the timespan when infiniteScroll set to true.

It should be provided as a coefficient, which will be multiplied by the size of the scheduling area.

For example, if bufferCoef is 5 and the panel view width is 200px then the timespan will be calculated to have approximately 1000px (5 * 200) to the left and 1000px to the right of the visible area, resulting in 2200px of totally rendered content.
bufferThreshold : Number0.2

ADVANCED

This config defines the scroll limit, which, when exceeded will cause a timespan shift. The limit is calculated as the panelWidth * bufferCoef * bufferThreshold. During scrolling, if the left or right side has less than that of the rendered content - a shift is triggered.

For example if bufferCoef is 5 and the panel view width is 200px and bufferThreshold is 0.2, then the timespan will be shifted when the left or right side has less than 200px (5 * 200 * 0.2) of content.
infiniteScroll : Boolean

Set to true to automatically adjust the panel timespan during scrolling in the time dimension, when the scroller comes close to the start/end edges.

The actually rendered timespan in this mode (and thus the amount of HTML in the DOM) is calculated based on the bufferCoef option, and is thus not controlled by the startDate and endDate configs. The moment when the timespan shift happens is determined by the bufferThreshold value.

To specify initial point in time to view, supply the visibleDate config.

If you activate lazy loading you get an infinitely scrollable timeline with lazy loading of content.

Has a corresponding runtime infiniteScroll property.

Properties

Properties are getters/setters or publicly accessible variables on this class

isTimelineScroll : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of TimelineScroll class, or subclass thereof.

isTimelineScroll : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of TimelineScroll class, or subclass thereof.
infiniteScroll : Boolean

Set to true to automatically adjust the panel timespan during scrolling in the time dimension, when the scroller comes close to the start/end edges.

The actually rendered timespan in this mode (and thus the amount of HTML in the DOM) is calculated based on the bufferCoef option, and is thus not controlled by the startDate and endDate configs. The moment when the timespan shift happens is determined by the bufferThreshold value.

To specify initial point in time to view, supply the visibleDate config.

If you activate lazy loading you get an infinitely scrollable timeline with lazy loading of content.

Has a corresponding infiniteScroll config.
scrollLeft : Number

Get/set the scrollLeft value of the SubGrid that holds the scheduler.

This may be negative when the writing direction is right-to-left.
scrollTop : Number

Get/set vertical scroll
scrollX : Number

Get/set the writing direction agnostic horizontal scroll position.

This is always the positive offset from the scroll origin whatever the writing direction in use.

Applies to the SubGrid that holds the scheduler
timelineScroller : Scroller

READONLY
A Scroller which scrolls the time axis in whatever mode the Scheduler is configured, either horizontal or vertical.

The width and height dimensions are replaced by size. So this will expose the following properties:
- clientSize The size of the time axis viewport.
- scrollSize The full scroll size of the time axis viewport
- position The position scrolled to along the time axis viewport

Functions

Functions are methods available for calling on the class

calculateInfiniteScrollingDateRange( date, centered, preset )
: Object

internal

Used to calculate the range to extend the TimeAxis to during infinite scroll.
scrollHorizontallyTo( x, options )
: Promise

ASYNC

Horizontal scrolling. Applies to the SubGrid that holds the scheduler
scrollTo( x, optionstrue )
: Promise

ASYNC

Scrolls the subgrid that contains the scheduler
scrollToCoordinate( localCoordinate, target, date, options )
: Promise

private

ASYNC

Used by scrollToDate to scroll to correct coordinate.
scrollToDate( date, options )
: Promise

ASYNC

Scrolls the timeline "tick" encapsulating the passed Date into view according to the passed options.
scrollToNow( options )
: Promise

ASYNC

Scrolls to current time.
scrollVerticallyTo( y, optionstrue )
: Promise

ASYNC

Vertical scrolling

Source path

Scheduler/view/mixin/TimelineScroll.js

Inheritance tree1

TimelineScroll

TimelineScroll
Mixin

See also

Configs

Properties

Functions

Source path

Inheritance tree1

Contents

TimelineScroll Mixin

See also

Configs

Properties

Functions

Source path

Inheritance tree1

Contents

TimelineScroll
Mixin