LegendItem API
Definition
A LegendItem is an element of a Legend and consists of a color field and a text.
Description of UI Element Properties
● semantics
Determines the color of the LegendItem. The semanticsproperty can be filled with the following values and is represented by the enumeration type WDTableCellDesign.
badvalue_dark |
Dark background color that indicates a negative value. |
badvalue_light |
Light background color that indicates a negative value. |
badvalue_medium |
Medium background color that indicates a negative value. |
criticalvalue_dark |
Dark background color that indicates a critical value. |
criticalvalue_light |
Light background color that indicates a critical value. |
criticalvalue_medium |
Medium background color that indicates a critical value. |
goodvalue_dark |
Dark background color that indicates a good value. |
goodvalue_light |
Light background color that indicates a good value. |
goodvalue_medium |
Medium background color that indicates a good value. |
group_level1 |
Background color for cells of group level 1 |
group_level2 |
Background color for cells of group level 2 |
group_level3 |
Background color for cells of group level 3 |
key_medium |
Medium background color for cells of key column |
negative |
Background color that indicates a negative value. |
positive |
Background color that indicates a positive value. |
standard |
Standard background color, the same for the entire row |
one |
Color of category one, depends on the respective design theme used. |
two |
Color of category two, depends on the respective design theme used. |
three |
Color of category three, depends on the respective design theme used. |
four |
Color of category four, depends on the respective design theme used. |
The default value for this property is standard.
● text
Determines the text of the LegendItem.
● textDirection
Specifies the text direction and allows you to use a LegendItem for texts in languages which require a specific text direction. The textDirection property can be filled with the following values and is represented by the enumeration type WDTextDirection.
inherit |
The text direction is inherited from the parent element. Therefore, the text direction is identical to the one of the parent element. |
ltr |
The text runs from left to right. |
rtl |
The text runs from right to left. |
The default value for this property is inherit.
● tooltip
This property describes a note for the LegendItem that is displayed when the user places the cursor on the LegendItem.
● visible
Determines whether the LegendItem is visible.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
semantics |
IWDLegendItem |
WDTableCellDesign |
standard |
bindable |
No |
text |
IWDLegendItem |
String |
|
bindable |
No |
textDirection |
IWDLegendItem |
WDTextDirection |
inherit |
bindable |
No |
tooltip |
IWDLegendItem |
String (TranslatableText) |
|
bindable |
Noe |
visible |
IWDLegendItem |
boolean |
true |
bindable |
No |