Edit

Share via


Excel.Interfaces.RangeFillData interface

An interface describing the data returned by calling rangeFill.toJSON().

Remarks

Used by

Properties

color

HTML color code representing the color of the background, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange")

pattern

The pattern of a range. See Excel.FillPattern for details. LinearGradient and RectangularGradient are not supported. A null value indicates that the entire range doesn't have a uniform pattern setting.

patternColor

The HTML color code representing the color of the range pattern, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange").

patternTintAndShade

Specifies a double that lightens or darkens a pattern color for the range fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A null value indicates that the range doesn't have uniform patternTintAndShade settings.

tintAndShade

Specifies a double that lightens or darkens a color for the range fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A null value indicates that the range doesn't have uniform tintAndShade settings.

Property Details

color

HTML color code representing the color of the background, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange")

color?: string;

Property Value

string

Remarks

API set: ExcelApi 1.1

pattern

The pattern of a range. See Excel.FillPattern for details. LinearGradient and RectangularGradient are not supported. A null value indicates that the entire range doesn't have a uniform pattern setting.

pattern?: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient";

Property Value

Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient"

Remarks

API set: ExcelApi 1.9

patternColor

The HTML color code representing the color of the range pattern, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange").

patternColor?: string;

Property Value

string

Remarks

API set: ExcelApi 1.9

patternTintAndShade

Specifies a double that lightens or darkens a pattern color for the range fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A null value indicates that the range doesn't have uniform patternTintAndShade settings.

patternTintAndShade?: number;

Property Value

number

Remarks

API set: ExcelApi 1.9

tintAndShade

Specifies a double that lightens or darkens a color for the range fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A null value indicates that the range doesn't have uniform tintAndShade settings.

tintAndShade?: number;

Property Value

number

Remarks

API set: ExcelApi 1.9