ItemBarOptions class (Gantt)

new ItemBarOptions()

The ItemBarOptions type holds all options(name, start, end, ...) an item-bar can display or own. The ItemBar(key) method gets the bar of the current item giving its key, and returns an object of ItemBar type.

Every option of the ItemBarOptions type has associated a property of the ItemBar object. For instance, the option:

caption {string}, specifies the caption to display within the bar

is associated with the property:

Caption {string}, specifies the caption to display within the bar

which means that the following statements are equivalent:

oItemBar.Options = {caption: "pointer"}
oItemBar.SetOptions({caption: "pointer"})
oItemBar.Caption = "pointer"
oItemBar.SetCaption("pointer")

where oItemBar is an object of ItemBar type

ItemBarOptions

Members

(static) alignPercentCaption :number

The alignPercentCaption field horizontally aligns the bar's percent-caption. (Only bars of percent-type ("A%B") display and handle the inner progress-bar). The alignPercentCaption field supports the following values:

0, 1 or 2 the caption is not clipped and it is aligned to the left, center or right side of the bar ( no clip )
3, 4 or 5 the caption of the bar gets clipped to the bar's client area, else the caption is aligned to the left, center or right side of the bar ( clip, inside )
6, 7 or 8 the bar's caption is hidden if its size is less or equal with MinUnitWidth property, else if it does not fit the bar's client are, gets clipped or else fully aligned to left, center or right side of the bar ( hide if min, clip if not fit, inside )
9, 10 or 11 the bar's caption is hidden if it does not fit entirely into the bar's client area, else it is fully displayed aligned to the left, center or right side of the bar ( hide if not fit, no clip, inside )
12, 13 or 14 the bar's caption is displayed inside of the bar's client area if it fits entirely, else it is displayed outside of the bar aligned to the left, center or right ( no clip, inside, outside )
16, 17, 18, the bar's caption is displayed outside of the bar to the left or to the right ( no clip, outside )

Type:

number

Example

18 {number} or null {null}, the bar's percent-caption is displayed right-outside
 0 {boolean}, the bar's percent-caption is aligned to the left

alignPercentCaption

(static) canBeLinked :boolean

The canBeLinked field specifies whether the bar can be linked.

Type:

boolean

Example

false {boolean}, no link can start from, or end into the current bar
 true {boolean} or null {null}, the bar can be linked

canBeLinked

(static) canEndLink :boolean

The canEndLink field specifies whether a link can end on this bar.

Type:

boolean

Example

false {boolean}, no link can end on this bar
 true {boolean} or null {null}, any link can end on this bar

canEndLink

(static) canMove :boolean

The canMove field specifies whether the user can move the bar within the same item by drag (requires to be selectable too).

Type:

boolean

Example

false {boolean}, the user can't move the item-bar
true {boolean} or null{null}, the user can move the item-bar by drag

canMove

(static) canMoveToAnother :boolean

The canMoveToAnother field specifies whether the bar can be moved to another item by drag and drop (requires to be selectable too).

Type:

boolean

Example

false {boolean} or null{null}, the user can't move the item-bar
true {boolean}, the user can move the item-bar from an item to another, by drag

canMoveToAnother

(static) canResize :number

The canResize field specifies whether the user can resize the bar on both margins by drag (requires to be selectable too), as explained:

0 {number} or false {boolean}, the user can not resize the bar by drag
-1 {number} or null {null}, the bar can be resized on both sides
1 {number} or true {boolean}, the bar can be resized on left side, and can not be resized on right
2 {number}, the bar can be resized on right side, and can not be resized on left

Type:

number

Example

false {boolean}, the user can't resize the item-bar
true {boolean}, the user can resize the bar on left side, and can not be resize on right
-1 {number} or null {null}, the user can resize the bar on both sides

canResize

(static) canResizePercent :boolean

The canResizePercent field specifies whether the user can resize the percent at runtime.

Type:

boolean

Example

