Packagecom.yworks.graph.model
Interfacepublic interface ILabelCandidateDescriptor
Implementors LabelCandidateDescriptor

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.

See also

ILabelCandidateDescriptorProvider

Public Properties
 PropertyDefined By
  externalCandidate : Boolean
[read-only] Gets a value indicating whether this candidate is deemed an external candidate.
ILabelCandidateDescriptor
  profit : Number
[read-only] Gets the profit to weigh in if this candidate is chosen.
ILabelCandidateDescriptor
Property Detail
externalCandidateproperty
externalCandidate:Boolean  [read-only]

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

This is mainly for INode 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.


Implementation
    public function get externalCandidate():Boolean
profitproperty 
profit:Number  [read-only]

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


Implementation
    public function get profit():Number




Wed Oct 7 2015, 04:52 PM +02:00