| Package | com.yworks.graph.model |
| Class | public class LabelCandidateDescriptor |
| Inheritance | LabelCandidateDescriptor  Object |
| Implements | ILabelCandidateDescriptor, IMarkupExtensionFactory |
ILabelCandidateDescriptor interface.
All properties are read/write in this implementation.
| Property | Defined By | ||
|---|---|---|---|
| externalCandidate : Boolean
Gets a value indicating whether this candidate is deemed an external candidate. | LabelCandidateDescriptor | ||
| externalDescriptor : ILabelCandidateDescriptor [static] [read-only]
A sharable immutable implementation of the ILabelCandidateDescriptor
interface that has penalties of 1.0 and a profit of 1.0 and yields true
for the ILabelCandidateDescriptor.externalCandidate property. | LabelCandidateDescriptor | ||
| externalDescriptorLookup : ILookup [static] [read-only] | LabelCandidateDescriptor | ||
| internalDescriptor : ILabelCandidateDescriptor [static] [read-only]
A sharable immutable implementation of the ILabelCandidateDescriptor
interface that has penalties of 1.0 and a profit of 1.0 and yields false
for the ILabelCandidateDescriptor.externalCandidate property. | LabelCandidateDescriptor | ||
| internalDescriptorLookup : ILookup [static] [read-only] | LabelCandidateDescriptor | ||
| profit : Number
Gets the profit to weigh in if this candidate is chosen. | LabelCandidateDescriptor | ||
| Method | Defined By | ||
|---|---|---|---|
LabelCandidateDescriptor(externalCandidate:Boolean = false, profit:Number = 1)
Creates a new instance of LabelCandidateDescriptor. | LabelCandidateDescriptor | ||
Creates a markup extension that can be used instead of the original class. | LabelCandidateDescriptor | ||
| externalCandidate | property |
externalCandidate:BooleanGets 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.
The default value is false.
public function get externalCandidate():Boolean public function set externalCandidate(value:Boolean):void| externalDescriptor | property |
externalDescriptor:ILabelCandidateDescriptor [read-only]
A sharable immutable implementation of the ILabelCandidateDescriptor
interface that has penalties of 1.0 and a profit of 1.0 and yields true
for the ILabelCandidateDescriptor.externalCandidate property.
public static function get externalDescriptor():ILabelCandidateDescriptor| externalDescriptorLookup | property |
externalDescriptorLookup:ILookup [read-only] public static function get externalDescriptorLookup():ILookup| internalDescriptor | property |
internalDescriptor:ILabelCandidateDescriptor [read-only]
A sharable immutable implementation of the ILabelCandidateDescriptor
interface that has penalties of 1.0 and a profit of 1.0 and yields false
for the ILabelCandidateDescriptor.externalCandidate property.
public static function get internalDescriptor():ILabelCandidateDescriptor| internalDescriptorLookup | property |
internalDescriptorLookup:ILookup [read-only] public static function get internalDescriptorLookup():ILookup| profit | property |
profit:NumberGets the profit to weigh in if this candidate is chosen.
The default value is 1.
public function get profit():Number public function set profit(value:Number):void| LabelCandidateDescriptor | () | Constructor |
public function LabelCandidateDescriptor(externalCandidate:Boolean = false, profit:Number = 1)
Creates a new instance of LabelCandidateDescriptor.
externalCandidate:Boolean (default = false) | |
profit:Number (default = 1) |
| createMarkupExtension | () | method |
public function createMarkupExtension(context:ILookup):MarkupExtensionCreates a markup extension that can be used instead of the original class.
Parameters
context:ILookup — The context that shall be considered when creating the markup extension.
|
MarkupExtension |