ILabelConfig
Configuration options for labeling conditions.
export interface ILabelConfig
Properties
Property | Modifiers | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
string | (Optional) This property specify the label of the equals comparison value
| ||||||||||
boolean | (Optional) This property specifies whether to use the unconditional value for all conditions or separate values for each condition. | ||||||||||
string | (Optional) This property specify the label of the negative comparison | ||||||||||
string | (Optional) This property specify the label of the positive comparison value | ||||||||||
string | (Optional) Specifies the label to be used for the comparison value. |
Property details
ILabelConfig.equalsproperty
This property specify the label of the equals comparison value
Primary is equals Secondary
| Calculation type | Default label |
| change | No change |
| difference | No difference |
| ratio | (Not applicable) |
equals?: string;
ILabelConfig.isConditionalproperty
This property specifies whether to use the unconditional value for all conditions or separate values for each condition.
isConditional?: boolean;
Default Value
false
ILabelConfig.negativeproperty
This property specify the label of the negative comparison
Primary is less than Secondary
negative?: string;
Default Value
based on the calculation type
| Calculation type | Default label |
| change | Decrease |
| difference | Decrease |
| ratio | (Not applicable) |
ILabelConfig.positiveproperty
This property specify the label of the positive comparison value
Primary is larger than Secondary
positive?: string;
Default Value
based on the calculation type
| Calculation type | Default label |
| change | Increase |
| difference | Increase |
| ratio | (Not applicable) |
ILabelConfig.unconditionalValueproperty
Specifies the label to be used for the comparison value.
unconditionalValue?: string;
Remarks
The default value is based on the calculation type:
| Calculation Type | Default value |
|---|---|
| change | Change |
| ratio | of |
| difference | Difference |
| change_difference | Change |