SymbolDescription API in JavaScript Diagram API control

Defines the textual description of a symbol

Properties

bold

boolean

Enables/disables the bold style of text

color

string

Sets the font color of a text

fill

string

Sets the fill color of a shape/path

fontFamily

string

Sets the font type of a text

fontSize

number

Defines the font size of a text

italic

boolean

Enables/disables the italic style of text

margin

MarginModel

Sets/Gets the margin of the element The margin top and bottom alone works for the symbol description

overflow

string

Defines how to handle the text when its size exceeds the given symbol size

• Wrap - Wraps the text to next line, when it exceeds its bounds
• Ellipsis - It truncates the overflown text and represents the clipping with an ellipsis
• Clip - It clips the overflow text

text

string

Defines the symbol description

textDecoration

string

Defines how the text should be decorated. For example, with underline/over line

• Overline - Decorates the text with a line above the text
• Underline - Decorates the text with an underline
• LineThrough - Decorates the text by striking it with a line
• None - Text will not have any specific decoration

wrap

string

Defines how to wrap the text

• WrapWithOverflow - Wraps the text so that no word is broken
• Wrap - Wraps the text and breaks the word, if necessary
• NoWrap - Text will no be wrapped