SchedulerScroll

Configs

1

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

2
isSchedulerScroll: Boolean= truereadonly
Identifies an object as an instance of SchedulerScroll class, or subclass thereof.
isSchedulerScroll: Boolean= truereadonlystatic
Identifies an object as an instance of SchedulerScroll class, or subclass thereof.

Functions

4

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.

ParameterTypeDescription
assignmentRecordAssignmentModel

Assignment record

optionsBryntumScrollOptions

How to scroll.

Returns: Promise -

A Promise which resolves when the scrolling is complete.

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.

ParameterTypeDescription
eventRecordEventModel

the event record to scroll into view

optionsBryntumScrollOptions

How to scroll.

Returns: Promise -

A Promise which resolves when the scrolling is complete.

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.

ParameterTypeDescription
resourceRecordResourceModel

The resource record

eventRecordEventModel

An event record to scroll into view

optionsBryntumScrollOptions

How to scroll.

Returns: Promise -

A Promise which resolves when the scrolling is complete.

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

ParameterTypeDescription
resourceRecordResourceModel

A resource record

optionsBryntumScrollOptions

How to scroll.

Returns: Promise -

A promise which is resolved when the scrolling has finished.