TreeSummary

A feature allowing you to roll up and display values in the time axis cell for each parent row in a tree scheduler.

This feature is disabled by default.

const scheduler = new Scheduler({
     appendTo : 'container',
     features : {
         treeSummary : {
             renderer({ startDate, endDate, resourceRecord, timeline }) {
                 let totalDemandedCapacity = 0;

                 resourceRecord.traverse(child => {
                     child.events.forEach(task => {
                         if (DateHelper.intersectSpans(task.startDate, task.endDate, startDate, endDate)) {
                             totalDemandedCapacity += task.demandedCapacity || 0;
                         }
                     });
                 }, true);

                 if (timeline.project.effectiveCalendar.isWorkingTime(startDate, endDate)) {
                     return 1 - totalDemandedCapacity;
                 }

                 return 0;
             }
         }
     }
});

Configs

Common

disabledInstancePlugin

listenersEvents

Other

enableMouseEvents: Boolean= trueAlso a property

Set to false to disallow mouse interactions with the rendered range elements. By default, the range elements are reachable with the mouse.

renderer: function

Required, renderer function for parent resource summary cells. Used to both calculate and format the summary. Should return textual content or a DomConfig object.

new Scheduler({
    features : {
        treeSummary : {
            renderer({ startDate, endDate, resourceRecord, timeline }) {
                 let totalDemandedCapacity = 0;

                 resourceRecord.traverse(node => {
                    node.events.forEach(task => {
                         if (DateHelper.intersectSpans(task.startDate, task.endDate, startDate, endDate)) {
                             totalDemandedCapacity += task.demandedCapacity || 0;
                         }
                     });
                 }, true);

                 if (timeline.project.effectiveCalendar.isWorkingTime(startDate, endDate)) {
                     return 1 - totalDemandedCapacity;
                 }

                 return 0;
            }
        }
    }
});

Parameter	Type	Description
`context`	Object	Summary context object
`context.startDate`	Date	Tick start date
`context.endDate`	Date	Tick end date
`context.resourceRecord`	ResourceModel	Resource record representing the current row
`context.eventStore`	EventStore	Event store
`context.resourceStore`	ResourceStore	Resource store
`context.timeline`	TimelineBase	The timeline/scheduler instance

Returns: String | DomConfig -

Either textual content or a DomConfig object

catchEventHandlerExceptionsEvents

Misc

bubbleEventsEvents

callOnFunctionsEvents

clientInstancePlugin

localeClassLocalizable

localizableLocalizable

localizablePropertiesLocalizable

Properties

Common

disabledInstancePlugin

Class hierarchy

isTreeSummary: Boolean= truereadonly

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

isTreeSummary: Boolean= truereadonlystatic

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

isEventsEvents

isInstancePluginInstancePlugin

isLocalizableLocalizable

Other

enableMouseEvents: Boolean= trueAlso a config

Set to false to disallow mouse interactions with the rendered range elements. By default, the range elements are reachable with the mouse.

catchEventHandlerExceptionsEvents

Lifecycle

configBase

isConstructingBase

isDestroyedBase

isDestroyingBase

Misc

callOnFunctionsEvents

clientInstancePlugin

localeHelperLocalizable

localeManagerLocalizable

Functions

destroystaticBase

doDestroyBase

setConfigBase

Misc

animatePropertyBase

callbackBase

doDisableInstancePlugin

downloadTestCaseBase

initClassstaticBase

isOfTypeNamestaticBase

mixinstaticBase

optionalLstaticLocalizable

resolveCallbackBase

updateLocalizationLocalizable

Other

addListenerEvents

hasListenerEvents

LstaticLocalizable

onEvents

relayAllEvents

removeAllListenersEvents

removeListenerEvents

resumeEventsEvents

suspendEventsEvents

triggerEvents

unEvents

Events

tickCellClick

Triggered for click on a tick cell. Only triggered if the TreeSummary feature is configured with enableMouseEvents: true.

// Adding a listener using the "on" method
treeSummary.on('tickCellClick', ({ source, feature, startDate, endDate, resourceRecord, domEvent }) => {

});

Parameter	Type	Description
`source`	Scheduler	This Scheduler
`feature`	TreeSummary	The TreeSummary feature
`startDate`	Date	Tick start date
`endDate`	Date	Tick end date
`resourceRecord`	ResourceModel	Resource record
`domEvent`	MouseEvent	Browser event

tickCellContextMenu

Triggered for right-click on a tick cell. Only triggered if the TreeSummary feature is configured with enableMouseEvents: true.

// Adding a listener using the "on" method
treeSummary.on('tickCellContextMenu', ({ source, feature, startDate, endDate, resourceRecord, domEvent }) => {

});

Parameter	Type	Description
`source`	Scheduler	This Scheduler
`feature`	TreeSummary	The TreeSummary feature
`startDate`	Date	Tick start date
`endDate`	Date	Tick end date
`resourceRecord`	ResourceModel	Resource record
`domEvent`	MouseEvent	Browser event

tickCellDblClick

Triggered for double-click on a tick cell. Only triggered if the TreeSummary feature is configured with enableMouseEvents: true.

