Range (Base Model)
Property | Description | Default | Type | Required |
---|---|---|---|---|
key | String key representing the date range | None | Union[str, None] | No |
start | Specify the start for the range | None | Union[str, int, float, None] | No |
start_display | Text to show for the start range | None | Union[str, None] | No |
end | Specify the end for the range | None | Union[str, int, float, None] | No |
end_display | Text to show for the end range | None | Union[str, None] | No |
RangeAgg
Property | Description | Default | Type | Required |
---|---|---|---|---|
type | Type of aggregation | DynamicAggType.RANGE | DynamicAggType | Yes |
ranges | List of `Range` instances, representing different value ranges | List[Range] | Yes | |
ui_only | Section dedicated to UI transformation options only. Not required for regular aggregation process | None | Union[RangeAggUI, None] | No |
Warning |
---|
This aggregation should always be defined with non overlapping ranges. While functionally it might work, the number of results can be unpredictable if overlapped ranges are selected by the user. |