documentationfor yFiles for HTML 3.0.0.3

Usages of LabelCandidate

Properties

edgeLabelCandidatesResultin GenericLabelingDataGets a mapper from edge labels to the LabelCandidates chosen by the labeling algorithm.
nodeLabelCandidatesResultin GenericLabelingDataGets a mapper from node labels to the LabelCandidates chosen by the labeling algorithm.

Fields

EDGE_LABEL_CANDIDATE_RESULT_DATA_KEYin GenericLabelingA data key for publishing the chosen candidates for all affected edge labels.
NODE_LABEL_CANDIDATE_RESULT_DATA_KEYin GenericLabelingA data key for publishing the chosen candidates for all affected node labels.

Method Return Values

buildCandidates (LayoutEdgeLabel)in EdgeLabelCandidatesReturns all LabelCandidates that describe valid label positions.
buildCandidates (LayoutNodeLabel)in NodeLabelCandidatesReturns all LabelCandidates that describe valid label positions.
createEdgeLabelCandidate (ILabel, ILabel, ILabelModelParameter, LayoutEdgeLabel)in LayoutGraphAdapterCreates the LabelCandidate for a given label and ILabelModelParameter combination.
createNodeLabelCandidate (ILabel, ILabel, ILabelModelParameter, LayoutNodeLabel)in LayoutGraphAdapterCreates a LabelCandidate for a given label and ILabelModelParameter combination.

Method Parameters

getOverlapCost (LabelCandidate, LabelCandidate)in GenericLabelingCan be used in custom implementations of modifyWeights to query the calculated overlap costs for the given LabelCandidates.
setOverlapCost (LabelCandidate, LabelCandidate, number)in GenericLabelingCan be used in custom implementations of modifyWeights to set custom overlap penalties for the given LabelCandidates.

Extending Types

ExtendedEdgeLabelCandidateA LabelCandidate that is associated with a label model parameter.
ExtendedNodeLabelCandidateA LabelCandidate that is associated with a label model parameter.