IItemFactory

This interface is a factory for creating and destroying helper structures used in the graph during layout.

Inheritance Hierarchy

IItemFactory

Remarks

An implementation of this interface is provided by the HierarchicLayoutCore during the layout for the different sub-modules.

Type Details

yfiles module: layout-hierarchic
yfiles-umd modules: layout-familytree, layout-hierarchic, layout-radial, layout
Legacy UMD name: yfiles.hierarchic.IItemFactory

It is mainly for internal use.

Methods

convertToLabelNode

(dummyNode: YNode)

Converts a given YNode to a label node.

Parameters

options - Object
A map of options to pass to the method.

dummyNode - YNode: the given YNode to be converted

createBendNode

(layer: ILayer, edge: Edge, laneDescriptor?: SwimlaneDescriptor) : YNode

Creates a bend YNode for the given Edge in the given ILayer and assigns it to the given SwimlaneDescriptor instance.

Parameters

options - Object
A map of options to pass to the method.

layer - ILayer: the given ILayer instance
edge - Edge: the given Edge
laneDescriptor - SwimlaneDescriptor: a given SwimlaneDescriptor instance

Returns

↪YNode: the new bend YNode

createBendNodeData

(node: YNode, edge: Edge, laneDescriptor?: SwimlaneDescriptor) : INodeData

Creates a INodeData object for a bend YNode and associates it with the YNode.

Remarks

The bend is assigned to the given SwimlaneDescriptor instance.

Parameters

options - Object
A map of options to pass to the method.

node - YNode: the given YNode
edge - Edge: the given Edge
laneDescriptor - SwimlaneDescriptor: the given SwimlaneDescriptor instance

Returns

↪INodeData: a INodeData object for the given bend YNode

createBusDummyEdge

(sourceBusNode: YNode, targetBusNode: YNode, edgeLayoutDescriptor: HierarchicLayoutEdgeLayoutDescriptor, groupingId: Object, groupingAtSource: boolean) : Edge

Creates a dummy edge that models the bus segment of a bus substructure.

Remarks

Such an edge is created between the bus root node and the first bus dummy node and between bus dummy nodes on consecutive layers.

Parameters

options - Object
A map of options to pass to the method.

sourceBusNode - YNode: the source bus dummy node or the root node of the bus substructure
targetBusNode - YNode: the target bus dummy node or the root node of the bus substructure
edgeLayoutDescriptor - HierarchicLayoutEdgeLayoutDescriptor: the descriptor which is assigned to the new dummy edge
groupingId - Object: the edge grouping id assigned to the new dummy edge
groupingAtSource - boolean: true if the dummy edge should be grouped at the source side, false if it should be grouped at the target side

Returns

↪Edge: the newly created bus dummy edge connecting the two given nodes

createBusDummyEdgeData

(busDummyEdge: Edge, edgeLayoutDescriptor: HierarchicLayoutEdgeLayoutDescriptor, groupingId: Object, groupingAtSource: boolean) : IEdgeData

Creates an IEdgeData instance for a bus dummy edge.

Parameters

options - Object
A map of options to pass to the method.

busDummyEdge - Edge: the bus dummy edge
edgeLayoutDescriptor - HierarchicLayoutEdgeLayoutDescriptor: the descriptor which is assigned to the given bus dummy edge
groupingId - Object: the grouping id assigned to the given bus dummy edge
groupingAtSource - boolean: true if the dummy edge is grouped at the source side, false if it is grouped at the target side

Returns

↪IEdgeData: the newly created IEdgeData for the given bus dummy edge

createBusDummyNode

(layer: ILayer, groupNode: YNode, laneDescriptor: SwimlaneDescriptor) : YNode

Creates a dummy node that is used during the sequencing and drawing phase for the bus-style routing edges at a certain root node.

Parameters

options - Object
A map of options to pass to the method.

layer - ILayer: the layer to which the created dummy node is added
groupNode - YNode: the group node to which the created dummy node is added
laneDescriptor - SwimlaneDescriptor: the lane to which the dummy should belong to

Returns

↪YNode: the newly created bus dummy node

createBusDummyNodeData

(busDummyNode: YNode, groupNode: YNode, laneDescriptor: SwimlaneDescriptor) : INodeData

Creates a INodeData instance for a bus dummy node.

Parameters

options - Object
A map of options to pass to the method.

busDummyNode - YNode: the bus dummy node for which the data is created
groupNode - YNode: the group node to which the bus dummy node belongs
laneDescriptor - SwimlaneDescriptor: the lane to which the bus dummy node belongs

Returns

