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.circular |
Provides circular layout style algorithms.
|
com.yworks.yfiles.layout.genealogy |
Provides layout algorithms that are especially suited for genealogical family trees.
|
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.radial |
Provides the radial layout algorithm.
|
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,
NodeDpKey<V> tag,
IMapper<INode,V> mapper)
Adds a previously created mapper to this instance for the given tag.
|
default <V> IMapper<INode,V> |
IMapperRegistry.createConstantMapper(Class<V> valueType,
NodeDpKey<V> tag,
V constant)
|
default <V> IMapper<INode,V> |
IMapperRegistry.createDelegateMapper(Class<V> valueType,
NodeDpKey<V> tag,
Function<INode,V> getter)
|
default <V> Mapper<INode,V> |
IMapperRegistry.createMapper(Class<V> valueType,
NodeDpKey<V> tag)
|
default <V> Mapper<INode,V> |
IMapperRegistry.createWeakMapper(Class<V> valueType,
NodeDpKey<V> tag)
|
default <V> IMapper<INode,V> |
IMapperRegistry.getMapper(Class<V> valueType,
NodeDpKey<V> tag)
Returns a mapper that has previously been registered with this instance for the given tag.
|
Modifier and Type | Field and Description |
---|---|
static NodeDpKey<Boolean> |
ComponentLayout.AFFECTED_COMPONENTS_DPKEY
A
DataProvider key for specifying which nodes should be arranged
If no IDataProvider is registered with this key, all components will be laid out by the core layout algorithm. |
static NodeDpKey<Boolean> |
LayoutKeys.AFFECTED_NODES_DPKEY
A
DataProvider key for looking up the selected state of the nodes in the graph
A layout algorithm can retrieve a IDataProvider registered with this key to apply a
special handling to the selected nodes. |
static NodeDpKey<Comparable> |
ComponentLayout.COMPONENT_ID_DPKEY
A
DataProvider key for specifying custom graph components
|
static NodeDpKey<Boolean> |
FixGroupLayoutStage.FIXED_GROUP_NODES_DPKEY
A
DataProvider key for selecting group nodes whose contents should keep their relative positions.
|
static NodeDpKey<Boolean> |
FixNodeLayoutStage.FIXED_NODE_DPKEY
A
DataProvider key for determining the nodes that should be considered fixed
|
static NodeDpKey<Boolean> |
GroupingKeys.GROUP_DPKEY
A
DataProvider key for distinguishing normal nodes from group nodes.
|
static NodeDpKey<YInsets> |
GroupingKeys.GROUP_NODE_INSETS_DPKEY
A
DataProvider key for assigning insets for group nodes.
|
static NodeDpKey<ILayoutAlgorithm> |
RecursiveGroupLayout.GROUP_NODE_LAYOUT_DPKEY
A
DataProvider key for arranging the content of each group node with an individual layout algorithm.
|
static NodeDpKey<ILayoutAlgorithm> |
LayoutMultiplexer.LAYOUT_DPKEY
A
DataProvider key for assigning layout algorithms to the nodes
At runtime, the layout algorithms are determined and applied to the current graph. |
static NodeDpKey<YDimension> |
GroupingKeys.MINIMUM_NODE_SIZE_DPKEY
A
DataProvider key for assigning minimum sizes for group nodes.
|
static NodeDpKey<Comparable> |
NormalizeGraphElementOrderStage.NODE_COMPARABLE_DPKEY
A
DataProvider key for defining a (global) order for nodes
|
static NodeDpKey<NodeHalo> |
NodeHalo.NODE_HALO_DPKEY
A
DataProvider key for assigning halos for the nodes
|
static NodeDpKey<Object> |
LayoutKeys.NODE_ID_DPKEY
A
DataProvider key for looking up a unique identifier for each node in a graph
Layout algorithms may use this information to provide consistent layouts for multiple runs. |
static NodeDpKey<Object> |
GroupingKeys.NODE_ID_DPKEY
A
DataProvider key for assigning a unique ID for each node.
|
static NodeDpKey<LabelLayoutData> |
LabelLayoutKeys.NODE_LABEL_LAYOUT_DPKEY
A
DataProvider key for accessing label information of each node in the input graph
|
static NodeDpKey<PortCandidateSet> |
PortCandidateSet.NODE_PORT_CANDIDATE_SET_DPKEY
A
DataProvider key for specifying a port candidate set for each node.
|
static NodeDpKey<INode> |
LayoutGraphAdapter.ORIGINAL_NODE_DPKEY
|
static NodeDpKey<Object> |
GroupingKeys.PARENT_NODE_ID_DPKEY
A
DataProvider key for describing the hierarchy of nodes in the graph.
|
static NodeDpKey<PartitionCellId> |
PartitionGrid.PARTITION_CELL_ID_DPKEY
A
DataProvider key for storing a set of partition cells for each node
Each node is placed inside the columns/rows defined by the corresponding PartitionCellId identifier. |
static NodeDpKey<IEdge> |
LayoutGraphAdapter.PORT_DUMMY_NODE_DPKEY
This key is used to provide information about dummy nodes that have been inserted into the graph to model edges at
edges.
|
Modifier and Type | Field and Description |
---|---|
static NodeDpKey<Integer> |
CircularLayout.CIRCLE_ID_DPKEY
A
DataAcceptor key for publishing the final circle information
For each node, the ID of the circle on which it was placed will be stored. |
static NodeDpKey<Object> |
CircularLayout.CUSTOM_GROUPS_DPKEY
A
DataProvider key for defining custom node partitions
The IDataProvider needs to provide a mapping from Node s to unique Object IDs for each group of
nodes. |
Modifier and Type | Field and Description |
---|---|
static NodeDpKey<FamilyType> |
FamilyTreeLayout.FAMILY_TYPE_DPKEY
A
DataProvider key for assigning a node type for each node
The layout algorithm will handle the nodes according to this type. |
Modifier and Type | Field and Description |
---|---|
static NodeDpKey<YRectangle> |
HierarchicLayout.ALTERNATIVE_GROUP_BOUNDS_DPKEY
A
DataProvider key for associating an alternative bounds with the collapsed/expanded group.
|
static NodeDpKey<Boolean> |
BFSLayerer.CORE_NODES_DPKEY
A
DataProvider key for identifying the core nodes of the BFS layering.
|
static NodeDpKey<Boolean> |
HierarchicLayout.FOLDER_NODES_DPKEY
A
DataProvider key for marking folder nodes.
|
static NodeDpKey<Boolean> |
HierarchicLayoutCore.INCREMENTAL_NODES_DPKEY
A
DataProvider key for internal use only.
|
static NodeDpKey<Integer> |
GivenLayersLayerer.LAYER_ID_DPKEY
A
DataProvider key for storing the layer IDs.
|
static NodeDpKey<Integer> |
HierarchicLayoutCore.LAYER_INDEX_DPKEY
A
DataAcceptor key for publishing the layer IDs for all nodes in the graph.
|
static NodeDpKey<Integer> |
HierarchicLayout.LAYER_INDEX_DPKEY
A
DataAcceptor key for publishing the layer IDs for all nodes in the graph.
|
static NodeDpKey<Double> |
SelfLoopCalculator.MINIMUM_NODE_DISTANCE_DPKEY
A
DataProvider key for defining for each node a minimum distance to the self-loop edges
|
static NodeDpKey<NodeLayoutDescriptor> |
HierarchicLayoutCore.NODE_LAYOUT_DESCRIPTOR_DPKEY
A
DataProvider key for providing layout information for each node
|
static NodeDpKey<Integer> |
HierarchicLayoutCore.SEQUENCE_INDEX_DPKEY
A
DataAcceptor key for publishing the index inside their layer for all nodes in the graph.
|
static NodeDpKey<Integer> |
HierarchicLayout.SEQUENCE_INDEX_DPKEY
A
DataAcceptor key for publishing the index inside their layer for all nodes in the graph.
|
static NodeDpKey<SwimlaneDescriptor> |
HierarchicLayoutCore.SWIMLANE_DESCRIPTOR_DPKEY
A
DataProvider key for providing information about swimlanes
If this key is present during the layout, the layout algorithm will arrange nodes in swimlanes. |
static NodeDpKey<SwimlaneDescriptor> |
HierarchicLayout.SWIMLANE_DESCRIPTOR_DPKEY
A
DataProvider key for defining swimlanes for the nodes.
|
Modifier and Type | Field and Description |
---|---|
static NodeDpKey<Object> |
MultiPageLayout.NODE_CLUSTER_ID_DPKEY
A
DataProvider key for assigning a cluster ID to common (non-group) nodes.
|
static NodeDpKey<Object> |
MultiPageLayout.NODE_ID_DPKEY
A
DataProvider key for mapping each node of the input graph to a unique ID.
|
Modifier and Type | Field and Description |
---|---|
static NodeDpKey<Boolean> |
OrganicLayout.AFFECTED_NODES_DPKEY
A
DataProvider key for marking the nodes that are part of the relevant subset
|
static NodeDpKey<Boolean> |
ClassicOrganicLayout.AFFECTED_NODES_DPKEY
A
DataProvider key for marking the nodes that are part of the current scope
|
static NodeDpKey<Boolean> |
ClassicOrganicLayout.FIXED_GROUP_NODES_DPKEY
A
DataProvider key for marking group nodes as fixed
The content of a fixed group node will not be changed by this algorithm but be treated as fixed. |
static NodeDpKey<Boolean> |
ShuffleLayout.FIXED_NODE_DPKEY
A
DataProvider key for marking nodes as fixed
A node marked as fixed will not be moved by this algorithm but stay at its current position. |
static NodeDpKey<Boolean> |
OrganicRemoveOverlapsStage.FIXED_NODE_DPKEY
A
DataProvider key for marking nodes as fixed
A node marked as fixed will not be moved by this algorithm but stay at its current position. |
static NodeDpKey<GroupNodeMode> |
OrganicLayout.GROUP_NODE_MODE_DPKEY
A
DataProvider key for assigning individual modes for all group nodes
The modes specify how a group's content is handled and if it is resized during layout calculation. |
static NodeDpKey<Double> |
ShuffleLayout.MINIMUM_DISTANCE_DPKEY
A
DataProvider key for specifying a minimum distance for each node
The default minimum distance specified by MinimumNodeDistance will be ignored
for a node if the IDataProvider registered with this key contains a valid minimum distance for that node. |
Modifier and Type | Field and Description |
---|---|
static NodeDpKey<Integer> |
KanCompactor.BORDER_DPKEY |
Modifier and Type | Field and Description |
---|---|
static NodeDpKey<Boolean> |
PartialLayout.AFFECTED_NODES_DPKEY
A
DataProvider key for marking partial nodes.
|
static NodeDpKey<Object> |
PartialLayout.COMPONENT_ID_DPKEY
A
DataProvider key for defining custom subgraph components.
|
Modifier and Type | Field and Description |
---|---|
static NodeDpKey<RadialLayout.NodeInfo> |
RadialLayout.NODE_INFO_DPKEY
A
DataAcceptor key for publishing the circle ID and sector data
For each node, the ID of the circle and data regarding the circular sector on which it was placed will be stored. |
Modifier and Type | Field and Description |
---|---|
static NodeDpKey<Comparator<Object>> |
SeriesParallelLayout.OUT_EDGE_COMPARATOR_DPKEY
A
DataProvider key for assigning different orderings for outgoing edges of the nodes
If the Comparator associated with a node is null , the outgoing edges maintain their initial order. |
static NodeDpKey<IPortAssignment> |
SeriesParallelLayout.PORT_ASSIGNMENT_DPKEY
A
DataProvider key for providing an individual port distribution at nodes
If there is no IPortAssignment specified for a node, the layout algorithm uses the
default assignment . |
Modifier and Type | Field and Description |
---|---|
static NodeDpKey<Boolean> |
AssistantNodePlacer.ASSISTANT_NODE_DPKEY
A
DataProvider key for marking which nodes are placed as assistants
|
static NodeDpKey<Boolean> |
TreeComponentLayout.DUMMY_NODE_DPKEY
A
DataProvider key for identifying dummy nodes during the layout calculation
This IDataProvider is registered and also removed in
TreeComponentLayout.applyLayoutUsingDummies(LayoutGraph, IDataProvider) . |
static NodeDpKey<Boolean> |
BalloonLayout.INTERLEAVED_NODES_DPKEY
A
DataProvider key for marking nodes whose child nodes should be placed in an interleaved fashion
This IDataProvider allows to individually configure the interleaving feature for each node in the graph. |
static NodeDpKey<Boolean> |
LeftRightNodePlacer.LEFT_RIGHT_DPKEY
A
DataProvider key for assigning nodes to the left or the right side of the bus
If no IDataProvider is specified using this key, the nodes will be placed alternating from left to right. |
static NodeDpKey<MultiParentDescriptor> |
TreeLayout.MULTI_PARENT_DESCRIPTOR_DPKEY
A
DataProvider key for retrieving descriptors for nodes in multi-parent structures.
|
static NodeDpKey<Comparable> |
NodeOrderComparator.NODE_ORDER_COMPARABLE_DPKEY
A
DataProvider key for registering an order for each node in the graph
|
static NodeDpKey<INodePlacer> |
TreeLayout.NODE_PLACER_DPKEY
A
DataProvider key for specifying a child node placer for each node.
|
static NodeDpKey<Comparator<Object>> |
TreeLayout.OUT_EDGE_COMPARATOR_DPKEY
A
DataProvider key for specifying the comparator for the outgoing edges.
|
static NodeDpKey<IPortAssignment> |
TreeLayout.PORT_ASSIGNMENT_DPKEY
A
DataProvider key for assigning ports to nodes.
|
static NodeDpKey<Boolean> |
DelegatingNodePlacer.PRIMARY_NODES_DPKEY
A
DataProvider key for dividing the children into two sets
If there is no IDataProvider registered with this key, half of the nodes are placed left of the root and the
remaining nodes are placed right of the root. |
static NodeDpKey<Object> |
AspectRatioTreeLayout.ROOT_PLACEMENT_DPKEY
A
DataProvider key for specifying the placement of each subtree root
If no root placement is specified for one of the subtree roots, the default root placement
will be used. |
static NodeDpKey<Integer> |
GridNodePlacer.ROW_INDEX_DPKEY
A
DataProvider key for assigning nodes to the rows in the grid
If no IDataProvider is registered with this key, all nodes will be placed in the same row. |
static NodeDpKey<Boolean> |
TreeLayout.SELECTED_ROOT_DPKEY
A
DataProvider key for marking the node that will be used as root node of the tree.
|
static NodeDpKey<Boolean> |
ClassicTreeLayout.SELECTED_ROOT_DPKEY
A
DataProvider key for marking the node that will be used as root node of the tree.
|
static NodeDpKey<Boolean> |
BalloonLayout.SELECTED_ROOT_DPKEY
A
DataProvider key for marking the node that will be used as root node of the tree.
|
static NodeDpKey<Boolean> |
AspectRatioTreeLayout.SELECTED_ROOT_DPKEY
A
DataProvider key for marking the node that will be used as root node of the tree.
|
static NodeDpKey<Double> |
AspectRatioTreeLayout.SUBTREE_ASPECT_RATIO_DPKEY
A
DataProvider key for specifying a target aspect ratio for each subtree
The aspect ratio needs to be greater than 0 . |
static NodeDpKey<Object> |
AspectRatioTreeLayout.SUBTREE_ROUTING_POLICY_DPKEY
A
DataProvider key for specifying the routing direction for each subtree root
The children in a subtree are arranged either horizontally or vertically. |