SheetXL - v1.0.2
    Preparing search index...

    Interface IPlotArea

    The plot area: where the series are drawn. Its place is the layout's; its fill and border are set here.

    interface IPlotArea {
        isIPlotArea: true;
        getChart(): IChart;
        getElementType(): IChart.ElementType;
        getHeight(): number;
        getInsideHeight(): number;
        getInsideLeft(): number;
        getInsideTop(): number;
        getInsideWidth(): number;
        getLeft(): number;
        getParent(): IElement | null;
        getPath(): string;
        getStyle(): IShapeStyle;
        getTop(): number;
        getWidth(): number;
        update(
            update: IChart.IPlotArea.Update,
            options?: ITransaction.OperationOptions,
        ): this;
    }

    Hierarchy (View Summary)

    Index
    isIPlotArea
    getChart getElementType getHeight getInsideHeight getInsideLeft getInsideTop getInsideWidth getLeft getParent getPath getStyle getTop getWidth update
    isIPlotArea: true

    For runtime type checking.

    • Returns number

    • Returns number

    • Returns the left of the area inside the axes, in px from the chart's left; 0 without a layout.

      Returns number

    • Returns number

    • Returns number

    • Returns the left of the plot area, axis labels included, in px from the chart's left; 0 without a layout.

      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 number

    • Returns number

    Settings
    Member Visibility

    On This Page
    Properties
    Methods