documentationfor yFiles for HTML 3.0.0.3

Usages of NodeDataKey

Fields

NODE_WEIGHT_DATA_KEYin LayoutGraphNodeAggregationA data key for specifying the (non-negative) weights of the nodes.
TOP_LEVEL_NODES_DATA_KEYin LayoutGraphNodeAggregationA data key for specifying the top-level nodes of the aggregation info.
CIRCLE_ID_RESULT_DATA_KEYin CircularLayoutA data key for publishing the final circle information.
PARTITION_DATA_KEYin CircularLayoutA data key for defining custom node partitions.
CORE_NODES_DATA_KEYin BfsLayerAssignerA data key for identifying the core nodes of the BFS layering.
LAYER_INDEX_DATA_KEYin GivenLayersAssignerA data key for storing the layer indices.
PLACE_BEFORE_BUS_DATA_KEYin GridComponentDescriptorA data key for assigning nodes to a specific side of the common bus.
ROOT_OFFSET_DATA_KEYin GridComponentDescriptorA data key for assigning nodes to specific layers relative to the root node of the grid component.
ALTERNATIVE_GROUP_BOUNDS_DATA_KEYin HierarchicalLayoutA data key for associating an alternative bounds with the collapsed/expanded group.
FOLDER_NODES_DATA_KEYin HierarchicalLayoutA data key for marking folder nodes.
GROUP_BORDER_CROSSING_COST_DATA_KEYin HierarchicalLayoutA data key for specifying individual crossing costs for vertical borders of group nodes.
INCREMENTAL_NODE_HINTS_DATA_KEYin HierarchicalLayoutA data key for specifying incremental hints.
LAYER_INDEX_RESULT_DATA_KEYin HierarchicalLayoutA data key for publishing the layer ID of each node.
NODE_DESCRIPTOR_DATA_KEYin HierarchicalLayoutA data key for providing layout information for each node.
SEQUENCE_INDEX_RESULT_DATA_KEYin HierarchicalLayoutA data key for publishing the index inside their layer for each node.
SUBCOMPONENT_DESCRIPTOR_DATA_KEYin HierarchicalLayoutA data key for specifying custom subcomponents.
TABULAR_GROUP_CHILD_COMPARATOR_DATA_KEYin HierarchicalLayoutA data key for specifying orderings of child nodes of a tabular group node.
TABULAR_GROUPS_DATA_KEYin HierarchicalLayoutA data key for marking tabular group nodes.
UNIFORM_PORT_ASSIGNMENT_GROUPS_DATA_KEYin HierarchicalLayoutA data key for specifying whether or not the ports of edges incident to a specific group node should be uniformly distributed.
SNAP_OFFSET_DATA_KEYin AlignmentStageA data key for specifying the points of the nodes that are aligned.
AFFECTED_COMPONENTS_DATA_KEYin ComponentLayoutA data key for specifying which components should be arranged.
COMPONENT_ID_DATA_KEYin ComponentLayoutA data key for specifying custom graph components.
COMPONENT_LAYOUT_DATA_KEYin ComponentLayoutA data key for arranging the nodes of each component with an individual layout algorithm.
NODE_LOCATION_DATA_KEYin GivenCoordinatesLayoutA data key for specifying the initial location of nodes.
NODE_SIZE_DATA_KEYin GivenCoordinatesLayoutA data key for specifying the size of nodes.
NODE_ANCHORING_POLICY_DATA_KEYin LayoutAnchoringStageA data key used to specify the nodes that should be used to calculate the anchor point.
UNCONNECTED_NODE_PORTS_DATA_KEYin LayoutExecutorAsyncWorkerA data provider key that can be used to retrieve information about unconnectedports of the original LayoutNode.
ORIGINAL_NODE_DATA_KEYin LayoutGraphAdapterA data provider key that can be used to look up the original INode of a LayoutNode.
PORT_HELPER_NODE_DATA_KEYin LayoutGraphAdapterThis key is used to provide information about helper nodes that have been inserted into the graph to model edges at edges.
UNCONNECTED_NODE_PORTS_DATA_KEYin LayoutGraphAdapterA data provider key that can be used to look up the original unconnected ports of the original IPortOwner of an LayoutNode.
LAYOUT_GRID_CELL_DESCRIPTOR_DATA_KEYin LayoutGridA data key for storing a set of layout grid cells for each node.
GROUP_NODE_PADDING_DATA_KEYin LayoutKeysGets a NodeDataKey<TValue> used for specifying the padding around the contents of group nodes.
MINIMUM_GROUP_NODE_SIZE_DATA_KEYin LayoutKeysGets a NodeDataKey<TValue> used for specifying the minimum size of group nodes.
NODE_MARGIN_DATA_KEYin LayoutKeysA data key for assigning margins for the nodes.
NODE_TYPE_DATA_KEYin LayoutKeysA data key for specifying the type of the nodes in the graph.
NODE_PORT_CANDIDATES_DATA_KEYin NodePortCandidatesA data key for specifying a port candidate set for each node.
AFFECTED_NODES_DATA_KEYin PlaceNodesAtBarycenterStageA data key for determining which nodes should be placed by this stage.
AFFECTED_NODES_SIZE_DATA_KEYin PlaceNodesAtBarycenterStageA data key for specifying the size of affected nodes.
COLLAPSED_SUBTREE_ROOTS_DATA_KEYin RadialGroupLayoutA data key for specifying the roots of collapsed subtrees in the hierarchy.
PARENT_OVERLAP_RATIO_DATA_KEYin RadialGroupLayoutA data key for specifying the overlap of nodes with their parent in the hierarchy.
GROUP_NODE_LAYOUT_DATA_KEYin RecursiveGroupLayoutA data key for arranging the content of each group node with an individual layout algorithm.
FIXED_NODE_DATA_KEYin RemoveOverlapsStageA data key for marking nodes as fixed.
MINIMUM_DISTANCE_DATA_KEYin RemoveOverlapsStageA data key for specifying an individual minimum distance for each node.
SUBGRAPH_NODES_DATA_KEYin SubgraphLayoutStageA data key for marking nodes that are included in the subgraph, thus, visible during the core layout.
LAYOUT_GRID_CELL_DESCRIPTOR_RESULT_DATA_KEYin TabularLayoutA data key for publishing the layout grid cell descriptors for all nodes in the graph.
NODE_DESCRIPTOR_DATA_KEYin TabularLayoutA data key for providing layout information for each node.
INSERTED_GROUP_NODE_DATA_KEYin TemporaryGroupInsertionStageA data key that this stage uses for marking the inserted group nodes.
TEMPORARY_GROUP_DESCRIPTOR_DATA_KEYin TemporaryGroupInsertionStageA data key for specifying temporary groups of the input graph.
NODE_CLUSTER_ID_DATA_KEYin MultiPageLayoutA data key for assigning a cluster ID to common (non-group) nodes.
NODE_ID_DATA_KEYin MultiPageLayoutA data key for mapping each node of the input graph to a unique ID.
NODE_HANDLE_DATA_KEYin InteractiveOrganicLayoutA data key for specifying the InteractiveOrganicNodeHandle instances that provide more information as input and information about updated positions of nodes after the layout stopped.
CLUSTER_ID_DATA_KEYin OrganicLayoutA data key for specifying user-defined node clusters.
GROUP_NODE_HANDLING_POLICY_DATA_KEYin OrganicLayoutA data key for assigning individual policies for all group nodes.
NODE_INERTIA_DATA_KEYin OrganicLayoutA data key for specifying the inertia of nodes.
NODE_STRESS_DATA_KEYin OrganicLayoutA data key for specifying the stress of nodes.
OVERLAPPING_NODES_DATA_KEYin OrganicLayoutA data key for marking nodes that are allowed to overlap other nodes.
SCOPE_DATA_KEYin OrganicLayoutA data key for marking the nodes that are part of the relevant subset.
Z_COORDINATE_RESULT_DATA_KEYin OrganicLayoutA data key for publishing the z-coordinate for all non-group nodes in the graph.
AREA_GROUP_NODE_DATA_KEYin ClearAreaLayoutA data key for specifying the group node inside which the cleared area should be located.
AREA_NODES_DATA_KEYin ClearAreaLayoutA data key for specifying a set of nodes that define the area which should be cleared.
COMPONENT_ID_DATA_KEYin ClearAreaLayoutA data key for defining custom components whose elements should preferably not be separated.
EXPANDED_NODE_DATA_KEYin ClearAreaLayoutA data key for marking the node that was expanded and, thus, defines the area that must be cleared.
COMPONENT_ID_DATA_KEYin FillAreaLayoutA data key for defining custom components whose elements should preferably not be separated.
FIXED_NODE_DATA_KEYin FillAreaLayoutA data key for marking nodes as fixed.
COMPONENT_ID_DATA_KEYin PartialLayoutA data key for defining custom subgraph components.
NODE_SCOPE_DATA_KEYin PartialLayoutA data key for marking partial nodes.
CENTER_NODES_DATA_KEYin RadialLayoutA data key for marking custom nodes that should be placed in the center.
LAYER_ID_DATA_KEYin RadialLayoutA data key for providing user-defined layer/circle IDs.
NODE_PLACEMENT_RESULT_DATA_KEYin RadialLayoutA data key for publishing the circle ID and sector data.
OUT_EDGE_COMPARATOR_DATA_KEYin RadialLayoutA data key for specifying the comparator for the outgoing edges which ultimately orders the successor nodes of a node.
OUT_EDGE_COMPARATOR_DATA_KEYin SeriesParallelLayoutA data key for assigning different orderings for outgoing edges of the nodes.
PORT_ASSIGNER_DATA_KEYin SeriesParallelLayoutA data key for providing an individual port distribution at nodes.
ASSISTANT_NODE_DATA_KEYin AssistantSubtreePlacerA data key for marking which nodes are placed as assistants.
STRATEGY_MEMENTO_DATA_KEYin CompactSubtreePlacerA data key for storing/restoring the placement strategy of the children of nodes.
LEFT_RIGHT_DATA_KEYin LeftRightSubtreePlacerA data key for assigning nodes to the left or the right side of the bus.
LAYER_INDEX_DATA_KEYin MultiLayerSubtreePlacerA data key for assigning nodes to the local layers.
INTERLEAVED_NODES_DATA_KEYin RadialTreeLayoutA data key for marking nodes whose child nodes should be placed in an interleaved fashion.
OUT_EDGE_COMPARATOR_DATA_KEYin RadialTreeLayoutA data key for specifying a comparison instance that determines the order of the outgoing edges for each node of the tree individually.
SELECTED_ROOT_DATA_KEYin RadialTreeLayoutA data key for marking the node that will be used as root node of the tree.
PRIMARY_NODES_DATA_KEYin SingleSplitSubtreePlacerA data key for dividing the children into two sets.
MULTI_PARENT_DESCRIPTOR_DATA_KEYin TreeLayoutA data key for retrieving descriptors for nodes in multi-parent structures.
OUT_EDGE_COMPARATOR_DATA_KEYin TreeLayoutA data key for specifying the comparer for the outgoing edges.
PORT_ASSIGNER_DATA_KEYin TreeLayoutA data key for assigning ports to nodes.
SELECTED_ROOT_DATA_KEYin TreeLayoutA data key for marking the node that will be used as root node of the tree.
SUBTREE_PLACER_DATA_KEYin TreeLayoutA data key for specifying a child subtree placer for each node.
NODE_WEIGHT_DATA_KEYin TreeMapLayoutA data key for specifying the weight of the nodes.

