DisplayLinkType class (Gantt)

DisplayLinkType()

new DisplayLinkType()

Represents the configuration of a link between elements, including type, direction, width, color, arrow, style, and start/end positions. Used by criticalPathLinkApp and criticalPathOffLinkApp fields of DefSchedulePDM, and link, linkStartFrom, linkEndTo, linkUnselected fields of ChartOptions.
DisplayLinkType

Members

(static) arrow :string

The arrow field specifies the color of the link's arrow. If undefined, the arrow uses the link's color.
Type:
  • string
Example
null {null}, arrow uses link's color
"transparent" {string}, transparent arrow
"red" {string}, red arrow
"#00FF00" {string}, green arrow
"rgba(255,0,0,0.5)" {string}, 50% red arrow
arrow

(static) arrowShape :exontrol.Def.Shape

The arrowShape field defines a custom shape for the arrow, as an object of exontrol.Def.Shape type.
Type:
  • exontrol.Def.Shape
Example
null {null}, default triangle arrow
{primitive: "Circle"} {object}, circular arrow
{primitive: "Rect"} {object}, rectangular arrow
arrowShape

(static) arrowSize :number

The arrowSize field specifies the size of the arrow. Defaults to link width if not provided.
Type:
  • number
Example
null {null}, arrow size equals link width
2 {number}, arrow size 2
arrowSize

(static) color :string

The color field specifies the link color (any CSS color format).
Type:
  • string
Example
null {null}, black link
"transparent" {string}, transparent link
"red" {string}, red link
"#00FF00" {string}, green link
"rgba(255,0,0,0.5)" {string}, 50% red link
color

(static) dir :number

The dir field determines whether the link's direction arrows are displayed. Values:
  • 0, no direction shown
  • 1, arrow at link start
  • 2, arrow at link end (default)
  • 3, arrows at both ends
.
Type:
  • number
Example
null {null}, arrow at link end (default)
0 {number}, hide direction
3 {number}, show arrows at both ends
dir

(static) endPos :null|number|string

The endPos field defines the corners of the end element where the link ends. Could be any of the following:
  • endPos {undefined//null/0/false}, equivalent of ["TC","ML","BC","MR"], specifies that the link ends into the in-element's closest point to in-element
  • endPos {number}, indicates an OR combination of one or more values of exontrol.CT type
  • endPos {string}, indicates a list of corners separated by comma(,) which can be any of "TL", "TC", "TR", "ML", "MR", "BL", "BC" or "BR"
The exontrol.CT type defines the following values:
  • TL (17 or 0x11), indicates the top-left corner, equivalent of "TL"
  • TC (18 or 0x12), indicates the top-center point, equivalent of "TC"
  • TR (20 or 0x14), indicates the top-right corner, equivalent of "TR"
  • ML (33 or 0x21), indicates the middle-left point, equivalent of "ML"
  • C (34 or 0x22), indicates the center of the object, equivalent of "C"
  • MR (36 or 0x24), indicates the middle-right point, equivalent of "MR"
  • BL (65 or 0x41), indicates the bottom-left corner, equivalent of "BL"
  • BC (66 or 0x42), indicates the bottom-center point, equivalent of "BC"
  • BR (68 or 0x44), Indicates the bottom-right corner, equivalent of "BR"
.
Type:
  • null | number | string
Example
null {null}, equivalent of ["TC","ML","BC","MR"], specifies that the link ends into the out-element's closest point to in-element<br>
 exontrol.CT.BC {number}, indicates that the link always ends into the bottom-center point of the out-element<br>
 exontrol.CT.BL | exontrol.CT.BC | exontrol.CT.BR {number}, indicates that the link ends into the out-element's bottom side (the closest to in-element)<br>
 "ML" {string}, specifies that the link always ends to the middle-left point of the out-element<br>
 "TL,ML,BL" {string}, specifies that the link ends into the out-element's left side (the closest to in-element)
endPos

(static) startPos :null|number|string

The startPos field defines the corners of the start element where the link begins. Could be any of the following:
  • startPos {undefined//null/0/false}, equivalent of ["TC","ML","BC","MR"], specifies that the link starts from the in-element's closest point to out-element
  • startPos {number}, indicates an OR combination of one or more values of exontrol.CT type
  • startPos {string}, indicates a list of corners separated by comma(,) which can be any of "TL", "TC", "TR", "ML", "MR", "BL", "BC" or "BR"
The exontrol.CT type defines the following values:
  • TL (17 or 0x11), indicates the top-left corner, equivalent of "TL"
  • TC (18 or 0x12), indicates the top-center point, equivalent of "TC"
  • TR (20 or 0x14), indicates the top-right corner, equivalent of "TR"
  • ML (33 or 0x21), indicates the middle-left point, equivalent of "ML"
  • C (34 or 0x22), indicates the center of the object, equivalent of "C"
  • MR (36 or 0x24), indicates the middle-right point, equivalent of "MR"
  • BL (65 or 0x41), indicates the bottom-left corner, equivalent of "BL"
  • BC (66 or 0x42), indicates the bottom-center point, equivalent of "BC"
  • BR (68 or 0x44), Indicates the bottom-right corner, equivalent of "BR"
.
Type:
  • null | number | string
Example
null {null}, equivalent of ["TC","ML","BC","MR"], specifies that the link starts from the in-element's closest point to out-element<br>
 exontrol.CT.TC {number}, indicates that the link always starts from the top-center point of the in-element<br>
 exontrol.CT.TL | exontrol.CT.TC | exontrol.CT.TR {number}, indicates that the link starts from the in-element's top side (the closest to out-element)<br>
 "MR" {string}, specifies that the link always starts from the middle-right point of the in-element<br>
 "TR,MR,BR" {string}, specifies that the link starts from the in-element's right side (the closest to out-element)
startPos

(static) style :null|number|Array.<number>

The style field specifies the pattern of the link line. Can be null, a number, or an array of numbers defining line and gap distances.
Type:
  • null | number | Array.<number>
Example
null {null}, solid line
[] {array}, solid line
2 {number}, repeated [2,2,...]
[5,15,25] {array}, repeated [5,15,25,5,15,25,...]
style

(static) type :exontrol.LinkTypeEnum

The type field specifies the type of the link. Supported 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
Additionally, -1 indicates the default link type, similar to rectangular but more symmetrical. The type member always returns "undefined"
Type:
  • exontrol.LinkTypeEnum
Example
null {null}, default link type (equivalent to -1)
0 or exontrol.LinkTypeEnum.exRect {null}, rectangular link
2 or exontrol.LinkTypeEnum.exStraight {null}, straight link

(static) width :number

The width field specifies the thickness of the link line.
Type:
  • number
Example
null {null}, 1-pixel wide
2 {number}, 2-pixels wide
width