false {boolean}, the bar's percent can not be resized by drag
 true {boolean} or null {null}, the user can resize the bar's percent at runtime

canResizePercent

(static) canStartLink :boolean

The canStartLink field specifies whether a link can start from this bar.

Type:

boolean

Example

false {boolean}, no link can start from the current bar
 true {boolean} or null {null}, any link can start from the current bar

canStartLink

(static) caption :string

The caption field specifies the caption to display within the bar. The caption supports exHTML format, including the <%=formula%> tag, where formula is an expression that supports predefined operators, functions and % keywords such as %0 (itembar's property), %C0 (cell's value), %CD0 (cell's extra-data) or %CS0 (cell' checkbox-state) The caption-expression supports the following keywords:

%0, %1, %2, ... specifies the value/option of the item-bar as name, start, end and so on (ItemBarPropertyEnum type)
%C0, %C1, %C2, ... specifies the caption of the cell, or the string the cell displays in the column with the index 0, 1 2, ...
%CD0, %CD1, %CD2, ... specifies the item-bar's user-date in the column with the index 0, 1 2, ...
%CS0, %CS1, %CS2, ... specifies the item-bar's state in the column with the index 0, 1 2, ...

Type:

string

Example

"&lt;b>task&lt;/b>" {string}, the item-bar displays the task string in bold
"&lt;fgcolor white>&lt;bgcolor black> &lt;%=%0%> " {string}, the item-bar displays its type/name in black/white
"&lt;%=shortdate(%1)%>&lt;br>&lt;%=shortdate(%2)%>" {string}, the item-bar displays its start date-time in short format on the first line, and the end date-time in short format, on the second line
"&lt;%=%C0 + %C1%>" {string}, concatenates and displays the caption of first and second cell
"&lt;%=(%CD0 ? %0 : ``)%>" {string}, displays the first-column only if the item's data is not empty
"&lt;b>&lt;%=(%CS0 ? %0 : ``)%>&lt;/b>&lt;%=(%CS0 ? `` : %0)%>" {string}, displays the item-bar's name in bold only if the first cell is checked )

caption

(static) captionHOffset :number

The captionHOffset field defines the bar's caption horizontal-offset (relative to its alignment/default-position).

Type:

number

Example

0 {number}, null {null}, the bar's caption is shown at its alignment/default-position
 -4 {number}, the bar's caption is shown 4-pixels left to its alignment/default-position
 4 {number}, the bar's caption is shown 4-pixels right to its alignment/default-position

captionHOffset

(static) captionVOffset :number

The captionVOffset field defines the bar's caption vertical-offset (relative to its alignment/default-position).

Type:

number

Example

0 {number}, null {null}, the bar's caption is shown at its alignment/default-position
 -4 {number}, the bar's caption is shown 4-pixels up to its alignment/default-position
 4 {number}, the bar's caption is shown 4-pixels down to its alignment/default-position

captionVOffset

(static) effort :number|string

The effort field specifies the bar's effort, or the effort to execute an unit within the bar. Indicates the bar's histogram value, which is interpreted based on bar's histogramType property. The effort field could be:

a numeric value which it is applied for all units in the task (constant-effort)
a string that indicates the expression/formula to get the effort of the bar to be represented on the chart's histogram (variant-expression). The value keyword indicates the date-time being queried, the start and end keywords specify the starting and ending points of the bar as indicated by exBarStart and exBarEnd fields in the ItemBar property

Type:

number | string

Example