↪INodeData: the newly created INodeData instance for the given bus dummy node

createConnectorProxyForGroup

(groupNode: YNode, groupId: Object, layer: ILayer, edge: Edge) : YNode

Creates a dummy YNode that mimics a connector to a group YNode.

Parameters

options - Object
A map of options to pass to the method.

groupNode - YNode: the given group YNode
groupId - Object: the given group ID
layer - ILayer: the given ILayer instance
edge - Edge: the given Edge

Returns

↪YNode: the new YNode

createContentConnectorProxyForGroup

(groupNode: YNode, groupId: Object, layer: ILayer, e: Edge) : YNode

Creates a dummy node that mimics a connector to a group node from a descendant.

Parameters

options - Object
A map of options to pass to the method.

groupNode - YNode: the group node to which the edge is connected
groupId - Object: the id of the group node
layer - ILayer: the layer to which the dummy node will be assigned
e - Edge: the edge that connects to the dummy node

Returns

↪YNode: the dummy node

createDistanceNode

(layer: ILayer, size: Rectangle2D, edges: Edge[]) : YNode

Creates a spacer YNode for the drawing phase using the given bounds in the given ILayer.

Parameters

options - Object
A map of options to pass to the method.

layer - ILayer: the given ILayer instance
size - Rectangle2D: the given bounds
edges - Edge[]: an array of Edges

Returns

↪YNode: the new spacer YNode

createDummyEdge

(newSource: YNode, newTarget: YNode, oldEdge: Edge, sourceEnd: boolean, targetEnd: boolean) : Edge

Creates a dummy Edge using the given data.

Parameters

options - Object
A map of options to pass to the method.

newSource - YNode: the source node of the Edge
newTarget - YNode: the target node of the Edge
oldEdge - Edge: the old Edge from which to retrieve the data
sourceEnd - boolean: true if the source node of the edge is referred, false otherwise
targetEnd - boolean: true if the target node of the edge is referred, false otherwise

Returns

↪Edge: a new dummy Edge

createEdgeGroupNode

(layer: ILayer, groupId: Object) : YNode

Creates an edge group YNode in the given ILayer.

Parameters

options - Object
A map of options to pass to the method.

layer - ILayer: the given ILayer instance
groupId - Object: the ID of the edge group

Returns

↪YNode: the new group YNode

createEdgeGroupNodeData

(node: YNode, groupId: Object, source: boolean) : INodeData

Creates a INodeData object for an edge group YNode and associates it with the YNode.

Parameters

options - Object
A map of options to pass to the method.

node - YNode: the given YNode
groupId - Object: the given group ID
source - boolean: true if the edge group is referred to the source node, false otherwise

Returns

↪INodeData: a INodeData object for the given edge group YNode

createGroupBorderEdge

(source: YNode, target: YNode) : Edge

Creates an Edge that connects two group border YNodes.

Parameters

options - Object
A map of options to pass to the method.

source - YNode: the source YNode
target - YNode: the target YNode

Returns

↪Edge: the new Edge connecting the two group YNodes

createGroupBorderNode

(groupNode: YNode, layer: ILayer, type: NodeDataType) : YNode

Creates a group boundary YNode for a group node in the given ILayer.

Parameters

options - Object
A map of options to pass to the method.

groupNode - YNode: the given group YNode
layer - ILayer: the given ILayer
type - NodeDataType: one of GROUP_BEGIN or GROUP_END

Returns

↪YNode: the new group boundary YNode

createGroupLayerDummyNode

() : YNode

Create a dummy YNode for a group layer.

Returns

↪YNode: a new dummy YNode

createGroupNodeConnectorEdge

(groupNode1: YNode, groupNode2: YNode, representative: Edge) : Edge

Creates a group node connector Edge between two group YNodes.

Parameters

options - Object
A map of options to pass to the method.

groupNode1 - YNode: the first group node
groupNode2 - YNode: the first group node
representative - Edge: the given representative Edge

Returns

↪Edge: a new connector Edge between two group YNodes

createNormalEdgeData

(edge: Edge) : IEdgeData

Creates an IEdgeData object for a normal Edge and associates it with the edge.

Parameters

options - Object
A map of options to pass to the method.

edge - Edge: the given Edge

Returns

↪IEdgeData: an IEdgeData object for the given Edge

createNormalNodeData

(node: YNode) : INodeData

Creates a INodeData object for a normal YNode and associates it with the YNode.

Parameters

options - Object
A map of options to pass to the method.

node - YNode: the given YNode

Returns

↪INodeData: a INodeData object for the given YNode

createProxyNode

