Interface: DvtDiagramLayoutContextLink

Oracle® JavaScript Extension Toolkit (JET)
1.1.2
E65298-01

QuickNav

Methods

oj. DvtDiagramLayoutContextLink

Version:
  • 1.1.2
The DvtDiagramLayoutContextLink interface defines the link context for a layout call.
Source:

Methods

getEndConnectorOffset() → {number}

Get the offset of the end connector. This is the amount of space that the link should leave between its ending point and the node for the connector to be drawn.
Source:
Returns:
Type
number

getEndId() → {string}

Get the id of the end node of this link.
Source:
Returns:
Type
string

getId() → {string}

Get the id of the link.
Source:
Returns:
Type
string

getLabelBounds() → {Object}

Get the label bounds. The bounds are in the coordinate system of the label.
Properties:
Name Type Description
x number x-coordinate
y number y-coordinate
w number width
h number height
Source:
Returns:
An object with the following properties for the label bound
Type
Object

getLabelPosition() → {Object}

Get the position of the link label. The position is in the coordinate system of the link's container. The position represents the upper-left corner for locales with left-to-right reading direction and the upper-right corner for locales with right-to-left reading direction.
Properties:
Name Type Description
x number x-coordinate
y number y-coordinate
Source:
Returns:
An object with the following properties for the position of the link label
Type
Object

getLabelRotationAngle() → {number}

Get the angle of rotation of the link label, relative to the label rotation point, in radians.
Source:
Returns:
Type
number

getLabelRotationPoint() → {Object}

Get the point about which to rotate the link label, in the coordinate system of the label.
Properties:
Name Type Description
x number x-coordinate
y number y-coordinate
Source:
Returns:
An object with the following properties for the label rotation point
Type
Object

getLayoutAttributes() → {object}

Get the corresponding object from the links option array.
Source:
Returns:
Type
object

getLinkWidth() → {number}

Get the width of this link.
Source:
Returns:
Type
number

getPoints() → {array}

Get the points to use for rendering this link. The returned array can contain coordinates, like [x1, y1, x2, y2, ..., xn, yn], or SVG path commands, like ["M", x1, y1, "L", x2, y2, ..., "L", xn, yn]. The points are in the coordinate system of the link's container.
Source:
Returns:
Type
array

getSelected() → {boolean}

Determine whether this link is selected.
Source:
Returns:
Type
boolean

getStartConnectorOffset() → {number}

Get the offset of the start connector. This is the amount of space that the link should leave between its starting point and the node for the connector to be drawn.
Source:
Returns:
Type
number

getStartId() → {string}

Get the id of the start node of this link.
Source:
Returns:
Type
string

setLabelPosition(pos)

Set the position of the link label. The position is in the coordinate system of the link's container. The position represents the upper-left corner for locales with left-to-right reading direction and the upper-right corner for locales with right-to-left reading direction.
Parameters:
Name Type Description
pos Object An object with the following properties for the position of the link label
Properties:
Name Type Description
x number x-coordinate
y number y-coordinate
Source:

setLabelRotationAngle(angle)

Set the angle of rotation of the link label, relative to the label rotation point, in radians.
Parameters:
Name Type Description
angle number angle of rotation
Source:

setLabelRotationPoint(point)

Set the point about which to rotate the link label, in the coordinate system of the label.
Parameters:
Name Type Description
point Object An object with the following properties for the label rotation point
Properties:
Name Type Description
x number x-coordinate
y number y-coordinate
Source:

setPoints(points)

Set the points to use for rendering this link. The given array can contain coordinates, like [x1, y1, x2, y2, ..., xn, yn], or SVG path commands, like ["M", x1, y1, "L", x2, y2, ..., "L", xn, yn]. The points are in the coordinate system of the link's container.
Parameters:
Name Type Description
points array array of points to use for rendering this link
Source: