documentationfor yFiles for HTML 2.6

Usages of NodeDpKey

Fields

NODE_CENTER_DP_KEYin NodeAggregationAlgorithmA data provider key for specifying the coordinates of the nodes.
NODE_TYPE_DP_KEYin NodeAggregationAlgorithmA data provider key for specifying the type of the nodes.
NODE_WEIGHT_DP_KEYin NodeAggregationAlgorithmA data provider key for specifying the (non-negative) weights of the nodes.
TOP_LEVEL_NODES_DP_KEYin NodeAggregationAlgorithmA data provider key for specifying the top-level nodes of the aggregation info.
CIRCLE_ID_DP_KEYin CircularLayoutA data acceptor key for publishing the final circle information.
CUSTOM_GROUPS_DP_KEYin CircularLayoutA data provider key for defining custom node partitions.
FAMILY_TYPE_DP_KEYin FamilyTreeLayoutA data provider key for assigning a node type for each node.
CORE_NODES_DP_KEYin BFSLayererA data provider key for identifying the core nodes of the BFS layering.
PLACE_BEFORE_BUS_DP_KEYin HierarchicLayoutBusDescriptorA data provider key for assigning nodes to a specific side of the common bus.
ROOT_OFFSET_DP_KEYin HierarchicLayoutBusDescriptorA data provider key for assigning nodes to specific layers relative to the root node of the bus.
LAYER_ID_DP_KEYin GivenLayersLayererA data provider key for storing the layer IDs.
ALTERNATIVE_GROUP_BOUNDS_DP_KEYin HierarchicLayoutA data provider key for associating an alternative bounds with the collapsed/expanded group.
FOLDER_NODES_DP_KEYin HierarchicLayoutA data provider key for marking folder nodes.
GROUP_BORDER_CROSSING_COST_DP_KEYin HierarchicLayoutA data provider key for specifying individual crossing costs for vertical borders of group nodes.
LAYER_INDEX_DP_KEYin HierarchicLayoutA data acceptor key for publishing the layer IDs for all nodes in the graph.
SEQUENCE_INDEX_DP_KEYin HierarchicLayoutA data acceptor key for publishing the index inside their layer for all nodes in the graph.
SUBCOMPONENT_DESCRIPTOR_DP_KEYin HierarchicLayoutA data provider key for specifying custom subcomponents of the input graph.
SWIMLANE_DESCRIPTOR_DP_KEYin HierarchicLayoutA data provider key for defining swimlanes for the nodes.
TABULAR_GROUP_CHILD_COMPARER_DP_KEYin HierarchicLayoutA data provider key for specifying orderings of child nodes of a tabular group node.
TABULAR_GROUPS_DP_KEYin HierarchicLayoutA data provider key for marking tabular group nodes.
UNIFORM_PORT_ASSIGNMENT_GROUPS_DP_KEYin HierarchicLayoutA data provider key for specifying whether or not the ports of edges incident to a specific group node should be uniformly distributed.
INCREMENTAL_NODES_DP_KEYin HierarchicLayoutCoreA data provider key for internal use only.
LAYER_INDEX_DP_KEYin HierarchicLayoutCoreA data acceptor key for publishing the layer IDs for all nodes in the graph.
NODE_LAYOUT_DESCRIPTOR_DP_KEYin HierarchicLayoutCoreA data provider key for providing layout information for each node.
SEQUENCE_INDEX_DP_KEYin HierarchicLayoutCoreA data acceptor key for publishing the index inside their layer for all nodes in the graph.
SWIMLANE_DESCRIPTOR_DP_KEYin HierarchicLayoutCoreA data provider key for providing information about swimlanes.
MINIMUM_NODE_DISTANCE_DP_KEYin SelfLoopCalculatorA data provider key for defining for each node a minimum distance to the self-loop edges.
SNAP_OFFSET_DP_KEYin AlignmentStageA data provider key for specifying the points of the nodes that are aligned.
COLLAPSED_SUBTREE_ROOTS_DP_KEYin CactusGroupLayoutA data provider key for specifying the roots of collapsed subtrees in the hierarchy.
PARENT_OVERLAP_RATIO_DP_KEYin CactusGroupLayoutA data provider key for specifying the overlap of nodes with their parent in the hierarchy.
AFFECTED_COMPONENTS_DP_KEYin ComponentLayoutA data provider key for specifying which nodes should be arranged.
COMPONENT_ID_DP_KEYin ComponentLayoutA data provider key for specifying custom graph components.
FIXED_GROUP_NODES_DP_KEYin FixGroupLayoutStageA data provider key for selecting group nodes whose contents should keep their relative positions.
FIXED_NODE_DP_KEYin FixNodeLayoutStageA data provider key for determining the nodes that should be considered fixed.
NODE_LOCATION_DP_KEYin GivenCoordinatesStageA data provider key for specifying the initial location of nodes.
NODE_SIZE_DP_KEYin GivenCoordinatesStageA data provider key for specifying the size of nodes.
GROUP_DP_KEYin GroupingKeysA data provider key for distinguishing normal nodes from group nodes.
GROUP_NODE_INSETS_DP_KEYin GroupingKeysA data provider key for assigning insets for group nodes.
MINIMUM_NODE_SIZE_DP_KEYin GroupingKeysA data provider key for assigning minimum sizes for group nodes.
NODE_ID_DP_KEYin GroupingKeysA data provider key for assigning a unique ID for each node.
PARENT_NODE_ID_DP_KEYin GroupingKeysA data provider key for describing the hierarchy of nodes in the graph.
NODE_LABEL_LAYOUT_DP_KEYin LabelLayoutKeysA data provider key for accessing label information of each node in the input graph.
ORIGINAL_NODE_DP_KEYin LayoutGraphAdapterA data provider key that can be used to look up the original INode of a YNode.
PORT_DUMMY_NODE_DP_KEYin LayoutGraphAdapterThis key is used to provide information about dummy nodes that have been inserted into the graph to model edges at edges.
AFFECTED_NODES_DP_KEYin LayoutKeysA data provider key for looking up the selected state of the nodes in the graph.
NODE_ID_DP_KEYin LayoutKeysA data provider key for looking up a unique identifier for each node in a graph.
NODE_TYPE_DP_KEYin LayoutKeysA data provider key for specifying the type of the nodes in the graph.
LAYOUT_DP_KEYin LayoutMultiplexerA data provider key for assigning layout algorithms to the nodes.
NODE_HALO_DP_KEYin NodeHaloA data provider key for assigning halos for the nodes.
NODE_COMPARABLE_DP_KEYin NormalizeGraphElementOrderStageA data provider key for defining a (global) order for nodes.
PARTITION_CELL_ID_DP_KEYin PartitionGridA data provider key for storing a set of partition cells for each node.
AFFECTED_NODES_DP_KEYin PlaceNodesAtBarycenterStageA data provider key for determining which nodes should be placed by this stage.
AFFECTED_NODES_SIZE_DP_KEYin PlaceNodesAtBarycenterStageA data provider key for specifying the size of affected nodes.
NODE_PORT_CANDIDATE_SET_DP_KEYin PortCandidateSetA data provider key for specifying a port candidate set for each node.
GROUP_NODE_LAYOUT_DP_KEYin RecursiveGroupLayoutA data provider key for arranging the content of each group node with an individual layout algorithm.
GROUP_NODE_PARTITION_GRID_DP_KEYin RecursiveGroupLayoutA data provider key for specifying a local partition grid for each group node.
NODE_LAYOUT_DESCRIPTOR_DP_KEYin TabularLayoutA data provider key for providing layout information for each node.
INSERTED_GROUP_NODE_DP_KEYin TemporaryGroupNodeInsertionStageA data provider key that this stage uses for marking the inserted group nodes.
TEMPORARY_GROUP_DESCRIPTOR_DP_KEYin TemporaryGroupNodeInsertionStageA data provider key for specifying temporary groups of the input graph.
NODE_CLUSTER_ID_DP_KEYin MultiPageLayoutA data provider key for assigning a cluster ID to common (non-group) nodes.
NODE_ID_DP_KEYin MultiPageLayoutA data provider key for mapping each node of the input graph to a unique ID.
AFFECTED_NODES_DP_KEYin ClassicOrganicLayoutA data provider key for marking the nodes that are part of the current scope.
FIXED_GROUP_NODES_DP_KEYin ClassicOrganicLayoutA data provider key for marking group nodes as fixed.
AFFECTED_NODES_DP_KEYin OrganicLayoutA data provider key for marking the nodes that are part of the relevant subset.
CLUSTER_ID_DP_KEYin OrganicLayoutA data provider key for specifying user-defined node clusters.
GROUP_NODE_MODE_DP_KEYin OrganicLayoutA data provider key for assigning individual modes for all group nodes.
NODE_INERTIA_DP_KEYin OrganicLayoutA data provider key for specifying the inertia of nodes.
NODE_STRESS_DP_KEYin OrganicLayoutA data provider key for specifying the stress of nodes.
OVERLAPPING_NODES_DP_KEYin OrganicLayoutA data provider key for marking nodes that are allowed to overlap other nodes.
Z_COORDINATE_DP_KEYin OrganicLayoutA data acceptor key for publishing the z-coordinate for all non-group nodes in the graph.
FIXED_NODE_DP_KEYin OrganicRemoveOverlapsStageA data provider key for marking nodes as fixed.
FIXED_NODE_DP_KEYin ShuffleLayoutA data provider key for marking nodes as fixed.
MINIMUM_DISTANCE_DP_KEYin ShuffleLayoutA data provider key for specifying a minimum distance for each node.
AREA_GROUP_NODE_DP_KEYin ClearAreaLayoutA data provider key for specifying the group node inside which the cleared area should be located.
AREA_NODES_DP_KEYin ClearAreaLayoutA data provider key for specifying a set of nodes that define the area which should be cleared.
COMPONENT_ID_DP_KEYin ClearAreaLayoutA data provider key for defining custom components whose elements should preferably not be separated.
EXPANDED_NODE_DP_KEYin ClearAreaLayoutA data provider key for marking the node that was expanded and, thus, defines the area that must be cleared.
COMPONENT_ID_DP_KEYin FillAreaLayoutA data provider key for defining custom components whose elements should preferably not be separated.
FIXED_NODE_DP_KEYin FillAreaLayoutA data provider key for marking nodes as fixed.
AFFECTED_NODES_DP_KEYin PartialLayoutA data provider key for marking partial nodes.
COMPONENT_ID_DP_KEYin PartialLayoutA data provider key for defining custom subgraph components.
LAYER_ID_DP_KEYin RadialLayoutA data provider key for providing user-defined layer/circle IDs.
NODE_INFO_DP_KEYin RadialLayoutA data acceptor key for publishing the circle ID and sector data.
OUT_EDGE_COMPARER_DP_KEYin RadialLayoutA data provider key for specifying the comparator for the outgoing edges which ultimately orders the successor nodes of a node.
OUT_EDGE_COMPARER_DP_KEYin SeriesParallelLayoutA data provider key for assigning different orderings for outgoing edges of the nodes.
PORT_ASSIGNMENT_DP_KEYin SeriesParallelLayoutA data provider key for providing an individual port distribution at nodes.
ROOT_PLACEMENT_DP_KEYin AspectRatioTreeLayoutA data provider key for specifying the placement of each subtree root.
SELECTED_ROOT_DP_KEYin AspectRatioTreeLayoutA data provider key for marking the node that will be used as root node of the tree.
SUBTREE_ASPECT_RATIO_DP_KEYin AspectRatioTreeLayoutA data provider key for specifying a target aspect ratio for each subtree.
SUBTREE_ROUTING_POLICY_DP_KEYin AspectRatioTreeLayoutA data provider key for specifying the routing direction for each subtree root.
ASSISTANT_NODE_DP_KEYin AssistantNodePlacerA data provider key for marking which nodes are placed as assistants.
INTERLEAVED_NODES_DP_KEYin BalloonLayoutA data provider key for marking nodes whose child nodes should be placed in an interleaved fashion.
SELECTED_ROOT_DP_KEYin BalloonLayoutA data provider key for marking the node that will be used as root node of the tree.
SELECTED_ROOT_DP_KEYin ClassicTreeLayoutA data provider key for marking the node that will be used as root node of the tree.
STRATEGY_MEMENTO_DP_KEYin CompactNodePlacerA data acceptor key for storing/restoring the placement strategy of the children of nodes.
PRIMARY_NODES_DP_KEYin DelegatingNodePlacerA data provider key for dividing the children into two sets.
ROW_INDEX_DP_KEYin GridNodePlacerA data provider key for assigning nodes to the rows in the grid.
LEFT_RIGHT_DP_KEYin LeftRightNodePlacerA data provider key for assigning nodes to the left or the right side of the bus.
NODE_ORDER_COMPARABLE_DP_KEYin NodeOrderComparerA data provider key for registering an order for each node in the graph.
DUMMY_NODE_DP_KEYin TreeComponentLayoutA data provider key for identifying dummy nodes during the layout calculation.
MULTI_PARENT_DESCRIPTOR_DP_KEYin TreeLayoutA data provider key for retrieving descriptors for nodes in multi-parent structures.
NODE_PLACER_DP_KEYin TreeLayoutA data provider key for specifying a child node placer for each node.
OUT_EDGE_COMPARER_DP_KEYin TreeLayoutA data provider key for specifying the comparator for the outgoing edges.
PORT_ASSIGNMENT_DP_KEYin TreeLayoutA data provider key for assigning ports to nodes.
SELECTED_ROOT_DP_KEYin TreeLayoutA data provider key for marking the node that will be used as root node of the tree.
NODE_WEIGHT_DP_KEYin TreeMapLayoutA data provider key for specifying the weight of the nodes.

Method Parameters

createConstantMapper (NodeDpKey<V>, V)in IMapperRegistryCreates a simple read-only IMapper<K,V> implementation with key type INode and adds it to the registry using the provided tag.
createDelegateMapper (NodeDpKey<V>, function(INode):V)in IMapperRegistryCreates a delegate-based read-only IMapper<K,V> implementation with key type INode and adds it to the registry using the provided tag.
createMapper (NodeDpKey<V>)in IMapperRegistryCreates and adds a new Mapper<K,V> with key type INode to the registry using the provided tag.
addNodeItemCollection (NodeDpKey<boolean>, ItemCollection<INode>?)in GenericLayoutDataAdds a set of INodes in the graph that will be passed to the LayoutGraph
addNodeItemMapping (NodeDpKey<TValue>, ItemMapping<INode,TValue>?)in GenericLayoutDataAdds data per INode in the graph that will be added to the LayoutGraph