Packagecom.yworks.yfiles.layout
Interfacepublic interface EdgeLabelLayout extends LabelLayout
Implementors EdgeLabelLayoutImpl

This interface defines the properties of one edge label from the perspective of a labeling algorithm.

Note: if you update the model parameter with modelParameter you should also update the corresponding oriented box (orientedBox) to avoid inconsistency:

 // label box for which we set the model parameter OrientedRectangle newLabelBox = ... // calculate the model parameter for the label box Object param = labelLayout.getLabelModel().createModelParameter(newLabelBox, edgeLayout, sourceLayout, targetLayout); // calculate the label box for the model parameter. Note that it may differ from newLabelBox! OrientedRectangle labelPlacement = labelLayout.getLabelModel().getLabelPlacement(newLabelBox.getSize(), edgeLayout, sourceLayout, targetLayout, param); // update the oriented box labelLayout.getOrientedBox().adoptValues(labelPlacement); 

See also

modelParameter
oriented box


Public Properties
 PropertyDefined By
 Inheritedbox : YRectangle
[read-only] Returns the bounding box of the label
LabelLayout
  labelModel : EdgeLabelModel
[read-only] Returns the edge label model associated with this label layout
EdgeLabelLayout
 InheritedmodelParameter : Object
Specifies the label model parameter that describes the position of this label.
LabelLayout
 InheritedorientedBox : YOrientedRectangle
[read-only] Returns the box of the label
LabelLayout
  preferredPlacementDescriptor : PreferredPlacementDescriptor
[read-only] Returns preferred placement hints for layout algorithms.
EdgeLabelLayout
Property Detail
labelModelproperty
labelModel:EdgeLabelModel  [read-only]

Returns the edge label model associated with this label layout


Implementation
    public function get labelModel():EdgeLabelModel
preferredPlacementDescriptorproperty 
preferredPlacementDescriptor:PreferredPlacementDescriptor  [read-only]

Returns preferred placement hints for layout algorithms.


Implementation
    public function get preferredPlacementDescriptor():PreferredPlacementDescriptor