Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FieldChannelDef

Shape of a field definition

Hierarchy

Index

Properties

Optional aggregate

aggregate: "mean" | "sum" | "median" | "min" | "max" | "count"

Aggregation to perform of the field, if desired

Optional axis

axis: AxisDef | false

All axis settings for the channel, or false to not render an axis

Optional bin

bin: undefined | true | false

If the field should be binned

field

field: string | FieldId

String identifying field of channel FieldId is a local addition. (not in vega-lite) Subtraction types would make it easier to type this correctly

Optional legend

legend: LegendDef | false

All legend settings for the channel, or false to not render a legend

Optional scale

scale: ScaleDef

All scale settings for the channel

Optional sort

sort: "ascending" | "descending" | "none"

If the field needs to be sorted, how it should be sorted

Optional timeUnit

timeUnit: undefined | string

If the field is temporal, what granularity of time units to show, eg "year" or "yearmonth" There are too many options to enumerate here in the type definition, but the whole list is identical to the one in the vega-lite documentation

type

type: "quantitative" | "temporal" | "ordinal" | "nominal" | "Q" | "T" | "O" | "N"

Type of channel, allowed values defined by vega-lite

Generated using TypeDoc