An interface that can be used to retrieve ILabelCandidateDescriptor instances for a given pair of a ILabel and a candidate parameter.
Inheritance Hierarchy
ILabelCandidateDescriptorProvider
Remarks
This interface can be used by automatic labeling algorithms to help decide which labels candidate positions should be used.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.graph.ILabelCandidateDescriptorProvider
See Also
Methods
Gets the descriptor for a given pair of a label and a ILabelModelParameter.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- label - ILabel
- The label to possibly assign the
layoutParameter. - layoutParameter - ILabelModelParameter
- The parameter to provide a descriptor for if applied to the given
label.
Returns
- ↪ILabelCandidateDescriptor
- A descriptor or
null.