A data container representing the state of a port at a FolderNodeState or FoldingEdgeState.
Inheritance Hierarchy
FoldingLabelOwnerState
FoldingPortState
Remarks
When the properties of the state are changed, these changes are reflected immediately in the views.
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.NODE_TOP_ANCHOREDThe 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.NODE_RIGHT_ANCHOREDType Details
- yfiles module
- view-folding
- yfiles-umd modules
- view-folding, view-graphml, view
- Legacy UMD name
- yfiles.graph.FoldingPortState
See Also
FoldingEdgeState.sourcePort,
FoldingEdgeState.targetPort,
FolderNodeState.ports,
FolderNodeState.getFoldingPortState,
The State of Folded Elements
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.
Methods
addLabel
(text: string, layoutParameter: ILabelModelParameter, style: ILabelStyle, preferredSize: Size, tag: Object) : FoldingLabelStateAdds a FoldingLabelState to this state.
Parameters
options - Object
A map of options to pass to the method.
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 - Object
- The tag of the label.
Returns
- ↪FoldingLabelState
- The newly added FoldingLabelState.
Examples
const state = manager.getFolderNodeState(masterNode)
const style = new DefaultLabelStyle()
state.addLabel(
'Folder Label',
InteriorLabelModel.NORTH_EAST,
style,
new Size(20, 10),
null
)Defined in
Returns an IPort instance which represents this port state.
Remarks
The returned port is not present in any graph but may be passed to getViewItem to get the port state's view port in the folding view graph.
Returns
Removes all labels.