SchedulerState

Properties

isSchedulerState: Boolean= truereadonly

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

isSchedulerState: Boolean= truereadonlystatic

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

state: Object

Gets or sets scheduler's state. Check out SchedulerState mixin and GridState for more details.

Fired before state is applied to the source. Allows editing the state object or preventing the operation.

// Adding a listener using the "on" method
schedulerState.on('beforeStateApply', ({ state }) => {

});

Parameter	Type	Description
`state`	SchedulerStateInfo	State object config

Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.

// Adding a listener using the "on" method
schedulerState.on('beforeStateSave', ({ state }) => {

});

Parameter	Type	Description
`state`	SchedulerStateInfo	State object config

Called before state is applied to the source. Allows editing the state object or preventing the operation.

new SchedulerState({
    onBeforeStateApply({ state }) {

    }
});

Parameter	Type	Description
`state`	SchedulerStateInfo	State object config

Called before state is saved by the StateProvider. Allows editing the state object or preventing the operation.

new SchedulerState({
    onBeforeStateSave({ state }) {

    }
});

Parameter	Type	Description
`state`	SchedulerStateInfo	State object config

An object which encapsulates a Scheduler's saved state.