Package | com.yworks.graph.model |
Class | public class ExtendedEdgeLabelCandidate |
Inheritance | ExtendedEdgeLabelCandidate EdgeLabelCandidate LabelCandidate YObject Object |
EdgeLabelCandidate
that provides a ILabelCandidateDescriptor
.
See also
Property | Defined By | ||
---|---|---|---|
boundingBox : YRectangle [read-only]
Returns the bounding box of this label candidate. | LabelCandidate | ||
box : YOrientedRectangle [read-only]
Returns the real bounds of this label candidate. | LabelCandidate | ||
customProfit : Number
Specifies the custom profit for this label candidate. | LabelCandidate | ||
descriptor : ILabelCandidateDescriptor [read-only]
Gets the label candidate descriptor. | ExtendedEdgeLabelCandidate | ||
edgeOverlapPenalty : Number
Specifies the penalty value for a candidate position that overlaps the path of an edge. | LabelCandidate | ||
height : Number [read-only]
Returns the height of the label candidate bounds. | LabelCandidate | ||
internal2 : Boolean [read-only]
Returns whether this candidate is an internal node label, i.e. | LabelCandidate | ||
location : YPoint [read-only]
Returns the upper left corner of the label candidate bounds. | LabelCandidate | ||
modelParameter : Object [read-only]
Returns the model parameter that was used by the underlying model to generate this label candidate. | LabelCandidate | ||
nodeOverlapPenalty : Number
Specifies the penalty for a candidate position that overlaps the bounds of a node. | LabelCandidate | ||
overlapPenalty : Number [read-only]
Returns the sum of node overlap penalty and edge overlap penalty. | LabelCandidate | ||
owner : LabelLayout [read-only]
Returns the LabelLayout to which this candidate box belongs. | LabelCandidate | ||
parameter : Object [read-only]
Returns the model parameter that was used by the underlying model to generate this label candidate. | LabelCandidate | ||
propagated : Boolean [read-only]
Returns if this box had been chosen by the labeling algorithm. | LabelCandidate | ||
size : YDimension [read-only]
Returns the width and height of the label candidate bounds. | LabelCandidate | ||
width : Number [read-only]
Returns the width of the label candidate bounds. | LabelCandidate | ||
x : Number [read-only]
Returns the minimal x-coordinate of the label candidate bounds. | LabelCandidate | ||
y : Number [read-only]
Returns the minimal y-coordinate of the label candidate bounds. | LabelCandidate |
Method | Defined By | ||
---|---|---|---|
ExtendedEdgeLabelCandidate(orientedBox:YOrientedRectangle, param:Object, owner:EdgeLabelLayout, _internal:Boolean, descriptor:ILabelCandidateDescriptor, init:Boolean = true)
Creates a new instance of ExtendedEdgeLabelCandidate. | ExtendedEdgeLabelCandidate | ||
equals(o:Object):Boolean | YObject | ||
getClass():Class [override] | EdgeLabelCandidate | ||
hashCode():int | YObject | ||
newEdgeLabelCandidate1(orientedBox:YOrientedRectangle, param:Object, owner:EdgeLabelLayout):EdgeLabelCandidate [static]
Returns a new instance of EdgeLabelCandidate. | EdgeLabelCandidate | ||
newEdgeLabelCandidate2(orientedBox:YOrientedRectangle, param:Object, owner:EdgeLabelLayout, _internal:Boolean):EdgeLabelCandidate [static]
Returns a new instance of EdgeLabelCandidate. | EdgeLabelCandidate | ||
newEdgeLabelCandidate3(pos:YPoint, size:YDimension, param:Object, owner:EdgeLabelLayout):EdgeLabelCandidate [static]
Returns a new instance of LabelCandidate. | EdgeLabelCandidate | ||
newEdgeLabelCandidate4(pos:YPoint, size:YDimension, param:Object, owner:EdgeLabelLayout, _internal:Boolean):EdgeLabelCandidate [static]
Returns a new instance of EdgeLabelCandidate. | EdgeLabelCandidate | ||
newExtendedEdgeLabelCandidate(pos:YPoint, size:YDimension, param:Object, owner:EdgeLabelLayout, descriptor:ILabelCandidateDescriptor, _internal:Boolean = false):ExtendedEdgeLabelCandidate [static]
Returns a new instance of ExtendedEdgeLabelCandidate. | ExtendedEdgeLabelCandidate | ||
[static]
Returns a new instance of LabelCandidate. | LabelCandidate | ||
newLabelCandidate2(labelBox:YOrientedRectangle, param:Object, owner:LabelLayout, _internal:Boolean):LabelCandidate [static]
Returns a new instance of LabelCandidate. | LabelCandidate | ||
[static]
Returns a new instance of LabelCandidate. | LabelCandidate | ||
newLabelCandidate4(pos:YPoint, size:YDimension, param:Object, owner:LabelLayout, _internal:Boolean):LabelCandidate [static]
Returns a new instance of LabelCandidate. | LabelCandidate | ||
propagate():void
Sets the model parameters of the owner of this label candidate to the model parameters of this candidate box. | LabelCandidate | ||
toString():String | LabelCandidate |
descriptor | property |
descriptor:ILabelCandidateDescriptor
[read-only] Gets the label candidate descriptor.
public function get descriptor():ILabelCandidateDescriptor
ExtendedEdgeLabelCandidate | () | Constructor |
public function ExtendedEdgeLabelCandidate(orientedBox:YOrientedRectangle, param:Object, owner:EdgeLabelLayout, _internal:Boolean, descriptor:ILabelCandidateDescriptor, init:Boolean = true)
Creates a new instance of ExtendedEdgeLabelCandidate.
ParametersorientedBox:YOrientedRectangle — The label size and orientation.
| |
param:Object — The parameters of the labeling model associated with this candidate.
| |
owner:EdgeLabelLayout — The label associated with the candidate.
| |
_internal:Boolean — Flag whether the candidate is allowed to overlap the layout of the edge.
| |
descriptor:ILabelCandidateDescriptor — The label candidate descriptor.
| |
init:Boolean (default = true ) — An internally used switch to help handle proper instance initialization in inheritance
chains where classes can have multiple constructor-like factory methods.
This parameter can safely be ignored/omitted when calling the constructor.
|
newExtendedEdgeLabelCandidate | () | method |
public static function newExtendedEdgeLabelCandidate(pos:YPoint, size:YDimension, param:Object, owner:EdgeLabelLayout, descriptor:ILabelCandidateDescriptor, _internal:Boolean = false):ExtendedEdgeLabelCandidate
Returns a new instance of ExtendedEdgeLabelCandidate.
Parameters
pos:YPoint — The location of the upper left corner of the candidate.
| |
size:YDimension — The size of the candidate.
| |
param:Object — The parameters of the labeling model associated with this candidate.
| |
owner:EdgeLabelLayout — The label associated with the candidate.
| |
descriptor:ILabelCandidateDescriptor — The label candidate descriptor.
| |
_internal:Boolean (default = false ) — Flag whether the candidate is allowed to overlap the layout of the edge.
|
ExtendedEdgeLabelCandidate — A new instance of ExtendedEdgeLabelCandidate
|