SheetXL - v1.0.2
    Preparing search index...

    Interface IUpDownBars

    A line or stock chart's up/down bars: in each category a bar from the first series' value to the last's, an up bar where the last is higher and a down bar where it is not (VBA's ChartGroup.UpBars and DownBars). The series of the group share them.

    interface IUpDownBars {
        isIUpDownBars: true;
        getChart(): IChart;
        getDownBarsStyle(): IShapeStyle;
        getElementType(): IChart.ElementType;
        getGapWidth(): number;
        getParent(): IElement | null;
        getPath(): string;
        getStyle?(): IShapeStyle;
        getUpBarsStyle(): IShapeStyle;
        getVisible(): boolean;
        setGapWidth(
            gapWidth: number,
            options?: ITransaction.OperationOptions,
        ): this;
        setVisible(visible: boolean, options?: ITransaction.OperationOptions): this;
        update(
            update: IChart.IUpDownBars.Update,
            options?: ITransaction.OperationOptions,
        ): this;
    }

    Hierarchy (View Summary)

    Index
    isIUpDownBars
    getChart getDownBarsStyle getElementType getGapWidth getParent getPath getStyle? getUpBarsStyle getVisible setGapWidth setVisible update
    isIUpDownBars: true

    For runtime type checking.

    • Returns what the down bars are drawn with: fill and line. Setting it shows the bars.

      Returns IShapeStyle

    • Returns the gap between the bars, as a percentage of a bar's width; Excel's 150 where there are none.

      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 what the up bars are drawn with: fill and line. Setting it shows the bars.

      Returns IShapeStyle

    • Returns whether the bars are drawn.

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Properties
    Methods