Split
Feature

This feature allows splitting the Scheduler into multiple views, either by using the cell context menu, or programmatically by calling split().

See Split for more details.

Scheduler specifics

Scheduler allows splitting by dates, either programmatically or by using the context menu.
Scheduler prevents splitting in the grid part using the context menu.
The eventDrag feature will automatically be configured to allow dragging between the clones (by setting constrainDragToTimeline to false).
Splitting is not supported in vertical mode.

Note that although Gantt is related to Scheduler, splitting is not supported in Gantt.

This feature is disabled by default. For info on enabling it, see GridFeatures.

Please note that this feature will not work with the LockRows feature.

Configs

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

relayProperties : Object<String, Boolean>
Properties whose changes should be relayed to sub-views at runtime.

Supply an object with property names as keys, and a truthy value to relay the change, or a falsy value to not relay it. The object will be merged with the default values.

In addition to the properties relayed by Grid, Scheduler also relays these:
- barMargin
- eventColor
- eventStyle
- eventLayout
- fillTicks
- resourceMargin
- snap
- tickSize
Example of supplying a custom set of properties to relay:
```
const scheduler = new Scheduler({
    features : {
        split : {
            relayProperties : {
                barMargin : false, // Do not relay barMargin changes
                myConfig : true   // Relay changes to the myConfig property
            }
        }
    }
}
```

Properties

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

isSplit : Booleantrue

READONLY

static

ADVANCED

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

isSplit : Booleantrue

READONLY

ADVANCED

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

Functions

Functions are methods available for calling on the class

split( options )
: Promise

ASYNC

ON-OWNER
Split the scheduler into two or four parts.
- Splits into two when passed direction : 'vertical', direction : 'horizontal' or atColumn, atRecord or atDate.
- Splits into four when passed direction : 'both' or atColumn/atDate and atRecord.
```
// Split horizontally (at the row in the center of the scheduler)
await scheduler.split({ direction : 'horizontal' });

// Split both ways by a specific date and resource
await schedule.split({
   atRecord : scheduler.resourceStore.getById(10),
   atDate   : new Date(2023, 5, 8)
});
```
To return to a single scheduler, call unsplit.

Note that this function is callable directly on the scheduler instance.

Events

Events are triggered for certain actions in this class and can be listened for to react to those actions in your code

split

ON-OWNER

Fired when splitting the Scheduler.

Note that this event is triggered on the owning widget:

Event handlers

Event handlers are callbacks called as a result of certain actions in this class

onSplit

ON-OWNER

Called when splitting the Scheduler.

Note that this handler is called on the owning widget:

id: split

Source path

Scheduler/feature/Split.js

Demo

examples/split

Split
Feature

Scheduler specifics

See also

Configs

Properties

Functions

Events

Event handlers

Source path

Demo

Inheritance tree4

Mixins2

Contents

Split Feature

Scheduler specifics

See also

Configs

Properties

Functions

Events

Event handlers

Source path

Demo

Inheritance tree4

Mixins2

Contents

Split
Feature