Skip to content

@urban-toolkit/autk-plot


@urban-toolkit/autk-plot / BinningEventsTransformConfig

Type Alias: BinningEventsTransformConfig ​

BinningEventsTransformConfig = object

Defined in: api.ts:145

Binning-events preset config.

The events array column is read from PlotConfig.attributes.axis[0]. Use '@transform' in axis[1] to mark the output slot. timestamp and value are sub-fields within each event object.

Properties ​

options? ​

optional options?: object

Defined in: api.ts:147

reducer? ​

optional reducer?: TransformReducer

Reducer applied within each bucket. Defaults to 'count'.

resolution? ​

optional resolution?: TransformResolution

Granularity of the time buckets. Defaults to 'month'.

timestamp? ​

optional timestamp?: string

Field within each event object that holds the timestamp. Defaults to 'timestamp'.

value? ​

optional value?: string

Field within each event object used for non-count reducers. Defaults to 'value'.


preset ​

preset: "binning-events"

Defined in: api.ts:146

Released under the MIT License.