Global

Type Definitions

DisplayLinkType

Defines the {type, dir, width, color, arrow, arrowSize, arrowShape, style} type for link, linka and linkg fields of OrgChart.Options object.
Type:
  • object
Properties:
Name Type Description
type exontrol.LinkTypeEnum Specifies the type of the link. The exontrol.LinkTypeEnum supports the following values:
  • exRect (0), defines a rectangular-link
  • exDirect (1), defines a direct-link
  • exStraight (2), defines a straight-link
  • exRound (3), defines a round-link
Also, the type field supports the value:
  • -1, which indicates the default type of link, which is similar with rectangular-link but more symmetrical
Example:
null {null}, indicates the default type of link, which is similar with rectangular-link but more symmetrical (equivalent of -1)
0 or exontrol.LinkTypeEnum.exRect {null}, shows rectangular-links
2 or exontrol.LinkTypeEnum.exStraight {null}, shows straight-links
dir number The dir field specifies whether the link's direction is shown or hidden. The dir field can be any of the following values:
  • 0, specifies that no direction for the link is shown
  • 1, shows the direction/arrow where the link begins
  • 2, shows the direction/arrow where the link ends
  • 3, shows the arrows on both sides
If not specified, the option 2 is used by default. Example:
null {null}, shows the direction/arrow where the link ends (equivalent of 2)
0 {number}, hides the link's direction
3 {number}, shows the arrows on both sides
width number The width field defines the size/width of the link.

Example:

null {null}, indicates links of 1-pixel wide
2 {number}, indicates links of 2-pixels wide
color string The color field specifies the color to show the link (defines the color of the link as a CSS color format).

Example:

null {null}, indicates a black link
"transparent" {string}, specifies a transparent link
"red" {string}, specifies a red link
"#00FF00" {string}, specifies a green link
"rgba(255,0,0,0.5)" {string}, indicates 50% red link
arrow string The arrow field indicates the arrow's color (if it is missing or not specified the arrow is shown using the link's color).

Example:

null {null}, indicates that the link's color defines the color of the link's arrow
"transparent" {string}, specifies a transparent arrow
"red" {string}, specifies a red arrow
"#00FF00" {string}, specifies a green arrow
"rgba(255,0,0,0.5)" {string}, indicates 50% red arrow
arrowSize number The arrowSize field indicates the arrow's size (if it is missing or not specified the arrow's size is defined by link's width).

Example:

null {null}, indicates that the link's width defines the size of the link's arrow
2 {number}, specifies that the link's arrow size is 2 (equivalent of arrows when link's width is set on 2)
arrowShape object The arrowShape field defines the custom-shape to draw the link's arrow, as an object of exontrol.Def.Shape type.

Example:

null {null}, indicates that the link's arrow is shown by default as a triangle oriented to point the direction
{primitive: "Circle"} {object}, shows the link's arrow as a circle
{primitive: "Rect"} {object}, shows the link's arrow as a rectangle
style null | number | Array.<number> The style field defines the style of the link. Could be any of the following:
  • {number[]} an array of numbers which specify distances to alternately draw a line and a gap (in coordinate space units)
  • {number} specifies number of elements in the array is odd, the elements of the array get copied and concatenated
Example:
null {null}, defines a solid grid-lines
[] {array}, indicates a solid grid-lines
2 {number}, will become [2, 2, ...]
[5, 15, 25] {array}, will become [5, 15, 25, 5, 15, 25, ...]
DisplayLinkType