Packagecom.yworks.yfiles.layout
Classpublic class SliderEdgeLabelLayoutModel_ModelParameter
InheritanceSliderEdgeLabelLayoutModel_ModelParameter Inheritance YObject Inheritance Object

Encodes the model parameters for the two slider edge label models specified by com.yworks.yfiles.layout.SliderEdgeLabelLayoutModel.CENTER_SLIDER and com.yworks.yfiles.layout.SliderEdgeLabelLayoutModel.SIDE_SLIDER.

See also

com.yworks.yfiles.layout.SliderEdgeLabelLayoutModel.CENTER_SLIDER
com.yworks.yfiles.layout.SliderEdgeLabelLayoutModel.SIDE_SLIDER


Public Properties
 PropertyDefined By
  absRatio : Number
[read-only] Returns the label's absolute ratio with respect to the entire length of the edge path.
SliderEdgeLabelLayoutModel_ModelParameter
  labelPosition : int
[read-only] Returns the label's symbolic ratio specifier, i.e., one of com.yworks.yfiles.layout.SliderEdgeLabelLayoutModel.CENTER_RATIO, com.yworks.yfiles.layout.SliderEdgeLabelLayoutModel.LEFT_RATIO, or com.yworks.yfiles.layout.SliderEdgeLabelLayoutModel.RIGHT_RATIO.
SliderEdgeLabelLayoutModel_ModelParameter
  offsetVector : YVector
[read-only] Returns the offset vector between the label and the edge segment relative to which it is placed.
SliderEdgeLabelLayoutModel_ModelParameter
  ratio : Number
[read-only] Returns the label's ratio with respect to the length of the edge segment relative to which it is placed.
SliderEdgeLabelLayoutModel_ModelParameter
  segmentNumber : int
[read-only] Returns the index of the edge segment relative to which the label is placed.
SliderEdgeLabelLayoutModel_ModelParameter
Public Methods
 MethodDefined By
  
SliderEdgeLabelLayoutModel_ModelParameter(s:int, r:Number, v:YVector, p:int, aRatio:Number, init:Boolean = true)
Returns a new instance of ModelParameter that has the given characteristics.
SliderEdgeLabelLayoutModel_ModelParameter
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
SliderEdgeLabelLayoutModel_ModelParameter
 Inherited
hashCode():int
YObject
  
[static] Returns a new instance of ModelParameter that has the given characteristics.
SliderEdgeLabelLayoutModel_ModelParameter
Protected Methods
 MethodDefined By
  
initSliderEdgeLabelLayoutModel_ModelParameter(s:int, r:Number, v:YVector, p:int, aRatio:Number):void
Initializes this object.
SliderEdgeLabelLayoutModel_ModelParameter
Property Detail
absRatioproperty
absRatio:Number  [read-only]

Returns the label's absolute ratio with respect to the entire length of the edge path.


Implementation
    public function get absRatio():Number
labelPositionproperty 
labelPosition:int  [read-only]

Returns the label's symbolic ratio specifier, i.e., one of com.yworks.yfiles.layout.SliderEdgeLabelLayoutModel.CENTER_RATIO, com.yworks.yfiles.layout.SliderEdgeLabelLayoutModel.LEFT_RATIO, or com.yworks.yfiles.layout.SliderEdgeLabelLayoutModel.RIGHT_RATIO.


Implementation
    public function get labelPosition():int

See also

offsetVectorproperty 
offsetVector:YVector  [read-only]

Returns the offset vector between the label and the edge segment relative to which it is placed.

The offset vector describes the distance between the edge segment and the label's upper-left corner.


Implementation
    public function get offsetVector():YVector
ratioproperty 
ratio:Number  [read-only]

Returns the label's ratio with respect to the length of the edge segment relative to which it is placed.


Implementation
    public function get ratio():Number
segmentNumberproperty 
segmentNumber:int  [read-only]

Returns the index of the edge segment relative to which the label is placed.

The index is zero-based and starts at the edge's source end. Let s denote the number of edge segments. Then, a negative index value i denotes the segment with index s + i.


Implementation
    public function get segmentNumber():int
Constructor Detail
SliderEdgeLabelLayoutModel_ModelParameter()Constructor
public function SliderEdgeLabelLayoutModel_ModelParameter(s:int, r:Number, v:YVector, p:int, aRatio:Number, init:Boolean = true)

Returns a new instance of ModelParameter that has the given characteristics.

Parameters
s:int — The index of the edge segment relative to which the label should be placed.
 
r:Number — The label's ratio with respect to the length of the edge segment relative to which it should be placed.
 
v:YVector — The offset vector between the label and the edge segment relative to which it should be placed.
 
p:int — One of the symbolic ratio specifiers com.yworks.yfiles.layout.SliderEdgeLabelLayoutModel.CENTER_RATIO, com.yworks.yfiles.layout.SliderEdgeLabelLayoutModel.LEFT_RATIO, or com.yworks.yfiles.layout.SliderEdgeLabelLayoutModel.RIGHT_RATIO.
 
aRatio:Number — The label's absolute ratio with respect to the entire length of the edge path. Note that this value is derived from the ratio value.
 
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.

See also

Method Detail
getClass()method
override public function getClass():Class

Returns
Class
initSliderEdgeLabelLayoutModel_ModelParameter()method 
protected final function initSliderEdgeLabelLayoutModel_ModelParameter(s:int, r:Number, v:YVector, p:int, aRatio:Number):void

Initializes this object. See the documentation of the corresponding factory method newSliderEdgeLabelLayoutModel_ModelParameter() for details.

Parameters

s:int
 
r:Number
 
v:YVector
 
p:int
 
aRatio:Number

See also

newSliderEdgeLabelLayoutModel_ModelParameter()method 
public static function newSliderEdgeLabelLayoutModel_ModelParameter(s:int, r:Number, v:YVector, p:int, aRatio:Number):SliderEdgeLabelLayoutModel_ModelParameter

Returns a new instance of ModelParameter that has the given characteristics.

Parameters

s:int — The index of the edge segment relative to which the label should be placed.
 
r:Number — The label's ratio with respect to the length of the edge segment relative to which it should be placed.
 
v:YVector — The offset vector between the label and the edge segment relative to which it should be placed.
 
p:int — One of the symbolic ratio specifiers com.yworks.yfiles.layout.SliderEdgeLabelLayoutModel.CENTER_RATIO, com.yworks.yfiles.layout.SliderEdgeLabelLayoutModel.LEFT_RATIO, or com.yworks.yfiles.layout.SliderEdgeLabelLayoutModel.RIGHT_RATIO.
 
aRatio:Number — The label's absolute ratio with respect to the entire length of the edge path. Note that this value is derived from the ratio value.

Returns
SliderEdgeLabelLayoutModel_ModelParameter

See also