0 {number}, the bar is not represented into the control's histogram
 1.5 {number}, the bar's histogram value is based on the bar's histogramType option as explained:

   exHistOverload(0), adds 1.5-unit(s) to the histogram for each date-time of the bar
   exHistOverAllocation(1), adds 150% to the histogram for each date-time of the bar (1 day long), 75% for a 2-days long or shortly effort divided by length (in days) (effort/length)
   exHistOverAllocationFixed(512), adds 150% to the histogram for each date-time of the bar (no matter of its length) (fixed percent)
   exHistOverAllocationMultiply(1024), adds 150% to the histogram for each date-time of the bar (1 day long), 300% for a 2-days long or shortly effort multiplied by length (in days) (effort*length)

 "weekday(value) in (0,6) ? 0 : 2" {string}, defines an effort-expression or a variable-effort as explained: the effort to do the job is 2 for any day in the task, excepts the Sundays(0) and Saturdays(6) (weekend)
 "weekday(value) = 1 ? 2 : 1" {string}, indicates that the effort to do the job is 2 for Mondays(1), else 1
 "(month(value)=month(value+1)) ? 1 : 0" {string}, indicates that the effort to do the job is 1 for any day, excepts the last day in the month
 "int((value-start)/86400000) ? 1 : 2" {string},  indicates that the effort to do the job is 2 for the first day in the task, and 1 for the others (86400000 represents the number of mili-seconds within a day, as 24 * 60 * 60 * 1000)
 "(int((value-start)/86400000)+1) mod 2 ? 1 : 0" {string},  indicates that the effort to do the job is 2 for the first day in the task, and 1 for the others (86400000 represents the number of mili-seconds within a day, as 24 * 60 * 60 * 1000)

effort

(static) end :any

The end field indicates the date-time the bar ends to, as one of the following:

end {null}, indicates the current date and time (equivalent of Now)
end {string}, defines the date in string-format as "#MM/DD/YYYY[ HH:mm:ss]#"
end {Date}, indicates a JavaScript date to be copied
end {number} integer value representing the year of the date to be created

Type:

Example

"#1/2/2001#" {string}, defines the bar's end date-time as January 2nd, 2001
 Date.Today().NextDay(2) {Date}, changes the bar's end date-time to 1 day after tomorrow

end

(static) extraCaption :string

The extraCaption field associates an extra caption with the current item-bar. The extraCaption supports exHTML format, including the <%=formula%> tag, where formula is an expression that supports predefined operators, functions and % keywords such as %0 (itembar's property), %C0 (cell's value), %CD0 (cell's extra-data) or %CS0 (cell' checkbox-state) The extraCaption-expression supports the following keywords:

%0, %1, %2, ... specifies the value/option of the item-bar as name, start, end and so on (ItemBarPropertyEnum type)
%C0, %C1, %C2, ... specifies the caption of the cell, or the string the cell displays in the column with the index 0, 1 2, ...
%CD0, %CD1, %CD2, ... specifies the item-bar's user-date in the column with the index 0, 1 2, ...
%CS0, %CS1, %CS2, ... specifies the item-bar's state in the column with the index 0, 1 2, ...

Type:

string

Example

"&lt;b>task&lt;/b>" {string}, the item-bar displays the task string in bold
"&lt;fgcolor white>&lt;bgcolor black> &lt;%=%0%> " {string}, the item-bar displays its type/name in black/white
"&lt;%=shortdate(%1)%>&lt;br>&lt;%=shortdate(%2)%>" {string}, the item-bar displays its start date-time in short format on the first line, and the end date-time in short format, on the second line
"&lt;%=%C0 + %C1%>" {string}, concatenates and displays the caption of first and second cell
"&lt;%=(%CD0 ? %0 : ``)%>" {string}, displays the first-column only if the item's data is not empty
"&lt;b>&lt;%=(%CS0 ? %0 : ``)%>&lt;/b>&lt;%=(%CS0 ? `` : %0)%>" {string}, displays the item-bar's name in bold only if the first cell is checked )

extraCaption

(static) extraCaptionHAlign :number

The extraCaptionHAlign field specifies the horizontal-alignment / clipping of the item-bar's extra caption inside / outside the bar, as explained:

