new Chart(oGantt)
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 headeris associated with the property:
LevelCount {number}, specifies the number of levels in the chart's headerwhich means that the following statements are equivalent:
oChart.Options = {levelCount: 2}where oChart is an object of Chart type
oChart.SetOptions({levelCount: 2})
oChart.LevelCount = 2
oChart.SetLevelCount(2)
Parameters:
| Name | Type | Description |
|---|---|---|
oGantt |
Gantt | Specifies an object of Gantt type that defines the owner control of the chart. |
Members
AdjustLevelsToBase :boolean
Type:
- boolean
Example
true {boolean}, aligns the units of the level with units of the base-level
false {boolean}, does not align the units of the level with units of the base-level
AdjustLevelsToBase
AllowOverviewZoom :boolean
Type:
- boolean
Example
false {boolean}, the overview displays no zooming time-scales
true {boolean}, the overview displays the time-scales the user can zoom to
AllowOverviewZoom
AllowSelectDate :exontrol.Tree.SingleSelEnum
Type:
- exontrol.Tree.SingleSelEnum
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.
AllowSelectDate
Bars :object
Type:
- object
Example
The following sample redefines the predefined bars of the chart:
{
"Task":
{
height: 16,
shape:
{
frameColor: "darkgray",
fillColor: "lightgray",
},
},
"Progress":
{
shape:
{
pad: [0,-4],
fillColor: "gray",
}
},
"Task%Progress":
{
shortcut: "Task",
def:
{
showPercentCaption: true,
}
},
}
Each field of the object represents a bar to add to the chart's predefined bars. The name of the field specifies the type of the bar to add, while the value of the field is an object of BarOptions type that defines the properties of the bar to add.
Bars
DateTickerLabel :string
The <%=FORMULA%> tag (@since 2.3) holds a format-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
Name Description Sample (day-patterns) <%d%> Day of the month using one or two numeric digits, depending on the value 1 - 31 <%dd%> Day of the month using exactly two numeric digits 01 - 31 <%d1%> Weekday using its first letter S - S <%loc_d1%> Weekday as a single-letter abbreviation based on the current user settings S - S <%d2%> Weekday using its first two letters Su - Sa <%loc_d2%> Weekday as a two-letter abbreviation based on the current user settings Su - Sa <%d3%> Weekday using its first three letters Sun - Sat <%ddd%> Weekday using its first three letters Sun - Sat <%loc_d3%> Weekday as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_ddd%> Sun - Sat <%loc_ddd%> Weekday as a three-letter abbreviation based on the current user regional and language settings Sun - Sat <%dddd%> Full name of the weekday Sunday - Saturday <%loc_dddd%> Full weekday name based on the current user regional and language settings Sunday - Saturday <%w%> Numeric day of the week 1 - 7 <%y%> Numeric day of the year 1 - 366 (week-patterns) <%ww%> Week of the year 1 - 53 (month-patterns) <%m%> Month of the year using one or two numeric digits, as needed 1 - 12 <%mm%> Month of the year using exactly two numeric digits 01 - 12 <%mr%> Month of the year using Roman numerals, as needed I - XII <%m1%> Month using its first letter J - D <%loc_m1%> Month as a single-letter abbreviation based on the current user settings J - D <%m2%> Month using its first two letters Ja - De <%loc_m2%> Month as a two-letter abbreviation based on the current user settings Ja - De <%m3%> Month using its first three letters Jan - Dec <%mmm%> Month using its first three letters Jan - Dec <%loc_m3%> Month as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_mmm%> Jan - Dec <%loc_mmm%> Month as a three-letter abbreviation based on the current user regional and language settings Jan - Dec <%mmmm%> Full name of the month January - December <%loc_mmmm%> Full month name based on the current user regional and language settings January - December (year-patterns) <%q%> Date shown as the quarter of the year 1 - 4 <%hy%> Date shown as the half of the year 1 - 2 <%loc_y%> Year represented by the last digit only, based on the current regional settings 0 - 9 <%yy%> Last two digits of the year 01 - 99 <%loc_yy%> Year represented by the last two digits only, based on the current regional settings; a leading zero is added for single-digit years 01 - 99 <%yyyy%> Full year using four digits 0100 - 9999 <%loc_yyyy%> Year represented using four or five digits, depending on the calendar in use. Thai Buddhist and Korean calendars use five-digit years; the "yyyy" pattern displays five digits for these calendars and four digits for all other supported calendars. Calendars with single-digit or two-digit years, such as the Japanese Emperor era, are formatted differently: single-digit years include a leading zero (for example, "03"), two-digit years use two digits (for example, "13"), and no additional leading zeros are applied 0100 - 9999 <%i%> Numeric value displayed instead of a date, representing the number of milliseconds elapsed since the Unix Epoch, January 1, 1970, 00:00:00 UTC 1767085565940 (localized era-patterns) <%loc_g%> Period/era based on the current user regional and language settings A,B <%loc_gg%> Period/era based on the current user regional and language settings AD,BC (localized date-patterns) <%loc_sdate%> Date in short format based on the current user regional and language settings 12/31/2000 <%loc_ldate%> Date in long format based on the current user regional and language settings December 31, 2000 <%loc_dsep%> Date separator based on the current user regional and language settings / (time-patterns) <%h%> Hour in one or two digits, as needed 0 - 23 <%hh%> Hour in two digits 00 - 23 <%h12%> Hour in 12-hour format, in one or two digits 0/12 - 11 <%hh12%> Hour in 12-hour format, in two digits 00/12 - 11 <%n%> Minute in one or two digits, as needed 0 - 59 <%nn%> Minute in two digits 00 - 59 <%s%> Second in one or two digits, as needed 0 - 59 <%ss%> Second in two digits 00 - 59 <%AM/PM%> 12-hour clock with uppercase "AM" or "PM" as appropriate AM, PM (localized time-patterns) <%loc_AM/PM%> Time marker such as AM or PM based on the current user regional and language settings AM, PM <%loc_A/P%> Single-character time marker such as A or P based on the current user regional and language settings A, P <%loc_time%> Time based on the current user regional and language settings 1:30:15 PM <%loc_time24%> Time in 24-hour format without a time marker based on the current user regional and language settings 13:30:15 <%loc_tsep%> Time separator based on the current user regional and language settings :
Type:
- string
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)
DateTickerLabel
DateTickerLabelHMargin :number
Type:
- number
- 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
DateTickerLabelHMargin
DateTickerLabelVAlign :number
The DateTickerLabelVAlign property supports 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
Type:
- number
- 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
DateTickerLabelVAlign
DrawDateTicker :boolean
Type:
- boolean
Example
true {boolean}, shows the chart's ticker that's visible only when the mouse pointer hovers the date-time
false {boolean}, no date-ticker is shown while the mouse pointer hovers the chart area
DrawDateTicker
DrawGridLines :exontrol.Tree.GridLinesEnum
The DrawGridLines property of exontrol.Gantt.Chart 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
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
DrawGridLines
DrawLevelSeparator :Gantt.LevelLineEnum
The DrawLevelSeparator property 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:
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
DrawLevelSeparator
(readonly) EndPrintDate :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
EndPrintDate
FirstVisibleDate :number|string|Date
- 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)
The StartPrintDate property gets the minimum-date for the entire chart (lower date) as undefined (the chart includes no bars) or the minimum-date for the entire chart (lower date). The EndPrintDate property gets the maximum-date for the entire chart (upper date), as undefined (the chart includes no bars) or the maximum-date for the entire chart (upper date). The ScrollTo() method scrolls the chart to ensure that specified date fits the chart's area.
Type:
- number | string | Date
Example
The following statements are equivalents:
oGantt.Chart.SetFirstVisibleDate("#03/15/2024#"), sets the chart's first visible date to March 15, 2024
oGantt.Chart.FirstVisibleDate = "#03/15/2024#", sets the chart's first visible date to March 15, 2024
where oGantt is an object of Gantt type
FirstVisibleDate
FirstVisibleOffset :number
Type:
- number
Example
The following statements are equivalents:
oGantt.Chart.SetFirstVisibleOffset(8), sets the chart's first visible offset to 8-pixels
oGantt.Chart.FirstVisibleOffset = 8, sets the chart's first visible offset to 8-pixels
where oGantt is an object of Gantt type
FirstVisibleOffset
HistogramHeight :number
To display bars in the controls histogram, the following conditions must be met:
- Each Bar must have its HistogramShape property set. By default, this property is null, so without setting it, the bar will not appear in the histogram
- The control's HistogramVisible property must be enabled to make the histogram visible
- The control's HistogramHeight property defines the vertical size of the histogram
Together, these settings ensure that the bars are correctly represented in the controls histogram.
In order to show cumulative values within the histogram, the control requires the following:
- a hierarchy must be displayed, for example by grouping items using a specific column (AllowGroupBy, SortBarVisible properties)
- the HistogramView property must include the exHistogramGroupCumulative and exHistogramNoGrouping flags
Type:
- number
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
HistogramHeight
HistogramUnitCount :number
Type:
- number
Example
null {null}, the chart's resizeUnitCount defines the histogram's unit-count
2 {number}, sets the chart's histogram unit-count to 2
HistogramUnitCount
HistogramUnitScale :number
The HistogramUnitScale property as a value of exontrol.UnitEnum type, supports 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:
- number
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
HistogramUnitScale
HistogramView :Gantt.HistogramViewEnum
To display bars in the controls histogram, the following conditions must be met:
- Each Bar must have its HistogramShape property set. By default, this property is null, so without setting it, the bar will not appear in the histogram
- The control's HistogramVisible property must be enabled to make the histogram visible
- The control's HistogramHeight property defines the vertical size of the histogram
Together, these settings ensure that the bars are correctly represented in the controls histogram.
In order to show cumulative values within the histogram, the control requires the following:
- a hierarchy must be displayed, for example by grouping items using a specific column (AllowGroupBy, SortBarVisible properties)
- the HistogramView property must include the exHistogramGroupCumulative and exHistogramNoGrouping flags
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:
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
HistogramView
HistogramVisible :boolean
To display bars in the controls histogram, the following conditions must be met:
- Each Bar must have its HistogramShape property set. By default, this property is null, so without setting it, the bar will not appear in the histogram
- The control's HistogramVisible property must be enabled to make the histogram visible
- The control's HistogramHeight property defines the vertical size of the histogram
Together, these settings ensure that the bars are correctly represented in the controls histogram.
In order to show cumulative values within the histogram, the control requires the following:
- a hierarchy must be displayed, for example by grouping items using a specific column (AllowGroupBy, SortBarVisible properties)
- the HistogramView property must include the exHistogramGroupCumulative and exHistogramNoGrouping flags
Type:
- boolean
Example
false {boolean}, the control's histogram is hidden
true {boolean}, the control shows the historam
HistogramVisible
HistogramZOrder :string
By default, the control defines the following bar-names/types:
- "Task"
- "Split"
- "Progress"
- "Milestone"
- "Summary"
- "Project Summary"
- "Deadline"
You can also defines new bar types using the Bars.Add method, by specifying the name parameter.
Type:
- string
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
HistogramZOrder
Labels :ChartLabelType
The Labels property of ChartLabelType type supports the following fields:
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:
Example
The following example sets custom labels for year, month, week and day time-units:
{
year: "<%yy%><|>'<%yy%><|><%yyyy%>",
month: "<|><%m1%><|><%m2%><|><%m3%><|><%mmmm%><|><%m3%> '<%yy%><|><%mmmm%> <%yyyy%>",
week: "<|><%ww%><|><%ww%> <off -4><%m3%> <%d%>, '<%yy%><|><%ww%> <off -4><%mmmm%> <%d%>, <%yyyy%><||><||>256",
day: "<|><%d%><|><%d%> <off -4><%d1%><|><%d%> <off -4><%d2%><||><||>4096",
}
The following statements are equivalents:
oGantt.Chart.SetLabels({...}), sets the predefined format to display the level's label of each time-unit
oGantt.Chart.Options.labels = {...}, sets the predefined format to display the level's label of each time-unit
where oGantt is an object of Gantt type
Labels
(readonly) LastVisibleDate :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
LastVisibleDate
LevelCount :number
Type:
- number
Example
1 {number}, defines a single-level header
2 {number}, specifies that the chart's header displays 2-levels
LevelCount
Link :DisplayLinkType
- 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:
Example
The following sample defines "straight" links shown in gray:
{
type: 2,
color: "gray"
}
Link
LinkEndTo :DisplayLinkType
The LinkEndTo property 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
Type:
Example
The following sample defines "direct" links shown in blue:
{
type: 1,
color: "blue"
}
LinkEndTo
LinkStartFrom :DisplayLinkType
The LinkStartFrom property defines 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:
Example
The following sample defines "round" links shown in red:
{
type: 3,
color: "red"
}
LinkStartFrom
LinkUnselected :DisplayLinkType
The LinkUnselected property defines 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:
Example
The following sample defines "rectangular" links of 2-pixels width with no direction:
{
type: 0,
width: 2,
dir: 0
}
LinkUnselected
(readonly) Links :Links
Type:
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
Links
Locale :string
Type:
- string
Example
null {null}, indicates that the browser's UI language is used.
"de" {string}, defines German locale
"de-DE" {string}, defines Germany German locale
"en-US" {string}, defines U.S. English locale
"es" {string}, defines Spanish locale
"fr" {string}, defines French locale
Locale
MaxUnitWidth :number
Type:
- number
Example
36 {number}, specifies that maximum width to display the units in base-level, is 36-pixels wide
MaxUnitWidth
MinUnitWidth :number
Type:
- number
Example
12 {number}, specifies that minimum width to display the units in base-level, is 12-pixels wide
MinUnitWidth
NonworkingDays :number
- 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
The "nw" entry of the Shapes property defines the visual appearance used to display non-working units. By default, the NonworkingDays property is null, meaning that non-working days are considered to be the weekend days defined by the chart's locale (typically Saturday and Sunday).
Type:
- number
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)
NonworkingDays
NonworkingHours :number
- 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
The "nw" entry of the Shapes property defines the visual appearance used to display non-working units. By default, all hours are working hours (no non-working hours).
Type:
- number
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)
NonworkingHours
Options :ChartOptions
levelCount {number}, specifies the number of levels in the chart's headeris associated with the property:
LevelCount {number}, specifies the number of levels in the chart's header
The Options property can be used to set or get multiple options of the control's chart at once, instead of changing each option separately. The getter of the Options property returns the options of the control's chart as an object of ChartOptions type. The setter of the Options property applies new options to the control's chart
Type:
Example
The following statements are equivalents:
oGantt.Chart.SetOptions({...}), sets multiple options of the control's chart at once
oGantt.Chart.Options = {...}, sets multiple options of the control's chart at once
where oGantt is an object of Gantt type
Options
OverlaidOnMoving :boolean
Type:
- boolean
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
OverlaidOnMoving
OverviewHeight :number
Type:
- number
Example
0 {number}, hides the control's overview (use better the overviewVisible on 0)
64 {number}, defines the height of the control's overview to 64-pixels tall
OverviewHeight
OverviewMarginsFormat :string
The OverviewMarginsFormat property supports the following keywords:
- value {Date}, specifies the date-time to display
- margin {number}, defines the position of the margin date to display: 0 for the left margin of the whole chart, 1 for the right margin of the whole chart, and 2 or 3 for the left or right margins of the current view
Type:
- string
- Since:
- 4.7
Example
"value format `MM/dd`" {string}, specifies that the margin dates displayed in the overview section of the control use two digits for the month and two digits for the day, instead of using the regional settings
"(margin < 2 ? `<fgcolor gray>` : `<b>`) + shortdate(value)" {string}, displays the left and right margins of the whole chart in gray, while showing the left and right margins of the current view in bold
OverviewMarginsFormat
OverviewShowSelectDates :boolean
Type:
- boolean
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
OverviewShowSelectDates
OverviewToolTip :string
The format supports ex-HTML tags such as (<b>, <i>, <fgcolor>, ...) and <%DATE%> tags as follows:
Name Description Sample (day-patterns) <%d%> Day of the month using one or two numeric digits, depending on the value 1 - 31 <%dd%> Day of the month using exactly two numeric digits 01 - 31 <%d1%> Weekday using its first letter S - S <%loc_d1%> Weekday as a single-letter abbreviation based on the current user settings S - S <%d2%> Weekday using its first two letters Su - Sa <%loc_d2%> Weekday as a two-letter abbreviation based on the current user settings Su - Sa <%d3%> Weekday using its first three letters Sun - Sat <%ddd%> Weekday using its first three letters Sun - Sat <%loc_d3%> Weekday as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_ddd%> Sun - Sat <%loc_ddd%> Weekday as a three-letter abbreviation based on the current user regional and language settings Sun - Sat <%dddd%> Full name of the weekday Sunday - Saturday <%loc_dddd%> Full weekday name based on the current user regional and language settings Sunday - Saturday <%w%> Numeric day of the week 1 - 7 <%y%> Numeric day of the year 1 - 366 (week-patterns) <%ww%> Week of the year 1 - 53 (month-patterns) <%m%> Month of the year using one or two numeric digits, as needed 1 - 12 <%mm%> Month of the year using exactly two numeric digits 01 - 12 <%mr%> Month of the year using Roman numerals, as needed I - XII <%m1%> Month using its first letter J - D <%loc_m1%> Month as a single-letter abbreviation based on the current user settings J - D <%m2%> Month using its first two letters Ja - De <%loc_m2%> Month as a two-letter abbreviation based on the current user settings Ja - De <%m3%> Month using its first three letters Jan - Dec <%mmm%> Month using its first three letters Jan - Dec <%loc_m3%> Month as a three-letter abbreviation based on the current user regional and language settings; equivalent to <%loc_mmm%> Jan - Dec <%loc_mmm%> Month as a three-letter abbreviation based on the current user regional and language settings Jan - Dec <%mmmm%> Full name of the month January - December <%loc_mmmm%> Full month name based on the current user regional and language settings January - December (year-patterns) <%q%> Date shown as the quarter of the year 1 - 4 <%hy%> Date shown as the half of the year 1 - 2 <%loc_y%> Year represented by the last digit only, based on the current regional settings 0 - 9 <%yy%> Last two digits of the year 01 - 99 <%loc_yy%> Year represented by the last two digits only, based on the current regional settings; a leading zero is added for single-digit years 01 - 99 <%yyyy%> Full year using four digits 0100 - 9999 <%loc_yyyy%> Year represented using four or five digits, depending on the calendar in use. Thai Buddhist and Korean calendars use five-digit years; the "yyyy" pattern displays five digits for these calendars and four digits for all other supported calendars. Calendars with single-digit or two-digit years, such as the Japanese Emperor era, are formatted differently: single-digit years include a leading zero (for example, "03"), two-digit years use two digits (for example, "13"), and no additional leading zeros are applied 0100 - 9999 <%i%> Numeric value displayed instead of a date, representing the number of milliseconds elapsed since the Unix Epoch, January 1, 1970, 00:00:00 UTC 1767085565940 (localized era-patterns) <%loc_g%> Period/era based on the current user regional and language settings A,B <%loc_gg%> Period/era based on the current user regional and language settings AD,BC (localized date-patterns) <%loc_sdate%> Date in short format based on the current user regional and language settings 12/31/2000 <%loc_ldate%> Date in long format based on the current user regional and language settings December 31, 2000 <%loc_dsep%> Date separator based on the current user regional and language settings / (time-patterns) <%h%> Hour in one or two digits, as needed 0 - 23 <%hh%> Hour in two digits 00 - 23 <%h12%> Hour in 12-hour format, in one or two digits 0/12 - 11 <%hh12%> Hour in 12-hour format, in two digits 00/12 - 11 <%n%> Minute in one or two digits, as needed 0 - 59 <%nn%> Minute in two digits 00 - 59 <%s%> Second in one or two digits, as needed 0 - 59 <%ss%> Second in two digits 00 - 59 <%AM/PM%> 12-hour clock with uppercase "AM" or "PM" as appropriate AM, PM (localized time-patterns) <%loc_AM/PM%> Time marker such as AM or PM based on the current user regional and language settings AM, PM <%loc_A/P%> Single-character time marker such as A or P based on the current user regional and language settings A, P <%loc_time%> Time based on the current user regional and language settings 1:30:15 PM <%loc_time24%> Time in 24-hour format without a time marker based on the current user regional and language settings 13:30:15 <%loc_tsep%> Time separator based on the current user regional and language settings :
Type:
- string
Example
"" {string}, displays no tooltip
"<%ddd%> <%m%>/<%d%>/<%yyyy%>" {string}, displays the date from the overview as "Sun 12/2/2007"
OverviewToolTip
OverviewVisible :Gantt.OverviewVisibleEnum
- 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. The overviewMarginsFormat field specifies the format used to display margin dates in the overview section of the control.
- exOverviewShowSelMargins(0x4000), displays the selection limits (first/last visible date in the chart). The overviewMarginsFormat field specifies the format used to display margin dates in the overview section of the control.
- exOverviewSplitter(0x10000), specifies whether the overview's horizontal splitter is visible or hidden(makes the control's overview resizable or fixed)
Type:
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
OverviewVisible
OverviewZoomCaption :string
Type:
- string
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
OverviewZoomCaption
OverviewZoomUnit :number
Type:
- number
Example
0 {number}, the overview displays no zooming time-scales
36 {number}, sets the width of the zooming time-scale to 36 pixels
OverviewZoomUnit
PaneWidthLeft :number
Type:
- number
Example
0 {number}, hides the control's left-pane (items)
300 {number}, changes the width of control's left-pane (items) to 300
The following statement is equivalent:
oGantt.Chart.SetPaneWidthLeft(300) {number}, changes the width of control's left-pane (items) to 300
oGantt.Chart.PaneWidthLeft = 300 {number}, changes the width of control's left-pane (items) to 300
oGantt.Chart.SetPaneWidth(false, 300) {number}, changes the width of control's left-pane (items) to 300
where oGantt is an object of Gantt type
PaneWidthLeft
PaneWidthRight :number
Type:
- number
Example
0 {number}, hides the control's right-pane (chart)
300 {number}, changes the width of control's right-pane (chart) to 300
The following statement is equivalent:
oGantt.Chart.SetPaneWidthRight(300) {number}, changes the width of control's right-pane (chart) to 300
oGantt.Chart.PaneWidthRight = 300 {number}, changes the width of control's right-pane (chart) to 300
oGantt.Chart.SetPaneWidth(true, 300) {number}, changes the width of control's right-pane (chart) to 300
where oGantt is an object of Gantt type
PaneWidthRight
ResizeUnitCount :number
Type:
- number
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
4 {number}, creates, moves, or resizes at every fourth time unit
ResizeUnitCount
ResizeUnitScale :number
- 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:
- number
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
The following statements are equivalents:
oGantt.Chart.SetResizeUnitScale(0x10000), sets the chart's resize unit-scale to hours
oGantt.Chart.ResizeUnitScale = 0x10000, sets the chart's resize unit-scale to hours
where oGantt is an object of Gantt type
ResizeUnitScale
ScrollBar :boolean
Type:
- boolean
Example
true {boolean}, shows the chart's horizontal scroll-bar
false {boolean}, hides the chart's horizontal scroll-bar
The following statements are equivalent:
oGantt.Chart.SetScrollBar(false); {boolean}, hides the chart's horizontal scroll-bar
oGantt.Chart.ScrollBar = false; {boolean}, hides the chart's horizontal scroll-bar
where oGantt is an exontrol.Gantt object
ScrollBar
ScrollRange :ScrollRangeType
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#"
}
The following statements are equivalent:
oGantt.Chart.SetScrollRange({start:2001, end:2002}); {ScrollRangeType}, sets the range of dates to scroll within 2001 to 2002
oGantt.Chart.ScrollRange = {start:2001, end:2002}; {ScrollRangeType}, sets the range of dates to scroll within 2001 to 2002
where oGantt is an exontrol.Gantt object
ScrollRange
SelectDates :any
- 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
Type:
- any
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"
The following statements are equivalents:
oGantt.Chart.SetSelectDates({start:2001, end:2002}); {object}, selects the time zone from Jan 1st 2001, to Jan 1st 2002
oGantt.Chart.SelectDates = {start:2001, end:2002}; {object}, selects the time zone from Jan 1st 2001, to Jan 1st 2002
where oGantt is an object of Gantt type
SelectDates
Selection :any
The Selection property 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)
Type:
- any
Example
oGantt.Chart.Selection = null, clears the chart's selection (unselects all)
oGantt.Chart.Selection = oGantt.Items, selects all item-bars of all items (select all)
oGantt.Chart.Selection = oItem, selects all item-bars of specified item
The following statements are equivalents:
oGantt.Chart.SetSelection( oItemBar ), selects the item-bar giving its reference as an object of ItemBar type
oGantt.Chart.Selection = oItemBar, selects the item-bar giving its reference as an object of ItemBar type
where oGantt is an object of Gantt type, oItem is an object of exontrol.Tree.Item type, and oItemBar is an object of ItemBar type
Selection
ShowLinks :exontrol.ShowLinksEnum
The ShowLinks property is a combination of exontrol.ShowLinksEnum flags as follows:
- 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
- exPreventOverlap (0x100), adjusts the links to prevent them from overlapping the connected objects. The exPreventOverlap flag has effect only for rectangular links. The exPreventOverlap option calculates the path between A and B using the A* (A-star) pathfinding algorithm, which can be a time-consuming operation. The exontrol.L.PO.dir.def specifies the default directions for determining the best route between two points, A and B. These directions are represented as a combination of the letters R (Right), L (Left), U (Up), and D (Down), separated by commas ("RLDU,DURL" {string}, indicates the shortest route between RLDU and DURL directional path). When used with the exPreventOverlapMixt flag, it ensures that links avoid overlapping with elements or obstacles, enabling their paths to include both rectangular and diagonal lines. (@since 4.0)
- exPreventOverlapMixt (0x80), When used with the exPreventOverlap flag, it ensures that links avoid overlapping with elements or obstacles, enabling their paths to include both rectangular and diagonal lines. When combined with the exChangeColorOnOverlap flag, overlapping links alternately adjust their width in addition to changing colors. The exPreventOverlapMixt flag must always be used alongside either the exPreventOverlap or exChangeColorOnOverlap flag. (@since 4.0)
- exChangeColorOnOverlap (0x200), changes the color for links in areas where they overlap with other links, enhancing clarity and distinction between them. The exontrol.L.PO.OverlapColors defines the list of colors, separated by commas, used to display overlapping links. When combined with the exPreventOverlapMixt flag, overlapping links alternately adjust their width in addition to changing colors. (@since 4.0)
Type:
- exontrol.ShowLinksEnum
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
ShowLinks
ShowNonworkingDays :boolean
Type:
- boolean
Example
false {boolean}, hides the chart's non-working days
true {boolean}, shows the chart's non-working days
ShowNonworkingDays
ShowNonworkingHours :boolean
Type:
- boolean
Example
false {boolean}, hides the chart's non-working hours
true {boolean}, shows the chart's non-working hours
ShowNonworkingHours
ShowNonworkingUnits :boolean
Type:
- boolean
Example
false {boolean}, hides the chart's non-working units (days and hours)
ShowNonworkingUnits
SingleSel :exontrol.Tree.SingleSelEnum
The SingleSel property accepts an OR combination of exontrol.Tree.SingleSelEnum flags to specify how the user can select item-bars, as explained:
- 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
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.
SingleSel
(readonly) StartPrintDate :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
StartPrintDate
ToolTips :object
The ToolTips property of supports the following fields:
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:
- object
Example
The following sample shows how predefined-tooltips can be defined:
{
year: "<%yyyy%>",
month: "<%mmmm%> <%yyyy%>",
week: "<%mmmm%> <b><%d%></b>, <%yyyy%>/<%ww%>",
day: "<%dddd%>, <%mmmm%> <b><%d%></b>, <%yyyy%>",
hour: "<%dddd%>, <%mmmm%> <b><%d%></b>, <%yyyy%> <%h%> <%AM/PM%>",
minute: "<%dddd%>, <%mmmm%> <b><%d%></b>, <%yyyy%> <%h%>:<%nn%> <%AM/PM%>",
second: "<%dddd%>, <%mmmm%> <b><%d%></b>, <%yyyy%> <%h%>:<%nn%>:<%ss%> <%AM/PM%>"
}
The following statements are equivalents:
oGantt.Chart.SetToolTips({...}), sets predefined-tooltips of each time-unit
oGantt.Chart.ToolTips = {...}, sets predefined-tooltips of each time-unit
where oGantt is an object of Gantt type
ToolTips
UnitScale :number
- 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:
- number
Example
256 or exontrol.UnitEnum.exWeek {number}, sets the chart to display weeks
4096 or exontrol.UnitEnum.exDay {number}, sets the chart to display days
The following statements are equivalents:
oGantt.Chart.SetUnitScale(value), sets the chart's unit scale
oGantt.Chart.UnitScale = value, sets the chart's unit scale
where oGantt is an object of Gantt type
UnitScale
UnitWidth :number
Type:
- number
Example
8 {number}, changes the width for units in the base-level to 8-pixels
UnitWidth
UnitWidthNonworking :number
- 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
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)
The following statements are equivalents:
oGantt.Chart.SetUnitWidthNonworking(value), sets the width to display the non-working units in base-level
oGantt.Chart.UnitWidthNonworking = value, sets the width to display the non-working units in base-level
where oGantt is an object of Gantt type
UnitWidthNonworking
Methods
Bar(name, includeShortcutopt) → {Bar}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
name |
any | The name parameter could be any of the following:
|
|
includeShortcut |
boolean |
<optional> |
Specifies whether the bar is searched for its shortcut as well (defaults to false) (@since 3.2). The Shortcut property gets or sets the bar's shortcut shortcut. The shortcut is an alternate name to refer the bar. The Name property holds the main name of the bar. When includeShortcut is set to true, the Bar() method searches for the bar by its name and its shortcut, and returns the bar if either the name or the shortcut matches the given name parameter. When includeShortcut is false, the Bar() method searches for the bar by its name only. |
Returns:
- 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
Bar
EnsureVisibleSelection(ensureOpts)
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ensureOpts |
object | Specifies different options to run the current method, as an object of {expandParents, selection, duration} type.
Properties
|
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
EnsureVisibleSelection
GetLabel(unit) → {string}
Parameters:
| Name | Type | Description |
|---|---|---|
unit |
exontrol.UnitEnum | Specifies the time-unit to request its label for
The exontrol.UnitEnum type support the following values:
|
Returns:
- Type
- string
Example
The following statements are equivalents:
oGantt.Chart.GetLabel(exontrol.UnitEnum.exMonth) {string}, gets the predefined format of the level's label for month unit
oGantt.Chart.Labels.month {string}, gets the predefined format of the level's label for month unit
where oGantt is an object of Gantt type
GetLabel
GetPaneWidth(rightopt) → {number}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
right |
boolean |
<optional> |
A Boolean expression that indicates whether the left (items) or right(chart) area is requested. |
Returns:
- Type
- number
Example
The following statements are equivalent:
oGantt.Chart.GetPaneWidth() {number}, gets the width of the left(items) pane
oGantt.Chart.GetPaneWidth(false) {number}, gets the width of the left(items) pane
oGantt.Chart.PaneWidthLeft {number}, gets the width of the left(items) pane
oGantt.Chart.GetPaneWidthLeft() {number}, gets the width of the left(items) pane
where oGantt is an object of Gantt type
GetPaneWidth
GetToolTip(unit) → {string}
Parameters:
| Name | Type | Description |
|---|---|---|
unit |
exontrol.UnitEnum | Specifies the time-unit to request its label for
The exontrol.UnitEnum type support the following values:
|
Returns:
- Type
- string
Example
The following statements are equivalents:
oGantt.Chart.GetToolTip(exontrol.UnitEnum.exMonth) {string}, gets the predefined-tooltip for month unit
oGantt.Chart.ToolTips.month {string}, gets the predefined-tooltip for month unit
where oGantt is an object of Gantt type
GetToolTip
HistogramValue(date) → {number}
Parameters:
| Name | Type | Description |
|---|---|---|
date |
any | Specifies the date to get histogram-value for, as explained:
|
Returns:
- Type
- number
Example
oGanttChart.HistogramValue("min") {number}, gets the minimum cumulated histogram-value, excepts 0
oGanttChart.HistogramValue("max") {number}, gets the maximum cumulated histogram-value
The following example shows how to get the histogram value at the date-time corresponding to the mouse position over the control's histogram:
cvsGantt.onmousemove = function(event)
{
console.log(oChart.HistogramValue(oGantt.oGV.p2UL(oGantt.oGV.gPtr(event), 8).r));
}
where oGantt is the Gantt control's instance, oChart is the chart object (oGantt.Chart), and oGantt.oGV.p2UL() method converts the mouse position into a date-time value.
HistogramValue
Level(index) → {Level}
Parameters:
| Name | Type | Description |
|---|---|---|
index |
number | A long expression that indicates the index of the level being accessed. |
Returns:
- Type
- Level
Example
oGantt.Chart.Level(0), gets the first level of the chart's header
Level
RemoveSelection() → {number}
Returns:
- Type
- number
ScrollTo(date, align)
Parameters:
| Name | Type | Description |
|---|---|---|
date |
number | string | Date | A value of one of the following types:
|
align |
exontrol.AlignEnum | Specifies the horiontal-alignment to display the date.
The exontrol.AlignEnum type supports the following values:
|
Example
oGantt.Chart.ScrollTo("#9/1/1994#"), scrolls the chart to ensure that Sep 1st, 1994 is centered in the chart's area, equivalent to oGantt.Chart.FirstVisibleDate = "#9/1/1994#"
oGantt.Chart.ScrollTo("#9/1/1994#", "right"), scrolls the chart to ensure that Sep 1st, 1994 is aligned to the right in the chart's area
ScrollTo
SetLabel(unit, value)
Parameters:
| Name | Type | Description |
|---|---|---|
unit |
exontrol.UnitEnum | Specifies the time-unit to request its label for
The exontrol.UnitEnum type support the following values:
|
value |
string | Defines the predefined label for the giving unit. The label can contain multiple alternative HTML labels, separated by <|>, and can include values for Level.Count and Level.Unit, separated by <||>, as described in the Level.Label property. |
Example
oGantt.Chart.SetLabel(exontrol.UnitEnum.exMonth, "<%mmmm%> <%yyyy%>") {string}, sets the predefined format of the level's label for month unit
SetLabel
SetPaneWidth(right, 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. |
SetToolTip(unit, value)
Parameters:
| Name | Type | Description |
|---|---|---|
unit |
exontrol.UnitEnum | Specifies the time-unit to request its label for
The exontrol.UnitEnum type support the following values:
|
value |
string | Defines the predefined-tooltip for the giving unit. |
Example
oGantt.Chart.SetToolTip(exontrol.UnitEnum.exMonth, "<%mmmm%> <%yyyy%>") {string}, sets the predefined-tooltip for month unit
SetToolTip
Zoom(start, end, changeUnitWidthopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
start |
number | string | Date | A value of one of the following types:
|
|
end |
number | string | Date | A value of one of the following types:
|
|
changeUnitWidth |
boolean |
<optional> |
Specifies whether the chart's unit-width is changed (defaults to true). |
Example
oGantt.Chart.Zoom("#9/1/1994#", "#10/1/1994#"), zooms the chart to fit the interval from Sep 1st, 1994 to Oct 1st, 1994
oGantt.Chart.Zoom(new Date(1994,8,1), new Date(1994,9,1)), zooms the chart to fit the interval from Sep 1st, 1994 to Oct 1st, 1994
oGantt.Chart.Zoom(1994, 1995), zooms the chart to fit the interval from Jan 1st, 1994 to Jan 1st, 1995
Zoom
unkS() → {object}
Returns:
- Type
- object
Example
The following statement sets a custom-shape to show "unknown" bars:
oGantt.Chart.unkS = function()
{
return this.oUnkS || (this.oUnkS =
{
frameColor: "red",
patternColor: "orangered",
pattern: exontrol.PatternEnum.exPatternFDiagonal,
opacity: 0.25,
primitive: "Round"
})
}
where oGantt is an object of Gantt type
unkS