Class: Chart

Chart(oGantt)

new Chart(oGantt)

The Chart object handles objects to be displayed by the control's chart (right-pane). Use the Chart / GetChart() method to access the control's chart object.

Every option of the ChartOptions type has associated a property of the Chart object. For instance, the option:

levelCount {number}, specifies the number of levels in the chart's header
is associated with the property:
LevelCount {number}, specifies the number of levels in the chart's header
which means that the following statements are equivalent:
oChart.Options = {levelCount: 2}
oChart.SetOptions({levelCount: 2})
oChart.LevelCount = 2
oChart.SetLevelCount(2)
where oChart is an object of Chart type
Parameters:
Name Type Description
oGantt Gantt Specifies an object of Gantt type that defines the owner control of the chart.

Methods

Bar(name) → {Bar}

The Bar() method gets the bar giving its index, name or reference. The Bar(name) method is equivalent with Chart.Bars.Item(name) method.
Parameters:
Name Type Description
name any The name parameter could be any of the following:
  • name {number}, indicates a numeric value that defines the index of the bar to request
  • name {string}, specifies a string expression that defines the name of the bar to request
  • name {Bar}, specifies the object reference to the bar to request for
Returns:
Returns null(the bar is not found), or an object of Bar type, if the bars collection contains the giving name.
Type
Bar
Example
The following statements are equivalents:

   oGantt.Bar("Task") {Bar}
   oGantt.Chart.Bar("Task") {Bar}
   oGantt.Chart.Bars.Item("Task") {Bar}

 and returns the "Task" bar

where oGantt is an object of Gantt type

EnsureVisibleSelection(ensureOpts)

The EnsureVisibleSelection() method scrolls the chart to ensure that the chart's selection fits the chart's view.
Parameters:
Name Type Description
ensureOpts object Specifies different options to run the current method, as an object of {expandParents, selection, duration} type
Properties
Name Type Description
expandParents number expands the parent-items as explained:
  • 0 {number}, no parent-item is expanded (ignored)
  • 1 {number}, the parent-item(s) is expanded
  • 2 {number}, ensure to fit the parent-item(s) as well
selection Array.<ItemBar> holds an array of item-bars as [ItemBar] type to fit into current-view. If missing the EnsureVisibleSelection() method scrolls the chart to ensure that the current chart's selection fits the chart's visible area.
duration number specifies the time in ms the control is smoothly performs the changes
Example
oGantt.Chart.EnsureVisibleSelection({selection: [oGantt.ItemBar(0,"Sum")]}), scrolls the chart to ensure that the "Sum"-bar of the first item, fits the chart's visible area.

where oGantt is an object of Gantt type

GetAdjustLevelsToBase() → {boolean}

The GetAdjustLevelsToBase() method specifies whether the units of the levels are aligned with the units of the base level
Returns:
Returns true, if the units of the levels are aligned with the units of the base level
Type
boolean

GetAllowOverviewZoom() → {boolean}

The GetAllowOverviewZoom() method indicates whether the chart's overview shows the time-scales the user can zoom to
Returns:
Returns true if the chart's overview shows the time-scales the user can zoom to
Type
boolean

GetAllowSelectDate() → {exontrol.Tree.SingleSelEnum}

The GetAllowSelectDate() method specifies whether the chart supports single, multiple, toggle date(s) selection.
Returns:
Returns an OR combination of exontrol.Tree.SingleSelEnum flags that specifies how to select date(s). The exontrol.Tree.SingleSelEnum type defines the following flags:
  • exDisableSel(0), specifies that the chart's date(s) selection is disabled (can not be combined with any other flags)
  • exEnableSel(1), specifies that the chart's date(s) selection is enabled (multiple-selection, unless the exSingleSel is set )
  • exSingleSel(2), specifies that the user can select a date/time period only
  • exToggleSel(4), specifies that the date/time period's selection state is toggled once the user clicks an date/time period.
  • exDisableCtrlSel(8), disables toggling the date/time period's selection state when user clicks an date/time period, while CTRL modifier key is pressed.
  • exDisableShiftSel(16), disables selecting date/time periods using the SHIFT key.
  • exDisableDrag(32), disables selecting date/time periods by drag.
Type
exontrol.Tree.SingleSelEnum

GetBars() → {Bars}

The GetBars() method gets the control's bars. The Bar(name) method gets the bar giving its index, name or reference.
Returns:
Returns an object of Bars type.
Type
Bars
Example
The following statements are equivalents:

 oGantt.Chart.GetBars().Count, counts the number of predefined type of bars
 oGantt.Chart.Bars.Count, counts the number of predefined type of bars

where oGantt is an object of Gantt type

GetDateTickerLabel() → {string}

The GetDateTickerLabel() method gets the format to display the bar's start and end margins while creating, moving or resizing it. The GetDrawDateTicker() method specifies whether the chart supports date-ticker (the chart's date-ticker is visible only if the mouse pointer hovers the chart area).

The <%=FORMULA%> tag (@since 2.3) holds an expression that supports the following keywords:

  • value, {Date} defines the DATE being displayed (could be the start or end)
  • start, {Date} defines the start-margin of the bar as a DATE type
  • end, {Date} defines the end-margin of the bar as a DATE type
The <%DATE%> tag can be any of the following:
  • <%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
Returns:
Returns the format to display the bar's start and end margins while creating, moving or resizing it.
Type
string

GetDateTickerLabelHMargin() → {number}

The GetDateTickerLabelHMargin() method gets the distance between the date-label and the bar, while create, resize or move it
Since:
  • 2.3
Returns:
Returns the distance between the date-label and the bar, while create, resize or move it
Type
number

GetDateTickerLabelVAlign() → {number}

The GetDateTickerLabelVAlign() method gets the vertical alignment of the date label, while create, resize or move the bar
Since:
  • 2.3
Returns:
Returns the vertical alignment of the date label, while create, resize or move the bar, as one of the folowing:
  • 0 {number}, indicates that the date-label is displayed on top, right-below the header (default)
  • 1 {number}, specifies that the start/end margins of the bar are displayed to left/side of it
Type
number

GetDrawDateTicker() → {boolean}

