C

FoldingLabelState

Show Usages
A data container representing the state of a label at a FolderNodeState or FoldingEdgeState.
Inheritance Hierarchy

Remarks

When the properties of the state are changed, these changes are reflected immediately in the views.

This class cannot be instantiated

Examples

const state = manager.getFolderNodeState(masterNode)
const labelState = state.labels.get(0)
labelState.text = 'New Label Text'
const state = manager.getFolderNodeState(masterNode)
const style = new LabelStyle()
state.addLabel(
  'Folder Label',
  InteriorNodeLabelModel.TOP_RIGHT,
  style,
  new Size(20, 10),
)

See Also

Developer's Guide

API

labels, addLabel, removeLabel

Members

No filters for this type

Properties

layoutParameter

: ILabelModelParameter
Gets or sets the ILabelModelParameter used to describe the label's layout.
final

preferredSize

: Size
Gets or sets the preferred size of the label.
conversionfinal

style

: ILabelStyle
Gets or sets the style of this label.
final

tag

: ILabel['tag']
Gets or sets the tag of the label.
final

text

: string
Gets or sets the label's text.
final

Methods

adjustPreferredSize

()
Adjusts the preferredSize by querying the style for the preferred size.
final

See Also

API
preferredSize

asLabel

(): ILabel
Returns an ILabel instance which represents this label state.
The returned label is not present in any graph but may be passed to getViewItem to get the label state's view label in the folding view graph.
final

Return Value

ILabel
An ILabel instance which represents this label state.