documentationfor yFiles for HTML 3.0.0.3

Usages of EdgeDataKey

Fields

EDGE_WEIGHT_DATA_KEYin LayoutGraphNodeAggregationA data key for specifying the (non-negative) weights of the edges.
EXTERIOR_EDGES_DATA_KEYin CircularLayoutA data key for marking edges that should be routed externally, around the circle instead of inside.
ADDITIONAL_EDGE_WEIGHT_DATA_KEYin ConstraintIncrementalLayerAssignerA data key for assigning additional edge weights.
ALTERNATIVE_EDGE_PATH_DATA_KEYin HierarchicalLayoutA data key for associating alternative paths for edges connecting to groups, group content or folder nodes.
CRITICAL_EDGE_PRIORITY_DATA_KEYin HierarchicalLayoutA data key for defining the priority of critical edges.
EDGE_CROSSING_COST_DATA_KEYin HierarchicalLayoutA data key for specifying individual crossing costs of the edges.
EDGE_DESCRIPTOR_DATA_KEYin HierarchicalLayoutA data key for providing layout information for each edge.
EDGE_THICKNESS_DATA_KEYin HierarchicalLayoutA data key for specifying the thickness of the edges.
GRID_COMPONENT_DESCRIPTOR_DATA_KEYin HierarchicalLayoutA data key for specifying the grid component to which an edge belongs.
INCREMENTAL_EDGE_HINTS_DATA_KEYin HierarchicalLayoutA data key for specifying incremental hints.
AFFECTED_EDGES_DATA_KEYin BendSubstitutionStageA data key to register an IMapper<K,V> which identifies edges as selected.
DEFAULT_AFFECTED_EDGES_DATA_KEYin CurveFittingStageA data key for selecting edges for curve fitting.
EDGE_BUNDLE_DESCRIPTOR_DATA_KEYin EdgeBundlingA data key for specifying individual bundling settings for edges.
SOURCE_PORT_CANDIDATES_DATA_KEYin EdgePortCandidatesA data key for specifying source port candidates for each edge.
TARGET_PORT_CANDIDATES_DATA_KEYin EdgePortCandidatesA data key for specifying target port candidates for each edge.
INTER_EDGES_DATA_KEYin GenericLayoutGridStageAn IMapper<K,V> key for marking the inter-edges to be routed.
SPLIT_EDGES_DATA_KEYin GenericLayoutGridStageA data key for explicitly marking (some) edges that should not be considered when calculating the sub-components.
EDGE_PATH_DATA_KEYin GivenCoordinatesLayoutA data key for specifying the initial path of edges.
EDGE_ANCHORING_POLICY_DATA_KEYin LayoutAnchoringStageA data key used to specify the edges that should be used to calculate the anchor point.
UNCONNECTED_EDGE_PORTS_DATA_KEYin LayoutExecutorAsyncWorkerA data provider key that can be used to retrieve information about unconnectedports of the original LayoutEdge.
ORIGINAL_EDGE_DATA_KEYin LayoutGraphAdapterA data provider key that can be used to look up the original IEdge of an LayoutEdge.
ORIGINAL_SOURCE_PORT_DATA_KEYin LayoutGraphAdapterA data provider key that can be used to look up the source port of the original IEdge of an LayoutEdge.
ORIGINAL_TARGET_PORT_DATA_KEYin LayoutGraphAdapterA data provider key that can be used to look up the target port of the original IEdge of an LayoutEdge.
UNCONNECTED_EDGE_PORTS_DATA_KEYin LayoutGraphAdapterA data provider key that can be used to look up the original unconnected ports of the original IPortOwner of an LayoutEdge in the case of edge-to-edge connections.
EDGE_DIRECTEDNESS_DATA_KEYin LayoutKeysA data key for specifying the directedness of edges.
ROUTE_EDGES_DATA_KEYin LayoutKeysA data key for specifying the graph edges as in- or out-of-scope for edge routing algorithms.
SOURCE_EDGE_GROUP_ID_DATA_KEYin LayoutKeysA data key for assigning source edge group information for edges.
SOURCE_PORT_ALIGNMENT_ID_DATA_KEYin LayoutKeysA data key for assigning source alignment information for edges.
SOURCE_PORT_GROUP_ID_DATA_KEYin LayoutKeysA data key for assigning port group ids to the edges' source.
TARGET_EDGE_GROUP_ID_DATA_KEYin LayoutKeysA data key for assigning target edge group information for edges.
TARGET_PORT_ALIGNMENT_ID_DATA_KEYin LayoutKeysA data key for assigning target alignment information for edges.
TARGET_PORT_GROUP_ID_DATA_KEYin LayoutKeysA data key for assigning port group ids to the edges' target.
SOURCE_SPLIT_ID_DATA_KEYin RecursiveGroupLayoutA data key for assigning source split ids to edges connecting to group nodes.
TARGET_SPLIT_ID_DATA_KEYin RecursiveGroupLayoutA data key for assigning target split ids to edges connecting to group nodes.
AFFECTED_EDGES_DATA_KEYin ReverseEdgesStageA data key for selecting edges for reversal.
SUBGRAPH_EDGES_DATA_KEYin SubgraphLayoutStageA data key for marking edges that are included in the subgraph, thus, visible during the core layout.
EDGE_ID_DATA_KEYin MultiPageLayoutA data key for mapping each edge of the input graph to a unique ID.
MULTI_EDGE_CONNECTOR_ID_DATA_KEYin MultiPageLayoutA data key for specifying which multi-edges may share a connector node.
EDGE_HANDLE_DATA_KEYin InteractiveOrganicLayoutA data key for specifying the InteractiveOrganicEdgeHandle instances that provide more information as input and updated information about edges after the layout stopped.
EDGE_ORIENTATION_DATA_KEYin OrganicLayoutA data key for specifying the orientation of edges in the layout.
MINIMUM_EDGE_LENGTH_DATA_KEYin OrganicLayoutA data key for specifying the minimum length of edges.
PREFERRED_EDGE_LENGTH_DATA_KEYin OrganicLayoutA data key for defining an individual preferred length for each edge.
SUBSTRUCTURE_SOURCE_GROUP_ID_DATA_KEYin OrganicLayoutA data key for assigning source edge group information for edges.
SUBSTRUCTURE_TARGET_GROUP_ID_DATA_KEYin OrganicLayoutA data key for assigning target edge group information for edges.
EDGE_BEND_COST_DATA_KEYin OrthogonalLayoutA data key for providing bend costs for each edge.
EDGE_CROSSING_COST_DATA_KEYin OrthogonalLayoutA data key for providing crossing costs for each edge.
EDGE_DESCRIPTOR_DATA_KEYin OrthogonalLayoutA data key for providing layout information for each edge.
EDGE_ORIENTATION_DATA_KEYin OrthogonalLayoutA data key for specifying the orientation of edges with respect to the main layout orientation.
EXPANDED_NODE_ORIGINAL_EDGE_PATH_DATA_KEYin ClearAreaLayoutA data key for associating original paths for edges connecting to the expanded node, including edges that did so only when the node was not yet expanded.
EDGE_ORIENTATION_DATA_KEYin PartialLayoutA data key for specifying the orientation of edges with respect to the main layout orientation.
EDGE_SCOPE_DATA_KEYin PartialLayoutA data key for marking partial edges.
EDGE_DESCRIPTOR_DATA_KEYin CurveRoutingStageA data key for specifying individual edge layout information.
BUS_DESCRIPTOR_DATA_KEYin EdgeRouterA data key for specifying a bus descriptor for each edge.
EDGE_DESCRIPTOR_DATA_KEYin EdgeRouterA data key for specifying individual edge layout information.
SCOPE_DATA_KEYin EdgeRouterA IMapper<K,V> key to look up the selection state of the edges.
AFFECTED_EDGES_DATA_KEYin ParallelEdgeRouterA data key for marking edges that will be routed.
LEADING_EDGE_DATA_KEYin ParallelEdgeRouterA data key for specifying the leading edges.
ROUTED_MULTI_EDGES_RESULT_DATA_KEYin ParallelEdgeRouterA data key for publishing the multi-edges that were routed and not treated as leading edges.
SELF_LOOP_SCOPE_DATA_KEYin SelfLoopRouterA data key for determining which self-loops should be routed.
EDGE_DESCRIPTOR_DATA_KEYin SeriesParallelLayoutA data key for storing individual settings for edges.
CRITICAL_EDGE_DATA_KEYin TreeLayoutA data key for defining the priority of critical edges.
NON_TREE_EDGES_DATA_KEYin TreeReductionStageA data key for explicitly marking (some) edges that should not be considered for the tree.
NON_TREE_EDGES_RESULT_DATA_KEYin TreeReductionStageA data key for publishing the non-tree edges that this stage actually selected.

