Global

Type Definitions

ChartLabelType

Defines the {year, halfYear, quarterYear, month, thirdMonth, week, day, hour, minute, second} type for labels, toolTips fields of ChartOptions object. Every field of the ChartLabelType supports alternative HTML labels being separated by "<|>" and values for Count and Unit being separated by "<||>". By alternate HTML label we mean that you can define a list of HTML labels that may be displayed in the chart's header based on the space allocated for the time-unit. In other words, the control chooses automatically the alternate HTML label to be displayed for best fitting in the portion of the chart where the time-unit should be shown.

The label field format is "ALT1[<|>ALT2<|>...[<||>COUNT[<||>UNIT]]]" where

ALT defines a HTML label
COUNT specifies the value for the count field
UNIT field indicates the value for the unit field
(the parts delimited by [] brackets may miss)

The ALT part of the label supports ex-HTLM tags such as (<b>, <i>, <fgcolor>, ...) and <%DATE%> tags as follows:

  • <%d%> - Day of the month in one or two numeric digits, as needed (1 to 31)
  • <%dd%> - Day of the month in two numeric digits (01 to 31)
  • <%d1%> - First letter of the weekday (S to S)
  • <%loc_d1%> - Indicates day of week as a one-letter abbreviation using the current user settings
  • <%d2%> - First two letters of the weekday (Su to Sa)
  • <%loc_d2%> - Indicates day of week as a two-letters abbreviation using the current user settings
  • <%d3%> - First three letters of the weekday (Sun to Sat)
  • <%loc_d3%> equivalent with <%loc_ddd%>
  • <%ddd%> - First three letters of the weekday (Sun to Sat)
  • <%loc_ddd%> - Indicates the day of week as a three-letter abbreviation using the current user regional and language settings
  • <%dddd%> - Full name of the weekday (Sunday to Saturday)
  • <%loc_dddd%> - Indicates day of week as its full name using the current user regional and language settings
  • <%i%> - Displays the number instead the date
  • <%w%> - Day of the week (1 to 7)
  • <%ww%> - Week of the year (1 to 53)
  • <%m%> - Month of the year in one or two numeric digits, as needed (1 to 12)
  • <%mr%> - Month of the year in Roman numerals, as needed (I to XII)
  • <%mm%> - Month of the year in two numeric digits (01 to 12)
  • <%m1%> - First letter of the month (J to D)
  • <%loc_m1%> - Indicates month as a one-letter abbreviation using the current user settings
  • <%m2%> - First two letters of the month (Ja to De)
  • <%loc_m2%> - Indicates month as a two-letters abbreviation using the current user settings
  • <%m3%> - First three letters of the month (Jan to Dec)
  • <%loc_m3%> - equivalent with <%loc_mmm%>
  • <%mmm%> - First three letters of the month (Jan to Dec)
  • <%loc_mmm%> - Indicates month as a three-letter abbreviation using the current user regional and language settings
  • <%mmmm%> - Full name of the month (January to December)
  • <%loc_mmmm%> - Indicates month as its full name using the current user regional and language settings
  • <%q%> - Date displayed as the quarter of the year (1 to 4)
  • <%y%> - Number of the day of the year (1 to 366)
  • <%yy%> - Last two digits of the year (01 to 99)
  • <%yyyy%> - Full year (0100 to 9999)
  • <%hy%> - Date displayed as the half of the year (1 to 2)
  • <%loc_g%> - Indicates period/era using the current user regional and language settings
  • <%loc_gg%> - Indicates period/era using the current user regional and language settings
  • <%loc_sdate%> - Indicates the date in the short format using the current user regional and language settings
  • <%loc_ldate%> - Indicates the date in the long format using the current user regional and language settings
  • <%loc_dsep%> - Indicates the date separator using the current user regional and language settings (/)
  • <%h%> - Hour in one or two digits, as needed (0 to 23)
  • <%hh%> - Hour in two digits (00 to 23)
  • <%h12%> - Hour in 12-hour time format, in one or two digits - [0(12),11]
  • <%hh12%> - Hour in 12-hour time format, in two digits - [00(12),11]
  • <%n%> - Minute in one or two digits, as needed (0 to 59)
  • <%nn%> - Minute in two digits (00 to 59)
  • <%s%> - Second in one or two digits, as needed (0 to 59)
  • <%ss%> - Second in two digits (00 to 59)
  • <%AM/PM%> - Twelve-hour clock with the uppercase letters "AM" or "PM", as appropriate
  • <%loc_AM/PM%> - Indicates the time marker such as AM or PM using the current user regional and language settings
  • <%loc_A/P%> - Indicates the one character time marker such as A or P using the current user regional and language settings
  • <%loc_time%> - Indicates the time using the current user regional and language settings
  • <%loc_time24%> - Indicates the time in 24 hours format without a time marker using the current user regional and language settings
  • <%loc_tsep%> - indicates the time separator using the current user regional and language settings (:)
  • <%loc_y%> - Represents the Year only by the last digit, using current regional settings
  • <%loc_yy%> - Represents the Year only by the last two digits, using current regional settings. A leading zero is added for single-digit years
  • <%loc_yyyy%> - Represents the Year by a full four or five digits, depending on the calendar used. Thai Buddhist and Korean calendars have five-digit years. The "yyyy" pattern shows five digits for these two calendars, and four digits for all other supported calendars. Calendars that have single-digit or two-digit years, such as for the Japanese Emperor era, are represented differently. A single-digit year is represented with a leading zero, for example, "03". A two-digit year is represented with two digits, for example, "13". No additional leading zeros are displayed
