com.yworks.yfiles.layout

Class PortConstraintKeys

java.lang.Object

com.yworks.yfiles.layout.PortConstraintKeys

public final class PortConstraintKeys
extends Object

PortConstraintKeys are used for associating DataProviders that contain constraints for the edges of the input graph.

These constraints can either be PortConstraints or edge groups. PortConstraints force the edges to start/end on specified sides of the node. They may also restrict ports of edges to certain coordinates. Edge groups will bundle edges at a common source or target. They will start at the same coordinates and may share parts of their edge routes.

Layout algorithms that support PortConstraints or edge groups will access the IDataProviders using the provided keys.

Field Summary

Fields

Modifier and Type	Field and Description
static EdgeDpKey<Object>	SOURCE_GROUP_ID_DPKEY A DataProvider key for assigning source group information for edges of the input graph Edges sharing a source group identifier will share a common bus near the source or at a common source node if possible.
static EdgeDpKey<PortConstraint>	SOURCE_PORT_CONSTRAINT_DPKEY A DataProvider key for providing source constraints for edges in the input graph
static EdgeDpKey<Object>	SOURCE_PORT_GROUP_ID_DPKEY A DataProvider key for assigning port group ids to the edges' source.
static EdgeDpKey<Object>	TARGET_GROUP_ID_DPKEY A DataProvider key for assigning target group information for edges of the input graph Edges sharing a target group identifier will share a common bus near the target or at a common target node if possible.
static EdgeDpKey<PortConstraint>	TARGET_PORT_CONSTRAINT_DPKEY A DataProvider key for providing target constraints for edges in the input graph
static EdgeDpKey<Object>	TARGET_PORT_GROUP_ID_DPKEY A DataProvider key for assigning port group ids to the edges' target.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SOURCE_GROUP_ID_DPKEY

public static final EdgeDpKey<Object> SOURCE_GROUP_ID_DPKEY

A DataProvider key for assigning source group information for edges of the input graph

Edges sharing a source group identifier will share a common bus near the source or at a common source node if possible.

The HierarchicLayout is able to group incoming and outgoing edges. Therefore, the source group identifier of the outgoing edges of a node has to match with the target group identifier of the incoming edges.

SOURCE_PORT_CONSTRAINT_DPKEY

public static final EdgeDpKey<PortConstraint> SOURCE_PORT_CONSTRAINT_DPKEY

A DataProvider key for providing source constraints for edges in the input graph

SOURCE_PORT_GROUP_ID_DPKEY

public static final EdgeDpKey<Object> SOURCE_PORT_GROUP_ID_DPKEY

A DataProvider key for assigning port group ids to the edges' source.

All edges with the same port id at a node will share the same port location. However, they will be routed independently.

Currently, only HierarchicLayout supports port grouping.

TARGET_GROUP_ID_DPKEY

public static final EdgeDpKey<Object> TARGET_GROUP_ID_DPKEY

A DataProvider key for assigning target group information for edges of the input graph

Edges sharing a target group identifier will share a common bus near the target or at a common target node if possible.

The HierarchicLayout is able to group incoming and outgoing edges. Therefore, the target group identifier of the incoming edges of a node has to match with the source group identifier of the outgoing edges.

TARGET_PORT_CONSTRAINT_DPKEY

public static final EdgeDpKey<PortConstraint> TARGET_PORT_CONSTRAINT_DPKEY

A DataProvider key for providing target constraints for edges in the input graph

TARGET_PORT_GROUP_ID_DPKEY

public static final EdgeDpKey<Object> TARGET_PORT_GROUP_ID_DPKEY

A DataProvider key for assigning port group ids to the edges' target.

All edges with the same port id at a node will share the same port location. However, they will be routed independently.

Currently, only HierarchicLayout supports port grouping.