Packagecom.yworks.graph.model
Interfacepublic interface ILabelCandidateDescriptorProvider
Implementors ConstantLabelCandidateDescriptorProvider, DescriptorWrapperLabelModel, GenericLabelModel

An interface that can be used to retrieve ILabelCandidateDescriptor instances for a given combination of ILabels and ILabelModelParameter candidates.

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

See also

ILabelCandidateDescriptor


Public Methods
 MethodDefined By
  
Gets the descriptor for a given combination of label and ILabelModelParameter.
ILabelCandidateDescriptorProvider
Method Detail
getDescriptor()method
public function getDescriptor(label:ILabel, parameter:ILabelModelParameter):ILabelCandidateDescriptor

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

Parameters

label:ILabel — The label to possibly assign the parameter.
 
parameter:ILabelModelParameter — The parameter to provide a descriptor for if applied to the given label

Returns
ILabelCandidateDescriptor — A descriptor or null.