ApiDatabar

Class representing a data bar conditional formatting rule.

ApiDatabar is a subclass of ApiFormatCondition.

Properties

Name	Type	Description
AxisPosition	XlDataBarAxisPosition	Returns or sets the axis position of the data bar conditional formatting rule.
BarFillType	XlDataBarFillType	Returns or sets the bar fill type of the data bar.
Direction	XlReadingOrder	Returns or sets the direction of the data bar.
Formula	string	Returns the formula of the data bar.
MaxPoint	object	Returns the maximum value condition of the data bar.
MinPoint	object	Returns the minimum value condition of the data bar.
NegativeBarColor	ApiColor	Returns or sets the negative bar color of the data bar.
NegativeBorderColor	ApiColor	Returns or sets the negative bar border color of the data bar.
PercentMax	number	Returns or sets the percent maximum value of the data bar.
PercentMin	number	Returns or sets the percent minimum value of the data bar.
ShowValue	boolean	Returns or sets whether the data bar shows or hides the cell value.
Type	XlFormatConditionType	Returns the type of the data bar conditional formatting rule.

Methods

The following table lists the available methods.

Method	Returns	Description
Delete	None	Deletes the data bar conditional formatting rule.
GetAppliesTo	ApiRange	Returns the range of cells to which the current conditional formatting rule applies.
GetAxisColor	ApiColor | null	Returns the axis color of the data bar conditional formatting rule.
GetAxisPosition	XlDataBarAxisPosition	Returns the axis position of the data bar conditional formatting rule.
GetBarBorderColor	ApiColor | null	Returns the bar border color of the data bar.
GetBarColor	ApiColor | null	Returns the bar color of the data bar.
GetBarFillType	XlDataBarFillType	Returns the bar fill type of the data bar.
GetDateOperator	XlTimePeriods | null	Returns the date operator for time period conditions.
GetDirection	XlReadingOrder	Returns the direction of the data bar.
GetFillColor	ApiColor | 'No Fill'	Returns the background color for the format condition.
GetFont	ApiFont | null	Returns the font applied by the current format condition.
GetFormula	string	Returns the formula of the data bar.
GetFormula1	string	Returns the first formula used by the current conditional formatting rule.
GetFormula2	string	Returns the second formula used by the current conditional formatting rule.
GetMaxPointType	XlConditionValueTypes | null	Returns the type of the maximum value condition for the data bar.
GetMaxPointValue	string | number | null	Returns the value of the maximum value condition for the data bar.
GetMinPointType	XlConditionValueTypes | null	Returns the type of the minimum value condition for the data bar.
GetMinPointValue	string | number | null	Returns the value of the minimum value condition for the data bar.
GetNegativeBarColor	ApiColor | null	Returns the negative bar color of the data bar.
GetNegativeBorderColor	ApiColor | null	Returns the negative bar border color of the data bar.
GetNumberFormat	string	Returns the number format applied to a cell when the conditional formatting rule evaluates to true.
GetOperator	XlFormatConditionOperator	Returns the format condition operator.
GetPTCondition	PTCondition | null	Returns the pivot table condition object.
GetParent	ApiRange	Returns the parent range object of the current format condition.
GetPercentMax	number	Returns the percent maximum value of the data bar.
GetPercentMin	number	Returns the percent minimum value of the data bar.
GetPriority	number	Returns the priority value of the conditional formatting rule.
GetScopeType	XlPivotConditionScope	Returns the scope type of the conditional formatting rule.
GetShowValue	boolean	Returns whether the data bar displays the cell value.
GetStopIfTrue	boolean	Returns whether the editor will stop evaluating additional formatting rules if this rule evaluates to true. This rule type cannot stop the evaluation, so the value can be changed only by opening a file where it is set.
GetText	string	Returns the text value used in text-based conditional formatting rules.
GetTextOperator	XlContainsOperator | null	Returns the text operator for text-based conditional formatting rules.
GetType	XlFormatConditionType	Returns the type of the data bar conditional formatting rule.
Modify	ApiFormatCondition | null	Modifies the current format condition with the specified parameters.
ModifyAppliesToRange	None	Modifies the cell range to which the current conditional formatting rule applies.
SetAxisColor	None	Sets the axis color for the data bar conditional formatting rule.
SetAxisPosition	None	Sets the axis position for the data bar conditional formatting rule.
SetBarBorderColor	None	Sets the bar border color for the data bar.
SetBarColor	None	Sets the bar color for the data bar.
SetBarFillType	None	Sets the bar fill type for the data bar.
SetBorders	None	Sets the border style for the conditional formatting rule.
SetDateOperator	None	Sets the date operator for time period conditions.
SetDirection	None	Sets the direction for the data bar.
SetFillColor	None	Sets the background color to the format condition with the previously created color object.
SetFirstPriority	None	Sets the priority value for the current conditional formatting rule to "1" so that it will be evaluated before all other rules on the worksheet.
SetLastPriority	None	Sets the evaluation order for the current conditional formatting rule so it is evaluated after all other rules on the worksheet.
SetMaxPointType	None	Sets the type for the maximum value condition for the data bar.
SetMaxPointValue	None	Sets the value for the maximum value condition for the data bar.
SetMinPointType	None	Sets the type for the minimum value condition for the data bar.
SetMinPointValue	None	Sets the value for the minimum value condition for the data bar.
SetNegativeBarColor	None	Sets the negative bar color for the data bar.
SetNegativeBorderColor	None	Sets the negative bar border color for the data bar.
SetNumberFormat	None	Sets the number format applied to a cell when the conditional formatting rule evaluates to true.
SetPercentMax	None	Sets the percent maximum value for the data bar.
SetPercentMin	None	Sets the percent minimum value for the data bar.
SetPriority	None	Sets the priority value for the conditional formatting rule.
SetScopeType	None	Sets the scope type for the conditional formatting rule.
SetShowValue	None	Specifies whether the data bar displays the cell value.
SetStopIfTrue	None	Sets whether the editor will stop evaluating additional formatting rules if this rule evaluates to true.
SetText	None	Sets the text value used in text-based conditional formatting rules.
SetTextOperator	None	Sets the text operator for text-based conditional formatting rules.