NinePositionsEdgeLabelModel

An edge label model that places labels at positions near the source port, target port, or the center of the edge.

Inheritance Hierarchy

NinePositionsEdgeLabelModel

Implemented Interfaces

Remarks

The possible positions are near the source port, at the center of the edge, or near the target port, each above, below, or centered on the edge. The distance to the edge and the absolute angular orientation of the label can be specified.

Type Details

yFiles module: view

Sample Graphs

Constructors

NinePositionsEdgeLabelModel

(distance?: number, angle?: number)

Initializes a new instance of the NinePositionsEdgeLabelModel class.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

distance - number: The distance.
angle - number: The angle.

Properties

angle

: number

Gets or sets the angle for the rotation of the labels.

Remarks

A value of 0 makes the label appear horizontally aligned.

Property Value

The angle in radians.

distance

: number

Gets or sets the distance of the labels above or below the edge.

Property Value

The distance to the edge.

Methods

createParameter

(position: NinePositionsEdgeLabelModelPosition) : NinePositionsEdgeLabelModelParameter

Create a model parameter for the specified position

Parameters

options - Object
A map of options to pass to the method.

position - NinePositionsEdgeLabelModelPosition: The position for this parameter

Returns

↪NinePositionsEdgeLabelModelParameter: a model parameter for the specified position

getContext

(label: ILabel) : ILookup

Provides a lookup context for the given label.

Parameters

options - Object
A map of options to pass to the method.

label - ILabel: The label to use in the context.

Returns

↪ILookup: An implementation of the ILookup interface that can be used to query additional aspects of the label.

Implements

ILabelModel

getGeometry

(label: ILabel, layoutParameter: ILabelModelParameter) : IOrientedRectangle

Calculates the geometry of the given label using the given model parameter.

Parameters

options - Object
A map of options to pass to the method.

label - ILabel: The label to calculate the geometry for.
layoutParameter - ILabelModelParameter: A parameter that is compatible with this model. Typically, this is a parameter that has been created by this model, and its property model returns this instance.

Returns

↪IOrientedRectangle: An IOrientedRectangle that describes the geometry of the label. This is typically designed as a flyweight, therefore clients should not cache the instance but store the values if they need a snapshot for later use.

Implements

ILabelModel

Constants