PivotConditionalFormat

PivotConditionalFormat class

Represents a PivotTable Format Condition in PivotFormatCondition Collection.

class PivotConditionalFormat;

Methods

Method	Description
getPivotAreas()	Gets all pivot areas.
getFormatConditions()	Get conditions for the pivot table conditional format .
getScopeType()	Get and set scope type for the pivot table conditional format .
setScopeType(PivotConditionFormatScopeType)	Get and set scope type for the pivot table conditional format .
getRuleType()	Get and set rule type for the pivot table condition format .
setRuleType(PivotConditionFormatRuleType)	Get and set rule type for the pivot table condition format .
getCellAreas()	Gets all cell areas where this conditional format applies to.
addCellArea(CellArea)	Adds an area based on pivot table view.
addFieldArea(PivotFieldType, string)	Adds an area of pivot field.
addFieldArea(PivotFieldType, PivotField)	Adds an area of pivot field.
isNull()	Checks whether the implementation object is null.

getPivotAreas()

Gets all pivot areas.

getPivotAreas() : PivotAreaCollection;

Returns

PivotAreaCollection

getFormatConditions()

Get conditions for the pivot table conditional format .

getFormatConditions() : FormatConditionCollection;

Returns

FormatConditionCollection

getScopeType()

Get and set scope type for the pivot table conditional format .

getScopeType() : PivotConditionFormatScopeType;

Returns

PivotConditionFormatScopeType

setScopeType(PivotConditionFormatScopeType)

Get and set scope type for the pivot table conditional format .

setScopeType(value: PivotConditionFormatScopeType) : void;

Parameters:

Parameter	Type	Description
value	PivotConditionFormatScopeType	The value to set.

getRuleType()

Get and set rule type for the pivot table condition format .

getRuleType() : PivotConditionFormatRuleType;

Returns

PivotConditionFormatRuleType

setRuleType(PivotConditionFormatRuleType)

Get and set rule type for the pivot table condition format .

setRuleType(value: PivotConditionFormatRuleType) : void;

Parameters:

Parameter	Type	Description
value	PivotConditionFormatRuleType	The value to set.

getCellAreas()

Gets all cell areas where this conditional format applies to.

getCellAreas() : CellArea[];

Returns

CellArea[]

addCellArea(CellArea)

Adds an area based on pivot table view.

addCellArea(ca: CellArea) : void;

Parameters:

Parameter	Type	Description
ca	CellArea	The cell area.

addFieldArea(PivotFieldType, string)

Adds an area of pivot field.

addFieldArea(axisType: PivotFieldType, fieldName: string) : void;

Parameters:

Parameter	Type	Description
axisType	PivotFieldType	The region type.
fieldName	string	The name of pivot field.

addFieldArea(PivotFieldType, PivotField)

Adds an area of pivot field.

addFieldArea(axisType: PivotFieldType, field: PivotField) : void;

Parameters:

Parameter	Type	Description
axisType	PivotFieldType	The region type.
field	PivotField	The pivot field.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;