Legend API
Definition
The Legend UI element allows you to display a descriptive text for different colors used in an assigned UI element. The Legend element can be positioned anywhere in the view and be assigned to a table or a DateNavigator.
The screen shot below shows a DatNavigator element with assigned legend.
Assigning the Legend element
· to the DateNavigator element:
In the view, after the DateNavigator element insert a Legend element and assign it to the DateNavigator element by setting the ID of the Legend element as the legendID property of the DateNavigator element.
· to the table:
You can insert a Legend element after the table and use the legendId property to assign it to the table. To position the Legend element at the bottom of the table, you can use the LegendPopin. Insert a LegendPopin into the table and a content into the LegendPopin. Then insert a Legend element into the content.
The color assignment of the LegendItem is carried out using the enumeration type WDTableCellDesign. The following properties are of this type:
· For the LegendItem, the property semantics
· For the DateNavigatorMarking, the property daySemantics
· For the table, the property cellDesign of the TableColumn.
Structure
A Legend is composed of LegendItems.
Description of UI Element Properties
· colCount
Determines the number of columns in which LegendItems are displayed.
· width
Determines the width of the Legend, which you can specify in relative CSS units like em, ex, or percentage.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
colCount |
IWDLegend |
int |
1 |
bindable |
No |
enabled |
IWDUIElement |
boolean |
true |
bindable |
No |
tooltip |
IWDUIElement |
String |
|
bindable |
No |
visible |
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
width |
IWDLegend |
String |
100% |
bindable |
No |