The GetDrawDateTicker() method specifies whether the chart supports date-ticker (the chart's date-ticker is visible only if the mouse pointer hovers the chart area). The GetDateTickerLabel() method gets the format to display the bar's start and end margins while creating, moving or resizing it.
Returns:
Returns true if the chart supports date-ticker which is shown to indicate the date-time being hovered
Type
boolean

GetDrawGridLines() → {exontrol.Tree.GridLinesEnum}

The GetDrawGridLines() method specifies whether the chart's grid-lines are visible or hidden
Returns:
Returns a numeric value that determines whether the chart's grid-lines are visible or hidden. The exontrol.Tree.GridLinesEnum type supports the following flags:
  • exNoLines(0), no grid lines
  • exAllLines(-1), shows all vertical and horizontal grid lines
  • exRowLines(-2), shows grid lines for existing rows only
  • exHLines(1), shows only the horizontal grid lines
  • exVLines(2), shows only the vertical grid lines
Type
exontrol.Tree.GridLinesEnum

GetDrawLevelSeparator() → {Gantt.LevelLineEnum}

The GetDrawLevelSeparator() method specifies whether lines lines between chart's levels are visible or hidden
Returns:
Returns the type of lines between chart's levels The exontrol.Gantt.LevelLineEnum type supports the following values and flags:
  • exLevelNoLine(0), no line is shown
  • exLevelDefaultLine(-1), indicates the default grid line style
  • exLevelDotLine(1), indicates a dotted line. For vertical/tick lines, it can be combined with exLevelLowerHalf, exLevelUpperHalf or exLevelMiddleLine. Can be combined with exLevelLowerHalf, exLevelUpperHalf or exLevelMiddleLine option.
  • exLevelSolidLine(2), indicates a solid line. For vertical/tick lines, it can be combined with exLevelLowerHalf, exLevelUpperHalf or exLevelMiddleLine. Can be combined with exLevelLowerHalf, exLevelUpperHalf or exLevelMiddleLine option.
  • exLevelLowerHalf(0x10), (no effect) indicates that the line is shown in the lower half of the level. For vertical/tick lines, it can be combined with exLevelDotLine or exLevelSolidLine
  • exLevelUpperHalf(0x20), (no effect) indicates that the line is shown in the upper half of the level. For vertical/tick lines, it can be combined with exLevelDotLine or exLevelSolidLine
  • exLevelMiddleLine(0x40), (no effect) indicates that the line is shown in the middle. For vertical/tick lines, it can be combined with exLevelDotLine or exLevelSolidLine
  • exLevelQuarterHeight(0x100), (no effect) indicates that the line is shown as a quarter of the full height. Specify the exLevelQuarterHeight option to show shorter tick lines in the chart's level. Can be combined with exLevelLowerHalf, exLevelUpperHalf or exLevelMiddleLine option
Type
Gantt.LevelLineEnum

GetEndPrintDate() → {Date}

The GetEndPrintDate() method gets the maximum-date for the entire chart (upper date)
Returns:
Returns undefined (the chart includes no bars) or the maximum-date for the entire chart (upper date)
Type
Date
Example
The following statements are equivalents:

 oGantt.Chart.GetEndPrintDate(), gets the maximum-date for the entire chart (upper date)
 oGantt.Chart.EndPrintDate, gets the maximum-date for the entire chart (upper date)

where oGantt is an object of Gantt type

GetFirstVisibleDate() → {Date}

The GetFirstVisibleDate() method gets the chart's first visible date. The GetLastVisibleDate() method gets the chart's last visible date.
Returns:
Returns the chart's first visible date.
Type
Date
Example
The following statements are equivalents:

 oGantt.Chart.GetFirstVisibleDate(), gets the chart's first visible date
 oGantt.Chart.FirstVisibleDate, gets the chart's first visible date

where oGantt is an object of Gantt type

GetFirstVisibleOffset() → {number}

The GetFirstVisibleOffset() method specifies the chart's first visible offset.
Returns:
Returns chart's first visible offset
Type
number

GetHistogramHeight() → {number}

The GetHistogramHeight() method indicates the height of the chart's histogram
Returns:
Returns the height of the chart's histogram
Type
number

GetHistogramUnitCount() → {number}

The GetHistogramUnitCount() method gets the time-scale count to determine the effort of bars with variable-effort (effort of expression/string type). The GetHistogramUnitScale() method gets the time-scale unit to determine the effort of bars with variable-effort (effort of expression/string type).
Returns:
Returns the time-scale count to determine the effort of bars with variable-effort (effort of expression/string type)
Type
number

GetHistogramUnitScale() → {exontrol.UnitEnum}

The GetHistogramUnitScale() method gets the time-scale unit to determine the effort of bars with variable-effort (effort of expression/string type). The GetHistogramUnitCount() method gets the time-scale count to determine the effort of bars with variable-effort (effort of expression/string type).
Returns:
Returns the time-scale unit to determine the effort of bars with variable-effort (effort of expression/string type) The exontrol.UnitEnum type support the following values:
  • exYear (0), indicates the year scale
  • exHalfYear (1), indicates the half-year scale
  • exQuarterYear (2), indicates the quarter-year scale
  • exMonth (0x10), indicates the month scale
  • exThirdMonth (0x11), indicates the third-month scale
  • exWeek (0x100), indicates the week scale
  • exDay (0x1000), indicates the day scale
  • exHour (0x10000), indicates the hour scale
  • exMinute (0x100000), indicates the minute scale
  • exSecond (0x1000000), indicates the second scale
Type
exontrol.UnitEnum

GetHistogramValue(date)

The GetHistogramValue() method gets the value in the histogram at specified date-time. The GetHistogramValue(date) method is equivalent with HistogramValue(date) method.
Parameters:
Name Type Description
date any Specifies the date to get histogram-value for, as explained:
  • date {string}, defines the date in string-format as "#MM/DD/YYYY[ HH:mm:ss]#"
  • date {Date}, indicates a JavaScript date to be copied
  • date {number} integer value representing the year of the date to be created
  • date {null}, indicates the current date and time (equivalent of Now)

GetHistogramView() → {Gantt.HistogramViewEnum}

The GetHistogramView() method gets the items the control's histogram displays data for
Returns:
Returns the items the control's histogram displays data for. The Gantt.HistogramViewEnum type supports the following values and flags:
  • exHistogramVisibleItems(1), the histogram is shown for the visible items only
  • exHistogramSelectedItems(2), the histogram is shown for the selected items only
  • exHistogramCheckedItems(4), the histogram is shown for the checked items only
  • exHistogramSelectedBars(8), the histogram is shown for the selected bars only
  • exHistogramUnlockedItems(0x10), the histogram is shown only for unlocked items
  • exHistogramLockedTopItems(0x20), the histogram is shown only for locked items in the top side of the control
  • exHistogramLockedBottomItems(0x40), The histogram is shown only for locked items in the bottom side of the control
  • exHistogramAllItems(0x70), The histogram is shown for all items
  • exHistogramFilteredItems(0x80), The histogram is shown for the filtered items only
  • exHistogramLeafItems(0x100), The histogram shows the bars for leaf items (a leaf item contains no child items)
  • exHistogramRecLeafItems(0x200), The histogram shows all bars for all recursive leaf items (a leaf item contains no child items)
  • exHistogramNoGrouping(0x400), The histogram shows all bars without grouping based on the item's parent
  • exHistogramBackground(0x800), The histogram's chart goes on the background, while the non-working part is shown on front ( erases the non-working parts )
  • exHistogramNoGroupCaption(0x1000), The histogram shows no caption for groups being shown
  • exHistogramGroupCumulative(0x2000), The histogram shows cumulative groups
Type
Gantt.HistogramViewEnum

GetHistogramVisible() → {boolean}

The GetHistogramVisible() method specifies whether the chart's histogram is visible or hidden
Returns:
Returns a combination of one or more flags of boolean type, that specifies whether the chart's histogram is visible or hidden
Type
boolean

GetHistogramZOrder() → {string}

The GetHistogramZOrder() method gets the z-order of the bars to be shown within the chart's histogram
Returns:
Returns the z-order of the bars to be shown within the chart's histogram.
Type
string

GetLabel(unit) → {string}

The GetLabel() method gets the predefined format of the level's label for specified unit. The GetLabels() method gets predefined format to display the level's label of each time-unit.
Parameters:
Name Type Description
unit exontrol.UnitEnum Specifies the time-unit to request its label for The exontrol.UnitEnum type support the following values:
  • exYear (0), indicates the year scale
  • exHalfYear (1), indicates the half-year scale
  • exQuarterYear (2), indicates the quarter-year scale
  • exMonth (0x10), indicates the month scale
  • exThirdMonth (0x11), indicates the third-month scale
  • exWeek (0x100), indicates the week scale
  • exDay (0x1000), indicates the day scale
  • exHour (0x10000), indicates the hour scale
  • exMinute (0x100000), indicates the minute scale
  • exSecond (0x1000000), indicates the second scale
Returns:
Returns undefined(no label defined) or a string that defines the predefined label for the giving unit
Type
string

GetLabels() → {ChartLabelType}

The GetLabels() method gets predefined format to display the level's label of each time-unit. The GetLabel(unit) method gets the predefined format of the level's label for specified unit.
Returns:
Returns an object of {year, halfYear, quarterYear, month, thirdMonth, week, day, hour, minute, second} type as explained:
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
Type
ChartLabelType

GetLastVisibleDate() → {Date}

The GetLastVisibleDate() method gets the chart's last visible date. The GetFirstVisibleDate() method gets the chart's first visible date.
Returns:
Returns chart's last visible date
Type
Date
Example
The following statements are equivalents:

 oGantt.Chart.GetLastVisibleDate(), gets the chart's last visible date
 oGantt.Chart.LastVisibleDate, gets the chart's last visible date

where oGantt is an object of Gantt type

GetLevelCount() → {number}

The GetLevelCount() method gets the count of levels the chart's header displays
Returns:
Returns the count of levels the chart's header displays
Type
number
The GetLink() method gets the appearance of the link between bars.
Returns:
Returns the appearance of the link between bars, as an object of {type, dir, width, color, arrow, style, startPos, endPos} type, where:
  • type {exontrol.LinkTypeEnum}, specifies the type of the link as 0 (rectangular), 1 (direct), 2(straight) or 3(round)
  • dir {number}, specifies whether the link's direction is shown or hidden as 0 (hidden), 1(shows the direction/arrow where the link begins), 2(shows the direction where the link ends, default) or 3 shows the arrows in both sides
  • width {number}, specifies the link's width or size (1 by default)
  • color {string}, indicates the link's color (partial-black by default)
  • arrow {string}, indicates the arrow's color. If it is missing or not specified the arrow is shown using the link's color (gray by default)
  • arrowSize {number}, indicates the arrow's size. If it is missing or not specified the arrow's size is defined by link's width (1 by default) (since 2.2)
  • arrowShape {object}, defines an object of exontrol.Def.Shape type to customize the shape of the link's arrow (for instance shows the link's arrow as a circle instead of a triangle) (since 2.2)
  • style {array}, specifies the link's dash pattern to show the lines (solid by default)
  • startPos {any}, indicates the list of corners of in-element, the link can start from
  • endPos {any}, indicates the list of corners of out-element, the link can end to
Type
DisplayLinkType

GetLinkEndTo() → {DisplayLinkType}

The GetLinkEndTo() method gets the appearance of the link that ends to any selected-bar (incoming links)
Returns:
Returns the appearance of the link that ends to any selected-bar (incoming links), as an object of {type, dir, width, color, arrow, style, startPos, endPos} type, where:
  • type {exontrol.LinkTypeEnum}, specifies the type of the link as 0 (rectangular), 1 (direct), 2(straight) or 3(round)
  • dir {number}, specifies whether the link's direction is shown or hidden as 0 (hidden), 1(shows the direction/arrow where the link begins), 2(shows the direction where the link ends, default) or 3 shows the arrows in both sides
  • width {number}, specifies the link's width or size (1 by default)
  • color {string}, indicates the link's color (partial-black by default)
  • arrow {string}, indicates the arrow's color. If it is missing or not specified the arrow is shown using the link's color (gray by default)
  • arrowSize {number}, indicates the arrow's size. If it is missing or not specified the arrow's size is defined by link's width (1 by default) (since 2.2)
  • arrowShape {object}, defines an object of exontrol.Def.Shape type to customize the shape of the link's arrow (for instance shows the link's arrow as a circle instead of a triangle) (since 2.2)
  • style {array}, specifies the link's dash pattern to show the lines (solid by default)
  • startPos {any}, indicates the list of corners of in-element, the link can start from
  • endPos {any}, indicates the list of corners of out-element, the link can end to
Type
DisplayLinkType

GetLinkStartFrom() → {DisplayLinkType}

The GetLinkStartFrom() method gets the appearance of the link that starts from any selected-bar (outgoing links)
Returns:
Returns the appearance of the link that starts from any selected-bar (outgoing links), as an object of {type, dir, width, color, arrow, style, startPos, endPos} type, where:
  • type {exontrol.LinkTypeEnum}, specifies the type of the link as 0 (rectangular), 1 (direct), 2(straight) or 3(round)
  • dir {number}, specifies whether the link's direction is shown or hidden as 0 (hidden), 1(shows the direction/arrow where the link begins), 2(shows the direction where the link ends, default) or 3 shows the arrows in both sides
  • width {number}, specifies the link's width or size (1 by default)
  • color {string}, indicates the link's color (partial-black by default)
  • arrow {string}, indicates the arrow's color. If it is missing or not specified the arrow is shown using the link's color (gray by default)
  • arrowSize {number}, indicates the arrow's size. If it is missing or not specified the arrow's size is defined by link's width (1 by default) (since 2.2)
  • arrowShape {object}, defines an object of exontrol.Def.Shape type to customize the shape of the link's arrow (for instance shows the link's arrow as a circle instead of a triangle) (since 2.2)
  • style {array}, specifies the link's dash pattern to show the lines (solid by default)
  • startPos {any}, indicates the list of corners of in-element, the link can start from
  • endPos {any}, indicates the list of corners of out-element, the link can end to
Type
DisplayLinkType

GetLinkUnselected() → {DisplayLinkType}

The GetLinkUnselected() method gets the appearance of the link not related to any selected-bar (unselected links)
Returns:
Returns the appearance of the link not related to any selected-bar (unselected links), as an object of {type, dir, width, color, arrow, style, startPos, endPos} type, where:
  • type {exontrol.LinkTypeEnum}, specifies the type of the link as 0 (rectangular), 1 (direct), 2(straight) or 3(round)
  • dir {number}, specifies whether the link's direction is shown or hidden as 0 (hidden), 1(shows the direction/arrow where the link begins), 2(shows the direction where the link ends, default) or 3 shows the arrows in both sides
  • width {number}, specifies the link's width or size (1 by default)
  • color {string}, indicates the link's color (partial-black by default)
  • arrow {string}, indicates the arrow's color. If it is missing or not specified the arrow is shown using the link's color (gray by default)
  • arrowSize {number}, indicates the arrow's size. If it is missing or not specified the arrow's size is defined by link's width (1 by default) (since 2.2)
  • arrowShape {object}, defines an object of exontrol.Def.Shape type to customize the shape of the link's arrow (for instance shows the link's arrow as a circle instead of a triangle) (since 2.2)
  • style {array}, specifies the link's dash pattern to show the lines (solid by default)
  • startPos {any}, indicates the list of corners of in-element, the link can start from
  • endPos {any}, indicates the list of corners of out-element, the link can end to
Type
DisplayLinkType
The GetLinks property gets the control's links.
Returns:
Returns an object of Links type
Type
Links
Example
The following statements are equivalents:

 oGantt.Chart.GetLinks().Count, counts the links within the control
 oGantt.Chart.Links.Count, counts the links within the control

where oGantt is an object of Gantt type

