SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface ColorScaleStop

    A IConditionalFormat.Stop that also carries the color its band starts at.

    interface ColorScaleStop {
        color: string;
        exclusive?: boolean;
        type?: IConditionalFormat.ColorStopType;
        value?: string | number | IFormula;
    }

    Hierarchy (View Summary)

    • Stop
      • ColorScaleStop
    Index
    color exclusive? type? value?
    color: string

    Stop color.

    exclusive?: boolean

    Upper bound exclusivity.

    false => inclusive (>=), true => exclusive (>) If true, equality does NOT enter the upper stop/segment (exclusive upper bound). Default false matches Excel's boundary-inclusive behavior.

    false
    type?: IConditionalFormat.ColorStopType
    StopType.Num
    value?: string | number | IFormula

    The value of the stop

    • For numbers: Threshold value:
      • Num: absolute number
      • Percent: 0..100 of min..max span
      • Percentile: 0..100 quantile (requires percentile stats)
    • For formulas:
    • Formula: a formula whose result is the threshold. Authored as formula text or an ICalculation.IFormula; a rule holds it as an IFormula.

    Settings
    Member Visibility

    On This Page
    Properties