Interface that provides more information about a potential label geometry (a candidate) to an automatic labeling algorithm.
Inheritance Hierarchy
ILabelCandidateDescriptor
Remarks
Typically, instances of this interface are created by an implementation of ILabelCandidateDescriptorProvider for a pair of an ILabel and a ILabelModelParameter that describes a potential placement of that label (a 'candidate').
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.graph.ILabelCandidateDescriptor
See Also
Properties
Gets a penalty value that is used by labeling algorithms to judge the severity if this candidate overlaps with an edge path.
Remarks
This value must be between 0 and 1 (inclusive). A value of 0 means that an overlap is considered not important, while a value of 1 means that an overlap is considered severe.
Gets a value indicating whether this candidate is deemed an external candidate.
Remarks
This is mainly for INode labels that are a visual part of the node's internals. It could be used for edge labels, too, if the edge occupies significant amounts of visual space.
Gets a penalty value that is used by labeling algorithms to judge the severity if this label candidate overlaps with a node's bounds.
Remarks
This value must be between 0 and 1 (inclusive). A value of 0 means that an overlap is considered not important, while a value of 1 means that an overlap is considered severe.