A data container representing the state of a port at a FolderNodeState or FoldingEdgeState.
Remarks
When the properties of the state are changed, these changes are reflected immediately in the views.
This class cannot be instantiated
Examples
Ports at folder nodes should be retrieved from the ports collection of its owner.
const state = manager.getFolderNodeState(masterNode)
const portState = state.ports.get(0)
portState.locationParameter = FreeNodePortLocationModel.TOPThe source and target ports of an edge should be retrieved from the sourcePort and targetPort properties of the edge.
const state = manager.getFoldingEdgeState(
new FoldingEdgeStateId(
masterEdge,
masterSource,
true,
masterTarget,
false,
),
)
const portState = state.sourcePort
portState.locationParameter = FreeNodePortLocationModel.RIGHTType Details
- yFiles module
- view
See Also
Properties
Gets the FoldingLabelStates owned by this state.
Examples
const state = manager.getFolderNodeState(masterNode)
const labelState = state.labels.get(0)
labelState.text = 'New Label Text'const state = manager.getFolderNodeState(masterNode)
const labelState = state.labels.get(0)
labelState.text = 'New Label Text'Defined in
Gets or sets the IPortLocationModelParameter describing the position of this port.
Gets or sets the style of this port.
Gets the type of port this state represents.
Methods
addLabel
(text: string, layoutParameter?: ILabelModelParameter, style?: ILabelStyle, preferredSize?: Size, tag?: ILabel['tag']) : FoldingLabelStateAdds a FoldingLabelState to this state.
Parameters
A map of options to pass to the method.
- text - string
- The text of the new label.
- layoutParameter - ILabelModelParameter
- The layout parameter of the new label.
- style - ILabelStyle
- The style of the new label.
- preferredSize - Size
- The preferred size of the label.
- tag - ILabel['tag']
- The tag of the label.
Returns
- ↪FoldingLabelState
- The newly added FoldingLabelState.
Examples
const state = manager.getFolderNodeState(masterNode)
const style = new LabelStyle()
state.addLabel(
'Folder Label',
InteriorNodeLabelModel.TOP_RIGHT,
style,
new Size(20, 10),
)Defined in
Returns an IPort instance which represents this port state.
Remarks
Returns
Removes all labels.
Defined in
Removes the label from its owning FoldingLabelOwnerState.
Parameters
A map of options to pass to the method.
- label - FoldingLabelState
- The label to remove.