@jsfkit/types
    Preparing search index...

    Type Alias ChartSeries

    A logical series.

    type ChartSeries = {
        barShape?: ChartBarShape;
        bindings?: Record<string, ChartFieldBinding>;
        colorIndex?: integer;
        encoding?: Partial<ChartEncoding>;
        errorBars?: ChartErrorBars[];
        explosion?: integer;
        filteredPoints?: ChartFilteredPoint[];
        hidden?: boolean;
        id: string;
        invertIfNegative?: boolean;
        key?: ChartValue;
        labels?: ChartDataLabels;
        marker?: ChartMarker;
        name?: ChartText;
        order?: integer;
        pictureOptions?: ChartPictureOptions;
        points?: ChartDataPoint[];
        shaded?: boolean;
        shape?: Shape;
        smooth?: boolean;
        trendlines?: ChartTrendline[];
    }
    Index

    Properties

    barShape?: ChartBarShape

    Shape of the bars in a 3D bar series. Overrides the plot's bar shape. When absent, the plot's bar shape applies.

    bindings?: Record<string, ChartFieldBinding>

    Where this series' values come from, keyed by dataset field. These bindings define the series' data, and override the dataset's binding for the same field.

    Each series usually has its own value range here, for example { value: { formula: 'Sheet1!$B$2:$B$3', role: 'value' } }.

    colorIndex?: integer

    Index that picks the series' automatic color from the theme accents. It can differ from order. When absent, it's the series' position in the chart's series order, counting from 0.

    encoding?: Partial<ChartEncoding>

    Field mappings that override the plot's encoding, for example to give one series a different category field.

    errorBars?: ChartErrorBars[]

    Error bars on the series. A scatter, bubble, or area series can have one set for each direction, and other series one set. When absent, there are none.

    explosion?: integer

    How far pie slices are pulled out from the center, as a percentage of the radius (0-400).

    0
    
    filteredPoints?: ChartFilteredPoint[]

    Overrides for points in categories that are filtered out with Excel's chart filter, so they come back when the filter is removed. These points have no index, because they aren't in the series' records, so each is keyed by the cell reference of its value.

    hidden?: boolean

    Whether the series is filtered out with Excel's chart filter. A hidden series stays in the chart with its data, formatting, and order, but it isn't drawn, isn't in the legend, and doesn't count toward the automatic title. It comes back when the filter is removed.

    false
    
    id: string

    Identifies the series within the chart. Legend entry references name it, and the series' key defaults to it.

    invertIfNegative?: boolean

    Whether bars with negative values use inverted colors.

    false
    

    The value of the series field in this series' evaluated records. Records are in source point order, so the Nth record of a series is the point that ChartDataPoint.index N refers to.

    Usually the same as id. They differ when two series read the same records, such as a Pareto line, which has its own id but its owner's key.

    the series' id

    Data labels for this series. They override the plot's labels property by property: each property left out comes from the plot's labels.

    marker?: ChartMarker

    Markers on the series' points, in line, scatter, and radar charts. When absent, the plot decides whether the series shows markers.

    name?: ChartText

    The series name. When absent, the series has no name of its own, and an application shows a generated one, such as "Series1".

    order?: integer

    The series' position in the chart's series order.

    The order is chart-wide: in a chart with several plots, a series in one plot can come between two series in another. It decides where the series sits within its plot (for example, its place in a cluster or a stack), and the order of the chart's series in Excel's Select Data dialog.

    Rules:

    • Values are unique across the chart, but don't have to be consecutive.
    • Each plot lists its series in ascending order.
    • Either every series in the chart has an order, or none does. When none does, the order is each plot's series list in turn, in the order of Chart.plots.
    • Only the relative order matters. When that's the same as the order without order, an importer leaves order out.
    pictureOptions?: ChartPictureOptions

    How a picture fill is applied to the bars or areas of this series.

    points?: ChartDataPoint[]

    Overrides for individual data points. Each sets only what it changes for its point.

    shaded?: boolean

    Whether bubbles in this series are shaded to look like spheres.

    false
    
    shape?: Shape

    Fill and outline of the series. The defaults use the series' automatic color (see colorIndex). A series of a line, candlestick, or point plot has no fill and a 2.25pt line with round caps and joins. Bubbles, the ribbons of 3D line charts, and other series have a fill and no line.

    smooth?: boolean

    Whether a line series is drawn as a smooth curve.

    false
    
    trendlines?: ChartTrendline[]

    Trendlines fitted to the series. When absent, there are none.