Interface: DvtDiagramLayoutContextNode

Oracle® JavaScript Extension Toolkit (JET)
3.2.0

E87541-01

QuickNav

oj. DvtDiagramLayoutContextNode

Version:
  • 3.2.0
The DvtDiagramLayoutContextNode interface defines the node context for a layout call.
Source:

Methods

getBounds() → {Object}

Get the bounds of the node. Currently the method returns the same value as getContentBounds(). The bounds are in the coordinate system of the node.
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 bounds of the node
Type
Object

getChildNodes() → {array}

Get visible child nodes for the disclosed container.
Source:
Returns:
array of DvtDiagramLayoutContextNode objects
Type
array

getContentBounds() → {Object}

Get the bounds of the node content. Currently the method returns the same value as getBounds(). The bounds are in the coordinate system of the node.
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 bounds of the node content
Type
Object

getData() → {object}

Get the corresponding data object for the diagram node.
Source:
Returns:
a data object for the node
Type
object

getId() → {string}

Get the id of the node.
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 bounds
Type
Object

getLabelHalign() → {string}

Get the horizontal alignment of the node label. The default value is left for locales with left-to-right reading direction and right for locales with right-to-left reading direction.
Supported Values:
Name Type
"left" string
"center" string
"right" string
Source:
Returns:
A string that specifies the horizontal label alignment
Type
string

getLabelPosition() → {Object}

Get the position of the node label. The position is in the coordinate system of the node'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 node label
Type
Object

getLabelRotationAngle() → {number}

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

getLabelRotationPoint() → {Object}

Get the point about which to rotate the node 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

getLabelValign() → {string}

Get the vertical alignment of the node label.
Supported Values:
Name Type
"top" string
"middle" string
"bottom" string
"baseline" string
Default Value:
  • "top"
Source:
Returns:
A string that specifies the vertical label alignment
Type
string

getLayoutAttributes() → {Object}

Get the corresponding object from the nodes option array.
Deprecated:
Source:
Returns:
Type
Object

getPosition() → {Object}

Get the position of the node. The position is in the coordinate system of the node's container.
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 node
Type
Object

getRelativePosition(containerId) → {Object}

The method returns a position of the node relative to the specified ancestor container. If the container id is null, the method returns global position of the node. If the container id is not an ancestor id for the node, the method returns null.
Parameters:
Name Type Description
containerId string ancestor id
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 node relative to the specified ancestor container
Type
Object

getSelected() → {boolean}

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

isDisclosed() → {boolean}

Determine whether this container is disclosed.
Source:
Returns:
true if the node is a disclosed container
Type
boolean

setLabelHalign(halign)

Set the horizontal alignment of the node label. The default value is left for locales with left-to-right reading direction and right for locales with right-to-left reading direction.
Parameters:
Name Type Description
halign string A string that specifies the horizontal label alignment
Supported Values:
Name Type
"left" string
"center" string
"right" string
Source:

setLabelPosition(pos)

Set the position of the node label. The position is in the coordinate system of the node'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 position of the node label
Properties:
Name Type Description
x number x-coordinate
y number y-coordinate
Source:

setLabelRotationAngle(angle)

Set the angle of rotation of the node 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 node label, in the coordinate system of the label.
Parameters:
Name Type Description
point Object An object with the following properties for label rotation point
Properties:
Name Type Description
x number x-coordinate
y number y-coordinate
Source:

setLabelValign(valign)

Set the vertical alignment of the node label.
Parameters:
Name Type Description
valign string A string that specifies the vertical label alignment
Supported Values:
Name Type
"top" string
"middle" string
"bottom" string
"baseline" string
Default Value:
  • "top"
Source:

setPosition(pos)

Set the position of the node. The position is in the coordinate system of the node's container.
Parameters:
Name Type Description
pos Object An object with the following properties for the position of the node
Properties:
Name Type Description
x number x-coordinate
y number y-coordinate
Source: