SchedulerScroll
Mixin

Functions for scrolling to events, dates etc. Provides methods to programmatically scroll the schedule to bring specific events, resources, or dates into view.

// Scroll an event into view with animation
scheduler.scrollEventIntoView(eventRecord, {
    animate   : true,
    highlight : true
});

Configs

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

scrollExtensionThreshold : String/DurationConfig

Specifies the maximum duration for extending the current TimeSpan to allow for smooth scrolling to an event.

This configuration determines how far the scheduler should extend the visible timespan to enable smooth scrolling. If the target event is within this duration from the current view, the scheduler will animate the scroll. If the event lies beyond this threshold, the scheduler will directly jump to it without animation.

Setting a shorter duration can enhance performance in views with many events, as it limits the number of events that need to be rendered when extending the timespan.

The value can be specified as a string or a DurationConfig object, allowing for flexible duration definitions, such as '1 week' for one week or {unit: 'week', magnitude: 1}.

Default value is the duration of the currently rendered timespan at the time of invocation.

Properties

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

isSchedulerScroll : Booleantrue

READONLY

static

ADVANCED

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

isSchedulerScroll : Booleantrue

READONLY

ADVANCED

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

Functions

Functions are methods available for calling on the class

scrollAssignmentIntoView( assignmentRecord, options )
: Promise

ASYNC

Scrolls an assignment record into the viewport.

If the resource store is a tree store, this method will also expand all relevant parent nodes to locate the event.
scrollEventIntoView( eventRecord, options )
: Promise

ASYNC

Scrolls an event record into the viewport. If the resource store is a tree store, this method will also expand all relevant parent nodes to locate the event.

This function is not applicable for events with multiple assignments, please use #scrollResourceEventIntoView instead.
scrollResourceEventIntoView( resourceRecord, eventRecord, options )
: Promise

ASYNC

Scrolls a resource event record into the viewport.

If the resource store is a tree store, this method will also expand all relevant parent nodes to locate the event.
scrollResourceIntoView( resourceRecord, options )
: Promise

ASYNC

Scrolls the specified resource into view, works for both horizontal and vertical modes.
scrollUnrenderedEventIntoView( )

private

Scrolls an unrendered event into view. Internal function used from #scrollResourceEventIntoView.

Source path

Scheduler/view/mixin/SchedulerScroll.js

Inheritance tree1

SchedulerScroll

SchedulerScroll
Mixin

See also

Configs

Properties

Functions

Source path

Inheritance tree1

Contents

SchedulerScroll Mixin

See also

Configs

Properties

Functions

Source path

Inheritance tree1

Contents

SchedulerScroll
Mixin