com.yworks.graph.model.ExtendedNodeLabelCandidate

Public Properties

	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.	ExtendedNodeLabelCandidate
		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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ExtendedNodeLabelCandidate(orientedBox:YOrientedRectangle, param:Object, owner:NodeLabelLayout, _internal:Boolean, descriptor:ILabelCandidateDescriptor, init:Boolean = true) Creates a new instance of ExtendedNodeLabelCandidate.	ExtendedNodeLabelCandidate
		equals(o:Object):Boolean	YObject
		getClass():Class [override]	NodeLabelCandidate
		hashCode():int	YObject
		newExtendedNodeLabelCandidate(pos:YPoint, size:YDimension, param:Object, owner:NodeLabelLayout, descriptor:ILabelCandidateDescriptor, _internal:Boolean = false):ExtendedNodeLabelCandidate [static] Returns a new instance of ExtendedNodeLabelCandidate.	ExtendedNodeLabelCandidate
		newLabelCandidate1(labelBox:YOrientedRectangle, param:Object, owner:LabelLayout):LabelCandidate [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
		newLabelCandidate3(pos:YPoint, size:YDimension, param:Object, owner:LabelLayout):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
		newNodeLabelCandidate1(orientedBox:YOrientedRectangle, param:Object, owner:NodeLabelLayout, _internal:Boolean):NodeLabelCandidate [static] Returns a new instance of NodeLabelCandidate.	NodeLabelCandidate
		newNodeLabelCandidate2(pos:YPoint, size:YDimension, param:Object, owner:NodeLabelLayout):NodeLabelCandidate [static] Returns a new instance of NodeLabelCandidate.	NodeLabelCandidate
		newNodeLabelCandidate3(pos:YPoint, size:YDimension, param:Object, owner:NodeLabelLayout, _internal:Boolean):NodeLabelCandidate [static] Returns a new instance of NodeLabelCandidate.	NodeLabelCandidate
		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

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		initLabelCandidate1(labelBox:YOrientedRectangle, param:Object, owner:LabelLayout):void Initializes this object.	LabelCandidate
		initLabelCandidate2(labelBox:YOrientedRectangle, param:Object, owner:LabelLayout, _internal:Boolean):void Initializes this object.	LabelCandidate
		initLabelCandidate3(pos:YPoint, size:YDimension, param:Object, owner:LabelLayout):void Initializes this object.	LabelCandidate
		initLabelCandidate4(pos:YPoint, size:YDimension, param:Object, owner:LabelLayout, _internal:Boolean):void Initializes this object.	LabelCandidate
		initNodeLabelCandidate1(orientedBox:YOrientedRectangle, param:Object, owner:NodeLabelLayout, _internal:Boolean):void Initializes this object.	NodeLabelCandidate
		initNodeLabelCandidate2(pos:YPoint, size:YDimension, param:Object, owner:NodeLabelLayout):void Initializes this object.	NodeLabelCandidate
		initNodeLabelCandidate3(pos:YPoint, size:YDimension, param:Object, owner:NodeLabelLayout, _internal:Boolean):void Initializes this object.	NodeLabelCandidate

Property Detail

descriptor

property

descriptor:ILabelCandidateDescriptor [read-only]

Gets the label candidate descriptor.

Implementation
public function get descriptor():ILabelCandidateDescriptor

Constructor Detail

ExtendedNodeLabelCandidate

()

Constructor

public function ExtendedNodeLabelCandidate(orientedBox:YOrientedRectangle, param:Object, owner:NodeLabelLayout, _internal:Boolean, descriptor:ILabelCandidateDescriptor, init:Boolean = true)

Creates a new instance of ExtendedNodeLabelCandidate.

Parameters

	`orientedBox:YOrientedRectangle` — The label size and orientation.

	`param:Object` — The parameters of the labeling model associated with this candidate.

	`owner:NodeLabelLayout` — The label associated with the candidate.

	`_internal:Boolean` — Flag whether the candidate is inside the node.

	`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.

Method Detail

newExtendedNodeLabelCandidate

()

method

 public static function newExtendedNodeLabelCandidate(pos:YPoint, size:YDimension, param:Object, owner:NodeLabelLayout, descriptor:ILabelCandidateDescriptor, _internal:Boolean = false):ExtendedNodeLabelCandidate

Returns a new instance of ExtendedNodeLabelCandidate.

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:NodeLabelLayout` — The label associated with the candidate.

	`descriptor:ILabelCandidateDescriptor` — The label candidate descriptor.

	`_internal:Boolean` (default = `false`) — Flag whether the candidate is inside the node or outside.

Returns

ExtendedNodeLabelCandidate — A new instance of ExtendedNodeLabelCandidate

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

yFiles FLEX Client Layout Extension 1.5 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
ExtendedNodeLabelCandidate	Properties \| Methods

Package	com.yworks.graph.model
Class	public class ExtendedNodeLabelCandidate
Inheritance	ExtendedNodeLabelCandidate NodeLabelCandidate LabelCandidate YObject Object