Packagecom.flexmonster.pivot.vo
Classpublic class ConditionValueObject
InheritanceConditionValueObject Inheritance Object

The ConditionValueObject class describes the conditional formatting rule.



Public Properties
 PropertyDefined By
  column : int = -1
Column index to which the condition should be applied.
ConditionValueObject
  falseStyle : StyleValueObject
StyleValueObject object.
ConditionValueObject
  formula : String
IF statement with 3 arguments: IF(CONDITION, TRUE STYLE, FALSE STYLE), where the false style is optional.
ConditionValueObject
  hierarchy : String
Hierarchy unique name to which the condition should be applied.
ConditionValueObject
  id : String
Id of the conditional formatting rule.
ConditionValueObject
  isTotal : int = -1
If it is -1 (not defined) — the condition is applied for all cells.
ConditionValueObject
  measure : String
Measure unique name to which the condition should be applied.
ConditionValueObject
  member : String
Hierarchy's member unique name to which the condition should be applied.
ConditionValueObject
  row : int = -1
Row index to which the condition should be applied.
ConditionValueObject
  trueStyle : StyleValueObject
StyleValueObject object that will be applied to a cell if the condition for the cell value is met.
ConditionValueObject
Public Methods
 MethodDefined By
  
ConditionValueObject(formula:String, trueStyle:StyleValueObject)
Constructor for ConditionValueObject class
ConditionValueObject
  
[static] Convert object to ConditionValueObject class
ConditionValueObject
  
toObject():Object
Convert ConditionValueObject to Object
ConditionValueObject
Property Detail
columnproperty
public var column:int = -1

Column index to which the condition should be applied.

falseStyleproperty 
public var falseStyle:StyleValueObject

StyleValueObject object. If it is set it will be applied to a cell if the condition for the cell value is not met.

See also

formulaproperty 
public var formula:String

IF statement with 3 arguments: IF(CONDITION, TRUE STYLE, FALSE STYLE), where the false style is optional. Condition can contain AND, OR, ==, !=, >, <, >=, <=, +, -, /. #value is used to address the cell value in condition. Example: if(#value > 2, "trueStyle", "falseStyle").

hierarchyproperty 
public var hierarchy:String

Hierarchy unique name to which the condition should be applied.

idproperty 
public var id:String

Id of the conditional formatting rule. If id properties is not set, the id for the rule will be set inside Pivot component.

isTotalproperty 
public var isTotal:int = -1

If it is -1 (not defined) — the condition is applied for all cells. If it is 0 (false) — the condition is applied to regular cells only. If it is 1 (true) — the condition will be applied to totals and sub-totals cells only.

measureproperty 
public var measure:String

Measure unique name to which the condition should be applied.

memberproperty 
public var member:String

Hierarchy's member unique name to which the condition should be applied.

rowproperty 
public var row:int = -1

Row index to which the condition should be applied.

trueStyleproperty 
public var trueStyle:StyleValueObject

StyleValueObject object that will be applied to a cell if the condition for the cell value is met.

See also

Constructor Detail
ConditionValueObject()Constructor
public function ConditionValueObject(formula:String, trueStyle:StyleValueObject)

Constructor for ConditionValueObject class

Parameters
formula:String — formula
 
trueStyle:StyleValueObject — trueStyle
Method Detail
fromObject()method
public static function fromObject(object:Object):ConditionValueObject

Convert object to ConditionValueObject class

Parameters

object:Object — object

Returns
ConditionValueObject — ConditionValueObject object
toObject()method 
public function toObject():Object

Convert ConditionValueObject to Object

Returns
Object — object