0, 1 or 2 the caption is not clipped and it is aligned to the left, center or right side of the bar ( no clip )
3, 4 or 5 the caption of the bar gets clipped to the bar's client area, else the caption is aligned to the left, center or right side of the bar ( clip, inside )
6, 7 or 8 the bar's caption is hidden if its size is less or equal with MinUnitWidth property, else if it does not fit the bar's client are, gets clipped or else fully aligned to left, center or right side of the bar ( hide if min, clip if not fit, inside )
9, 10 or 11 the bar's caption is hidden if it does not fit entirely into the bar's client area, else it is fully displayed aligned to the left, center or right side of the bar ( hide if not fit, no clip, inside )
12, 13 or 14 the bar's caption is displayed inside of the bar's client area if it fits entirely, else it is displayed outside of the bar aligned to the left, center or right ( no clip, inside, outside )
16, 17, 18, the bar's caption is displayed outside of the bar to the left or to the right ( no clip, outside )

Also, the field supports the following flag (OR combination with any other value):

32 (0x20), which indicates that the bar's caption fits the bar and view (that bar's caption is aligned relative to the horizontal-intersection of the bar with the view).

Type:

number

Example

null {null}, the item-bar's extra caption is horizontally centered
18 {number}, the item-bar's extra caption is displayed outside of the bar to the right ( no clip, outside )

extraCaptionHAlign

(static) extraCaptionHOffset :number

The extraCaptionHOffset field defines the bar's extra-caption horizontal-offset (relative to its alignment/default-position).

Type:

number

Example

0 {number}, null {null}, the bar's caption is shown at its alignment/default-position
 -4 {number}, the bar's caption is shown 4-pixels left to its alignment/default-position
 4 {number}, the bar's caption is shown 4-pixels right to its alignment/default-position

extraCaptionHOffset

(static) extraCaptionVAlign :number

The extraCaptionVAlign field specifies the vertical-alignment of the item-bar's extra caption inside / outside the bar, as explained:

0, the caption is aligned to the top
1, the caption is vertically centered
2, the caption is aligned to the bottom
16 (0x10), The caption is displayed outside of the item-bar (16 outside on top, 18 outside on bottom)
32 (0x20), which indicates that the bar's caption fits the bar and view (that bar's caption is aligned relative to the vertical-intersection of the bar with the view).

Type:

number

Example

null {null}, the item-bar's extra caption is vertically centered
18 {number}, the item-bar's extra caption is displayed outside of the bar to the bottom

extraCaptionVAlign

(static) extraCaptionVOffset :number

The extraCaptionVOffset field defines the bar's extra-caption vertical-offset (relative to its alignment/default-position).

Type:

number

Example

0 {number}, null {null}, the bar's caption is shown at its alignment/default-position
 -4 {number}, the bar's caption is shown 4-pixels up to its alignment/default-position
 4 {number}, the bar's caption is shown 4-pixels down to its alignment/default-position

extraCaptionVOffset

(static) hAlignCaption :number

The hAlignCaption field specifies the horizontal-alignment / clipping of the item-bar's caption inside / outside the bar, as explained:

0, 1 or 2 the caption is not clipped and it is aligned to the left, center or right side of the bar ( no clip )
3, 4 or 5 the caption of the bar gets clipped to the bar's client area, else the caption is aligned to the left, center or right side of the bar ( clip, inside )
6, 7 or 8 the bar's caption is hidden if its size is less or equal with MinUnitWidth property, else if it does not fit the bar's client are, gets clipped or else fully aligned to left, center or right side of the bar ( hide if min, clip if not fit, inside )
9, 10 or 11 the bar's caption is hidden if it does not fit entirely into the bar's client area, else it is fully displayed aligned to the left, center or right side of the bar ( hide if not fit, no clip, inside )
12, 13 or 14 the bar's caption is displayed inside of the bar's client area if it fits entirely, else it is displayed outside of the bar aligned to the left, center or right ( no clip, inside, outside )
16, 17, 18, the bar's caption is displayed outside of the bar to the left or to the right ( no clip, outside )

Also, the field supports the following flag (OR combination with any other value):

32 (0x20), which indicates that the bar's caption fits the bar and view (that bar's caption is aligned relative to the horizontal-intersection of the bar with the view).