// Adding a listener using the "on" method
treeSummary.on('tickCellDblClick', ({ source, feature, startDate, endDate, resourceRecord, domEvent }) => {

});

Parameter	Type	Description
`source`	Scheduler	This Scheduler
`feature`	TreeSummary	The TreeSummary feature
`startDate`	Date	Tick start date
`endDate`	Date	Tick end date
`resourceRecord`	ResourceModel	Resource record
`domEvent`	MouseEvent	Browser event

tickCellMouseDown

Triggered for mouse down on a tick cell. Only triggered if the TreeSummary feature is configured with enableMouseEvents: true.

// Adding a listener using the "on" method
treeSummary.on('tickCellMouseDown', ({ source, feature, startDate, endDate, resourceRecord, domEvent }) => {

});

Parameter	Type	Description
`source`	Scheduler	This Scheduler
`feature`	TreeSummary	The TreeSummary feature
`startDate`	Date	Tick start date
`endDate`	Date	Tick end date
`resourceRecord`	ResourceModel	Resource record
`domEvent`	MouseEvent	Browser event

tickCellMouseUp

Triggered for mouse up on a tick cell. Only triggered if the TreeSummary feature is configured with enableMouseEvents: true.

// Adding a listener using the "on" method
treeSummary.on('tickCellMouseUp', ({ source, feature, startDate, endDate, resourceRecord, domEvent }) => {

});

Parameter	Type	Description
`source`	Scheduler	This Scheduler
`feature`	TreeSummary	The TreeSummary feature
`startDate`	Date	Tick start date
`endDate`	Date	Tick end date
`resourceRecord`	ResourceModel	Resource record
`domEvent`	MouseEvent	Browser event

beforeDestroyEvents

catchAllEvents

destroyEvents

disableInstancePlugin

enableInstancePlugin

Event handlers

onTickCellClick

Called for click on a tick cell. Only called if the TreeSummary feature is configured with enableMouseEvents: true.

new TreeSummary({
    onTickCellClick({ source, feature, startDate, endDate, resourceRecord, domEvent }) {

    }
});

Parameter	Type	Description
`source`	Scheduler	This Scheduler
`feature`	TreeSummary	The TreeSummary feature
`startDate`	Date	Tick start date
`endDate`	Date	Tick end date
`resourceRecord`	ResourceModel	Resource record
`domEvent`	MouseEvent	Browser event

onTickCellContextMenu

Called for right-click on a tick cell. Only called if the TreeSummary feature is configured with enableMouseEvents: true.

new TreeSummary({
    onTickCellContextMenu({ source, feature, startDate, endDate, resourceRecord, domEvent }) {

    }
});

Parameter	Type	Description
`source`	Scheduler	This Scheduler
`feature`	TreeSummary	The TreeSummary feature
`startDate`	Date	Tick start date
`endDate`	Date	Tick end date
`resourceRecord`	ResourceModel	Resource record
`domEvent`	MouseEvent	Browser event

onTickCellDblClick

Called for double-click on a tick cell. Only called if the TreeSummary feature is configured with enableMouseEvents: true.

new TreeSummary({
    onTickCellDblClick({ source, feature, startDate, endDate, resourceRecord, domEvent }) {

    }
});

Parameter	Type	Description
`source`	Scheduler	This Scheduler
`feature`	TreeSummary	The TreeSummary feature
`startDate`	Date	Tick start date
`endDate`	Date	Tick end date
`resourceRecord`	ResourceModel	Resource record
`domEvent`	MouseEvent	Browser event

onTickCellMouseDown

Called for mouse down on a tick cell. Only called if the TreeSummary feature is configured with enableMouseEvents: true.

new TreeSummary({
    onTickCellMouseDown({ source, feature, startDate, endDate, resourceRecord, domEvent }) {

    }
});

Parameter	Type	Description
`source`	Scheduler	This Scheduler
`feature`	TreeSummary	The TreeSummary feature
`startDate`	Date	Tick start date
`endDate`	Date	Tick end date
`resourceRecord`	ResourceModel	Resource record
`domEvent`	MouseEvent	Browser event

onTickCellMouseUp

Called for mouse up on a tick cell. Only called if the TreeSummary feature is configured with enableMouseEvents: true.

new TreeSummary({
    onTickCellMouseUp({ source, feature, startDate, endDate, resourceRecord, domEvent }) {

    }
});

Parameter	Type	Description
`source`	Scheduler	This Scheduler
`feature`	TreeSummary	The TreeSummary feature
`startDate`	Date	Tick start date
`endDate`	Date	Tick end date
`resourceRecord`	ResourceModel	Resource record
`domEvent`	MouseEvent	Browser event

onBeforeDestroyEvents

onCatchAllEvents

onDestroyEvents

onDisableInstancePlugin

onEnableInstancePlugin

Typedefs

BryntumListenerConfigEvents

TreeSummary

Configs

Common

Other

Misc

Properties

Common

Class hierarchy

Other

Lifecycle

Misc

Functions

Configuration

Events

Lifecycle

Misc

Other

Events

Event handlers

Typedefs