Package | Description |
---|---|
com.yworks.yfiles.graph |
Definitions, default implementations, and support classes that represent graph structures and provide facilities for their programmatic modification.
|
com.yworks.yfiles.layout |
Provides essential classes and interfaces that constitute the infrastructure for automatic graph layout generation.
|
com.yworks.yfiles.layout.hierarchic |
Provides hierarchic layout style algorithms.
|
com.yworks.yfiles.layout.multipage |
Provides the
MultiPageLayout that subdivides the input graph into several smaller graphs whose layouts fit the specified maximum page size. |
com.yworks.yfiles.layout.organic |
Provides organic layout style algorithms that are based on a force-directed layout paradigm.
|
com.yworks.yfiles.layout.orthogonal |
Provides orthogonal layout style algorithms.
|
com.yworks.yfiles.layout.partial |
Provides class
PartialLayout that enables layout of user-specified, distinct parts of a diagram without altering the existing layout of the remainder of the diagram. |
com.yworks.yfiles.layout.router |
Provides classes for automatic routing of the edges in a graph.
|
com.yworks.yfiles.layout.router.polyline |
Provides classes and interfaces for automatic polyline routing of the edges of a graph.
|
com.yworks.yfiles.layout.seriesparallel |
Provides the series-parallel layout algorithm.
|
com.yworks.yfiles.layout.tree |
Provides tree layout style algorithms.
|
Modifier and Type | Method and Description |
---|---|
default <V> void |
IMapperRegistry.addMapper(Class<V> valueType,
EdgeDpKey<V> tag,
IMapper<IEdge,V> mapper)
Adds a previously created mapper to this instance for the given tag.
|
default <V> IMapper<IEdge,V> |
IMapperRegistry.createConstantMapper(Class<V> valueType,
EdgeDpKey<V> tag,
V constant)
|
default <V> IMapper<IEdge,V> |
IMapperRegistry.createDelegateMapper(Class<V> valueType,
EdgeDpKey<V> tag,
Function<IEdge,V> getter)
|
default <V> Mapper<IEdge,V> |
IMapperRegistry.createMapper(Class<V> valueType,
EdgeDpKey<V> tag)
|
default <V> Mapper<IEdge,V> |
IMapperRegistry.createWeakMapper(Class<V> valueType,
EdgeDpKey<V> tag)
|
default <V> IMapper<IEdge,V> |
IMapperRegistry.getMapper(Class<V> valueType,
EdgeDpKey<V> tag)
Returns a mapper that has previously been registered with this instance for the given tag.
|
Modifier and Type | Field and Description |
---|---|
static EdgeDpKey<Boolean> |
ReverseEdgesStage.AFFECTED_EDGES_DPKEY
A
DataProvider key for selecting edges for reversal
|
static EdgeDpKey<Boolean> |
ParallelEdgeRouter.AFFECTED_EDGES_DPKEY
A
DataProvider key for marking edges that will be routed
|
static EdgeDpKey<Boolean> |
LayoutKeys.AFFECTED_EDGES_DPKEY
A
DataProvider key for looking up the selected state of the edges in the graph
A layout algorithm can retrieve a IDataProvider registered with this key to apply a
special handling to the selected edges. |
static EdgeDpKey<Boolean> |
CurveFittingLayoutStage.DEFAULT_AFFECTED_EDGES_DPKEY
A
DataProvider key for selecting edges for curve fitting
|
static EdgeDpKey<Boolean> |
BendConverter.DEFAULT_AFFECTED_EDGES_DPKEY
A
DataProvider key for specifying the set of edges for which this stage will replace bends
Only the bends of the marked edges will be replaced with dummy nodes. |
static EdgeDpKey<EdgeBundleDescriptor> |
EdgeBundling.EDGE_BUNDLE_DESCRIPTOR_DPKEY
A
DataProvider key for specifying individual bundling settings for edges
If no EdgeBundleDescriptor is mapped to an edge, the default descriptor is
used by the layout algorithm to obtain the bundling setup of that edge. |
static EdgeDpKey<Comparable> |
NormalizeGraphElementOrderStage.EDGE_COMPARABLE_DPKEY
A
DataProvider key for defining a (global) order for edges
|
static EdgeDpKey<Object> |
LayoutKeys.EDGE_ID_DPKEY
A
DataProvider key for looking up a unique identifier for each edge in a graph
Layout algorithms may use this information to provide consistent layouts for multiple runs. |
static EdgeDpKey<LabelLayoutData> |
LabelLayoutKeys.EDGE_LABEL_LAYOUT_DPKEY
A
DataProvider key for accessing label information of each edge in the input graph
|
static EdgeDpKey<Boolean> |
SelfLoopRouter.KEEP_SELF_LOOP_LAYOUT_DPKEY
A
DataProvider key for determining which self-loops should keep their current path
If no IDataProvider is registered with this key, all self-loops will be routed. |
static EdgeDpKey<Boolean> |
ParallelEdgeRouter.LEADING_EDGE_DPKEY
A
DataProvider key for specifying the master edges
Marked edges won't be removed for the
core layout algorithm . |
static EdgeDpKey<IEdge> |
LayoutGraphAdapter.ORIGINAL_EDGE_DPKEY
|
static EdgeDpKey<IPort> |
LayoutGraphAdapter.ORIGINAL_SOURCE_PORT_DPKEY
|
static EdgeDpKey<IPort> |
LayoutGraphAdapter.ORIGINAL_TARGET_PORT_DPKEY
|
static EdgeDpKey<Object> |
PortConstraintKeys.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<IIntersectionCalculator> |
IntersectionCalculatorKeys.SOURCE_INTERSECTION_CALCULATOR_DPKEY
A
DataProvider key for providing an individual intersection calculation for each edge source in the graph
|
static EdgeDpKey<Collection<PortCandidate>> |
PortCandidate.SOURCE_PORT_CANDIDATE_COLLECTION_DPKEY
A
DataProvider key for specifying source port candidates for each edge.
|
static EdgeDpKey<PortConstraint> |
PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY
A
DataProvider key for providing source constraints for edges in the input graph
|
static EdgeDpKey<Object> |
PortConstraintKeys.SOURCE_PORT_GROUP_ID_DPKEY
A
DataProvider key for assigning port group ids to the edges' source.
|
static EdgeDpKey<Object> |
RecursiveGroupLayout.SOURCE_SPLIT_ID_DPKEY
A
DataProvider key for assigning source split ids to edges connecting to group nodes.
|
static EdgeDpKey<Object> |
PortConstraintKeys.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<IIntersectionCalculator> |
IntersectionCalculatorKeys.TARGET_INTERSECTION_CALCULATOR_DPKEY
A
DataProvider key for providing an individual intersection calculation for each edge target in the graph
|
static EdgeDpKey<Collection<PortCandidate>> |
PortCandidate.TARGET_PORT_CANDIDATE_COLLECTION_DPKEY
A
DataProvider key for specifying target port candidates for each edge.
|
static EdgeDpKey<PortConstraint> |
PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY
A
DataProvider key for providing target constraints for edges in the input graph
|
static EdgeDpKey<Object> |
PortConstraintKeys.TARGET_PORT_GROUP_ID_DPKEY
A
DataProvider key for assigning port group ids to the edges' target.
|
static EdgeDpKey<Object> |
RecursiveGroupLayout.TARGET_SPLIT_ID_DPKEY
A
DataProvider key for assigning target split ids to edges connecting to group nodes.
|
Modifier and Type | Field and Description |
---|---|
static EdgeDpKey<Integer> |
ConstraintIncrementalLayerer.ADDITIONAL_EDGE_WEIGHT_DPKEY
A
DataProvider key for assigning additional edge weights
The ILayerer tries to maintain edges with higher weights short. |
static EdgeDpKey<YPointPath> |
HierarchicLayout.ALTERNATIVE_EDGE_PATH_DPKEY
A
DataProvider key for associating alternative paths for edges connecting to groups, group content or folder nodes.
|
static EdgeDpKey<Integer> |
HierarchicLayout.CRITICAL_EDGE_PRIORITY_DPKEY
A
DataProvider key for defining the priority of critical edges.
|
static EdgeDpKey<Double> |
HierarchicLayout.EDGE_DIRECTEDNESS_DPKEY
A
DataProvider key for specifying the directedness of edges.
|
static EdgeDpKey<EdgeLayoutDescriptor> |
HierarchicLayoutCore.EDGE_LAYOUT_DESCRIPTOR_DPKEY
A
DataProvider key for providing layout information for each edge
|
static EdgeDpKey<Double> |
HierarchicLayout.EDGE_THICKNESS_DPKEY
A
DataProvider key for specifying the thickness of the edges.
|
static EdgeDpKey<Double> |
SelfLoopCalculator.MINIMUM_EDGE_DISTANCE_DPKEY
A
DataProvider key for specifying the minimum distance to the next edge or node side
|
static EdgeDpKey<Double> |
SelfLoopCalculator.MINIMUM_FIRST_SEGMENT_LENGTH_DPKEY
A
DataProvider key for specifying the minimum length of the first segment of each edge
|
static EdgeDpKey<Double> |
SelfLoopCalculator.MINIMUM_LAST_SEGMENT_LENGTH_DPKEY
A
DataProvider key for specifying the minimum length of the last segment of each edge
|
static EdgeDpKey<Double> |
SelfLoopCalculator.MINIMUM_OCTILINEAR_SEGMENT_LENGTH_DPKEY
A
DataProvider key for specifying the minimum length of the octilinear segments of an octilinear edge
|
static EdgeDpKey<Boolean> |
SelfLoopCalculator.OCTILINEAR_EDGES_DPKEY
A
DataProvider key for specifying whether or not an edge is octilinear
|
Modifier and Type | Field and Description |
---|---|
static EdgeDpKey<Object> |
MultiPageLayout.EDGE_ID_DPKEY
A
DataProvider key for mapping each edge of the input graph to a unique ID.
|
static EdgeDpKey<Object> |
MultiPageLayout.EDGE_TYPE_DPKEY
A
DataProvider key for specifying the type of multi-edges.
|
Modifier and Type | Field and Description |
---|---|
static EdgeDpKey<Double> |
OrganicLayout.EDGE_DIRECTEDNESS_DPKEY
A
DataProvider key for specifying the directedness of edges.
|
static EdgeDpKey<Double> |
OrganicLayout.PREFERRED_EDGE_LENGTH_DPKEY
A
DataProvider key for defining an individual preferred length for each edge
|
static EdgeDpKey<Double> |
ClassicOrganicLayout.PREFERRED_EDGE_LENGTH_DPKEY
A
DataProvider key for defining an individual preferred length for each edge
|
Modifier and Type | Field and Description |
---|---|
static EdgeDpKey<Boolean> |
OrthogonalLayout.DIRECTED_EDGE_DPKEY
A
DataProvider key for marking edges which should be routed such that they point to the main layout orientation
The main layout orientation can be set using method
LayoutOrientation . |
static EdgeDpKey<EdgeLayoutDescriptor> |
OrthogonalLayout.EDGE_LAYOUT_DESCRIPTOR_DPKEY
A
DataProvider key for providing layout information for each edge
If no edge layout descriptor is mapped for an edge, a default edge layout descriptor will be obtained using method
OrthogonalLayout.createEdgeLayoutDescriptor() . |
Modifier and Type | Field and Description |
---|---|
static EdgeDpKey<Boolean> |
PartialLayout.AFFECTED_EDGES_DPKEY
A
DataProvider key for marking partial edges.
|
static EdgeDpKey<Boolean> |
PartialLayout.DIRECTED_EDGES_DPKEY
A
DataProvider key for specifying the edges that should be considered to be directed.
|
static EdgeDpKey<Boolean> |
PartialLayout.ROUTE_EDGE_DPKEY
A
DataProvider key for obtaining the edges that should be routed by the edge router.
|
Modifier and Type | Field and Description |
---|---|
static EdgeDpKey<Boolean> |
OrganicEdgeRouter.AFFECTED_EDGES_DPKEY
A
DataProvider key for selecting edges that should be routed
|
static EdgeDpKey<Boolean> |
ChannelEdgeRouter.AFFECTED_EDGES_DPKEY
A
DataProvider key for marking the edges that should be routed.
|
static EdgeDpKey<Boolean> |
OrthogonalSegmentDistributionStage.DEFAULT_AFFECTED_EDGES_DPKEY
A
DataProvider key for determining which edges are distributed.
|
static EdgeDpKey<Boolean> |
OrthogonalPatternEdgeRouter.DEFAULT_AFFECTED_EDGES_DPKEY
A
DataProvider key for determining which edges are routed.
|
static EdgeDpKey<Boolean> |
BusRouter.DEFAULT_AFFECTED_EDGES_DPKEY
A
DataProvider key for specifying the edge subset to be routed
This key is used if no custom key for specifying the subset is defined using
AffectedEdgesDpKey . |
static EdgeDpKey<BusDescriptor> |
BusRouter.EDGE_DESCRIPTOR_DPKEY
A
DataProvider key for specifying a bus descriptor object for each edge
The BusDescriptor for an edge provides the edge's bus ID, its optional group IDs and whether or not the edge is
fixed. |
static EdgeDpKey<Object> |
BusRepresentations.SOURCE_ID_DPKEY
A
DataAcceptor key to transfer a user-defined object from each original edge to the respective newly created edge
Since there is no one-to-one mapping between original and new edges, the data provider of this key is responsible for
the edges whose source endpoint is a regular node. |
static EdgeDpKey<Object> |
BusRepresentations.TARGET_ID_DPKEY
A
DataAcceptor key to transfer a user-defined object from each original edge to the respective newly created edge
Since there is no one-to-one mapping between original and new edges, the data provider of this key is responsible for
the edges whose target endpoint is a regular node. |
Modifier and Type | Field and Description |
---|---|
static EdgeDpKey<EdgeLayoutDescriptor> |
EdgeRouter.EDGE_LAYOUT_DESCRIPTOR_DPKEY
A
DataProvider key for specifying individual edge layout information
If this IDataProvider does not contain an EdgeLayoutDescriptor for an edge, then the layout algorithm
will use the default descriptor . |
Modifier and Type | Field and Description |
---|---|
static EdgeDpKey<EdgeLayoutDescriptor> |
SeriesParallelLayout.EDGE_LAYOUT_DESCRIPTOR_DPKEY
A
DataProvider key for storing individual settings for edges
If no edge layout descriptor is mapped for an edge, a default edge layout descriptor will be obtained by method
DefaultEdgeLayoutDescriptor . |
Modifier and Type | Field and Description |
---|---|
static EdgeDpKey<Integer> |
TreeLayout.CRITICAL_EDGE_DPKEY
A
DataProvider key for defining the priority of critical edges.
|
static EdgeDpKey<Boolean> |
TreeReductionStage.NON_TREE_EDGES_DPKEY
A
DataProvider key for explicitly marking (some) edges that should not be considered for the tree
|