Method Parameters

WeightedLayerAssigner (EdgeDataKey<number>?, )in WeightedLayerAssignerCreates an instance of WeightedLayerAssigner with unlimited stop duration and the given key that provides access to the IMapper<K,V> that holds the edge weights.
addDataKeyTransfer (EdgeDataKey<T>, EdgeDataKey<T>)in ContextModificationStageAdds the specified keys as a pair of keys whose associated data should be transferred.
addHiddenKey (EdgeDataKey<T>)in ContextModificationStageAdds the specified key to the data keys whose associated data is temporarily hidden by this stage.
addReplacementMap (EdgeDataKey<T>, IMapper<LayoutEdge,T>)in ContextModificationStageAdds the specified key to the data keys whose associated data is temporarily replaced by this stage.
addItemCollection (EdgeDataKey<boolean>, ItemCollectionConvertible<TEdge>?)in GenericLayoutDataAdds a set of TEdge in the graph that will be passed to the LayoutGraph.
addItemMapping (EdgeDataKey<TValue>, ItemMappingConvertible<TEdge,TValue>?)in GenericLayoutDataAdds data per TEdge in the graph that will be added to the LayoutGraph.
getData (EdgeDataKey<TData>)in LayoutEdgeReturns the data stored for the edge in the IMapper<K,V> registered with the owning graph under the given look-up key.
addItemData (EdgeDataKey<T>, IMapper<IEdge,T>)in LayoutGraphAdapterRegisters data for individual edges at the graph with the specified EdgeDataKey<TValue>.
addItemData (EdgeDataKey<T>, function(IEdge):T, function(IEdge, T):void?)in LayoutGraphAdapterRegisters data for individual edges at the graph with the specified EdgeDataKey<TValue>.
addItemConstantData (EdgeDataKey<TValue>, TValue)in LayoutGraphContextRegisters a constant value for all edges at the graph with the specified data key.
addItemData (EdgeDataKey<TValue>, IMapper<LayoutEdge,TValue>)in LayoutGraphContextRegisters data for individual edges at the graph with the specified EdgeDataKey<TValue>.
addItemData (EdgeDataKey<TValue>, function(LayoutEdge):TValue, function(LayoutEdge, TValue):void?)in LayoutGraphContextRegisters data for individual edges at the graph with the specified EdgeDataKey<TValue>.
getItemData (EdgeDataKey<TValue>)in LayoutGraphContextGets data for individual edges registered for the graph with the specified EdgeDataKey<TValue>.
hideItemData (EdgeDataKey<TValue>)in LayoutGraphContextHides the item data registered for the graph with the specified EdgeDataKey<TValue>.