Type:

number

Example

null {null}, the item-bar's caption is horizontally centered
18 {number}, the item-bar's caption is displayed outside of the bar to the right ( no clip, outside )

hAlignCaption

(static) height :number

The height field defines the height of the bar.

Type:

number

Example

null {null}, the bar's height is defined by the height of the bar of the same type/name
 -1 {number}, specifies that the bar's height is determined by the item's height (the item that hosts the bar defines the bar's height)
 0 {number}, defines a zero-height bar (bar is hidden)
 12 {number}, the bar's height is 12-pixels tall

height

(static) histLegend :string

The histLegend field specifies the description to show within the histogram's legend for the bar in the control's histogram. The exBarHistLegend option has effect only if the Bar.HistogramCumulativeOriginalColorBars is exKeepOriginalColor. The histLegend supports exHTML format, including the <%=formula%> tag, where formula is an expression that supports predefined operators, functions and % keywords such as %0 (itembar's property), %C0 (cell's value), %CD0 (cell's extra-data) or %CS0 (cell' checkbox-state) The histLegend-expression supports the following keywords:

%0, %1, %2, ... specifies the value/option of the item-bar as name, start, end and so on (ItemBarPropertyEnum type)
%C0, %C1, %C2, ... specifies the caption of the cell, or the string the cell displays in the column with the index 0, 1 2, ...
%CD0, %CD1, %CD2, ... specifies the item-bar's user-date in the column with the index 0, 1 2, ...
%CS0, %CS1, %CS2, ... specifies the item-bar's state in the column with the index 0, 1 2, ...

Type:

string

Since:

Example

"&lt;b>cust&lt;/b>" {string}, the legend displays the cust string in bold
"&lt;%=%0%> " {string}, the legend displays the bar's type/name
"&lt;fgcolor gray>&lt;%=lower(%3)%>" {string}, the histogram-legend displays the bar's caption in gray and lowercase

histLegend

(static) key :string

The key field specifies the key of the bar (used only if item hosts multiple bars).

Type:

string

Example

"A" {string}, defines a bar with the key "A"

key

(static) name :string

The name field specifies the name/type of the bar. The Bars collection holds the control's predefined type of bars.

Type:

string

Example

"Task" {string}, defines the current bar to look and act as a "Task" bar
"Task%Progress" {string}, defines the bar to look as a "Task" bar and to display the bar's "percent" option, as an inside "Progress"-bar. The Chart.Bars.Add("Task%Progress") should be previously called to define a bar of percent-type.

name

(static) offset :number

The offset field specifies the vertical-offset relative to the default position, the bar is displayed.

Type:

number

Example

0 {number} or null {null}, the item bar is shown in its default position, ussualy centered to the item, while it is not part of overlaid-bars
 -4 {number}, shifts vertically the item bar by 4-pixels

offset

(static) overlaidKey :string

The overlaidKey field specifies the z-order of the bar when it overlaps other bars (exOverlaidBarsCascade type).

Type:

string

Example

"Z" {string}, all overlaid-bars of the same overlaid-key "Z" are displayed on the same level

overlaidKey

(static) overviewColor :string

The overviewColor field defines the color to show a particular bar within the control's overview.

Type:

string

Example

"" {string} or null{null}, the overview color of the current item-bar is defined by the bar's overviewColor, item-bar's shape fill, pattern or frame color (the first truly value in this order)
 "transparent" or "rgba(0,0,0,0)" {string}, the overview representation of the current item-bar is hidden
 "red" or "#FF0000", "rgb(255,0,0)", "rgba(255,0,0,1)", ... {string}, the current item-bar is shown in red within the control's overview

overviewColor

(static) percent :number

The percent field specifies the bar's percent, as a value from 0 to 1 (for 100%).

Type:

number

Example

0 {number} or null {null}, the bar's percent is set to 0%
 1 {number}, the bar's percent is set to 100%

percent

(static) percentCaptionFormat :string

The percentCaptionFormat field specifies the HTML format to display the bar's percent. The %p keyword defines the bar's percent.

Type:

string

Example

"" {string}, displays the bar's percent as it is (no % character is displayed)
 "<b>%p%</b>" {string}, shows the bar's percent in bold

percentCaptionFormat

(static) predecessor :string

The predecessor field defines the list of predecessor bars, separated by comma. Tasks may have multiple predecessors or multiple successors. Before you begin establishing dependencies, it’s important to understand that there are four types:

Finish to Start (FS), the predecessor ends before the successor can begin
Start to Start (SS), the predecessor begins before the successor can begin
Finish to Finish (FF), the predecessor ends before the successor can end
Start to Finish (SF), the predecessor begins before the successor can end

The format of bar's predecessor is INDEX1["SF"|"FS"|"FF"|"SS"][KEY][:["W"]LAG|:LAG["W"]], where:

INDEX1 is the 1-based index of the item that hosts the bar
followed by the type of the link which can be one any of SF(Start-Finish), FS(Finish-Start), SS(Start-Start) or FF(Finish-Finish) sequence (FS if missing)
continues with the KEY of the bar (empty is not used)
and ends with the LAG of the link (specifies the delay the activity is postponed by the link). The "W" indicates a working-lag for the link (specifies the delay in working-units the activity is postponed by the link).

Type:

string

Since:

Example

"2FSZ", specifies that the current item-bar is linked with the "Z" bar of the second item (item with the index 1) using a Finish-Start link
 "1SF:-2", adds a Start-Finish link with the bar '' of the first-item, using a lag of -2 days

predecessor

(static) resourceFormat :string

The resourceFormat file specifies the format for displaying a bar's resource. This get/set property allows you to define a string expression to customize the display format. The expression supports the name keyword for the resource's 'name' and the 'percent' keyword for the usage percentage, which is a double value between 0 and 1. To get the HTML value of the formatted string using the bar's resources, use resourcesFormat(266) (note: not 'resourceFormat', which lacks the 's').

Type:

string

Since:

Example

"name" {string}, displays just the name of the resource (not including its usage)
"name + (percent = 1 ? `` : ( `(` + (round(100*percent) format `` replace `.00` with `` + `%`))  + `)`)" {string}, displays name followed by percentage
"`<b>` + name + `</b><font ;5><fgcolor gray>` + (percent = 1 ? `` : (round(100*percent) format ``) + `%` ) + `</fgcolor></font>`" {string}, resource names in bold and the usage percentage in a smaller font

resourceFormat

(static) resources :string

The resources field specifies the resources to be used by the current bar, separated by commas. The resources property is a string that specifies the list of resources, including their usage, or 100% if not specified. Resources are separated by commas, and usage is indicated as a double expression using a dot as the decimal separator. For example, Resource1,Resource2,Resource3 indicates that the bar uses Resource1, Resource2, and Resource3 at 100% each, while R1,R2[50%],R3[67.89%] specifies that the bar uses R1 at 100%, R2 at 50%, and R3 at 67.89%. If the first character is a plus sign (+), the rest of the expression indicates the resources to be added to the current bar. For instance, if the current bar has the 'resources' property set to "R1,R2" and we set 'resources' to "+R3", it means that "R3" is added to the bar's resources, resulting in a new 'resources' property of "R1,R2,R3" If the first character is a minus sign (-), the rest of the expression indicates the resources to be removed from the current bar. For instance, if the current bar has the 'resources' property set to "R1,R2" and we set 'resources' to "-R2", it means that "R2" is removed from the bar's resources, resulting in a new 'resources' property of "R1" If no + or - character is used, setting the 'resources' property replaces its current value entirely. For example, if the current bar has 'resources' set to "R1,R2" and we set 'resources' to "R3,R4", it means the new 'resources' property will be "R3,R4". This replaces the previous resources with the new ones specified.

Type:

string

Since:

Example

"R1,R2" {string}, allocates the R1 and R2 resources to the current bar
"R1[50%],R2[10%]" {string}, allocates 50% of R1 resources and 10% of R2 resource to the current bar
"+R3[34%]" {string}, adds 34% of R3 resource

resources

(static) selectable :boolean

The selectable field indicates whether the item-bar is selectable or unselectable.

Type:

boolean

Example

false {boolean}, the item-bar is unselectable (the user can select the item-bar)
 true {boolean}, the item-bar is selectable

selectable

(static) selected :boolean

The selected field specifies whether the bar is selected or unselected.

Type:

boolean

Example

false {boolean}, unselects the bar
 true {boolean}, selects the bar

selected

(static) shape :any

The shape field defines the shape to apply on the bar's background. The shape field can be any of the following:

the shape's name within the exontrol.Shape.Tree or exontrol.Shape namespace
a CSS color
a JSON string-representation of an object of exontrol.Def.Shape type, for the column itself
an object of {normal,hover,click,disabled} type. The normal, hover, click and disabled are objects of exontrol.Def.Shape type

Type:

Example

"" {string}, null {null}, no shape is applied
 "red" {string}, fills the object's background in red (CSS color)
 '{"fillColor": "red"}' or '{"normal":{"fillColor": "red"}}' {string}, fills the object's background in red (JSON-representation of an object of exontrol.Def.Shape type)
 "xxx" {string}, indicates that exontrol.Shapes.Tree.xxx or exontrol.Shapes.xxx is applied on the object's background. If the xxx field is missing, no custom shape is applied (no default object's shape is be applied)
 exontrol.Shapes.Button {object}, applies the "Button" shape on the object as defined into exontrol.Shapes namespace

