TimelineHistogramGrouping
Mixin

Mixin for TimelineHistogram that provides record grouping support. The class implements an API to work with groups and their members and allows to rollup group members data to their parents.

The groups here are either group headers built with the Group feature or parent nodes built with the TreeGroup feature.

Parent histogram data aggregating

The mixin provides a aggregateHistogramDataForGroups config which enables automatically rolling up child records histogram data to their parents. By default all registered series' values are just summed up on parents level, but that can be changed by providing aggregate config to series:

new TimelineHistogram({
    series : {
        salary : {
           type : 'bar',
           // show maximum value on the parent level
           aggregate : 'max'
        }
    },
    ...
})

Here is the list of supported aggregate values:

sum or add - sum of values in the group (default)
min - minimum value in the group
max - maximum value in the group
count - number of child records in the group
avg - average of the child values in the group

There are a few hooks allowing customization of the rolling up process: aggregateDataEntry, getDataEntryForAggregating and initAggregatedDataEntry.

Configs

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

aggregateDataEntry : Function/String
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.
Parameters
- aggregated : Object
  
  Target parent data entry to aggregate the entry into.
- entry : Object
  
  Current entry to aggregate into aggregated.
- arrayIndex : Number
  
  Index of current array (index of the record among other records being aggregated).
- entryIndex : Object[]
  
  Index of entry in the current array.
Returns

Object
:

Return value becomes the value of the aggregated parameter on the next invocation of this function.
aggregateHistogramDataForGroups : Booleantrue

When true the component will automatically calculate data for group records based on the groups members data by calling getGroupRecordHistogramData method.
getDataEntryForAggregating : Function/String
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.
Parameters
- entry : Object
  
  Current data entry.
Returns

Object
:

Entry to aggregate
initAggregatedDataEntry : Function/String

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.

Returns

Object
:

Target aggregated entry

Properties

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

isTimelineHistogramGrouping : Booleantrue

READONLY

static

ADVANCED

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

isTimelineHistogramGrouping : Booleantrue

READONLY

ADVANCED

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

Functions

Functions are methods available for calling on the class

aggregateHistogramData( recordsData, records, aggregationContext )

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

});

getGroupChildren( record )
: Model[]

internal

For a record representing a group built by Group or TreeGroup feature returns the group members.
getRecordParent( record )
: Model

internal

For a record belonging to a group built by Group or TreeGroup feature returns the group header or parent respectively.
isGroupRecord( record )
: Boolean

internal

Indicates if the passed record represents a group header built by Group feature or a group built by TreeGroup feature.
resetGeneratedRecordsHistogramDataCache( )

Resets generated records (parents and links) data cache
scheduleRecordParentsRefresh( record, clearCachetrue )

internal

Schedules refresh of the provided record's parents. The method iterates up from the provided record parent to the root node and schedules the iterated node rows refresh.
aggregateRecordsHistogramData( records, aggregationContext )
: Object[]/Promise

ASYNC

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.
getGroupRecordHistogramData( record, aggregationContext )
: Object[]/Promise

ASYNC
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);
```

Source path

Scheduler/view/mixin/TimelineHistogramGrouping.js

TimelineHistogramGrouping
Mixin

Parent histogram data aggregating

See also

Configs

Parameters

Returns

Parameters

Returns

Returns

Properties

Functions

Source path

Inheritance tree9

Mixins24

Contents

TimelineHistogramGrouping Mixin

Parent histogram data aggregating

See also

Configs

Parameters

Returns

Parameters

Returns

Returns

Properties

Functions

Source path

Inheritance tree9

Mixins24

Contents

TimelineHistogramGrouping
Mixin