Method Parameters

addDataKeyTransfer (NodeDataKey<T>, NodeDataKey<T>)in ContextModificationStageAdds the specified keys as a pair of keys whose associated data should be transferred.
addHiddenKey (NodeDataKey<T>)in ContextModificationStageAdds the specified key to the data keys whose associated data is temporarily hidden by this stage.
addReplacementMap (NodeDataKey<T>, IMapper<LayoutNode,T>)in ContextModificationStageAdds the specified key to the data keys whose associated data is temporarily replaced by this stage.
addItemCollection (NodeDataKey<boolean>, ItemCollectionConvertible<TNode>?)in GenericLayoutDataAdds a set of TNodes in the graph that will be passed to the LayoutGraph.
addItemMapping (NodeDataKey<TValue>, ItemMappingConvertible<TNode,TValue>?)in GenericLayoutDataAdds data per TNode in the graph that will be added to the LayoutGraph.
addItemData (NodeDataKey<T>, IMapper<INode,T>)in LayoutGraphAdapterRegisters data for individual nodes at the graph with the specified NodeDataKey<TValue>.
addItemData (NodeDataKey<T>, function(INode):T, function(INode, T):void?)in LayoutGraphAdapterRegisters data for individual nodes at the graph with the specified NodeDataKey<TValue>.
addItemConstantData (NodeDataKey<TValue>, TValue)in LayoutGraphContextRegisters a constant value for all nodes at the graph with the specified data key.
addItemData (NodeDataKey<TValue>, IMapper<LayoutNode,TValue>)in LayoutGraphContextRegisters data for individual nodes at the graph with the specified NodeDataKey<TValue>.
addItemData (NodeDataKey<TValue>, function(LayoutNode):TValue, function(LayoutNode, TValue):void?)in LayoutGraphContextRegisters data for individual nodes at the graph with the specified NodeDataKey<TValue>.
getItemData (NodeDataKey<TValue>)in LayoutGraphContextGets data for individual nodes registered for the graph with the specified NodeDataKey<TValue>.
hideItemData (NodeDataKey<TValue>)in LayoutGraphContextHides the item data registered for the graph with the specified NodeDataKey<TValue>.
getData (NodeDataKey<TData>)in LayoutNodeRetrieves the data associated with this node from the registered IMapper<K,V> in the owning graph using the specified look-up key.