shape

(static) showCaption :boolean

The showCaption field specifies whether the bar's caption is visible or hidden.

Type:

boolean

Example

false {boolean}, hides the item-bar's caption
true {boolean}, shows the item-bar's caption

showCaption

(static) showExtraCaption :boolean

The showExtraCaption field specifies whether the bar's extra caption is visible or hidden.

Type:

boolean

Example

false {boolean}, hides the item-bar's extra caption
true {boolean}, shows the item-bar's extra caption

showExtraCaption

(static) showPercentCaption :boolean

The showPercentCaption field shows or hides the bar's percent-caption. Only bars of percent-type ("A%B") display and handle the inner progress-bar.

Type:

boolean

Example

false {boolean} or null {null}, the bar's percent-caption is hidden
 true {boolean}, the bar's percent-caption is shown

showPercentCaption

(static) start :any

The start field indicates the date-time the bar starts from, as one of the following:

start {null}, indicates the current date and time (equivalent of Now)
start {string}, defines the date in string-format as "#MM/DD/YYYY[ HH:mm:ss]#"
start {Date}, indicates a JavaScript date to be copied
start {number} integer value representing the year of the date to be created

Type:

Example

"#1/1/2001#" {string}, defines the bar's start date-time as January 1st, 2001
 Date.Today() {Date}, changes the bar's start date-time to today

