A data holder that can be used to describe a folding edge that connects to nodes inside a collapsed group or to other folder nodes in a IFoldingView.
Remarks
Instances of this type are passed to the various methods in FoldingManager to identify different possible states of an edge inside IFoldingViews. A folding edge is identified through the master edge, which is an edge in the masterGraph and a source and target node. Also whether those source and target nodes are currently folder nodes needs to be taken into account.
The source and target nodes need to be the nodes in the masterGraph which represent the source and target nodes of the view edge, i.e. either the true owners of the adjacent edge's sourcePort and targetPort respectively, or ancestor group nodes in the masterGraph. In the latter case these folding edges are used to describe the state of the folding edges that are present in the views of the corresponding group nodes are in collapsed state, so that the true source and target nodes are not currently visible in the view. As such the currentMasterSource and currentMasterTarget nodes represent the masters of the nearest ancestors in the masterGraph that are visible in the folding view graph.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.graph.FoldingEdgeStateId
See Also
Sample Graphs
Constructors
FoldingEdgeStateId
(masterEdge: IEdge, currentMasterSource: INode, sourceCollapsed: boolean, currentMasterTarget: INode, targetCollapsed: boolean)Initializes an id for a folding edge in a view that represent a master edge and connects a specific pair of nodes.
Remarks
Parameters
A map of options to pass to the method.
- masterEdge - IEdge
- An edge in the masterGraph that is represented by the folding edge.
- currentMasterSource - INode
- The source node of the edge or one of its ancestors to which the folding edge connects in the view, if the actual parent is currently collapsed in an ancestor node.
- sourceCollapsed - boolean
trueif thecurrentMasterSourceis the true source of themasterEdge, but is in its collapsed/dummy state.- currentMasterTarget - INode
- The target node of the edge or one of its ancestors to which the folding edge connects in the view, if the actual parent is currently collapsed in an ancestor node.
- targetCollapsed - boolean
trueif thecurrentMasterTargetis the true target of themasterEdge, but is in its collapsed/dummy state.
See Also
Sample Graphs
Initializes an id for a folding edge that is currently part of the given view.
Parameters
A map of options to pass to the method.
- foldingView - IFoldingView
- The view the folding edge is part of.
- foldingEdge - IEdge
- The instance that is part of the folding view graph.
See Also
Properties
Gets the source node of the edge or an ancestor (both in the masterGraph).
Remarks
Gets the target node of the edge or an ancestor (both in the masterGraph).
Remarks
Gets the edge instance in the masterGraph that is represented by the folding edge in a view.
Gets whether the currentMasterSource node is in folder state.
Remarks
Gets whether the currentMasterTarget node is in folder state.