SheetXL - v1.0.2
    Preparing search index...

    Interface IErrorBars

    A series' error bars, of its values or of a scatter's x values.

    interface IErrorBars {
        isIErrorBars: true;
        getAmount(): number | null;
        getChart(): IChart;
        getElementType(): IChart.ElementType;
        getEndStyleCap(): boolean;
        getInclude(): ErrorBarsInclude;
        getMinusValuesFormula(): string | null;
        getParent(): IElement | null;
        getPath(): string;
        getPlusValuesFormula(): string | null;
        getStyle(): IShapeStyle;
        getType(): ErrorBarsType;
        getVisible(): boolean;
        setAmount(amount: number, options?: ITransaction.OperationOptions): this;
        setCustomValues(
            plus: string | ICellRange,
            minus: string | ICellRange,
            options?: ITransaction.OperationOptions,
        ): this;
        setEndStyleCap(cap: boolean, options?: ITransaction.OperationOptions): this;
        setInclude(
            include: ErrorBarsInclude,
            options?: ITransaction.OperationOptions,
        ): this;
        setType(type: ErrorBarsType, options?: ITransaction.OperationOptions): this;
        setVisible(visible: boolean, options?: ITransaction.OperationOptions): this;
        update(
            update: IChart.IErrorBars.Update,
            options?: ITransaction.OperationOptions,
        ): this;
    }

    Hierarchy (View Summary)

    Index
    isIErrorBars
    getAmount getChart getElementType getEndStyleCap getInclude getMinusValuesFormula getParent getPath getPlusValuesFormula getStyle getType getVisible setAmount setCustomValues setEndStyleCap setInclude setType setVisible update
    isIErrorBars: true

    For runtime type checking.

    • Returns the amount of a fixed value, a percentage or standard deviations; null for the other types.

      Returns number | null

    • Returns whether the bars' ends are capped.

      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 the formula of custom bars' amounts above each point, an array constant such as {1,2,3} where they are written into the chart; null for other bars.

      Returns string | null

    • Returns whether the bars are drawn.

      Returns boolean

    • Sets the amount, showing the bars.

      Parameters

      Returns this

      ExpectedError for a negative amount, or for bars of standard error or custom values.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods