TreeSummary
Feature

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;
             }
         }
     }
});

Useful configs and functions

Member	Description
tickCellClick	Fires on tick cell click
tickCellDblClick	Fires on tick cell double-click
tickCellContextMenu	Fires on tick cell right-click

Configs

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

enableMouseEvents : Booleantrue

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

Has a corresponding runtime enableMouseEvents property.

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;
            }
        }
    }
});

Parameters

context : Object

Summary context object
startDate : Date

Tick start date
endDate : Date

Tick end date
resourceRecord : ResourceModel

Resource record representing the current row
eventStore : EventStore

Event store
resourceStore : ResourceStore

Resource store
timeline : TimelineBase

The timeline/scheduler instance

Returns

String/DomConfig

Either textual content or a DomConfig object

Properties

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

isTreeSummary : Booleantrue

READONLY

static

ADVANCED

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

enableMouseEvents : Booleantrue

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

Has a corresponding enableMouseEvents config.
isTreeSummary : Booleantrue

READONLY

ADVANCED

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

Events

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

tickCellClick

ON-OWNER

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

Note that this event is triggered on the owning widget:
tickCellContextMenu

ON-OWNER

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

Note that this event is triggered on the owning widget:
tickCellDblClick

ON-OWNER

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

Note that this event is triggered on the owning widget:
tickCellMouseDown

ON-OWNER

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

Note that this event is triggered on the owning widget:
tickCellMouseUp

ON-OWNER

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

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

onTickCellClick

ON-OWNER

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

Note that this handler is called on the owning widget:
onTickCellContextMenu

ON-OWNER

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

Note that this handler is called on the owning widget:
onTickCellDblClick

ON-OWNER

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

Note that this handler is called on the owning widget:
onTickCellMouseDown

ON-OWNER

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

Note that this handler is called on the owning widget:
onTickCellMouseUp

ON-OWNER

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

Note that this handler is called on the owning widget:

id: treeSummary

Source path

Scheduler/feature/TreeSummary.js

Demo

examples/tree-summary

TreeSummary
Feature

Useful configs and functions

See also

Configs

Parameters

Returns

Properties

Events

Event handlers

Source path

Demo

Inheritance tree3

Mixins2

Contents

TreeSummary Feature

Useful configs and functions

See also

Configs

Parameters

Returns

Properties

Events

Event handlers

Source path

Demo

Inheritance tree3

Mixins2

Contents

TreeSummary
Feature