C

NinePositionsEdgeLabelModel

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

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.

See Also

Developer's Guide

Members

No filters for this type

Constructors

Initializes a new instance of the NinePositionsEdgeLabelModel class.

Parameters

distance?: number
The distance.
angle?: number
The angle.

Properties

Gets or sets the angle for the rotation of the labels.
A value of 0 makes the label appear horizontally aligned.

Property Value

The angle in radians.
Gets or sets the distance of the labels above or below the edge.

Property Value

The distance to the edge.

Methods

Create a model parameter for the specified position

Parameters

position: NinePositionsEdgeLabelModelPosition
The position for this parameter

Return Value

NinePositionsEdgeLabelModelParameter
a model parameter for the specified position
Provides a lookup context for the given label.

Parameters

label: ILabel
The label to use in the context.

Return Value

ILookup
An implementation of the ILookup interface that can be used to query additional aspects of the label.
Calculates the geometry of the given label using the given model parameter.
final

Parameters

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.

Return Value

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.

Constants

A predefined parameter instance that places the label at the center above the edge.
This parameter instance's model is immutable. Trying to change its angle or distance properties will raise an InvalidOperationError.
static

Sample Graphs

A predefined parameter instance that places the label at the center below the edge.
This parameter instance's model is immutable. Trying to change its angle or distance properties will raise an InvalidOperationError.
static

Sample Graphs

A predefined parameter instance that places the label at the center on the edge.
This parameter instance's model is immutable. Trying to change its angle or distance properties will raise an InvalidOperationError.
static

Sample Graphs

A predefined parameter instance that places the label at the source port above the edge.
This parameter instance's model is immutable. Trying to change its angle or distance properties will raise an InvalidOperationError.
static

Sample Graphs

A predefined parameter instance that places the label at the source port below the edge.
This parameter instance's model is immutable. Trying to change its angle or distance properties will raise an InvalidOperationError.
static

Sample Graphs

A predefined parameter instance that places the label at the source port on the edge.
This parameter instance's model is immutable. Trying to change its angle or distance properties will raise an InvalidOperationError.
static

Sample Graphs

A predefined parameter instance that places the label at the target port above the edge.
This parameter instance's model is immutable. Trying to change its angle or distance properties will raise an InvalidOperationError.
static

Sample Graphs

A predefined parameter instance that places the label at the target port below the edge.
This parameter instance's model is immutable. Trying to change its angle or distance properties will raise an InvalidOperationError.
static

Sample Graphs

A predefined parameter instance that places the label at the target port on the edge.
This parameter instance's model is immutable. Trying to change its angle or distance properties will raise an InvalidOperationError.
static

Sample Graphs