com.yworks.yfiles.layout

Interface IEdgeLabelLayout

All Superinterfaces:

ILabelLayout

public interface IEdgeLabelLayout
extends ILabelLayout

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

Note: To avoid inconsistencies, changing the model parameter should always be combined with updating the corresponding oriented box.

Method Summary

Modifier and Type	Method and Description
IEdgeLabelLayoutModel	getLabelModel() Gets the label model that describes the valid locations for this label.
PreferredPlacementDescriptor	getPreferredPlacementDescriptor() Gets the preferred placement for this edge label, which can be considered by layout algorithms.

Methods inherited from interface com.yworks.yfiles.layout.ILabelLayout

getBoundingBox, getModelParameter, getOrientedBox, setModelParameter

Method Detail

getLabelModel

IEdgeLabelLayoutModel getLabelModel()

Gets the label model that describes the valid locations for this label.

Returns:

the IEdgeLabelLayoutModel associated with this IEdgeLabelLayout

getPreferredPlacementDescriptor

PreferredPlacementDescriptor getPreferredPlacementDescriptor()

Gets the preferred placement for this edge label, which can be considered by layout algorithms.

Returns:

the PreferredPlacementDescriptor for this IEdgeLabelLayout