@jsfkit/types
    Preparing search index...

    Type Alias ChartLegend

    The chart legend.

    type ChartLegend = {
        hiddenEntries?: ChartLegendEntryRef[];
        layout?: ChartManualLayout;
        overlay?: boolean;
        position?: "left" | "right" | "top" | "bottom" | "topRight";
        scale?: string;
        shape?: Shape;
        textStyle?: ChartTextStyle;
    }
    Index

    Properties

    hiddenEntries?: ChartLegendEntryRef[]

    Legend entries that have been deleted, each identified by what it shows rather than by its position, so the entries stay right whatever order the legend lists them in. When absent, no entries are hidden.

    Manual position and size of the legend. When absent, they're automatic.

    overlay?: boolean

    Whether the legend overlaps the plot area instead of taking space from it. When false, space is made for the legend at its position, whether or not a layout has moved it from there. When true, no space is made, and the plot area takes that space too.

    false
    
    position?: "left" | "right" | "top" | "bottom" | "topRight"

    Which side of the chart the legend is on. topRight is the top-right corner.

    "right"
    
    scale?: string

    A scale that the legend shows, named by its id, for example a color gradient.

    When absent, the legend lists one entry per series, ordered by chart type, then by ChartPlot.axisGroup (primary before secondary), then by series order (see ChartSeries.order). Chart types rank by where their first plot appears in Chart.plots, and line and area count as one type. For a plot where ChartPlot.varyColors takes effect, it lists one entry per data point of the drawn series instead, as Excel does for pie charts. Each trendline adds its own entry.

    shape?: Shape

    Fill and outline of the legend. By default, there are none.

    textStyle?: ChartTextStyle

    Text style of the legend entries. By default, they're 9pt tx1 65%/35% in the minor font. See ChartTextStyle.