HotXLS Docs

AddCondFormatColorScale3 method

Adds an Excel 2007+ 3-stop Colour Scale conditional formatting rule over a cell range, returning the new TCondFormatRule. Cells receive a gradient fill interpolating between three colour stops: min, mid (default at the 50th percentile), and max. (Available since v2.34.0.)

Syntax

function AddCondFormatColorScale3(const ARange: WideString;
  AMinColor, AMidColor, AMaxColor: LongWord;
  AMinKind: TXLSCfValueKind = cfvMinOfRange; const AMinValue: WideString = '';
  AMidKind: TXLSCfValueKind = cfvPercentile; const AMidValue: WideString = '50';
  AMaxKind: TXLSCfValueKind = cfvMaxOfRange; const AMaxValue: WideString = ''): TCondFormatRule;
ARange WideString. Sqref string, e.g. 'A1:A10'.
AMinColor / AMidColor / AMaxColor LongWord. Three gradient anchor colours in Delphi BGR format.
AMinKind / AMidKind / AMaxKind TXLSCfValueKind. Threshold types. Mid defaults to cfvPercentile / '50' — the classic "Red–Yellow–Green" Excel preset.
AMinValue / AMidValue / AMaxValue WideString. Threshold literal text. AMidValue defaults to '50' to pair with cfvPercentile.

Example

This example colours A1:A10 with the classic Red-Yellow-Green scale.

Sheet.AddCondFormatColorScale3('A1:A10',
  $000000FF, $0000FFFF, $0000FF00);

See also