SheetXL - v1.0.2
    Preparing search index...

    Interface ILegendEntry

    One entry of the legend: a series', or a slice's (VBA's LegendEntry).

    interface ILegendEntry {
        isILegendEntry: true;
        getChart(): IChart;
        getElementType(): IChart.ElementType;
        getIndex(): number;
        getParent(): IElement | null;
        getPath(): string;
        getStyle(): ITextBoxStyle;
        getText(): string;
        getVisible(): boolean;
        setVisible(visible: boolean, options?: ITransaction.OperationOptions): this;
    }

    Hierarchy (View Summary)

    Index
    isILegendEntry: true

    For runtime type checking.

    • Returns the entry's place in the legend, from 0.

      Returns number

    • 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 the entry's style: its font, over the legend's. An entry has no fill or line of its own, so they read the legend's, and setting them throws.

      Returns ITextBoxStyle

    • Returns the entry's text.

      Returns string

    • Returns whether the entry is shown.

      Returns boolean