GetLocale() → {string}

The GetLocale() method determines the language to format the calendar.
Returns:
A string with a BCP 47 language tag, or null to specify the browser's UI language.
Type
string

GetMaxUnitWidth() → {number}

The GetMaxUnitWidth() method specifies the maximum width of the units within the base-level, while the user resizes or zooms-in/out the chart
Returns:
Returns the maximum width of the units within the base-level, while the user resizes or zooms-in/out the chart
Type
number

GetMinUnitWidth() → {number}

The GetMinUnitWidth() method specifies the minimum width of the units within the base-level, while the user resizes or zooms-in/out the chart
Returns:
Returns the minimum width of the units within the base-level, while the user resizes or zooms-in/out the chart
Type
number

GetNonworkingDays() → {number}

The GetNonworkingDays() method specifies the chart's non-working days
Returns:
Returns the chart's non-working days as a combination of one or more of the following flags:
  • 0b00000001 (1) {number}, specifies that each Sunday is a non-working day
  • 0b00000010 (2) {number}, specifies that each Monday is a non-working day
  • 0b00000100 (4) {number}, specifies that each Tuesday is a non-working day
  • 0b00001000 (8) {number}, specifies that each Wednesday is a non-working day
  • 0b00010000 (16) {number}, specifies that each Thursday is a non-working day
  • 0b00100000 (32) {number}, specifies that each Friday is a non-working day
  • 0b01000000 (64) {number}, specifies that each Saturday is a non-working day
Type
number

GetNonworkingHours() → {number}

The GetNonworkingHours() method specifies the chart's non-working hours
Returns:
Returns the chart's non-working hours as a combination of one or more of the following flags:
  • 0b00000000000000000000000000000001 (1) {number}, indicates that the hour after 12PM is a non-working hour
  • 0b00000000000000000000000000000010 (2) {number}, indicates that the hour after 1AM is a non-working hour
  • 0b00000000000000000000000000000100 (4) {number}, indicates that the hour after 2AM is a non-working hour
  • 0b00000000000000000000000000001000 (8) {number}, indicates that the hour after 3AM is a non-working hour
  • 0b00000000000000000000000000010000 (16) {number}, indicates that the hour after 4AM is a non-working hour
  • 0b00000000000000000000000000100000 (32) {number}, indicates that the hour after 5AM is a non-working hour
  • 0b00000000000000000000000001000000 (64) {number}, indicates that the hour after 6AM is a non-working hour
  • 0b00000000000000000000000010000000 (128) {number}, indicates that the hour after 7AM is a non-working hour
  • 0b00000000000000000000000100000000 (256) {number}, indicates that the hour after 8AM is a non-working hour
  • 0b00000000000000000000001000000000 (512) {number}, indicates that the hour after 9AM is a non-working hour
  • 0b00000000000000000000010000000000 (1024) {number}, indicates that the hour after 10AM is a non-working hour
  • 0b00000000000000000000100000000000 (2048) {number}, indicates that the hour after 11AM is a non-working hour
  • 0b00000000000000000001000000000000 (4096) {number}, indicates that the hour after 12AM is a non-working hour
  • 0b00000000000000000010000000000000 (8192) {number}, indicates that the hour after 1PM is a non-working hour
  • 0b00000000000000000100000000000000 (16384) {number}, indicates that the hour after 2PM is a non-working hour
  • 0b00000000000000001000000000000000 (32768) {number}, indicates that the hour after 3PM is a non-working hour
  • 0b00000000000000010000000000000000 (65536) {number}, indicates that the hour after 4PM is a non-working hour
  • 0b00000000000000100000000000000000 (131072) {number}, indicates that the hour after 5PM is a non-working hour
  • 0b00000000000001000000000000000000 (262144) {number}, indicates that the hour after 6PM is a non-working hour
  • 0b00000000000010000000000000000000 (524288) {number}, indicates that the hour after 7PM is a non-working hour
  • 0b00000000000100000000000000000000 (1048576) {number}, indicates that the hour after 8PM is a non-working hour
  • 0b00000000001000000000000000000000 (2097152) {number}, indicates that the hour after 9PM is a non-working hour
  • 0b00000000010000000000000000000000 (4194304) {number}, indicates that the hour after 10PM is a non-working hour
  • 0b00000000100000000000000000000000 (8388608) {number}, indicates that the hour after 11PM is a non-working hour
Type
number

GetOptions() → {object}

The GetOptions() method returns the options of the control's chart.
Returns:
An object of ChartOptions type that indicates the options of the control's chart.
Type
object
Example
The following statements are equivalents:

 oGantt.Chart.GetOptions(), gets the options of the control's chart
 oGantt.Chart.Options, gets the options of the control's chart

where oGantt is an object of Gantt type

GetOverlaidOnMoving() → {boolean}

The GetOverlaidOnMoving() method specifies whether the overlaid bars are re-arranged while the user moves or resizes at runtime a bar
Returns:
Returns true if the overlaid bars are re-arranged while the user moves or resizes at runtime a bar
Type
boolean

GetOverviewHeight() → {number}

The GetOverviewHeight() method indicates the height of the chart's overview
Returns:
Returns the height of the chart's overview
Type
number

GetOverviewShowSelectDates() → {boolean}

The GetOverviewShowSelectDates() method indicates whether the chart's overview shows the selected dates
Returns:
Returns true if the selected dates are shown on the control's overview
Type
boolean

GetOverviewToolTip() → {string}

The GetOverviewToolTip() method indicates the format of the tooltip being shown while the cursor hovers the chart's overview area.
Returns:
Returns the format of the tooltip being shown while the cursor hovers the chart's overview area. The format 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
string

GetOverviewVisible() → {Gantt.OverviewVisibleEnum}

The GetOverviewVisible() method specifies whether the chart's overview layout is visible or hidden
Returns:
Returns a combination of one or more flags of Gantt.OverviewVisibleEnum type, that specifies whether the chart's overview layout is visible or hidden. The Gantt.OverviewVisibleEnum type supports the following values and flags:
  • exOverviewHidden(0), the control's overview is not visible
  • exOverviewShowOnlyVisible(1), the control's overview shows the bars from the visible items using the range of bars in the visible items only
  • exOverviewShowAllVisible(2), the control's overview shows the bars from the visible items using the range for all bars in the chart
  • exOverviewAllowVerticalScroll(0x100), indicates whether the user can vertically scroll the chart while navigating up or down the overview part of the control. For instance, you can click the overview panel, the chart displays the selected area, and you can drag the cursor left or right to select a new date-time range to be displayed, or you can go up or down, to scroll items up or down
  • exOverviewHideBars(0x200), prevents showing the bars in the overview part of the control. For instance, you can use this flag in combination of any other flag to show just the time-scale in the overview part of the control, to allow the user to quickly scroll the chart's content to a specific time-zone
  • exOverviewShowDateTimeScale(0x1000), specifies whether the overview part of the control displays the date-time scale. This flag includes the time-scale on the overview. The time-scale intersects the bars in the overview. By default, the time-scale of the overview part is shown on the top of it, so you can combine the exOverviewShowDateTimeScale flag with exOverviewShowDateTimeScaleBottom flag, to display the time-scale on the bottom side of the overview part of the control
  • exOverviewShowDateTimeScaleSplit(0x1400), specifies whether the overview's date-time scale is displayed into a separate portion of the overview. This flag includes the time-scale on the overview. The time-scale does not intersect the bars in the overview. By default, the time-scale of the overview part is shown on the top of it, so you can combine the exOverviewShowDateTimeScaleSplit flag with exOverviewShowDateTimeScaleBottom flag, to display the time-scale on the bottom side of the overview part of the control
  • exOverviewShowDateTimeScaleBottom(0x1800), specifies whether the overview's date-time scale is displayed on the bottom side of the overview. By default, the time-scale of the overview part is shown on the top of it, so you can use the exOverviewShowDateTimeScaleBottom flag with exOverviewShowDateTimeScale or exOverviewShowDateTimeScaleSplit to display the time-scale on the bottom side of the overview part of the control
  • exOverviewShowMargins(0x2000), displays the limits of the overview bars. You can include the exOverviewShowMargins flag to display the margins/limits of all (project) / visible bars. In other words, the exOverviewShowMargins flag displays the minimal ItemBar(exBarStart) value, and the maximal ItemBar(exBarEnd) value
  • exOverviewShowSelMargins(0x4000), displays the selection limits (first/last visible date in the chart)
  • exOverviewSplitter(0x10000), specifies whether the overview's horizontal splitter is visible or hidden(makes the control's overview resizable or fixed)
Type
Gantt.OverviewVisibleEnum

GetOverviewZoomCaption() → {string}

The GetOverviewZoomCaption() method gets the captions for each zooming unit
Returns:
Retrns the captions for each zooming unit, separated by | character
Type
string

GetOverviewZoomUnit() → {number}

The GetOverviewZoomUnit() method gets the width of the time-unit scale in the overview
Returns:
Returns the width of the time-unit scale in the overview
Type
number

GetPaneWidth(rightopt) → {number}

The GetPaneWidth() method gets the width of the left(items) or right(chart) pane. The GetPaneWidthLeft() method is equivalent with GetPaneWidth() / GetPaneWidth(false), and GetPaneWidthRight() method is equivalent with GetPaneWidth(true).
Parameters:
Name Type Attributes Description
right boolean <optional>
 A Boolean expression that indicates whether the left (items) or right(chart) area is requested
Returns:
Returns the width of the requested pane
Type
number

GetPaneWidthLeft() → {number}

The GetPaneWidthLeft() method gets the width of the control's left-pane (items).
Returns:
Returns the width of the left-pane (items)
Type
number

GetPaneWidthRight() → {number}

The GetPaneWidthRight() method gets the width of the control's right-pane (chart).
Returns:
Returns the width of the right-pane (chart)
Type
number

GetResizeUnitCount() → {number}

The GetResizeUnitCount() method gets the count of time-unit(s) to create, move or resize bars. The GetResizeUnitScale() method gets the time-unit to create, move or resize bars.
Returns:
Returns the count of time-unit(s) to create, move or resize bars
Type
number

GetResizeUnitScale() → {exontrol.UnitEnum}

The GetResizeUnitScale() method gets the time-unit to create, move or resize bars. The GetResizeUnitCount() method gets the count of time-unit(s) to create, move or resize bars.
Returns:
Returns the time-unit to create, move or resize bars The exontrol.UnitEnum type support the following values:
  • exYear (0), indicates the year scale
  • exHalfYear (1), indicates the half-year scale
  • exQuarterYear (2), indicates the quarter-year scale
  • exMonth (0x10), indicates the month scale
  • exThirdMonth (0x11), indicates the third-month scale
  • exWeek (0x100), indicates the week scale
  • exDay (0x1000), indicates the day scale
  • exHour (0x10000), indicates the hour scale
  • exMinute (0x100000), indicates the minute scale
  • exSecond (0x1000000), indicates the second scale
Type
exontrol.UnitEnum

GetScrollBar() → {boolean}