(edge: Edge, source: boolean, laneDescriptor?: SwimlaneDescriptor) : YNode

Creates a proxy YNode for an Edge during the drawing phase, changing the Edge to end/start at the proxy and assigns it to a SwimlaneDescriptor instance.

Parameters

options - Object
A map of options to pass to the method.

edge - Edge: the given Edge
source - boolean: true if the node is the source node of the edge, false otherwise
laneDescriptor - SwimlaneDescriptor: a given SwimlaneDescriptor instance

Returns

↪YNode: the new proxy YNode

createProxyNodeData

(node: YNode, proxy: YNode, edge: Edge) : INodeData

Creates a INodeData object for a proxy YNode and associates it with the proxy node.

Parameters

options - Object
A map of options to pass to the method.

node - YNode: the given YNode
proxy - YNode: the given proxy node
edge - Edge: the given Edge

Returns

↪INodeData: a INodeData object for the given proxy node

createRecursiveDummyEdge

(newSource: YNode, newTarget: YNode, oldEdge: Edge, sourceEnd: boolean, targetEnd: boolean) : Edge

Creates a dummy edge that belongs to a recursive Edge.

Parameters

options - Object
A map of options to pass to the method.

newSource - YNode: the source node of the Edge
newTarget - YNode: the target node of the Edge
oldEdge - Edge: the old Edge from which to retrieve the data
sourceEnd - boolean: true if the source node of the edge is referred, false otherwise
targetEnd - boolean: true if the target node of the edge is referred, false otherwise

Returns

↪Edge: a new dummy Edge

createRecursiveEdgeDummy

(layer: ILayer, edge: Edge, laneDescriptor: SwimlaneDescriptor) : YNode

Creates a dummy YNode that represents a bend node of a recursive Edge.

Parameters

options - Object
A map of options to pass to the method.

layer - ILayer: the given ILayer to which the dummy YNode is assigned
edge - Edge: the given Edge to which the dummy YNode belongs
laneDescriptor - SwimlaneDescriptor: the given SwimlaneDescriptor instance

Returns

↪YNode: the new YNode

createRecursiveEdgeNodeData

(node: YNode, edge: Edge, laneDescriptor: SwimlaneDescriptor) : INodeData

Creates a INodeData for a dummy YNode of a recursive Edge.

Parameters

options - Object
A map of options to pass to the method.

node - YNode: the given YNode
edge - Edge: the given Edge to which the dummy YNode belongs
laneDescriptor - SwimlaneDescriptor: the given SwimlaneDescriptor instance

Returns

↪INodeData: the new INodeData instance

createRecursiveSameLayerEdgeData

(edge: Edge, originalEdgeData: IEdgeData, isUpper: boolean) : IEdgeData

Creates an IEdgeData object for a same-layer recursive Edge and associates it with the edge.

Parameters

options - Object
A map of options to pass to the method.

edge - Edge: the given Edge
originalEdgeData - IEdgeData: the IEdgeData object of the original edge
isUpper - boolean: true is the recursive edge is an upper same layer edge, false otherwise

Returns

↪IEdgeData: an IEdgeData object for the recursive same-layer Edge

createRedirectedGroupEdge

(newSource: YNode, newTarget: YNode, groupEdge: Edge) : Edge

Creates a redirected Edge to replace an Edge connected to a group YNode.

Parameters

options - Object
A map of options to pass to the method.

newSource - YNode: the source node of the Edge
newTarget - YNode: the target node of the Edge
groupEdge - Edge: the given group Edge

Returns

↪Edge: a new redirected Edge

createReverseDummyEdge

(newSource: YNode, newTarget: YNode, oldEdge: Edge, sourceEnd: boolean, targetEnd: boolean) : Edge

Creates a reversed dummy Edge using the given data.

Parameters

options - Object
A map of options to pass to the method.

newSource - YNode: the source node of the Edge
newTarget - YNode: the target node of the Edge
oldEdge - Edge: the old Edge from which to retrieve the data
sourceEnd - boolean: true if the source node of the edge is referred, false otherwise
targetEnd - boolean: true if the target node of the edge is referred, false otherwise

Returns

↪Edge: a new reversed dummy Edge

createSameLayerEdgeData

(edge: Edge) : IEdgeData

Creates an IEdgeData object for a same-layer Edge and associates it with the edge.

Parameters

options - Object
A map of options to pass to the method.

edge - Edge: the given Edge

Returns

↪IEdgeData: an IEdgeData object for the same-layer Edge

createSameLayerProxy

(layer: ILayer, edge: Edge, toProxy: YNode) : Edge

