SheetXL - v1.0.2
    Preparing search index...

    Interface DataBarDecoration

    The in-cell bar a IConditionalFormat.DataBar resolves to for one cell.

    Render-ready: the value has already been placed on the bar's track, so a renderer never sees a IConditionalFormat.Stop and never re-derives the range's domain.

    interface DataBarDecoration {
        axis: number;
        axisColor?: string;
        borderColor?: string;
        color: string;
        direction: "leftToRight" | "rightToLeft";
        negativeBorderColor?: string;
        negativeColor?: string;
        showValue: boolean;
        solidFill: boolean;
        type: "dataBar";
        value: number;
    }
    Index
    axis axisColor? borderColor? color direction negativeBorderColor? negativeColor? showValue solidFill type value
    axis: number

    Where zero sits on the track, 0 to 1. 0 when the range never goes negative — the common case, and the bar then simply grows from the left.

    axisColor?: string

    The axis rule's color, resolved. Only meaningful when axis is not 0.

    borderColor?: string

    The bar's border, resolved. Absent means no border.

    color: string

    The bar's fill, resolved to a CSS color.

    direction: "leftToRight" | "rightToLeft"

    The direction the bar grows in, resolved against the cell's text direction.

    negativeBorderColor?: string

    The border for a negative bar, resolved. Absent means it reuses borderColor.

    negativeColor?: string

    The fill for a negative bar, resolved. Absent means negative bars reuse color.

    showValue: boolean

    Draw the cell's value beside the bar. When false the bar is the cell's only content.

    solidFill: boolean

    Paint the bar in color edge to edge rather than fading it toward its tip.

    type: "dataBar"
    value: number

    Where the value sits on the track, 0 (the min point) to 1 (the max point). Clamped.

    Settings
    Member Visibility

    On This Page
    Properties