The GetScrollBar() method specifies whether the chart's horizontal scroll-bar is visible or hidden.
Returns:
Returns true, if the chart's horizontal scroll-bar is visible or hidden
Type
boolean

GetScrollRange() → {ScrollRangeType}

The GetScrollRange() method gets the range of dates to scroll within
Returns:
Returns the range of dates to scroll within, as an object of {start,end} type.
Type
ScrollRangeType

GetSelectDates() → {Array.<object>}

The GetSelectDates() method gets the current selected-dates as an array of [{start,end}] type.
Returns:
Returns the selected-dates as an array of [{start,end}] type, as explained:
  • start {any}, specifies the date-time the selected time period begins
  • end {any}, specifies the date-time the selected time period ends
The start or end field can be any of the following types:
  • date {string}, defines the date in string-format as "#MM/DD/YYYY[ HH:mm:ss]#"
  • date {Date}, indicates a JavaScript date to be copied
  • date {number} integer value representing the year of the date to be created
  • date {null}, indicates the current date and time (equivalent of Now)
Type
Array.<object>

GetSelection() → {array}

The GetSelection() method gets the chart's selection (bars).
Returns:
The GetSelection can return one of the following:
  • null, indicates that the chart has no selected-item-bars
  • {ItemBar}, indicates a single-selected item (while the chart support single-selection only)
  • {ItemBar}[], defines a collection of selected-item-bars within the chart
Type
array
Example
The following statements are equivalents:

 oGantt.Chart.GetSelection(), returns the chart's selection
 oGantt.Chart.Selection, returns the chart's selection

where oGantt is an object of Gantt type
The GetShowLinks() method specifies whether the control's links are shown or hidden.
Returns:
Returns an exontrol.ShowLinksEnum expression that specifies whether the links between bars are visible or hidden. The exontrol.ShowLinksEnum type supports the following flags:
  • exHide (0), specifies that no links are visible
  • exExtended (0x01), specifies that links are shown as extended
  • exShow (0x02), specifies that links are visible (the links are always shown while not exHide)
  • exFront (0x10), specifies that links are shown in front (by default, the control are shown on the background)
  • exCrossRect (0x20), shows rectangular cross-links
  • exCrossTriangle (0x20), shows triangular cross-links
  • exCrossMixt (0x60), shows mixt cross-links
Type
exontrol.ShowLinksEnum

GetShowNonworkingDays() → {boolean}

The GetShowNonworkingDays() method specifies whether the chart displays the non-working days (marks the non-working days)
Returns:
Returns true, when the chart's non-working days are visible or shown
Type
boolean

GetShowNonworkingHours() → {boolean}

The GetShowNonworkingHours() method specifies whether the chart displays the non-working hours (marks the non-working hours)
Returns:
Returns true, when the chart's non-working hours are visible or shown
Type
boolean

GetShowNonworkingUnits() → {boolean}

The GetShowNonworkingUnits() method specifies whether the chart's non-working units (days and hours) are visible or hidden
Returns:
Returns true, if the chart's non-working units (days and hours) are visible or hidden
Type
boolean

GetSingleSel() → {exontrol.Tree.SingleSelEnum}

The GetSingleSel() method specifies whether the chart supports single, multiple, toggle selection (equivalent of AllowSelectObjects property)
Returns:
Returns an OR combination of exontrol.Tree.SingleSelEnum flags that specifies how to select item-bars. The exontrol.Tree.SingleSelEnum type defines the following flags:
  • exDisableSel(0), specifies that the chart's selection is disabled (can not be combined with any other flags)
  • exEnableSel(1), specifies that the chart's selection is enabled (multiple-selection, unless the exSingleSel is set )
  • exSingleSel(2), specifies that the user can select an item-bar only
  • exToggleSel(4), specifies that the item-bar's selection state is toggled once the user clicks an item-bar.
  • exDisableCtrlSel(8), disables toggling the item-bar's selection state when user clicks an item-bar, while CTRL modifier key is pressed.
  • exDisableShiftSel(16), disables selecting item-bars using the SHIFT key.
  • exDisableDrag(32), disables selecting item-bars by drag.
Type
exontrol.Tree.SingleSelEnum

GetStartPrintDate() → {Date}

The GetStartPrintDate() method gets the minimum-date for the entire chart (lower date)
Returns:
Returns undefined (the chart includes no bars) or the minimum-date for the entire chart (lower date)
Type
Date
Example
The following statements are equivalents:

 oGantt.Chart.GetStartPrintDate(), gets the minimum-date for the entire chart (lower date)
 oGantt.Chart.StartPrintDate, gets the minimum-date for the entire chart (lower date)

where oGantt is an object of Gantt type

GetToolTip(unit) → {string}

The GetToolTip() method gets the predefined-tooltip for specified unit. The GetToolTips() method gets predefined-tooltips of each time-unit.
Parameters:
Name Type Description
unit exontrol.UnitEnum Specifies the time-unit to request its label for The exontrol.UnitEnum type support the following values:
  • exYear (0), indicates the year scale
  • exHalfYear (1), indicates the half-year scale
  • exQuarterYear (2), indicates the quarter-year scale
  • exMonth (0x10), indicates the month scale
  • exThirdMonth (0x11), indicates the third-month scale
  • exWeek (0x100), indicates the week scale
  • exDay (0x1000), indicates the day scale
  • exHour (0x10000), indicates the hour scale
  • exMinute (0x100000), indicates the minute scale
  • exSecond (0x1000000), indicates the second scale
Returns:
Returns undefined(no tooltip defined) or a string that defines the predefined-tooltip for the giving unit
Type
string

GetToolTips() → {ChartLabelType}

The GetToolTips() method gets predefined-tooltips of each time-unit. The GetToolTip(unit) method gets the predefined-tooltip for specified unit.
Returns:
Returns an object of {year, halfYear, quarterYear, month, thirdMonth, week, day, hour, minute, second} type as explained:
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
Type
ChartLabelType

GetUnitScale() → {exontrol.UnitEnum}

The GetUnitScale() method specifies the base unit the chart displays
Returns:
Returns the base unit the chart displays The exontrol.UnitEnum type support the following values:
  • exYear (0), indicates the year scale
  • exHalfYear (1), indicates the half-year scale
  • exQuarterYear (2), indicates the quarter-year scale
  • exMonth (0x10), indicates the month scale
  • exThirdMonth (0x11), indicates the third-month scale
  • exWeek (0x100), indicates the week scale
  • exDay (0x1000), indicates the day scale
  • exHour (0x10000), indicates the hour scale
  • exMinute (0x100000), indicates the minute scale
  • exSecond (0x1000000), indicates the second scale
Type
exontrol.UnitEnum

GetUnitWidth() → {number}

The GetUnitWidth() method specifies the width to display the units in base-level
Returns:
Returns the width to display the units in base-level
Type
number

GetUnitWidthNonworking() → {number}

The GetUnitWidthNonworking() method specifies the width to display the non-working units in base-level
Returns:
Returns the width to display the non-working units in base-level, as one of the following:
  • 0 {number}, no effect (the unitWidth field specifies the width for all units, including the non-working units in base-level). The showNonworkingUnits field, specifies whether the chart displays non-working units.
  • negative {number}, indicates that neighbor non-working units are shown as a single non-working unit with specified width ( absolute value )
  • positive {number}, indicates the width for non-working units
Type
number

Level(index) → {Level}

The Level() method retrieves the level based on its index.
Parameters:
Name Type Description
index number A long expression that indicates the index of the level being accessed.
Returns:
Returns the level as an object of Level type
Type
Level

RemoveSelection() → {number}

The RemoveSelection() method removes the objects(bars) of the chart's selection
Returns:
Returns the number of the objects(bars) being removed
Type
number

ScrollTo(date, align)

