com.yworks.yfiles.graph.labelmodels

Interface ILabelCandidateDescriptorProvider

All Known Implementing Classes:

ConstantLabelCandidateDescriptorProvider, DescriptorWrapperLabelModel, GenericLabelModel

public interface ILabelCandidateDescriptorProvider

An interface that can be used to retrieve ILabelCandidateDescriptor instances for a given pair of a ILabel and a candidate parameter.

This interface can be used by automatic labeling algorithms to help decide which labels candidate positions should be used.

See Also:

ILabelCandidateDescriptor

Method Summary

Modifier and Type	Method and Description
ILabelCandidateDescriptor	getDescriptor(ILabel label, ILabelModelParameter layoutParameter) Gets the descriptor for a given pair of a label and a ILabelModelParameter.

Method Detail

getDescriptor

ILabelCandidateDescriptor getDescriptor(ILabel label,
                                        ILabelModelParameter layoutParameter)

Gets the descriptor for a given pair of a label and a ILabelModelParameter.

Parameters:

label - The label to possibly assign the layoutParameter.

layoutParameter - The parameter to provide a descriptor for if applied to the given label.

Returns:

A descriptor or null.