.
Type:
  • object
Properties:
Name Type Description
year string specifies the predefined format of the level when it displays years.
halfYear string specifies the predefined format of the level when it displays half of years
quarterYear string specifies the predefined format of the level when it displays quarter of years
month string specifies the predefined format of the level when it displays months
thirdMonth string specifies the predefined format of the level when it displays third of months
week string specifies the predefined format of the level when it displays weeks
day string specifies the predefined format of the level when it displays days
hour string specifies the predefined format of the level when it displays hours
minute string specifies the predefined format of the level when it displays minutes
second string specifies the predefined format of the level when it displays seconds
Example
The following sample defines alternate-labels for year, month, week and day time-units:

{
   year:   "<%yy%><|>'<%yy%><|><%yyyy%>",
   month:  "<|><%m1%><|><%m2%><|><%m3%><|><%mmmm%><|><%m3%> '<%yy%><|><%mmmm%> <%yyyy%>",
   week:   "<|><%ww%><|><%m3%> <%d%>, '<%yy%><r><%ww%><|><%mmmm%> <%d%>, <%yyyy%><r><%ww%><||><||>256",
   day:    "<|><%d%><|><%d1%> <%d%><|><%d2%> <%d%><|><%d3%> <%d%><|><%dddd%> <%d%><|><%d3%>, <%m3%> <%d%>, '<%yy%><|><%dddd%>, <%mmmm%> <%d%>, <%yyyy%><||><||>4096",
}

where "<%yy%><|>'<%yy%><|><%yyyy%>" indicates that the "year" will be displayed using two or four digits based on the size of the field that displays it.
ChartLabelType

DisplayLinkType

Defines the {type, dir, width, color, arrow, style, startPos, endPos} type for criticalPathLinkApp, criticalPathOffLinkApp fields of DefSchedulePDM type, link, linkStartFrom, linkEndTo, linkUnselected fields of ChartOptions type.
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, ...]
startPos null | number | string The startPos field defines the in-element's corners, the link can start from. 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"
Example:
null {null}, equivalent of ["TC","ML","BC","MR"], specifies that the link starts from the in-element's closest point to out-element
exontrol.CT.TC {number}, indicates that the link always starts from the top-center point of the in-element
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)
"MR" {string}, specifies that the link always starts from the middle-right point of the in-element
"TR,MR,BR" {string}, specifies that the link starts from the in-element's right side (the closest to out-element)
endPos null | number | string The endPos field defines the out-element's corners, the link can end into. 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"
Example:
null {null}, equivalent of ["TC","ML","BC","MR"], specifies that the link ends into the out-element's closest point to in-element
exontrol.CT.BC {number}, indicates that the link always ends into the bottom-center point of the out-element
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)
"ML" {string}, specifies that the link always ends to the middle-left point of the out-element
"TL,ML,BL" {string}, specifies that the link ends into the out-element's left side (the closest to in-element)
DisplayLinkType

ScrollRangeType

Defines the {start, end} type for scrollRange field of ChartOptions object.
Type:
  • object
Properties:
Name Type Description
start any indicates the scroll range's start/left-margin date/time Both start and end fields must be specified, else scroll range has no effect. The start field can be of one of the following types:
  • start {string}, defines the date in string-format as "#MM/DD/YYYY[ HH:mm:ss]#"
  • start {Date}, indicates a JavaScript date to be copied
  • start {number} integer value representing the year of the date to be created
  • start {null}, indicates the current date and time (equivalent of Now)
end any indicates the scroll range's end/right-margin date/time Both start and end fields must be specified, else scroll range has no effect. The end field can be of one of the following types:
  • end {string}, defines the date in string-format as "#MM/DD/YYYY[ HH:mm:ss]#"
  • end {Date}, indicates a JavaScript date to be copied
  • end {number} integer value representing the year of the date to be created
  • end {null}, indicates the current date and time (equivalent of Now)
Example
The following sample limits the chart's scroll-range to Jan 1st, 2001 to Jan 1st, 2002:

{
   start: 2001
   end: 2002
}

The following sample limits the chart's scroll-range to Apr 1st, 2021 to Apr 30, 2021:

{
   start: "#4/1/2021#"
   end: "#4/30/2021#"
}
ScrollRangeType