The ScrollTo() method scrolls the chart to ensure that specified date fits the chart's area.
Parameters:
Name Type Description
date number | string | Date A value of one of the following types:
  • date {string}, defines the date in string-format as "#MM/DD/YYYY[ HH:mm:ss]#"
  • date {Date}, indicates a JavaScript date to be copied
  • date {number} integer value representing the year of the date to be created
  • date {null} or {undefined}, indicates the current date and time (equivalent of Now)
    align exontrol.AlignEnum Specifies the horiontal-alignment to display the date. The exontrol.AlignEnum type supports the following values:
    • exAlignTop (0x00), justifies the object to the top of the rectangle
    • exAlignLeft (0x00), aligns object to the left
    • exAlignCenter (0x01), centers object horizontally in the rectangle
    • exAlignRight (0x02), aligns object to the right
    • exAlignVCenter (0x04), centers object vertically
    • exAlignBottom (0x08), justifies the object to the bottom of the rectangle

    SetAdjustLevelsToBase(value)

    The SetAdjustLevelsToBase() method shows or hides the chart's non-working units (days and hours)
    Parameters:
    Name Type Description
    value boolean Indicates whether the units of the levels are aligned with the units of the base level
    Example
    true {boolean}, aligns the units of the level with units of the base-level

    SetAllowOverviewZoom(value)

    The SetAllowOverviewZoom() method shows or hides the time-scales on the chart's overview
    Parameters:
    Name Type Description
    value boolean Indicates whether the chart's overview shows the time-scales the user can zoom to
    Example
    false {boolean}, the overview displays no zooming time-scales
 true {boolean}, the overview displays the time-scales the user can zoom to

    SetAllowSelectDate(value)

    The SetAllowSelectDate() method sets the chart's date(s) selection to single, multiple or toggle
    Parameters:
    Name Type Description
    value exontrol.Tree.SingleSelEnum An OR combination of exontrol.Tree.SingleSelEnum flags to specify how user can select date(s) The exontrol.Tree.SingleSelEnum type defines the following flags:
    • exDisableSel(0), specifies that the chart's date(s) selection is disabled (can not be combined with any other flags)
    • exEnableSel(1), specifies that the chart's date(s) selection is enabled (multiple-selection, unless the exSingleSel is set )
    • exSingleSel(2), specifies that the user can select a date/time period only
    • exToggleSel(4), specifies that the date/time period's selection state is toggled once the user clicks an date/time period.
    • exDisableCtrlSel(8), disables toggling the date/time period's selection state when user clicks an date/time period, while CTRL modifier key is pressed.
    • exDisableShiftSel(16), disables selecting date/time periods using the SHIFT key.
    • exDisableDrag(32), disables selecting date/time periods by drag.
    Example
    0 or exontrol.Tree.SingleSelEnum.exDisableSel {number}, disables selecting any date
 3 or exontrol.Tree.SingleSelEnum.exSingleSel | exontrol.Tree.SingleSelEnum.exEnableSel {number}, enables chart's date single selection, so only a single date can be selected
 6 or exontrol.Tree.SingleSelEnum.exToggleSel | exontrol.Tree.SingleSelEnum.exSingleSel {number}, enables chart's date single and toggle selection, which means that once a date is selected it gets unselected once it is clicked, or reverse, and only a single-date can be selected at once.

    SetDateTickerLabel(value)

    The SetDateTickerLabel() method sets the format to display the bar's start and end margins while creating, moving or resizing it. The SetDrawDateTicker() method specifies whether the chart supports date-ticker (the chart's date-ticker is visible only if the mouse pointer hovers the chart area).
    Parameters:
    Name Type Description
    value string Specifies the format to display the bar's start and end margins while creating, moving or resizing it.

    The <%=FORMULA%> tag (@since 2.3) holds an expression that supports the following keywords:

    • value, {Date} defines the DATE being displayed (could be the start or end)
    • start, {Date} defines the start-margin of the bar as a DATE type
    • end, {Date} defines the end-margin of the bar as a DATE type
    The <%DATE%> tag can be any of the following:
    • <%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
    Example
    null {null}, no date-ticker(s) is shown while a bar is created, moved or resized
 "<%loc_sdate%>" {string} displays the bar's margins in short format
 "<c><b><%mmm%> <%d%></b><br><c><%hh%>:<%nn%>" {string}, displays the month and day on the first line, while the second shows the hour and minute
 "<%=shortdate(value=end?value-1:value)%>" {string}, displays the end-margin with one day before (@since 2.3)
 "<%mmm%> <%d%><fgcolor 808080><%=value=end?` (`+(end - start) + `)`:``%>" {string}, displays the month, the day and for the end-margin includes the number of days of the bar being created, resized or moved (@since 2.3)
 "<%=value=start?``:value%>" {string}, specifies that only end-margin of the bar is being shown (@since 2.3)

    SetDateTickerLabelHMargin(value)

    The SetDateTickerLabelHMargin() method sets the distance between the date-label and the bar, while create, resize or move it
    Parameters:
    Name Type Description
    value number Indicates the distance between the date-label and the bar, while create, resize or move it
    Since:
    • 2.3
    Example
    null {null}, the distance between the date-label and the bar is 4 pixels (default)
 0 {number}, the distance between the date-label and the bar is 0 pixels

    SetDateTickerLabelVAlign(value)

    The SetDateTickerLabelVAlign() method sets the vertical alignment of the date label, while create, resize or move the bar
    Parameters:
    Name Type Description
    value number Indicates one of the following:
    • 0 {number}, indicates that the date-label is displayed on top, right-below the header (default)
    • 1 {number}, specifies that the start/end margins of the bar are displayed to left/side of it
    Since:
    • 2.3
    Example
    null {null}, the date-label is displayed on top, right-below the header (default)
 1 {number}, the start/end margins of the bar are displayed to left/side of it

    SetDrawDateTicker(value)

    The SetDrawDateTicker() method specifies whether the chart supports date-ticker (the chart's date-ticker is visible only if the mouse pointer hovers the chart area). The SetDateTickerLabel() method sets the format to display the bar's start and end margins while creating, moving or resizing it.
    Parameters:
    Name Type Description
    value boolean Specifies whether the chart supports date-ticker (the chart's date-ticker is visible only if the mouse pointer hovers the chart area)
    Example
    true {boolean}, shows the chart's ticker that's visible only when the mouse pointer hovers the date-time

    SetDrawGridLines(value)

    The SetDrawGridLines() method shows or hides the chart's grid lines
    Parameters:
    Name Type Description
    value exontrol.Tree.GridLinesEnum Indicates whether the chart's grid-lines are visible or hidden. The exontrol.Tree.GridLinesEnum type supports the following flags:
    • exNoLines(0), no grid lines
    • exAllLines(-1), shows all vertical and horizontal grid lines
    • exRowLines(-2), shows grid lines for existing rows only
    • exHLines(1), shows only the horizontal grid lines
    • exVLines(2), shows only the vertical grid lines
    Example
    null {null}, inherits the control's drawGridLines property
 0 or exontrol.Tree.GridLinesEnum.exNoLines {number}, hides the grid-lines (default)
 -1 or exontrol.Tree.GridLinesEnum.exAllLines {number}, shows all vertical and horizontal grid lines

    SetDrawLevelSeparator(value)

    The SetDrawLevelSeparator() method shows or hides lines between chart's levels
    Parameters:
    Name Type Description
    value Gantt.LevelLineEnum Indicates the type of lines between chart's levels The exontrol.Gantt.LevelLineEnum type supports the following values and flags:
    • exLevelNoLine(0), no line is shown
    • exLevelDefaultLine(-1), indicates the default grid line style
    • exLevelDotLine(1), indicates a dotted line. For vertical/tick lines, it can be combined with exLevelLowerHalf, exLevelUpperHalf or exLevelMiddleLine. Can be combined with exLevelLowerHalf, exLevelUpperHalf or exLevelMiddleLine option.
    • exLevelSolidLine(2), indicates a solid line. For vertical/tick lines, it can be combined with exLevelLowerHalf, exLevelUpperHalf or exLevelMiddleLine. Can be combined with exLevelLowerHalf, exLevelUpperHalf or exLevelMiddleLine option.
    • exLevelLowerHalf(0x10), (no effect) indicates that the line is shown in the lower half of the level. For vertical/tick lines, it can be combined with exLevelDotLine or exLevelSolidLine
    • exLevelUpperHalf(0x20), (no effect) indicates that the line is shown in the upper half of the level. For vertical/tick lines, it can be combined with exLevelDotLine or exLevelSolidLine
    • exLevelMiddleLine(0x40), (no effect) indicates that the line is shown in the middle. For vertical/tick lines, it can be combined with exLevelDotLine or exLevelSolidLine
    • exLevelQuarterHeight(0x100), (no effect) indicates that the line is shown as a quarter of the full height. Specify the exLevelQuarterHeight option to show shorter tick lines in the chart's level. Can be combined with exLevelLowerHalf, exLevelUpperHalf or exLevelMiddleLine option
    Example
    0 or exontrol.Gantt.LevelLineEnum.exLevelNoLine {number}, hides the lines between chart's levels
 2 or exontrol.Gantt.LevelLineEnum.exLevelSolidLine {number}, shows solid lines between chart's levels

    SetFirstVisibleDate(value)

    The SetFirstVisibleDate() method changes chart's first visible date
    Parameters:
    Name Type Description
    value number | string | Date A value of one of the following types:
    • value {string}, defines the date in string-format as "#MM/DD/YYYY[ HH:mm:ss]#"
    • value {Date}, indicates a JavaScript date to be copied
    • value {number} integer value representing the year of the date to be created
    • value {null} or {undefined}, indicates the current date and time (equivalent of Now)

    SetFirstVisibleOffset(value)

    The SetFirstVisibleOffset() method changes the chart's first visible offset.
    Parameters:
    Name Type Description
    value number Specifies the chart's first visible offset

    SetHistogramHeight(value)

    The SetHistogramHeight() method shows or hides the control's histogram
    Parameters:
    Name Type Description
    value number Indicates the height of the chart's histogram
    Example
    0 {number}, hides the control's histogram (use better the histogramVisible on 0)
 36 {number}, defines the height of the control's histogram to 36-pixels tall

    SetHistogramUnitCount(value)

    The SetHistogramUnitCount() method sets the time-scale count to determine the effort of bars with variable-effort (effort of expression/string type). The SetHistogramUnitScale() method sets the time-scale unit to determine the effort of bars with variable-effort (effort of expression/string type).
    Parameters:
    Name Type Description
    value number Indicates the time-scale count to determine the effort of bars with variable-effort (effort of expression/string type)

    SetHistogramUnitScale(value)

    The SetHistogramUnitScale() method sets the time-scale unit to determine the effort of bars with variable-effort (effort of expression/string type). The SetHistogramUnitCount() method sets the time-scale count to determine the effort of bars with variable-effort (effort of expression/string type).
    Parameters:
    Name Type Description
    value number Indicates the new time-scale unit to determine the effort of bars with variable-effort (effort of expression/string type) The exontrol.UnitEnum type support the following values:
    • exYear (0), indicates the year scale
    • exHalfYear (1), indicates the half-year scale
    • exQuarterYear (2), indicates the quarter-year scale
    • exMonth (0x10), indicates the month scale
    • exThirdMonth (0x11), indicates the third-month scale
    • exWeek (0x100), indicates the week scale
    • exDay (0x1000), indicates the day scale
    • exHour (0x10000), indicates the hour scale
    • exMinute (0x100000), indicates the minute scale
    • exSecond (0x1000000), indicates the second scale
    Example
    null {null}, the chart's resizeUnitScale defines the histogram's unit-scale
 0x10000 or exontrol.UnitEnum.exHour {number}, sets the chart's histogram unit-scale to hours

    SetHistogramView(value)

    The SetHistogramView() method sets the items the control's histogram displays data for
    Parameters:
    Name Type Description
    value Gantt.HistogramViewEnum Indicates the items the control's histogram displays data for The Gantt.HistogramViewEnum type supports the following values and flags:
    • exHistogramVisibleItems(1), the histogram is shown for the visible items only
    • exHistogramSelectedItems(2), the histogram is shown for the selected items only
    • exHistogramCheckedItems(4), the histogram is shown for the checked items only
    • exHistogramSelectedBars(8), the histogram is shown for the selected bars only
    • exHistogramUnlockedItems(0x10), the histogram is shown only for unlocked items
    • exHistogramLockedTopItems(0x20), the histogram is shown only for locked items in the top side of the control
    • exHistogramLockedBottomItems(0x40), The histogram is shown only for locked items in the bottom side of the control
    • exHistogramAllItems(0x70), The histogram is shown for all items
    • exHistogramFilteredItems(0x80), The histogram is shown for the filtered items only
    • exHistogramLeafItems(0x100), The histogram shows the bars for leaf items (a leaf item contains no child items)
    • exHistogramRecLeafItems(0x200), The histogram shows all bars for all recursive leaf items (a leaf item contains no child items)
    • exHistogramNoGrouping(0x400), The histogram shows all bars without grouping based on the item's parent
    • exHistogramBackground(0x800), The histogram's chart goes on the background, while the non-working part is shown on front ( erases the non-working parts )
    • exHistogramNoGroupCaption(0x1000), The histogram shows no caption for groups being shown
    • exHistogramGroupCumulative(0x2000), The histogram shows cumulative groups
    Example
    9232 or exontrol.Gantt.HistogramViewEnum.exHistogramGroupCumulative | exontrol.Gantt.HistogramViewEnum.exHistogramUnlockedItems | exontrol.Gantt.HistogramViewEnum.exHistogramNoGrouping {number}, shows the histogram using cumulative-colors, without grouping the items by parents
 1152 or exontrol.Gantt.HistogramViewEnum.exHistogramFilteredItems | exontrol.Gantt.HistogramViewEnum.exHistogramNoGrouping {number}, shows the histogram for the visible items only (filtered items)
 1040 or exontrol.Gantt.HistogramViewEnum.exHistogramUnlockedItems | exontrol.Gantt.HistogramViewEnum.exHistogramNoGrouping {number}, shows the histogram for all items

    SetHistogramVisible(value)

    The SetHistogramVisible() method shows or hides the control's histogram
    Parameters:
    Name Type Description
    value boolean Indicates a combination of one or more flags of boolean type, that specifies whether the chart's histogram is visible or hidden
    Example
    false {boolean}, the control's histogram is hidden
 true {boolean}, the control shows the historam

    SetHistogramZOrder(value)

    The SetHistogramZOrder() method sets the z-order of the bars to be shown within the chart's histogram
    Parameters:
    Name Type Description
    value string Indicates the z-order of the bars to be shown within the chart's histogram
    Example
    "" {string} or null {null}, no z-order is specified
 "Task-A,Task" {number}, specifies that the "Task-A" bar is on top of "Task" when they display together within the chart's histogram

    SetLabel(unit, value)

    The SetLabel() method sets the predefined format of the level's label for specified unit. The SetLabels() method defines the predefined format to display the level's label of each time-unit.
    Parameters:
    Name Type Description
    unit exontrol.UnitEnum Specifies the time-unit to request its label for The exontrol.UnitEnum type support the following values:
    • exYear (0), indicates the year scale
    • exHalfYear (1), indicates the half-year scale
    • exQuarterYear (2), indicates the quarter-year scale
    • exMonth (0x10), indicates the month scale
    • exThirdMonth (0x11), indicates the third-month scale
    • exWeek (0x100), indicates the week scale
    • exDay (0x1000), indicates the day scale
    • exHour (0x10000), indicates the hour scale
    • exMinute (0x100000), indicates the minute scale
    • exSecond (0x1000000), indicates the second scale
    value string Defines the predefined label for the giving unit

    SetLabels(oLabelsOpts)

    The SetLabels() method defines the predefined format to display the level's label of each time-unit. The SetLabel(unit,value) method sets the predefined format of the level's label for specified unit.
    Parameters:
    Name Type Description
    oLabelsOpts ChartLabelType Indicates an object of {year, halfYear, quarterYear, month, thirdMonth, week, day, hour, minute, second} type as explained:
    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

    SetLevelCount(value)

    The SetLevelCount() method specifies the number of levels the chart's header displays
    Parameters:
    Name Type Description
    value number Indicates the number of levels the chart's header displays
    Example
    1 {number}, defines a single-level header
 2 {number}, specifies that the chart's header displays 2-levels
    The SetLink() method changes the appearance of the link between bars.
    Parameters:
    Name Type Description
    value DisplayLinkType Specifies the appearance of the link between bars, as an object of {type, dir, width, color, arrow, style, startPos, endPos} type, where:
    • type {exontrol.LinkTypeEnum}, specifies the type of the link as 0 (rectangular), 1 (direct), 2(straight) or 3(round)
    • dir {number}, specifies whether the link's direction is shown or hidden as 0 (hidden), 1(shows the direction/arrow where the link begins), 2(shows the direction where the link ends, default) or 3 shows the arrows in both sides
    • width {number}, specifies the link's width or size (1 by default)
    • color {string}, indicates the link's color (partial-black by default)
    • arrow {string}, indicates the arrow's color. If it is missing or not specified the arrow is shown using the link's color (gray by default)
    • arrowSize {number}, indicates the arrow's size. If it is missing or not specified the arrow's size is defined by link's width (1 by default) (since 2.2)
    • arrowShape {object}, defines an object of exontrol.Def.Shape type to customize the shape of the link's arrow (for instance shows the link's arrow as a circle instead of a triangle) (since 2.2)
    • style {array}, specifies the link's dash pattern to show the lines (solid by default)
    • startPos {any}, indicates the list of corners of in-element, the link can start from
    • endPos {any}, indicates the list of corners of out-element, the link can end to
    Example
    The following sample defines "straight" links shown in gray:
{
   type: 2,
   color: "gray"
}

    SetLinkEndTo(value)

    The SetLinkEndTo() method changes the appearance of the link that ends to any selected-bar (incoming links)
    Parameters:
    Name Type Description
    value DisplayLinkType Specifies the appearance of the link that ends to any selected-bar (incoming links), as an object of {type, dir, width, color, arrow, style, startPos, endPos} type, where:
    • type {exontrol.LinkTypeEnum}, specifies the type of the link as 0 (rectangular), 1 (direct), 2(straight) or 3(round)
    • dir {number}, specifies whether the link's direction is shown or hidden as 0 (hidden), 1(shows the direction/arrow where the link begins), 2(shows the direction where the link ends, default) or 3 shows the arrows in both sides
    • width {number}, specifies the link's width or size (1 by default)
    • color {string}, indicates the link's color (partial-black by default)
    • arrow {string}, indicates the arrow's color. If it is missing or not specified the arrow is shown using the link's color (gray by default)
    • arrowSize {number}, indicates the arrow's size. If it is missing or not specified the arrow's size is defined by link's width (1 by default) (since 2.2)
    • arrowShape {object}, defines an object of exontrol.Def.Shape type to customize the shape of the link's arrow (for instance shows the link's arrow as a circle instead of a triangle) (since 2.2)
    • style {array}, specifies the link's dash pattern to show the lines (solid by default)
    • startPos {any}, indicates the list of corners of in-element, the link can start from
    • endPos {any}, indicates the list of corners of out-element, the link can end to
    Example
    The following sample defines "direct" links shown in blue:
{
   type: 1,
   color: "blue"
}

    SetLinkStartFrom(value)

    The SetLinkStartFrom() method changes the appearance of the link that starts from any selected-bar (outgoing links)
    Parameters:
    Name Type Description
    value DisplayLinkType Specifies the appearance of the link that starts from any selected-bar (outgoing links), as an object of {type, dir, width, color, arrow, style, startPos, endPos} type, where:
    • type {exontrol.LinkTypeEnum}, specifies the type of the link as 0 (rectangular), 1 (direct), 2(straight) or 3(round)
    • dir {number}, specifies whether the link's direction is shown or hidden as 0 (hidden), 1(shows the direction/arrow where the link begins), 2(shows the direction where the link ends, default) or 3 shows the arrows in both sides
    • width {number}, specifies the link's width or size (1 by default)
    • color {string}, indicates the link's color (partial-black by default)
    • arrow {string}, indicates the arrow's color. If it is missing or not specified the arrow is shown using the link's color (gray by default)
    • arrowSize {number}, indicates the arrow's size. If it is missing or not specified the arrow's size is defined by link's width (1 by default) (since 2.2)
    • arrowShape {object}, defines an object of exontrol.Def.Shape type to customize the shape of the link's arrow (for instance shows the link's arrow as a circle instead of a triangle) (since 2.2)
    • style {array}, specifies the link's dash pattern to show the lines (solid by default)
    • startPos {any}, indicates the list of corners of in-element, the link can start from
    • endPos {any}, indicates the list of corners of out-element, the link can end to
    Example
    The following sample defines "round" links shown in red:
{
   type: 3,
   color: "red"
}

    SetLinkUnselected(value)

    The SetLinkUnselected() method changes the appearance of the link not related to any selected-bar (unselected links)
    Parameters:
    Name Type Description
    value DisplayLinkType Specifies the appearance of the link not related to any selected-bar (unselected links), as an object of {type, dir, width, color, arrow, style, startPos, endPos} type, where:
    • type {exontrol.LinkTypeEnum}, specifies the type of the link as 0 (rectangular), 1 (direct), 2(straight) or 3(round)
    • dir {number}, specifies whether the link's direction is shown or hidden as 0 (hidden), 1(shows the direction/arrow where the link begins), 2(shows the direction where the link ends, default) or 3 shows the arrows in both sides
    • width {number}, specifies the link's width or size (1 by default)
    • color {string}, indicates the link's color (partial-black by default)
    • arrow {string}, indicates the arrow's color. If it is missing or not specified the arrow is shown using the link's color (gray by default)
    • arrowSize {number}, indicates the arrow's size. If it is missing or not specified the arrow's size is defined by link's width (1 by default) (since 2.2)
    • arrowShape {object}, defines an object of exontrol.Def.Shape type to customize the shape of the link's arrow (for instance shows the link's arrow as a circle instead of a triangle) (since 2.2)
    • style {array}, specifies the link's dash pattern to show the lines (solid by default)
    • startPos {any}, indicates the list of corners of in-element, the link can start from
    • endPos {any}, indicates the list of corners of out-element, the link can end to
    Example
    The following sample defines "rectangular" links of 2-pixels width with no direction:
{
   type: 0,
   width: 2,
   dir: 0
}

    SetLocale(value)

    The SetLocale() method specifies the language to format the control.
    Parameters:
    Name Type Description
    value string A string with a BCP 47 language tag, or null to specify the browser's UI language.
    Example
    null {null}, indicates that the browser's UI language is used.
  "de" {string}, defines German locale
  "ro" {string}, defines Romanian locale

    SetMaxUnitWidth(value)

    The SetMaxUnitWidth() method changes the maximum width of the units within the base-level, while the user resizes or zooms-in/out the chart
    Parameters:
    Name Type Description
    value number Indicates the maximum width of the units within the base-level, while the user resizes or zooms-in/out the chart
    Example
    36 {number}, specifies that maximum width to display the units in base-level, is 36-pixels wide

    SetMinUnitWidth(value)

    The SetMinUnitWidth() method changes the minimum width of the units within the base-level, while the user resizes or zooms-in/out the chart
    Parameters:
    Name Type Description
    value number Indicates the minimum width of the units within the base-level, while the user resizes or zooms-in/out the chart
    Example
    12 {number}, specifies that minimum width to display the units in base-level, is 12-pixels wide

    SetNonworkingDays(value)

    The SetNonworkingDays() method changes the chart's non-working days
    Parameters:
    Name Type Description
    value number Indicates a number that represents the non-working of the week as a combination of one or more of the following flags:
    • 0b00000001 (1) {number}, specifies that each Sunday is a non-working day
    • 0b00000010 (2) {number}, specifies that each Monday is a non-working day
    • 0b00000100 (4) {number}, specifies that each Tuesday is a non-working day
    • 0b00001000 (8) {number}, specifies that each Wednesday is a non-working day
    • 0b00010000 (16) {number}, specifies that each Thursday is a non-working day
    • 0b00100000 (32) {number}, specifies that each Friday is a non-working day
    • 0b01000000 (64) {number}, specifies that each Saturday is a non-working day
    Example
    null {null}, the non-working days are weekend days, as defined by the chart's locale property (Saturday and Sunday are the weekend)
 0 {number}, all days of the week are working (no non-working days)
 0b01000001 or 65 {number}, every Sunday and Saturday is a non-working day (IE does not support binary representation)

    SetNonworkingHours(value)

    The SetNonworkingHours() method changes the chart's non-working hours
    Parameters:
    Name Type Description
    value number Indicates a number that represents the non-working of the day as a combination of one or more of the following flags:
    • 0b00000000000000000000000000000001 (1) {number}, indicates that the hour after 12PM is a non-working hour
    • 0b00000000000000000000000000000010 (2) {number}, indicates that the hour after 1AM is a non-working hour
    • 0b00000000000000000000000000000100 (4) {number}, indicates that the hour after 2AM is a non-working hour
    • 0b00000000000000000000000000001000 (8) {number}, indicates that the hour after 3AM is a non-working hour
    • 0b00000000000000000000000000010000 (16) {number}, indicates that the hour after 4AM is a non-working hour
    • 0b00000000000000000000000000100000 (32) {number}, indicates that the hour after 5AM is a non-working hour
    • 0b00000000000000000000000001000000 (64) {number}, indicates that the hour after 6AM is a non-working hour
    • 0b00000000000000000000000010000000 (128) {number}, indicates that the hour after 7AM is a non-working hour
    • 0b00000000000000000000000100000000 (256) {number}, indicates that the hour after 8AM is a non-working hour
    • 0b00000000000000000000001000000000 (512) {number}, indicates that the hour after 9AM is a non-working hour
    • 0b00000000000000000000010000000000 (1024) {number}, indicates that the hour after 10AM is a non-working hour
    • 0b00000000000000000000100000000000 (2048) {number}, indicates that the hour after 11AM is a non-working hour
    • 0b00000000000000000001000000000000 (4096) {number}, indicates that the hour after 12AM is a non-working hour
    • 0b00000000000000000010000000000000 (8192) {number}, indicates that the hour after 1PM is a non-working hour
    • 0b00000000000000000100000000000000 (16384) {number}, indicates that the hour after 2PM is a non-working hour
    • 0b00000000000000001000000000000000 (32768) {number}, indicates that the hour after 3PM is a non-working hour
    • 0b00000000000000010000000000000000 (65536) {number}, indicates that the hour after 4PM is a non-working hour
    • 0b00000000000000100000000000000000 (131072) {number}, indicates that the hour after 5PM is a non-working hour
    • 0b00000000000001000000000000000000 (262144) {number}, indicates that the hour after 6PM is a non-working hour
    • 0b00000000000010000000000000000000 (524288) {number}, indicates that the hour after 7PM is a non-working hour
    • 0b00000000000100000000000000000000 (1048576) {number}, indicates that the hour after 8PM is a non-working hour
    • 0b00000000001000000000000000000000 (2097152) {number}, indicates that the hour after 9PM is a non-working hour
    • 0b00000000010000000000000000000000 (4194304) {number}, indicates that the hour after 10PM is a non-working hour
    • 0b00000000100000000000000000000000 (8388608) {number}, indicates that the hour after 11PM is a non-working hour
    Example
    0 or null {number}, all hours of the week are working (no non-working hours)
 0b00000000111110000000000011111111 or 16253183 {number}, specifies that hours 8AM to 7PM are working hours (IE does not support binary representation)

    SetOptions(nOptions, bIncludeAllopt) → {boolean}

    The SetOptions() method applies new options to the control's chart
    Parameters:
    Name Type Attributes Description
    nOptions object Specifies an object of ChartOptions type that indicates the new options to apply
    bIncludeAll boolean <optional>
    		 Indicates whether all fields of nOptions are included in the item's oOptions object
    Returns:
    Returns true, if there were options applied to the item
    Type
    boolean

    SetOverlaidOnMoving(value)

    The SetOverlaidOnMoving() method specifies whether the overlaid bars are re-arranged while the user moves or resizes at runtime a bar
    Parameters:
    Name Type Description
    value boolean Indicates whether the overlaid bars are re-arranged while the user moves or resizes at runtime a bar
    Example
    false {boolean} or null {null}, the overlaid-bars are not re-arranged while user resizes or moves the item-bars
 true {boolean}, the overlaid-bars are re-arranged while user resizes or moves the item-bars

    SetOverviewHeight(value)

    The SetOverviewHeight() method shows or hides the control's overview
    Parameters:
    Name Type Description
    value number Indicates the height of the chart's overview
    Example
    0 {number}, hides the control's overview (use better the overviewVisible on 0)
 36 {number}, defines the height of the control's overview to 36-pixels tall

    SetOverviewShowSelectDates(value)

    The SetOverviewShowSelectDates() method shows or hides the selected-date(s) on the control's overview
    Parameters:
    Name Type Description
    value boolean Specifies true to show the selected-date(s) on the control's overview
    Example
    false {boolean}, the selected-date(s) are not visible on the control's overview
 true {boolean}, shows the selected-date(s) on the control's overview

    SetOverviewToolTip(value)

    The SetOverviewToolTip() method sets the format of the tooltip being shown while the cursor hovers the chart's overview area.
    Parameters:
    Name Type Description
    value string Specifies the format of the tooltip being shown while the cursor hovers the chart's overview area. The format 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
    Example
    "" {string}, displays no tooltip
