com.yworks.yfiles.server.graphml.flexio.data
Interface ILabelCandidateDescriptor

All Known Implementing Classes:

LabelCandidateDescriptor, LabelCandidateDescriptor.ConstantDescriptor

public interface ILabelCandidateDescriptor

Interface that describes the properties of a candidate ILabelModelParameter.

Automatic labeling algorithms may require additional properties for a set of ILabelModelParameters. This interface can be used to provide this information for a pair of ILabel and ILabelModelParameter via the ILabelCandidateDescriptorProvider provider interface.

Method Summary

double	getProfit() Gets the profit to weigh in if this candidate is chosen.
boolean	isExternalCandidate() Gets a value indicating whether this candidate is deemed an external candidate.

Method Detail

isExternalCandidate

public boolean isExternalCandidate()

Gets a value indicating whether this candidate is deemed an external candidate.

This is mainly for node labels, where the label may be a visual part of the node's internals, but could be used for edge labels, too, if the edge occupies significant amounts of space, visually.

Returns:

A value indicating whether this candidate is deemed an external candidate.

getProfit

public double getProfit()

Gets the profit to weigh in if this candidate is chosen.

Returns:

The profit to weigh in if this candidate is chosen.