documentationfor yFiles for HTML 3.0.0.3

Fields

EDGE_LABEL_CANDIDATE_PROCESSOR_DATA_KEYin GenericLabelingThe EdgeLabelDataKey<EdgeLabelCandidateProcessor> key used to associate an edge label candidate processor delegate with an edge label to modify the weights calculated during the GenericLabeling.
EDGE_LABEL_CANDIDATE_RESULT_DATA_KEYin GenericLabelingA data key for publishing the chosen candidates for all affected edge labels.
EDGE_LABEL_CANDIDATES_DATA_KEYin GenericLabelingThe EdgeLabelDataKey<TValue> key to specify candidates for each edge label.
EDGE_LABELING_COSTS_DATA_KEYin GenericLabelingThe EdgeLabelDataKey<LabelingCosts> key to specify LabelingCosts for each edge label.
EDGE_LABEL_PREFERRED_PLACEMENT_DATA_KEYin EdgeLabelPreferredPlacementA data key for specifying the preferred placement of the edge labels.
EDGE_LABEL_ANCHORING_POLICY_DATA_KEYin LayoutAnchoringStageA data key used to specify the edge labels that should be used to calculate the anchor point.
ORIGINAL_EDGE_LABEL_DATA_KEYin LayoutGraphAdapterA data provider key that can be used to look up the original ILabel of an LayoutEdgeLabel.
PLACE_EDGE_LABELS_DATA_KEYin LayoutKeysA data key for specifying the edge labels as in- or out-of-scope for labeling algorithms.
SUBGRAPH_EDGE_LABELS_DATA_KEYin SubgraphLayoutStageA data key for marking edge labels that are included in the subgraph, thus, visible during the core layout.
EDGE_LABEL_ID_DATA_KEYin MultiPageLayoutA data key for mapping each edge label of the input graph to a unique ID.
EDGE_LABEL_CROSSING_COST_FACTOR_DATA_KEYin EdgeRouterA data key for weighting the costs for crossing each edge label individually.

Method Parameters

addDataKeyTransfer (EdgeLabelDataKey<T>, EdgeLabelDataKey<T>)in ContextModificationStageAdds the specified keys as a pair of keys whose associated data should be transferred.
addHiddenKey (EdgeLabelDataKey<T>)in ContextModificationStageAdds the specified key to the data keys whose associated data is temporarily hidden by this stage.
addReplacementMap (EdgeLabelDataKey<T>, IMapper<LayoutEdgeLabel,T>)in ContextModificationStageAdds the specified key to the data keys whose associated data is temporarily replaced by this stage.
addItemCollection (EdgeLabelDataKey<boolean>, ItemCollectionConvertible<TEdgeLabel>?)in GenericLayoutDataAdds a set of edge labels in the graph that will be passed to the LayoutGraph.
addItemMapping (EdgeLabelDataKey<TValue>, ItemMappingConvertible<TEdgeLabel,TValue>?)in GenericLayoutDataAdds data per edge label in the graph that will be added to the LayoutGraph.
getData (EdgeLabelDataKey<TData>)in LayoutEdgeLabelReturns the data stored for the edge label in the IMapper<K,V> registered with the LayoutGraph of the owner under the given look-up key.
addItemData (EdgeLabelDataKey<T>, IMapper<ILabel,T>)in LayoutGraphAdapterRegisters data for individual edge labels at the graph with the specified EdgeLabelDataKey<TValue>.
addItemData (EdgeLabelDataKey<T>, function(ILabel):T, function(ILabel, T):void?)in LayoutGraphAdapterRegisters data for individual edge labels at the graph with the specified EdgeLabelDataKey<TValue>.
addItemData (EdgeLabelDataKey<TValue>, IMapper<LayoutEdgeLabel,TValue>)in LayoutGraphContextRegisters data for individual edge labels at the graph with the specified EdgeLabelDataKey<TValue>.
addItemData (EdgeLabelDataKey<TValue>, function(LayoutEdgeLabel):TValue, function(LayoutEdgeLabel, TValue):void?)in LayoutGraphContextRegisters data for individual edge labels at the graph with the specified EdgeLabelDataKey<TValue>.
getItemData (EdgeLabelDataKey<TValue>)in LayoutGraphContextGets data for individual edge labels registered for the graph with the specified EdgeLabelDataKey<TValue>.
hideItemData (EdgeLabelDataKey<TValue>)in LayoutGraphContextHides the item data registered for the graph with the specified EdgeLabelDataKey<TValue>.