Creates a same-layer Edge proxy connecting a newly created proxy YNode and a given proxy YNode in the given ILayer.

Parameters

options - Object
A map of options to pass to the method.

layer - ILayer: the given ILayer
edge - Edge: the given Edge
toProxy - YNode: the given proxy YNode

Returns

↪Edge: a new redefined same-layer Edge

createSameLayerSideProxy

(inLayer: ILayer, forNode: YNode, edge: Edge, sld?: SwimlaneDescriptor) : YNode

Creates a proxy YNode for a same-layer Edge during the drawing phase that ends at the side of a node.

Parameters

options - Object
A map of options to pass to the method.

inLayer - ILayer: the given ILayer instance
forNode - YNode: the given YNode
edge - Edge: the given Edge
sld - SwimlaneDescriptor: a given SwimlaneDescriptor instance

Returns

↪YNode: the new proxy YNode

createSameLayerSwitchProxy

(layer: ILayer, edge: Edge) : YNode

Creates a same-layer switch proxy YNode (switching between two same-layer Edges on two different sides of the layer).

Parameters

options - Object
A map of options to pass to the method.

layer - ILayer: the given ILayer
edge - Edge: the given Edge

Returns

↪YNode: the new same-layer switch proxy YNode

createSelfLoopEdgeData

(edge: Edge) : IEdgeData

Creates an IEdgeData object for a self-loop Edge and associates it with the edge.

Parameters

options - Object
A map of options to pass to the method.

edge - Edge: the given Edge

Returns

↪IEdgeData: an IEdgeData object for a self-loop Edge

destroyDistanceNode

(distanceNode: YNode)

Destroys a spacer YNode for the drawing phase created using createDistanceNode.

Parameters

options - Object
A map of options to pass to the method.

distanceNode - YNode: the YNode to be destroyed

destroyGroupConnectorLayer

(layer: ILayer, useInEdges: boolean)

Removes the given layer for proxies at groups to handle direct group content connector edges between a node in the first/last layer of the group node and the groups border.

Parameters

options - Object
A map of options to pass to the method.

layer - ILayer: the layer to destroy
useInEdges - boolean: whether the incoming edges should be used as the resulting edges

destroyLabelNodeLayer

(layer: ILayer, useInEdges: boolean)

Destroys a previously created label layer

Parameters

options - Object
A map of options to pass to the method.

layer - ILayer: the layer to destroy
useInEdges - boolean: whether the incoming edges should be used as the resulting edges

destroyProxyNode

(proxyNode: YNode) : Edge

Destroys a proxy YNode created using createProxyNode for the drawing phase.

Parameters

options - Object
A map of options to pass to the method.

proxyNode - YNode: the proxy YNode to be destroyed

destroySameLayerProxy

(edge: Edge) : Edge

Destroys a same-layer Edge proxy created using createSameLayerProxy.

Parameters

options - Object
A map of options to pass to the method.

edge - Edge: the Edge whose proxy will be destroyed

Returns

↪Edge: the redefined Edge after the removal of the proxy YNode

destroySameLayerSideProxy

(proxyNode: YNode)

Destroys a proxy YNode created using createProxyNode for the drawing phase.

Parameters

options - Object
A map of options to pass to the method.

proxyNode - YNode: the proxy YNode to be destroyed

destroySameLayerSwitchProxy

(node: YNode) : Edge

Destroys a same-layer switch proxy YNode created using createSameLayerSwitchProxy.

Parameters

options - Object
A map of options to pass to the method.

node - YNode: the YNode to be destroyed

Returns

↪Edge: the redefined Edge after the removal of the same-layer switch proxy YNode

insertEdge

(edge: Edge) : EdgeList

Inserts a same-layer Edge or an Edge that may span multiple layers into the data structure and returns the resulting list of Edges that has been created if this edge spans multiple layers.

Parameters

options - Object
A map of options to pass to the method.

edge - Edge: the given Edge

Returns

↪EdgeList: the resulting list of Edges that has been created if this edge spans multiple layers

insertGroupConnectorLayer

(top: boolean, index: number) : ILayer

Inserts a layer for proxies at groups to handle direct group content connector edges between a node in the first/last layer of the group node and the groups border.

Parameters

options - Object
A map of options to pass to the method.

top - boolean: true if this layer is placed above a group nodes, false if placed below
index - number: the index where the layer is inserted

Returns

↪ILayer: the new layer

insertGroupNodeLayer

(source: boolean, index: number) : ILayer

Inserts a layer for group YNodes.

Parameters

options - Object
A map of options to pass to the method.

