ResourceHistogram

A function that if provided decides whether an assignment should be taken into account or not when collecting allocation.

The function is recommended to be a generator so it can attach to the Engine and track the involved field changes automatically. It accepts two arguments: assignment record and ResourceAllocationInfo class instance collecting allocation. The instance has a special readField method that should be yielded to read the needed field value. The method also subscribes to further changes of the field triggering automatic allocation recollecting once the field gets changed:

new ResourceHistogram({
    // custom filtering function
    * assignmentFilterFn(assignment, allocationInfo) {
        // get the assignment event
        const event = yield assignment.$.event;

        // include only allocation of events having "type" field set to "Meeting"
        if (event) {
            // get "type" field value and bind to its changes
            // to refresh the histogram automatically
            const type = yield* allocationInfo.readField(event, 'type');

            return type === 'Meeting';
        }
    }
    ...
});

Default time unit used for displaying resources effort in bars. Yet the effective time unit used might change dynamically when zooming in the histogram so its ticks unit gets smaller than the default unit. Please use barTipEffortUnit to customize default units for tooltips (or effortUnit to customize both texts and tooltips default units).

Default time unit used when displaying resources effort in tooltips. Yet the effective time unit used might change dynamically when zooming in the histogram so its ticks unit gets smaller than the default unit. Please use barTextEffortUnit to customize default units for bar texts (or effortUnit to customize both texts and tooltips default units).

A Function which returns the tooltip text to display when hovering a bar. The following parameters are passed:

Specifies a format to use for displaying cost values. Default value is:

costFormat : {
    style    : 'currency',
    currency : 'USD'
},

See NumberFormat docs for details on the supported config values. Please keep in mind that currency value will be automatically set to the loaded project currency.

Effort value format string. Must be a template supported by NumberFormat class.

Default time unit to display resources effort values. The value is used as default when displaying effort in tooltips and bars text. Yet the effective time unit used might change dynamically when zooming in the histogram so its ticks unit gets smaller than the default unit. Please use barTipEffortUnit to customize default units for tooltips only and barTextEffortUnit to customize default units in bar texts.

A Function which returns a CSS class name to add to a bar's rectangle element. The following parameters are passed:

A Function which if provided returns DOM configuration object for a bar (a RECT element representing a single "bar"-type value). The function accepts default prepared DOM configuration in an argument which then can be processed and returned.

new ResourceHistogram({
    // Let's add left & right margins to bars
    getBarDOMConfig(series, domConfig) {
        // margin size is 10% of the bar width
        const xMargin = 0.1 * domConfig.width;

        // adjust the bar x-coordinate
        domConfig.x += xMargin;
        // reduce the bar width respectively
        domConfig.width -= 2 * xMargin;

        // return the edited domConfig
        return domConfig;
    },
    ...
})

new ResourceHistogram({
    getBarText(datum) {
        // "this" in the method refers core Histogram instance
        // get the view instance
        const resourceHistogram = this.owner;

        .....
    },
    ...
})

The following parameters are passed:

A Function which returns the text to render inside a bar.

Here for example the provided function displays resources time left instead of allocated time

new ResourceHistogram({
    getBarText(datum) {
        const resourceHistogram = this.owner;

        const { showBarText } = resourceHistogram;

        let result = '';

        // respect existing API - show bar texts only when "showBarText" is true
        // and if some work is done in the tick
        if (showBarText && datum.effort) {

            const unit = resourceHistogram.getBarTextEffortUnit();

            // display the resource available time
            result = resourceHistogram.getEffortText(datum.maxEffort - datum.effort, unit);
        }

        return result;
    },
})

Please note that the function will be injected into the underlying Histogram component that is used under the hood to render actual charts. So this will refer to the Histogram instance, not this class instance. To access the view please use this.owner in the function:

new ResourceHistogram({
    getBarText(datum) {
        // "this" in the method refers core Histogram instance
        // get the view instance
        const resourceHistogram = this.owner;

        .....
    },
})

The following parameters are passed:

A Function which returns a DOM configuration object for text elements.

new ResourceHistogram({
    getBarTextDOMConfig(domConfig, datum, index) {
        // Place text at the top of the "effort" bar
        // so calculate y-position in percents
        domConfig.y = `${100 * (1 - datum.effort / this.topValue)}%`;

        // also let's laid the text lines horizontally
        domConfig.style = 'writing-mode: lr';

        return domConfig;
    },
    ...
})

new ResourceHistogram({
    getBarTextDOMConfig(domConfig) {
        // "this" in the method refers core Histogram instance
        // get the view instance
        const resourceHistogram = this.owner;

        .....

        return domConfig;
    },
    ...
})

The following parameters are passed:

A Function which returns a CSS class name to add to a path element built for an outline type series. The following parameters are passed:

A Function which if provided should return a DOM configuration object for a path element built for an outline type series. The function accepts a default prepared DOM configuration in an argument which then can be processed and returned.

The following parameters are passed to the function:

Set to true to include inactive tasks allocation and false to not take such tasks into account.

Set to true to take task and assignment store filters into account when collecting allocation.

new ResourceHistogram({
    // skip filtered out events/assignments
    respectStoreFilters : true
    ...
});

Set to true if you want to display resources effort values in bars (for example: 24h, 7d, 60min etc.). The text contents can be changed by providing getBarText function.

Specifies whether effort values should display units or not.

Set to true if you want to display the maximum resource allocation line.

The default method that returns the text to render inside a bar if no getBarText function was provided.

The method can be used in a getBarText function to invoke the default implementation:

new ResourceHistogram({
    getBarText(datum) {
        const resourceHistogram = this.owner;

        // get default bar text
        let result = resourceHistogram.getBarTextDefault();

        // if the resource is overallocated in that tick display "Overallocated! " string
        // before the allocation value
        if (result && datum.maxEffort < datum.effort) {
            result = 'Overallocated! ' + result;
        }

        return result;
    },
})

The following parameters are passed:

Returns unit to display effort values in when rendering the histogram bars. The method by default returns barTextEffortUnit value if provided and if not falls back to effortUnit value. But it also takes zooming into account and when the timeaxis ticks unit gets smaller than the default value the ticks unit is returned.

Formats effort value to display in the component bars and tooltips.

Returns the provided record's allocation data. The process of allocation collecting is asynchronous so the method returns a Promise that provides the data once resolved.

The method used as the default value of getRecordData config.

The default function used for aggregating a child record histogram data values to its parent entry. The function sums up effort and maxEffort series values. It also propagates isOverallocated and isUnderallocated values so if there is a child having the corresponding value as true it will be true on the parent level as well.

All children assignments are united on the parent level assignments property.

The method is used as aggregateDataEntry default value.

The default function that initializes a target group record entry.

The method is used as initAggregatedDataEntry default value.

Generates points for the scale column.

Override the method to customize the scale column points.