TimelineHistogramGrouping

A function used for aggregating child records histogram data entries to their parent entry.

It's called for each child entry and is meant to apply the child entry values to the target parent entry (provided in aggregated parameter). The function must return the resulting aggregated entry that will be passed as aggregated parameter to the next aggregating step.

Should be provided as a function, or name of a function in the ownership hierarchy which may be called.

When true the component will automatically calculate data for group records based on the groups members data by calling getGroupRecordHistogramData method.

Function that extracts a record histogram data entry for aggregating. By default it returns the entry as is. Override the function if you need a more complex way to retrieve the value for aggregating.

Should be provided as a function, or the name of a function in the ownership hierarchy which may be called.

A function that initializes a target group record entry.

Should be provided as a function, or name of a function in the ownership hierarchy which may be called.

Aggregates collected child records data to its parent. The method is synchronous and is called when all the child records data is ready. Override the method if you need to preprocess or postprocess parent records aggregated data:

class MyHistogramView extends TimelineHistogram({

    aggregateHistogramData(recordsData, records, aggregationContext) {
        const result = super.aggregateHistogramData(recordsData, records, aggregationContext);

        // postprocess averageSalary series values collected for a parent record
        result.forEach(entry => {
            entry.averageSalary = entry.averageSalary / records.length;
        });

        return result;
    }

});

Resets generated records (parents and links) data cache

Aggregates multiple records histogram data. If some of the provided records data is not ready yet the method returns a Promise that's resolved once the data is ready and aggregated.

Aggregates the provided group record children histogram data. If some of the provided records data is not ready yet the method returns a Promise that's resolved once the data is ready and aggregated.

// get parent record aggregated histogram data
const aggregatedData = await histogram.getGroupRecordHistogramData(record);