This functionality is only available for certain module packages.

You are here: Reference > GRAPH2D > Tags > figureLabel

figureLabel

The element <figureLabel> displays a label on a component. A label displays usually an attribute or the value of a parameter of the component and can be combined with the icon of the component. The visibility of the text and icons can be controlled separately.

Note:

This figure is derived from figureBase and inherits its properties.

Attribute name Usage Attribute values Default value Description
direction optional NSEW Specifies the router ID of the router, which shall be used for the current <node> element, if it has an own connection layer.
rotate optional YES
NO
NO Specifies, whether movement and rotation of the object are coupled:
YES = movement and rotation are coupled
YES = movement and rotation are not coupled
rotateWithMaster required YES
NO
YES Specifies, whether master and slave rotate simultaneous.
YES = master and slave rotate smultaneous
NO = the slave keeps its orientation, if the master rotates
figure required com.mind8.graph2d.figure.Label
Allowed sub-elements Quantity
configuration 0 or 1
properties 0 or 1
property id="?" Values for read/write Description
autoSlaveBoColor 0,0,0 to 255,255,255 Border color of an automatically inserted slave node
bColor 0,0,0 to 255,255,255 Background color as RGB value
boColor 0,0,0 to 255,255,255 Border color as RGB value
boLineStyle 1, 2, 3, 4, 5 1 = solid line (default)
2 = dashed line
3 = dotted line
4 = dash-dot line
5 = dash-dot-dot line
boMargin Minimum distance of the graphical objects to the border in pixels
boWidth Border width in pixels
cornerRadius Radius of rounded corners in pixels. Only integers are allowed.
font Font-style-size Font type, style, and size for displaying text
fontBColor 0,0,0 to 255,255,255 Background color as RGB value of the non-selected label
fontFColor 0,0,0 to 255,255,255 Text color as RGB value of the non-selected label
fontSelectedBColor 0,0,0 to 255,255,255 Background color as RGB value of the selected label
fontSelectedFColor 0,0,0 to 255,255,255 Text color as RGB value of the selected label
height Height of the graphical object in pixels
highlightBoColor 0,0,0 to 255,255,255 Border color of slave nodes as an RGB value, if the associated master node is marked
isDeletable true, false Erasability of the object
true = deletable
false = not deletable
isStandaloneMode true, false
layout
locationX Horizontal position of the graphical object in pixels
locationY Vertical position of the graphical object in pixels
prefHeight Predefined height of the graphical object in pixels
At present, the height depends on the content and can not be predefined.
prefWidth Predefined width of the graphical object in pixels
At present, the width depends on the content and can not be predefined.
resizable true, false Changeability of the size. At present, the height and width depend on the content and can not be modified manually.
true = size is modifiable
true = size is fixed
selectable true, false Specifies, if the graphical object can be selected
true = object can be selected
false = object can not be selected
selectedBColor 0,0,0 to 255,255,255 Background color as RGB value, if the graphical object is marked
selectedBoColor 0,0,0 to 255,255,255 Border color as RGB value, if the graphical object is marked
selectedFColor 0,0,0 to 255,255,255 Font color as RGB value, if the graphical object is marked
showLabel true, false Specifies the visibility of the label
true = label is displayed
false = label is not displayed
showText true, false Specifies the visibility of the text in the label
true = text is displayed
false = text is not displayed
showIcon true, false Specifies the visibility of the icon in the label
true = icon is displayed
false = icon is not displayed
showLabelIcon true, false Specifies the icon, which is to be displayed in the label
true = icon of the label is displayed
true = icon of the label is not displayed
showLabelText true, false Specifies, if the text of a label is to be displayed
true = text of the label is displayed
true = text of the label is not displayed
sourceLabelFont Font-style-size Font type, style and size for displaying the label text at the starting point
targetLabelFont Font-style-size Font type, style and size for displaying the label text at the end point
text Text or formula, which determines a text, which is to be displayed in the label
textAlignment left, center, right Alignment of the label text
left = left-aligned
center = centered
right = right-aligned
tooltip Text or formula, which determines a text, which is to be displayed as tooltip
transparency 0 through 100 Transparency of the graphical object
0 = opaque
100 = transparent
visible true, false Specifies the visibility of the graphical object
true = object is visible
true = object is invisible

Note:

Follow the sequence:

Within <figureBase>, <figureContainer>, <figureEllipse>, <figureImage>, <figureLabel> and <figurePolygon> first configure <configuration> and then <properties>.