ProjectConsumer
Mixin

Creates a Project using any configured stores, and sets the stores configured into the project into the host object.

No results

Configs

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

destroyStores : Boolean

Configure as true to destroy the Project and stores when this is destroyed.
project : ProjectModel/ProjectModelConfig

A ProjectModel instance or a config object. The project holds all Scheduler data. Can be omitted in favor of individual store configs or crudManager config.

Note: In SchedulerPro the project is instance of SchedulerPro.model.ProjectModel class.

Has a corresponding runtime project property.

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

isProjectConsumer : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of ProjectConsumer class, or subclass thereof.
project : ProjectModel/ProjectModelConfig

A ProjectModel instance or a config object. The project holds all Scheduler data. Can be omitted in favor of individual store configs or crudManager config.

Note: In SchedulerPro the project is instance of SchedulerPro.model.ProjectModel class.

Has a corresponding project config.
isEngineReady : Boolean

READONLY

Returns true if engine is in a stable calculated state, false otherwise.

Functions are methods available for calling on the class

updateProject( project )

Implement in subclass to take action when project is replaced.

super.updateProject(...arguments) must be called first.
whenProjectReady( callback )

Accepts a callback that will be called when the underlying project is ready (no commit pending and current commit finalized)

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

dataChange

Fired when data in any of the projects stores changes.

Basically a relayed version of each store's own change event, decorated with which store it originates from. See the store change event documentation for more information.

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

onDataChange

Called when data in any of the projects stores changes.

Basically a relayed version of each store's own change event, decorated with which store it originates from. See the store change event documentation for more information.

Scheduler/data/mixin/ProjectConsumer.js