"<%ddd%> <%m%>/<%d%>/<%yyyy%>" {string}, displays the date from the overview as "Sun 12/2/2007"

    SetOverviewVisible(value)

    The SetOverviewVisible() method shows or hides the control's overview
    Parameters:
    Name Type Description
    value Gantt.OverviewVisibleEnum Indicates a combination of one or more flags of Gantt.OverviewVisibleEnum type, that specifies whether the chart's overview layout is visible or hidden The Gantt.OverviewVisibleEnum type supports the following values and flags:
    • exOverviewHidden(0), the control's overview is not visible
    • exOverviewShowOnlyVisible(1), the control's overview shows the bars from the visible items using the range of bars in the visible items only
    • exOverviewShowAllVisible(2), the control's overview shows the bars from the visible items using the range for all bars in the chart
    • exOverviewAllowVerticalScroll(0x100), indicates whether the user can vertically scroll the chart while navigating up or down the overview part of the control. For instance, you can click the overview panel, the chart displays the selected area, and you can drag the cursor left or right to select a new date-time range to be displayed, or you can go up or down, to scroll items up or down
    • exOverviewHideBars(0x200), prevents showing the bars in the overview part of the control. For instance, you can use this flag in combination of any other flag to show just the time-scale in the overview part of the control, to allow the user to quickly scroll the chart's content to a specific time-zone
    • exOverviewShowDateTimeScale(0x1000), specifies whether the overview part of the control displays the date-time scale. This flag includes the time-scale on the overview. The time-scale intersects the bars in the overview. By default, the time-scale of the overview part is shown on the top of it, so you can combine the exOverviewShowDateTimeScale flag with exOverviewShowDateTimeScaleBottom flag, to display the time-scale on the bottom side of the overview part of the control
    • exOverviewShowDateTimeScaleSplit(0x1400), specifies whether the overview's date-time scale is displayed into a separate portion of the overview. This flag includes the time-scale on the overview. The time-scale does not intersect the bars in the overview. By default, the time-scale of the overview part is shown on the top of it, so you can combine the exOverviewShowDateTimeScaleSplit flag with exOverviewShowDateTimeScaleBottom flag, to display the time-scale on the bottom side of the overview part of the control
    • exOverviewShowDateTimeScaleBottom(0x1800), specifies whether the overview's date-time scale is displayed on the bottom side of the overview. By default, the time-scale of the overview part is shown on the top of it, so you can use the exOverviewShowDateTimeScaleBottom flag with exOverviewShowDateTimeScale or exOverviewShowDateTimeScaleSplit to display the time-scale on the bottom side of the overview part of the control
    • exOverviewShowMargins(0x2000), displays the limits of the overview bars. You can include the exOverviewShowMargins flag to display the margins/limits of all (project) / visible bars. In other words, the exOverviewShowMargins flag displays the minimal ItemBar(exBarStart) value, and the maximal ItemBar(exBarEnd) value
    • exOverviewShowSelMargins(0x4000), displays the selection limits (first/last visible date in the chart)
    • exOverviewSplitter(0x10000), specifies whether the overview's horizontal splitter is visible or hidden(makes the control's overview resizable or fixed)
    Example
    0 or exontrol.Gantt.OverviewVisibleEnum.exOverviewHidden {number}, the control's overview is hidden
 70658 or exontrol.Gantt.OverviewVisibleEnum.exOverviewSplitter | exontrol.Gantt.OverviewVisibleEnum.exOverviewShowDateTimeScaleSplit | exontrol.Gantt.OverviewVisibleEnum.exOverviewShowAllVisible {number}, indicates that the overview is resizable, it displays the bars for all items and the overview time-scale too

    SetOverviewZoomCaption(value)

    The SetOverviewZoomCaption() method sets the captions for each zooming unit
    Parameters:
    Name Type Description
    value string A string expression that defines a list of captions ( one for each unit ) being displayed in the zoom scale, separated by | character. The list should contain a caption for each unit, from the exYear to exSecond. For instance, if you want to show nothing for exHalfYear zooming unit, the OverviewZoomCaption should be: "Year||¼Year...", and so on
    Example
    "|||Month||Week|Day|||" {string}, shows just month, week and day scales into the overview
