GroupFrames
Renames or groups frames that have common attributes.
Parameters
Name | Default | Meaning |
---|---|---|
column | The attribute name to group the timeframes by | |
as | The updated name to be used | |
values | The values that must be matched in order to be renamed |
Description
This sets an attribute on each time-frame based on a filter.
It searches through each time frame, looking for any with an attribute called column.
If it finds one, and it's one of the options in the values array, the value of column is changed to the value as'.
This is commonly used after a call to timeframes to group similar times.
Example
We have the following time frames…
Start | End | Type |
---|---|---|
06:00AM | 08:00AM | PROD |
08:00AM | 08:30AM | BREAK |
08:30AM | 11:30AM | PROD |
11:30AM | 12:30AM | LUNCH |
12:30AM | 06:00PM | PROD |
06:00PM | 07:00PM | DINNER |
We don't really need to differentiate our different meal breaks (BREAK, LUNCH and DINNER), so we can use the following layer…
{ "type": "groupframes", "groupby": "Type", "as": "MEAL", "values": ["BREAK","LUNCH","DINNER"] }
This will change the group name on each of the three meal breaks to MEAL.