PatternFill

PatternFill class

Encapsulates the object that represents pattern fill format

class PatternFill;

Properties

PropertyTypeDescription
patternFillPatternGets or sets the fill pattern type
backgroundColorColorGets or sets the background Color of the Area.
backgroundCellsColorCellsColorGets and sets the foreground CellsColor object.
foregroundColorColorGets or sets the foreground Color.
foregroundCellsColorCellsColorGets and sets the foreground CellsColor object.
foreTransparencynumberGets or sets the transparency of foreground color.
backTransparencynumberGets or sets the transparency of background color.

Methods

MethodDescription
getPattern()@deprecated. Please use the ‘pattern’ property instead. Gets or sets the fill pattern type
setPattern(FillPattern)@deprecated. Please use the ‘pattern’ property instead. Gets or sets the fill pattern type
getBackgroundColor()@deprecated. Please use the ‘backgroundColor’ property instead. Gets or sets the background Color of the Area.
setBackgroundColor(Color)@deprecated. Please use the ‘backgroundColor’ property instead. Gets or sets the background Color of the Area.
getBackgroundCellsColor()@deprecated. Please use the ‘backgroundCellsColor’ property instead. Gets and sets the foreground CellsColor object.
setBackgroundCellsColor(CellsColor)@deprecated. Please use the ‘backgroundCellsColor’ property instead. Gets and sets the foreground CellsColor object.
getForegroundColor()@deprecated. Please use the ‘foregroundColor’ property instead. Gets or sets the foreground Color.
setForegroundColor(Color)@deprecated. Please use the ‘foregroundColor’ property instead. Gets or sets the foreground Color.
getForegroundCellsColor()@deprecated. Please use the ‘foregroundCellsColor’ property instead. Gets and sets the foreground CellsColor object.
setForegroundCellsColor(CellsColor)@deprecated. Please use the ‘foregroundCellsColor’ property instead. Gets and sets the foreground CellsColor object.
getForeTransparency()@deprecated. Please use the ‘foreTransparency’ property instead. Gets or sets the transparency of foreground color.
setForeTransparency(number)@deprecated. Please use the ‘foreTransparency’ property instead. Gets or sets the transparency of foreground color.
getBackTransparency()@deprecated. Please use the ‘backTransparency’ property instead. Gets or sets the transparency of background color.
setBackTransparency(number)@deprecated. Please use the ‘backTransparency’ property instead. Gets or sets the transparency of background color.
isNull()Checks whether the implementation object is null.

pattern

Gets or sets the fill pattern type

pattern : FillPattern;

backgroundColor

Gets or sets the background Color of the Area.

backgroundColor : Color;

backgroundCellsColor

Gets and sets the foreground CellsColor object.

backgroundCellsColor : CellsColor;

foregroundColor

Gets or sets the foreground Color.

foregroundColor : Color;

foregroundCellsColor

Gets and sets the foreground CellsColor object.

foregroundCellsColor : CellsColor;

foreTransparency

Gets or sets the transparency of foreground color.

foreTransparency : number;

backTransparency

Gets or sets the transparency of background color.

backTransparency : number;

getPattern()

@deprecated. Please use the ‘pattern’ property instead. Gets or sets the fill pattern type

getPattern() : FillPattern;

Returns

FillPattern

setPattern(FillPattern)

@deprecated. Please use the ‘pattern’ property instead. Gets or sets the fill pattern type

setPattern(value: FillPattern) : void;

Parameters:

ParameterTypeDescription
valueFillPatternThe value to set.

getBackgroundColor()

@deprecated. Please use the ‘backgroundColor’ property instead. Gets or sets the background Color of the Area.

getBackgroundColor() : Color;

Returns

Color

setBackgroundColor(Color)

@deprecated. Please use the ‘backgroundColor’ property instead. Gets or sets the background Color of the Area.

setBackgroundColor(value: Color) : void;

Parameters:

ParameterTypeDescription
valueColorThe value to set.

getBackgroundCellsColor()

@deprecated. Please use the ‘backgroundCellsColor’ property instead. Gets and sets the foreground CellsColor object.

getBackgroundCellsColor() : CellsColor;

Returns

CellsColor

setBackgroundCellsColor(CellsColor)

@deprecated. Please use the ‘backgroundCellsColor’ property instead. Gets and sets the foreground CellsColor object.

setBackgroundCellsColor(value: CellsColor) : void;

Parameters:

ParameterTypeDescription
valueCellsColorThe value to set.

getForegroundColor()

@deprecated. Please use the ‘foregroundColor’ property instead. Gets or sets the foreground Color.

getForegroundColor() : Color;

Returns

Color

setForegroundColor(Color)

@deprecated. Please use the ‘foregroundColor’ property instead. Gets or sets the foreground Color.

setForegroundColor(value: Color) : void;

Parameters:

ParameterTypeDescription
valueColorThe value to set.

getForegroundCellsColor()

@deprecated. Please use the ‘foregroundCellsColor’ property instead. Gets and sets the foreground CellsColor object.

getForegroundCellsColor() : CellsColor;

Returns

CellsColor

setForegroundCellsColor(CellsColor)

@deprecated. Please use the ‘foregroundCellsColor’ property instead. Gets and sets the foreground CellsColor object.

setForegroundCellsColor(value: CellsColor) : void;

Parameters:

ParameterTypeDescription
valueCellsColorThe value to set.

getForeTransparency()

@deprecated. Please use the ‘foreTransparency’ property instead. Gets or sets the transparency of foreground color.

getForeTransparency() : number;

setForeTransparency(number)

@deprecated. Please use the ‘foreTransparency’ property instead. Gets or sets the transparency of foreground color.

setForeTransparency(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getBackTransparency()

@deprecated. Please use the ‘backTransparency’ property instead. Gets or sets the transparency of background color.

getBackTransparency() : number;

setBackTransparency(number)

@deprecated. Please use the ‘backTransparency’ property instead. Gets or sets the transparency of background color.

setBackTransparency(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;