start

(static) successor :string

The successor field defines the list of successor bars, separated by comma. Tasks may have multiple predecessors or multiple successors. Before you begin establishing dependencies, it’s important to understand that there are four types:

Finish to Start (FS), the predecessor ends before the successor can begin
Start to Start (SS), the predecessor begins before the successor can begin
Finish to Finish (FF), the predecessor ends before the successor can end
Start to Finish (SF), the predecessor begins before the successor can end

The format of bar's successor is INDEX1["SF"|"FS"|"FF"|"SS"][KEY][:["W"]LAG|:LAG["W"]], where:

INDEX1 is the 1-based index of the item that hosts the bar
followed by the type of the link which can be one any of SF(Start-Finish), FS(Finish-Start), SS(Start-Start) or FF(Finish-Finish) sequence (FS if missing)
continues with the KEY of the bar (empty is not used)
and ends with the LAG of the link (specifies the delay the activity is postponed by the link). The "W" indicates a working-lag for the link (specifies the delay in working-units the activity is postponed by the link).

Type:

string

Since:

Example

"3SFy",  specifies that the current item-bar is linked with the "y" bar of the third item (item with the index 1) using a Start-Finish link

successor

(static) summaryBarShape :any

The summaryBarShape field defines the shape to apply on the background of all summary-bar's child item-bars (have effect only for summary-bars, union of child item-bars). The summaryBarShape field can be any of the following:

