Class: ConditionalFormat

ConditionalFormat()

new ConditionalFormat()

The conditional formatting feature allows you to apply formats to a cell or range of cells, and have that formatting change depending on the value of the cell or the value of a formula. The same way the conditional-format can be applied to item-bars, so the ConditionalFormat object provides additional methods such as: ApplyToBars and BarShape so the visual appearance of the bar can be changed based on the conditional-format. The ConditionalFormat type defines additional properties and methods of the ConditionalFormat(extree) type. Use the ConditionalFormat(id) method to get the conditional-format based on its index or identifier/key.

Methods

(static) GetApplyToBars() → {any}

The GetApplyToBars() method specifies the list of bars the current format is applied to
Returns:
Indicates the list of bars the current format is applied to
Type
any

(static) GetBarShape() → {any}

The GetBarShape() method defines the shape to apply on bars
Returns:
Returns the shape for the conditional format itself, as one of the following:
  • {null}, no custom-shape is applied
  • the shape's name within the exontrol.BarShape.Tree or exontrol.BarShape namespace
  • a CSS color
  • a JSON string-representation of an object of exontrol.Def.BarShape type, for the column itself
  • an object of {normal,hover,click,disabled} type. The normal, hover, click and disabled are objects of exontrol.Def.BarShape type
Type
any

(static) SetApplyToBars(value)

The SetApplyToBars() method applies the format to items or columns
Parameters:
Name Type Description
value any Specifies the list of bars the current format is applied to
Example
null{null}, undefined{undefined} or ""{string}, the format is not applied to a bar
 "Task,Milestone" {string}, the format is applied to bars of "Task" or "Milestone" type

(static) SetBarShape(value)

The SetBarShape() method changes the shape to apply on bars
Parameters:
Name Type Description
value any The value could be any of the following: The shape field can be any of the following:
  • {null}, no custom-shape is applied
  • the shape's name within the exontrol.BarShape.Tree or exontrol.BarShape namespace
  • a CSS color
  • a JSON string-representation of an object of exontrol.Def.BarShape type, for the column itself
  • an object of {normal,hover,click,disabled} type. The normal, hover, click and disabled are objects of exontrol.Def.BarShape type