"Year|||Month||Week|Day|||" {string}, shows year, month, week and day scales into the overview

    SetOverviewZoomUnit(value)

    The SetOverviewZoomUnit() method sets the width of the time-unit scale in the overview
    Parameters:
    Name Type Description
    value number Specifies the width of the time-unit scale in the overview
    Example
    0 {number}, the overview displays no zooming time-scales
 36 {number}, sets the width of the zooming time-scale to 36 pixels

    SetPaneWidth(right, value)

    The SetPaneWidth() method sets the width of the left(items) or right(chart) pane. The SetPaneWidthLeft(value) method is equivalent with SetPaneWidth(false, value) and SetPaneWidthRight(value) method is equivalent with SetPaneWidth(true, value).
    Parameters:
    Name Type Description
    right boolean A Boolean expression that indicates whether the left (items) or right(chart) area is changed
    value number Indicates the width of the left(items) or right(chart) pane

    SetPaneWidthLeft(value)

    The SetPaneWidthLeft() method specifies the width of the control's left-pane (items).
    Parameters:
    Name Type Description
    value number Defines the width of the left-pane (items)
    Example
    0 {number}, hides the control's left-pane (items)
 300 {number}, changes the width of control's left-pane (items) to 300

    SetPaneWidthRight(value)

    The SetPaneWidthRight() method specifies the width of the control's right-pane (chart).
    Parameters:
    Name Type Description
    value number Defines the width of the right-pane (chart)
    Example
    0 {number}, hides the control's right-pane (chart)
 300 {number}, changes the width of control's right-pane (chart) to 300

    SetResizeUnitCount(value)

    The SetResizeUnitCount() method sets the count of time-unit(s) to create, move or resize bars. The SetResizeUnitScale() method sets the time-unit to create, move or resize bars.
    Parameters:
    Name Type Description
    value number Indicates the count of time-unit(s) to create, move or resize bars
    Example
    null {null}, the count of time-unit(s) of the chart's base level indicates the count of time-unit(s) to create, move or resize bars
 3 {number}, creates, moves or resizes to every third time-unit(s)

    SetResizeUnitScale(value)

    The SetResizeUnitScale() method sets the time-unit to create, move or resize bars. The SetResizeUnitCount() method sets the count of time-unit(s) to create, move or resize bars.
    Parameters:
    Name Type Description
    value number Indicates the new time-unit to create, move or resize bars The exontrol.UnitEnum type support the following values:
    • exYear (0), indicates the year scale
    • exHalfYear (1), indicates the half-year scale
    • exQuarterYear (2), indicates the quarter-year scale
    • exMonth (0x10), indicates the month scale
    • exThirdMonth (0x11), indicates the third-month scale
    • exWeek (0x100), indicates the week scale
    • exDay (0x1000), indicates the day scale
    • exHour (0x10000), indicates the hour scale
    • exMinute (0x100000), indicates the minute scale
    • exSecond (0x1000000), indicates the second scale
    Example
    null {null}, the chart's resize unit-scale is identichal with the chart's unit-scale (unitScale property)
 0x10000 or exontrol.UnitEnum.exHour {number}, sets the chart's resize unit-scale to hours

    SetScrollBar(value)

    The SetScrollBar() method shows or hides the chart's horizontal scroll-bar.
    Parameters:
    Name Type Description
    value boolean Indicates whether the chart's horizontal scroll-bar is visible or hidden
    Example
    false {boolean}, hides the chart's horizontal scroll-bar

    SetScrollRange(value)

    The SetScrollRange() method sets the range of dates to scroll within
    Parameters:
    Name Type Description
    value ScrollRangeType Specifies the range of dates to scroll within, as an object of {start,end} type.
    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#"
}

    SetSelectDates(value)

    The SetSelectDates() method sets the selected-dates
    Parameters:
    Name Type Description
    value any Specifies the selected-dates as one of the following:
    • value {array}, indicates an array of value(s) (could be any of the following)
    • value {object}, any object that contains "s", "e", "start" and/or "end" fields to specify the start/end margins of the time-period
    • value {any}, returns a 1-second time-period starting from giving value. The value could be any of the following:
      • value {string}, defines the date in string-format as "#MM/DD/YYYY[ HH:mm:ss]#"
      • value {Date}, indicates a JavaScript date
      • value {number} integer value representing the year of the date
    Example
    null {null}, removes all selected dates
 {start: 2001, end: 2002} {object}, selects the time zone from Jan 1st 2001, to Jan 1st 2002
 {start: Date.Today(), end: Date.Today().NextDay()} {object}, selects today
 ["#12/31/2000#",{start: "#1/1/2001#", end: "#1/2/2001#"}] {array}, selects one second from "Sun, 31 Dec 2000 00:00:00 GMT" to "31 Dec 2000 00:00:01 GMT", and one day from "Mon, 01 Jan 2001 00:00:00 GMT" to "Tue, 02 Jan 2001 00:00:00 GMT"
 "#12/31/2000#" {string}, selects one second from "Sun, 31 Dec 2000 00:00:00 GMT" to "31 Dec 2000 00:00:01 GMT"

    SetSelection(value)

    The SetSelection() method sets the chart's selection.
    Parameters:
    Name Type Description
    value any The value can be any of the following:
    • value {null}, specifies that the entire selection is cleared (unselects all)
    • value {Items}, selects all item-bars of all items (select all)
    • value {exontrol.Tree.Item}, selects all item-bars of specified item
    • value {ItemBar}, selects the item-bar giving its reference as an object of ItemBar type
    • value {ItemBar[]}, selects item-bars giving an array of [ItemBar] type (collection of item-bars) or [exontrol.Tree.Item] type (collection of items)
    The SetShowLinks() method shows or hides links between bars.
    Parameters:
    Name Type Description
    value exontrol.ShowLinksEnum An exontrol.ShowLinksEnum expression that specifies whether the links between bars are visible or hidden The exontrol.ShowLinksEnum type supports the following flags:
    • exHide (0), specifies that no links are visible
    • exExtended (0x01), specifies that links are shown as extended
    • exShow (0x02), specifies that links are visible (the links are always shown while not exHide)
    • exFront (0x10), specifies that links are shown in front (by default, the control are shown on the background)
    • exCrossRect (0x20), shows rectangular cross-links
    • exCrossTriangle (0x20), shows triangular cross-links
    • exCrossMixt (0x60), shows mixt cross-links
    Example
    0 or exontrol.ShowLinksEnum.exHide {number}, hides the links
 1 or exontrol.ShowLinksEnum.exShow {number}, shows the links (on the background)
 33 or exontrol.ShowLinksEnum.exExtended | exontrol.ShowLinksEnum.exCrossRect {number}, shows "extended" and "cross" links

    SetShowNonworkingDays(value)

    The SetShowNonworkingDays() method shows or hides the chart's non-working days (marks the non-working days)
    Parameters:
    Name Type Description
    value boolean Indicates whether the chart's non-working days are visible or hidden
    Example
    false {boolean}, hides the chart's non-working days

    SetShowNonworkingHours(value)

    The SetShowNonworkingHours() method shows or hides the chart's non-working hours (marks the non-working hours)
    Parameters:
    Name Type Description
    value boolean Indicates whether the chart's non-working hours are visible or hidden
    Example
    false {boolean}, hides the chart's non-working hours

    SetShowNonworkingUnits(value)

    The SetShowNonworkingUnits() method shows or hides the chart's non-working units (days and hours)
    Parameters:
    Name Type Description
    value boolean Indicates whether the chart's non-working units (days and hours) are visible or hidden
    Example
    false {boolean}, hides the chart's non-working units (days and hours)

    SetSingleSel(value)

    The SetSingleSel() method sets the chart's selection to single, multiple or toggle (equivalent of AllowSelectObjects property)
    Parameters:
    Name Type Description
    value exontrol.Tree.SingleSelEnum An OR combination of exontrol.Tree.SingleSelEnum flags to specify how user can select item-bars The exontrol.Tree.SingleSelEnum type defines the following flags:
    • exDisableSel(0), specifies that the chart's selection is disabled (can not be combined with any other flags)
    • exEnableSel(1), specifies that the chart's selection is enabled (multiple-selection, unless the exSingleSel is set )
    • exSingleSel(2), specifies that the user can select an item-bar only
    • exToggleSel(4), specifies that the item-bar's selection state is toggled once the user clicks an item-bar.
    • exDisableCtrlSel(8), disables toggling the item-bar's selection state when user clicks an item-bar, while CTRL modifier key is pressed.
    • exDisableShiftSel(16), disables selecting item-bars using the SHIFT key.
    • exDisableDrag(32), disables selecting item-bars by drag.
    Example
    0 or exontrol.Tree.SingleSelEnum.exDisableSel {number}, disables selecting any item-bar
 3 or exontrol.Tree.SingleSelEnum.exSingleSel | exontrol.Tree.SingleSelEnum.exEnableSel {number}, enables chart's single selection, so only a single item-bar can be selected
 6 or exontrol.Tree.SingleSelEnum.exToggleSel | exontrol.Tree.SingleSelEnum.exSingleSel {number}, enables chart's single and toggle selection, which means that once an item-bar is selected it gets unselected once it is clicked, or reverse, and only a single-item-bar can be selected at once.

    SetToolTip(unit, value)

    The SetToolTip() method sets the predefined-tooltip's label for specified unit. The SetToolTips() method defines the predefined-tooltips of each time-unit.
    Parameters:
    Name Type Description
    unit exontrol.UnitEnum Specifies the time-unit to request its label for The exontrol.UnitEnum type support the following values:
    • exYear (0), indicates the year scale
    • exHalfYear (1), indicates the half-year scale
    • exQuarterYear (2), indicates the quarter-year scale
    • exMonth (0x10), indicates the month scale
    • exThirdMonth (0x11), indicates the third-month scale
    • exWeek (0x100), indicates the week scale
    • exDay (0x1000), indicates the day scale
    • exHour (0x10000), indicates the hour scale
    • exMinute (0x100000), indicates the minute scale
    • exSecond (0x1000000), indicates the second scale
    value string Defines the predefined-tooltip for the giving unit

    SetToolTips(oToolTipsOpts)

    The SetToolTips() method defines the predefined-tooltips of each time-unit. The SetToolTip(unit, value) method sets the predefined-tooltip's label for specified unit.
    Parameters:
    Name Type Description
    oToolTipsOpts ChartLabelType Indicates an object of {year, halfYear, quarterYear, month, thirdMonth, week, day, hour, minute, second} type as explained:
    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

    SetUnitScale(value)

    The SetUnitScale() method changes chart's unit scale
    Parameters:
    Name Type Description
    value number Indicates the new chart's unit scale The exontrol.UnitEnum type support the following values:
    • exYear (0), indicates the year scale
    • exHalfYear (1), indicates the half-year scale
    • exQuarterYear (2), indicates the quarter-year scale
    • exMonth (0x10), indicates the month scale
    • exThirdMonth (0x11), indicates the third-month scale
    • exWeek (0x100), indicates the week scale
    • exDay (0x1000), indicates the day scale
    • exHour (0x10000), indicates the hour scale
    • exMinute (0x100000), indicates the minute scale
    • exSecond (0x1000000), indicates the second scale
    Example
    4096 or exontrol.UnitEnum.exDay {number}, sets the chart to display days

    SetUnitWidth(value)

    The SetUnitWidth() method changes the width to display the units in base-level
    Parameters:
    Name Type Description
    value number Indicates the width to display the units in base-level
    Example
    8 {number}, changes the width for units in the base-level to 8-pixels

    SetUnitWidthNonworking(value)

    The SetUnitWidthNonworking() method changes the width to display the non-working units in base-level
    Parameters:
    Name Type Description
    value number Indicates the width to display the non-working units in base-level, as explained:
    • 0 {number}, no effect (the unitWidth field specifies the width for all units, including the non-working units in base-level). The showNonworkingUnits field, specifies whether the chart displays non-working units.
    • negative {number}, indicates that neighbor non-working units are shown as a single non-working unit with specified width ( absolute value )
    • positive {number}, indicates the width for non-working units
    Example
    0 {number}, no effect (the unitWidth field specifies the width for all units, including the non-working units in base-level)
 -18 {number}, neighbor non-working units are shown as a single non-working unit with specified width (18-pixels wide)

    Zoom(start, end, changeUnitWidthopt)

    The Zoom() method zooms the chart so the start-end interval fits the client's area.
    Parameters:
    Name Type Attributes Description
    start number | string | Date A value of one of the following types:
    • date {string}, defines the date in string-format as "#MM/DD/YYYY[ HH:mm:ss]#"
    • date {Date}, indicates a JavaScript date to be copied
    • date {number} integer value representing the year of the date to be created
    • date {null} or {undefined}, indicates the current date and time (equivalent of Now)
        that defines the start of the interval
    end number | string | Date A value of one of the following types:
    • date {string}, defines the date in string-format as "#MM/DD/YYYY[ HH:mm:ss]#"
    • date {Date}, indicates a JavaScript date to be copied
    • date {number} integer value representing the year of the date to be created
    • date {null} or {undefined}, indicates the current date and time (equivalent of Now)
        that defines the end of the interval
    changeUnitWidth boolean <optional>
    		 Specifies whether the chart's unit-width is changed (defaults to true)