the shape's name within the exontrol.Shape.Tree or exontrol.Shape namespace
a CSS color
a JSON string-representation of an object of exontrol.Def.Shape type, for the column itself
an object of {normal,hover,click,disabled} type. The normal, hover, click and disabled are objects of exontrol.Def.Shape type

Type:

Example

"" {string}, null {null}, no shape is applied
 "red" {string}, fills the object's background in red (CSS color)
 '{"fillColor": "red"}' or '{"normal":{"fillColor": "red"}}' {string}, fills the object's background in red (JSON-representation of an object of exontrol.Def.Shape type)
 "xxx" {string}, indicates that exontrol.Shapes.Tree.xxx or exontrol.Shapes.xxx is applied on the object's background. If the xxx field is missing, no custom shape is applied (no default object's shape is be applied)
 exontrol.Shapes.Button {object}, applies the "Button" shape on the object as defined into exontrol.Shapes namespace

summaryBarShape

(static) toolTip :string

The toolTip field specifies the tooltip to be shown once the cursor hovers the bar. The tooltip supports exHTML format, including the <%=formula%> tag, where formula is an expression that supports predefined operators, functions and % keywords such as %0 (itembar's property), %C0 (cell's value), %CD0 (cell's extra-data) or %CS0 (cell' checkbox-state) The tooltip-expression supports the following keywords:

%0, %1, %2, ... specifies the value/option of the item-bar as name, start, end and so on (ItemBarPropertyEnum type)
%C0, %C1, %C2, ... specifies the caption of the cell, or the string the cell displays in the column with the index 0, 1 2, ...
%CD0, %CD1, %CD2, ... specifies the item-bar's user-date in the column with the index 0, 1 2, ...
%CS0, %CS1, %CS2, ... specifies the item-bar's state in the column with the index 0, 1 2, ...

Type:

string

Example

"&lt;b>task&lt;/b>" {string}, the tooltip displays the task string in bold
"&lt;%=%0%> " {string}, the tooltip displays the bar's type/name
"Start: &lt;%=shortdate(%1)%>&lt;br>End: &lt;%=shortdate(%2)%>" {string}, the tooltip displays the bar's start date-time in short format on the first line, and the end date-time in short format, on the second line
"&lt;%=%C0 + %C1%>" {string}, concatenates and displays the caption of first and second cell
"Duration: <%=((1:=int(0:= (%513))) != 0 ? (=:1 + ' day(s)') : '') + (=:1 ? ' ' : '' ) + ((1:=int(0:=((=:0 - =:1 + 1/24/60/60/2)*24))) != 0 ? =:1 + ' hour(s)' : '' ) + (=:1 ? ' ' : '' ) + ((1:=round((=:0 - =:1)*60)) != 0 ? =:1 + ' min(s)' : '')%>", {string} shows the item-bar's duration/length in days, hours and minutes

toolTip

(static) vAlignCaption :number

The vAlignCaption field specifies the vertical-alignment of the item-bar's caption inside / outside the bar, as explained:

0, the caption is aligned to the top
1, the caption is vertically centered
2, the caption is aligned to the bottom
16 (0x10), The caption is displayed outside of the item-bar (16 outside on top, 18 outside on bottom)
32 (0x20), which indicates that the bar's caption fits the bar and view (that bar's caption is aligned relative to the vertical-intersection of the bar with the view).

Type:

number

Example

null {null}, the item-bar's caption is vertically centered
18 {number}, the item-bar's caption is displayed outside of the bar to the bottom

vAlignCaption