source - boolean: true if the group refers to the source node of an edge, false otherwise
index - number: the index at which the specified layer is to be inserted

Returns

↪ILayer: a layer instance

insertLabelNodeLayer

(source: boolean, index: number) : ILayer

Inserts a ILayer for labels.

Parameters

options - Object
A map of options to pass to the method.

source - boolean: true if the source node of the edge, false otherwise
index - number: the index at which the specified ILayer is to be inserted

Returns

↪ILayer: a layer instance

registerSameLayerEdge

(edge: Edge)

Registers an Edge as a same-layer Edge appropriately into all data structures.

Parameters

options - Object
A map of options to pass to the method.

edge - Edge: the given Edge to be registered

setDirectlyConnectSameLayerEdge

(sameLayerEdge: Edge)

Converts a same-layer Edge to an Edge of type DIRECT_SAME_LAYER_EDGE.

Parameters

options - Object
A map of options to pass to the method.

sameLayerEdge - Edge: the given same-layer Edge

setTemporaryCriticalEdgePriority

(edge: Edge, priority: number) : IEdgeData

Specifies the critical edge priority for an Edge and defines it in an IEdgeData object.

Parameters

options - Object
A map of options to pass to the method.

edge - Edge: the given edge
priority - number: the new priority for the given edge

Returns

↪IEdgeData: an IEdgeData object with an adjusted critical edge priority

setTemporaryCrossingCost

(edge: Edge, crossingCost: number) : IEdgeData

Specifies the crossing cost for an Edge and defines it in an IEdgeData object.

Parameters

options - Object
A map of options to pass to the method.

edge - Edge: the given edge
crossingCost - number: the new crossing cost for the given edge

Returns

↪IEdgeData: an IEdgeData object with an adjusted edge crossing cost

setTemporaryEdgeGroups

(edge: Edge, sgId: Object, tgId: Object) : IEdgeData

Specifies an edge group constraint for an Edge and assigns it to an IEdgeData object.

Parameters

options - Object
A map of options to pass to the method.

edge - Edge: the given Edge
sgId - Object: the ID of the edge group at the source node
tgId - Object: the ID of the edge group at the target node

Returns

↪IEdgeData: an IEdgeData object

setTemporaryEdgeThickness

(edge: Edge, thickness: number) : IEdgeData

Specifies the thickness for an Edge and defines it in an IEdgeData object.

Parameters

options - Object
A map of options to pass to the method.

edge - Edge: the given Edge
thickness - number: the new edge thickness

Returns

↪IEdgeData: an IEdgeData object with an adjusted edge thickness

setTemporaryPortConstraint

(edge: Edge, source: boolean, pc: PortConstraint) : IEdgeData

Specifies a port constraint for an Edge at the given side and assigns it to an IEdgeData object.

Parameters

options - Object
A map of options to pass to the method.

edge - Edge: the given Edge
source - boolean: true of the port constraint is defined on the source node of the Edge, false otherwise
pc - PortConstraint: the given PortConstraint instance

Returns

↪IEdgeData: an IEdgeData object

unconvertToLabelNode

(labelNode: YNode)

Reverts a label node to the normal YNode.

Parameters

options - Object
A map of options to pass to the method.

labelNode - YNode: the given label node to be converted

IItemFactory

Remarks

Type Details

Methods

convertToLabelNode

Parameters

createBendNode

Parameters

Returns

createBendNodeData

Remarks

Parameters

Returns

createBusDummyEdge

Remarks

Parameters

Returns

createBusDummyEdgeData

Parameters

Returns

createBusDummyNode

Parameters

Returns

See Also

createBusDummyNodeData

Parameters

Returns

createConnectorProxyForGroup

Parameters

Returns

createContentConnectorProxyForGroup

Parameters

Returns

createDistanceNode

Parameters

Returns

createDummyEdge

Parameters

Returns

createEdgeGroupNode

Parameters

Returns

createEdgeGroupNodeData

Parameters

Returns

createGroupBorderEdge

Parameters

Returns

createGroupBorderNode

Parameters

Returns

createGroupLayerDummyNode

Returns

createGroupNodeConnectorEdge

Parameters

Returns

createNormalEdgeData

Parameters

Returns

createNormalNodeData

Parameters

Returns

createProxyNode

Parameters

Returns

createProxyNodeData

Parameters

Returns

createRecursiveDummyEdge

Parameters

Returns

createRecursiveEdgeDummy

Parameters

Returns

createRecursiveEdgeNodeData

Parameters

Returns

createRecursiveSameLayerEdgeData

Parameters

Returns