@jsfkit/types
    Preparing search index...

    Type Alias ChartEncoding

    Maps data fields to visual channels.

    A plot's encoding names every field its mark reads, so no one has to rely on field names. The channels each mark needs, besides series:

    Mark Channels
    bar, line, area x and y: the category (or X) and the value. Bins add x2.
    point x and y. A bubble plot adds size.
    arc x (the slice names) and angle (the slice sizes).
    candlestick x (the category). Series feed open, high, low, or close.
    surface x and y, and z when the chart has a series axis.
    boxplot, waterfall x (the category) and y (the value).
    funnel y (the category) and x (the value).
    treemap, sunburst None: their hierarchy transform names the level and value fields.
    Index

    Properties

    Slice size in pie and doughnut charts. The slices are named by x.

    Closing value in a candlestick plot.

    Maps a field to a color through a scale, for example a series name through an ordinal scale with explicit colors.

    When absent, colors are automatic: each series gets a theme accent color (see ChartSeries.colorIndex), or, when ChartPlot.varyColors is set, each data point does.

    Highest value in a candlestick plot.

    Lowest value in a candlestick plot.

    Opening value in a candlestick plot. Each stock series feeds one of open, high, low, and close through its own encoding.

    Distance from the center in a plot with polar coordinates.

    Says that the plot separates its records by series. It's always { field: 'series' }: every evaluated record holds its series' ChartSeries.key in the reserved series field. This channel has no scale.

    Bubble size.

    Label text: the field whose values data labels show when their show list includes cellRange (Excel's "Value From Cells"). The field's binding has the label role and the formula of the source range.

    Horizontal position, usually the category field. In a plot with polar coordinates (an arc plot), which has no horizontal axis, x names the slices: the category field. This keeps the category on the same channel as in bar and line plots, so changing a chart between pie and bar only changes the mark.

    End of a horizontal range that starts at x. A histogram's bars run from each bin's start (x) to its end (x2).

    Vertical position, usually the value field. In a horizontal bar chart, and in a funnel, y is the category instead, and x the value.

    End of a vertical range that starts at y.

    Depth position in a 3D chart. A 3D column chart with standard grouping places each series in its own row, front to back, by encoding the series field here.