SheetXL - v1.0.2
    Preparing search index...

    Interface ILegend

    The chart's legend.

    interface ILegend {
        isILegend: true;
        getChart(): IChart;
        getElementType(): IChart.ElementType;
        getLegendEntries(): readonly ILegendEntry[];
        getOverlay(): boolean;
        getParent(): IElement | null;
        getPath(): string;
        getPosition(): LegendPosition;
        getStyle(): ITextBoxStyle;
        getVisible(): boolean;
        setOverlay(overlay: boolean, options?: ITransaction.OperationOptions): this;
        setPosition(
            position: LegendPosition,
            options?: ITransaction.OperationOptions,
        ): this;
        setVisible(visible: boolean, options?: ITransaction.OperationOptions): this;
        update(
            update: IChart.ILegend.Update,
            options?: ITransaction.OperationOptions,
        ): this;
    }

    Hierarchy (View Summary)

    Index
    isILegend
    getChart getElementType getLegendEntries getOverlay getParent getPath getPosition getStyle getVisible setOverlay setPosition setVisible update
    isILegend: true

    For runtime type checking.

    • Returns the legend's entries, as drawn: one per series, or per slice of a single pie; a hidden entry is listed too.

      Returns readonly ILegendEntry[]

    • Returns whether the legend is drawn over the plot area rather than taking room beside it.

      Returns boolean

    • Returns the element this one is part of: a point's series, a gridline's axis, a legend entry's legend. The parts at the top (the title, the legend, the plot area, an axis, a series, a group) are the chart area's; the chart area has none.

      Returns IElement | null

    • Returns where the element is in its chart, as IChart.getElement takes it.

      Returns string

      A path is its parts' names joined by /, and does not change while the part is there:

      • chartArea, title, legend, legend/entries/<n>, plotArea, dataTable, and dataLabels (every series' at once);
      • axes/<primary|secondary>/<category|value|series>, and an axis's …/title, …/majorGridlines and …/minorGridlines;
      • series/<key>, and a series' …/marker, …/dataLabels, …/errorBars/<x|y>, …/trendlines/<n>, …/trendlines/<n>/label, …/points/<n>, …/points/<n>/marker and …/points/<n>/dataLabel;
      • groups/<n>, and a group's …/upDownBars, …/hiLoLines, …/dropLines and …/seriesLines.

      A series' key is its index in the file (c:idx), which an edit does not change; its place in the plot order can change. A point, a trendline, a legend entry and a group are named by their place, from 0: when one before it is removed, the path names the one that took its place.

    • Returns whether the legend is shown.

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Properties
    Methods