Positioning

General

Point

class Point()

A single point.

interface

Point.x

type: number

Point.y

type: number

RotationVector

class RotationVector()

Vector used for angles and offsets.

interface

RotationVector.dx

type: number

RotationVector.dy

type: number

RotationData

class RotationData()

Interface holding rotation information of a graph object.

interface

RotationData.absoluteRotation?

type: number

Absolute rotation angle in degree.

Absolute rotation overwrites any relative rotation.

RotationData.relativeRotation?

type: number

Relative rotation angle in degree.

Related Functions

calculateLength(vector)

Calculate the absolute length of the given vector.

Arguments:

• vector (RotationVector) –

Returns:

number –

normalizeVector(vector)

Normalize an existing vector to length 1.

Arguments:

• vector (RotationVector) –

Returns:

RotationVector –

calculateAngle(vector)

Calculate the Angle of a rotation vector in degree.

Arguments:

• vector (RotationVector) –

Returns:

number –

angleToVector(angle, length)

Calculate a rotation vector from an angle in degree and a length.

Arguments:

• angle (number) –

• length (number) –

Returns:

RotationVector –

Edge-Related Positioning

PathPositionRotationAndScale

class PathPositionRotationAndScale()

Interface describing the position of a marker, text component or link handle placed along an edge path.

interface

Extends:

• RotationData()

PathPositionRotationAndScale.absolutePositionOnLine?

type: number

The absolute position of the path element on the edge.

A positive value is counted from the start of the path. A negative value is counted from the end of the path. If the absolute value is longer than the path length the relative positionOnLine will be used as fallback value.

PathPositionRotationAndScale.ignorePathDirectionForRotation?

type: boolean

If true the relative rotation is applied as if the path always goes from left to right.

PathPositionRotationAndScale.positionOnLine?

type: number|”start”|”end”

The relative position of the path element on the edge (between 0 and 1). (Default 0 == ‘start’)

PathPositionRotationAndScale.scale?

type: number

A factor to scale the path element.

PathPositionRotationAndScale.scaleRelative?

type: boolean

If true the scaling factor is applied relative to the stroke width.

LineAttachementInfo

class LineAttachementInfo(lineAttachementPoint)

Helper class to calculate where the edge attaches to an end marker.

Create a new line attachement info object.

The attachement point can either be an offset from 0,0 or a point relative to 0,0 of the template. To specify an offset use a single number or a string containing exactly one number. To specify a point use a string with two numbers seperated by a space or a point object. The line attachement point must not include any transformations applied to the marker when it is rendered.

If only an offset was specified the attachement info is not directional.

Arguments:

• lineAttachementPoint (string|number|Point) –

Returns:

LineAttachementInfo –

LineAttachementInfo.getRotationVector(angle, scale)

Return a rotation vector pointing at the translated line attachement point.

Arguments:

• angle (number) –

• scale (number) –

Returns:

RotationVector –

Edge-Related Positioning Functions

normalizePositionOnLine(positionOnLine)

Normalize the positionOnLine argument to a number. (Default: 0 )

Arguments:

• positionOnLine (number|"start"|"end") –

Returns:

number –