ItemBar class (Gantt)

ItemBar(oIB, oOptionsopt)

new ItemBar(oIB, oOptionsopt)

The ItemBar object holds information(options) about a bar within the control. The AddBar(name, start, end, [key, [text]]) method of the Item object creates and adds a new bar for the item. 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
Parameters:
Name Type Attributes Description
oIB ItemBars Indicates an object of ItemBars type that's the owner collection of this bar
oOptions object <optional>
 Specifies an object of ItemBarOptions type that holds information about the bar, such as name, shape and so on.
ItemBar

Members

GetItem

The GetItem() method gets the item that hosts the item bar. The GetItem() method is equivalent with the GetParent() method.
Since:
  • 3.3
Example
The following statements are equivalents:

 oItemBar.GetItem(), gets the item that hosts the item bar
 oItemBar.Item, gets the item that hosts the item bar

where oItemBar is an object of ItemBar type
GetItem

SetItem

The SetItem() method sets the item to host the item-bar (moves the item-bar from an item to another). The SetItem() method is equivalent with SetParent() method.
Since:
  • 3.3
SetItem

Methods

DateToPercent(date) → {number}

The DateToPercent() method gets the percent of the giving date relative to the start/end margins of the bar, as 0 for start and 1(100%) for end margin of the bar
Parameters:
Name Type Description
date any Specifies the date to get percent for
Returns:
Returns the percent of date relative to the start/end margins of the bar
Type
number
DateToPercent

DefineSummaryBars(itemAdd, keyAdd)

The DefineSummaryBars() method defines bars of the summary bar. The UndefineSummaryBars(itemRemove, keyRemove) method undefines bars of the summary bar.
Parameters:
Name Type Description
itemAdd any Indicates an item-bar itself (one argument), or the item that hosts the item-bar (two arguments), as explained:
  • itemAdd {ItemBar}, specifies the item-bar itself, as an object of ItemBar type (keyAdd parameter has no effect)
  • itemAdd {ItemBar[]}, specifies a collection of item-bars, as an array of [ItemBar] type (keyAdd parameter has no effect)
  • itemAdd {object}, specifies a collection of item-bars, as an object of exontrol.Arr([ItemBar]) type (keyAdd parameter has no effect)
  • itemAdd {Item}, specifies the item itself, as an object of Item type
  • itemAdd {Item[]}, specifies a collection of items, as an array of [Item] type
  • itemAdd {object}, specifies a collection of items, as an object of exontrol.Arr([Item]) type
  • itemAdd {Items}, specifies all items, as an object of Items type
  • 0 {number}, indicates all items
  • -1 {number}, indicates the direct descendents/children items of the current item
  • -2 {number}, indicates the leaf descendents/items of the current item (where a leaf or terminal item is an item with no child items)
  • -3 {number}, indicates all descendents/children items of the current item (recursively)
keyAdd any indicates the key of the bar to include in the summary bar (null/undefined for keyMatch equivalent of all or "<*>"). The keyAdd parameter supports pattern if specified such as "", where the pattern may contain wild card characters such as:
  • '?' for any single character
  • '*' for zero or more occurrences of any character
  • '#' for any digit character
(for instance, DefineSummaryBars(,"") includes bars whose key start with character K into the summary bar)
DefineSummaryBars

GetAlignPercentCaption() → {number}

The GetAlignPercentCaption() method gets the horizontal alignment of the bar's percent-caption (Only bars of alignPercentCaption-type ("A%B") display and handle the inner progress-bar)
Returns:
Returns the horizontal alignment of the bar's percent-caption, as one of the following value:
  • 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
GetAlignPercentCaption

GetBar() → {Bar}

The GetBar() method gets the gantt-bar associated with the current item-bar
Returns:
Returns null (no type-bar found) or an object of Bar type that indicates the type of the bas associated with the current item-bar
Type
Bar
Example
The following statements are equivalents:

 oItemBar.GetBar(), gets the gantt-bar associated with the current item-bar
 oItemBar.Bar, gets the gantt-bar associated with the current item-bar

where oItemBar is an object of ItemBar type
GetBar

GetCanBeLinked() → {boolean}

The GetCanBeLinked() method specifies whether the bar can be linked
Returns:
Returns true if the bar can be linked
Type
boolean
GetCanBeLinked
The GetCanEndLink() method specifies whether a link can end to this bar
Returns:
Returns true if a link can end to this bar
Type
boolean
GetCanEndLink

GetCanMove() → {boolean}

The GetCanMove() method specifies whether the user can move the bar within the same item by drag (requires to be selectable too)
Returns:
Returns true if the user can move the bar within the same item by drag
Type
boolean
GetCanMove

GetCanMoveToAnother() → {boolean}

The GetCanMoveToAnother() method specifies whether the bar can be moved to another item by drag and drop (requires to be selectable too)
Returns:
Returns true if the user can move the bar from an item to another by drag
Type
boolean
GetCanMoveToAnother

GetCanResize() → {number}

The GetCanResize() method specifies whether the user can resize the bar on both margins by drag (requires to be selectable too)
Returns:
Returns a value 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
GetCanResize

GetCanResizePercent() → {boolean}

The GetCanResizePercent() method specifies whether the user can resize the bar's percent at runtime (Only bars of percent-type ("A%B") display and handle the inner progress-bar)
Returns:
Returns true if the user can resize the bar's percent at runtime
Type
boolean
GetCanResizePercent
The GetCanStartLink() method specifies whether a link can start from this bar
Returns:
Returns true if a link can start from this bar
Type
boolean
GetCanStartLink

GetCaption() → {string}

The GetCaption() method gets the bar's caption. 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, ...
Returns:
Returns bar's caption.
Type
string
GetCaption

GetCaptionHOffset() → {number}

The GetCaptionHOffset() method defines the bar's caption horizontal-offset (relative to its alignment/default-position)
Returns:
Returns the bar's caption horizontal-offset (relative to its alignment/default-position)
Type
number
GetCaptionHOffset

GetCaptionVOffset() → {number}

The GetCaptionVOffset() method defines the bar's caption vertical-offset (relative to its alignment/default-position)
Returns:
Returns the bar's caption vertical-offset (relative to its alignment/default-position)
Type
number
GetCaptionVOffset

GetCriticalPath() → {number}

The GetCriticalPath() method indicates whether the current bar is part of the critical path (currently, the exBarCriticalPath property specifies the position (1-based) of the bar in the critical path)
Returns:
Returns 0(if the bar is not part of the critical path), or the position (1-based) of the bar in the critical path (In other words the current bar is part of the critical path, if the exBarCriticalPath property is not 0. Any positive value indicates the position of the current bar in the critical path)
Type
number
Example
The following statements are equivalents:

 oItemBar.GetCriticalPath(), indicates whether the current bar is part of the critical path (currently, the exBarCriticalPath property specifies the position (1-based) of the bar in the critical path)
 oItemBar.CriticalPath, indicates whether the current bar is part of the critical path (currently, the exBarCriticalPath property specifies the position (1-based) of the bar in the critical path)

where oItemBar is an object of ItemBar type
GetCriticalPath

GetDuration() → {number}

The GetDuration() method gets the item-bar's duration or length in days
Returns:
Returns the item-bar's duration or length in days (or hours if including the decimal point, for instance 0.5 indicates a 12 hours lenght)
Type
number
Example
The following statements are equivalents:

 oItemBar.GetDuration(), returns the item-bar's duration or length in days
 oItemBar.Duration, returns the item-bar's duration or length in days

where oItemBar is an object of ItemBar type
GetDuration

GetEffort() → {number|string}

The GetEffort() method gets the bar's effort.
Returns:
Returns the bar's effort, or the effort to execute an unit within the bar (bar's histogram value) 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
GetEffort

GetEnd() → {any}

The GetEnd() method gets the date-time the bar ends to.
Returns:
Returns the date-time the bar ends to, as one of the following:
  • value {null}, indicates the current date and time (equivalent of Now)
  • 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
Type
any
GetEnd

GetExtraCaption() → {string}

The GetExtraCaption() method gets the bar's extra caption. 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, ...
Returns:
Returns bar's extra caption.
Type
string
GetExtraCaption

GetExtraCaptionHAlign() → {number}

The GetExtraCaptionHAlign() method gets the horizontal-alignment / clipping of the item-bar's extra caption inside / outside the bar
Returns:
Returns 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
GetExtraCaptionHAlign

GetExtraCaptionHOffset() → {number}

The GetExtraCaptionHOffset() method defines the bar's extra-caption horizontal-offset (relative to its alignment/default-position)
Returns:
Returns the bar's extra-caption horizontal-offset (relative to its alignment/default-position)
Type
number
GetExtraCaptionHOffset

GetExtraCaptionVAlign() → {number}

The GetExtraCaptionVAlign() method gets the vertical-alignment of the item-bar's extra caption inside / outside the bar
Returns:
Returns 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
GetExtraCaptionVAlign

GetExtraCaptionVOffset() → {number}

The GetExtraCaptionVOffset() method defines the bar's extra-caption vertical-offset (relative to its alignment/default-position)
Returns:
Returns the bar's extra-caption vertical-offset (relative to its alignment/default-position)
Type
number
GetExtraCaptionVOffset

GetHAlignCaption() → {number}

The GetHAlignCaption() method gets the horizontal-alignment / clipping of the item-bar's caption inside / outside the bar
Returns:
Returns 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
GetHAlignCaption

GetHeight() → {number}

The GetHeight() method gets the bar's individual height.
Returns:
Returns the bar's height
Type
number
GetHeight

GetHistLegend() → {string}

The GetHistLegend() method gets the bar's description in histogram-legend
Since:
  • 1.6
Returns:
Returns bar's description in histogram-legend. The histogram-legend 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 histogram-legend-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
GetHistLegend

GetKey() → {string}

The GetKey() method returns the bar's key
Returns:
Returns bar's key
Type
string
GetKey

GetName() → {string}

The GetName() method returns the bar's name
Returns:
Returns bar's name
Type
string
GetName

GetOffset() → {number}

The GetOffset() method gets the bar's vertical-offset
Returns:
Returns the bar's vertical-offset
Type
number
GetOffset

GetOptions() → {object}

The GetOptions() method returns the bar's options at once
Returns:
Returns an object of ItemBarOptions type
Type
object
Example
The following statements are equivalents:

 oItemBar.GetOptions(), returns the options of the item-bar
 oItemBar.Options, returns the options of the item-bar

where oItemBar is an object of ItemBar type
GetOptions

GetOverlaidKey() → {string}

The GetOverlaidKey() method gets the z-order of the bar when it overlaps other bars (exOverlaidBarsCascade type)
Returns:
Returns the z-order of the bar when it overlaps other bars (exOverlaidBarsCascade type)
Type
string
GetOverlaidKey

GetOverviewColor() → {string}

The GetOverviewColor() method gets the item-bar's individual overview-color
Returns:
Indicates the item-bar's individual overview-color
Type
string
GetOverviewColor

GetParent() → {Item}

The GetParent() method gets the item that hosts the item bar. The GetParent() method is equivalent with the GetItem() method.
Returns:
Returns the parent item as an object of Item type
Type
Item
Example
The following statements are equivalents:

 oItemBar.GetParent(), gets the item that hosts the item bar
 oItemBar.Parent, gets the item that hosts the item bar

where oItemBar is an object of ItemBar type
GetParent

GetPercent() → {number}

The GetPercent() method gets the bar's percent as a value from 0(0%) to 1(100%) (Only bars of percent-type ("A%B") display and handle the inner progress-bar)
Returns:
Returns the bar's percent
Type
number
GetPercent

GetPercentCaptionFormat() → {string}

The GetPercentCaptionFormat() method gets the HTML format to display the bar's percent (%p keyword defines the bar's percent)
Returns:
Indicates the HTML format to display the bar's percent
Type
string
GetPercentCaptionFormat

GetPredecessor() → {string}

The GetPredecessor() method gets 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). 
Since:
  • 2.3
Returns:
Returns the list of predecessor bars, separated by comma.
Type
string
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
GetPredecessor

GetResourceFormat() → {string}

The GetResourceFormat() method specifies the format for displaying a bar's resource.
Since:
  • 3.2
Returns:
Returns the format to display the bar's resource. The expression supports the following keywords:
  • name, for the resource's 'name'
  • percent, 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'). The <%=%266%> sequence within the item-bar's caption displays the item's bar resource usage according to 'resourceFormat' field.
Type
string
GetResourceFormat

GetResources() → {string}

The GetResources() method 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%. The <%=%49%> sequence within the item-bar's caption displays the item's bar resource usage, including the percentage if applicable.
Since:
  • 3.2
Returns:
Returns the resources to be used by the current bar, separated by commas.
Type
string
GetResources

GetSelectable() → {boolean}

The GetSelectable() method indicates whether the bar is selectable or unselectable
Returns:
Returns true if the bar is selectable
Type
boolean
GetSelectable

GetSelected() → {boolean}

The GetSelected() method indicates whether the bar is selected or unselected
Returns:
Returns true if the bar is selected
Type
boolean
GetSelected

GetShape() → {any}

The GetShape() method returns the bar's individual shape.
Returns:
Returns the bar's individual shape, as one 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
any
GetShape

GetShowCaption() → {boolean}

The GetShowCaption() method specifies whether the item-bar's caption is visible or hidden
Returns:
Returns true if the item-bar's caption is visible or hidden
Type
boolean
GetShowCaption

GetShowExtraCaption() → {boolean}

The GetShowExtraCaption() method specifies whether the item-bar's extra caption is visible or hidden
Returns:
Returns true if the item-bar's extra caption is visible or hidden
Type
boolean
GetShowExtraCaption

GetShowPercentCaption() → {boolean}

The GetShowPercentCaption() method specifies whether the bar's percent-caption is visible or hidden (Only bars of percent-type ("A%B") display and handle the inner progress-bar)
Returns:
Returns true if the bar's percent-caption is visible or hidden
Type
boolean
GetShowPercentCaption

GetStart() → {any}

The GetStart() method gets the date-time the bar starts from.
Returns:
Returns the date-time the bar starts from, as one of the following:
  • value {null}, indicates the current date and time (equivalent of Now)
  • 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
Type
any
GetStart

GetSuccessor() → {string}

The GetSuccessor() method gets 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). 
Since:
  • 2.3
Returns:
Returns the list of successor bars, separated by comma.
Type
string
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
GetSuccessor

GetSummaryBarShape() → {string}

The GetSummaryBarShape() method defines the shape to apply on the background of all summary-bar's child item-bars
Returns:
Returns the shape to apply on the background of all summary-bar's child item-bars, as one 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
string
GetSummaryBarShape

GetToolTip() → {string}

The GetToolTip() method gets the bar's tool-tip
Returns:
Returns bar's tool-tip. 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
GetToolTip

GetVAlignCaption() → {number}

The GetVAlignCaption() method gets the vertical-alignment of the item-bar's caption inside / outside the bar
Returns:
Returns 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
GetVAlignCaption

Remove()

The Remove() method removes the bar itself from its collection (removes the item-bar from the item).
Remove

SetAlignPercentCaption(value)

The SetAlignPercentCaption() method horizontally aligns the bar's percent-caption (Only bars of alignPercentCaption-type ("A%B") display and handle the inner progress-bar)
Parameters:
Name Type Description
value number Specifies horizontal alignment of the bar's percent-caption, as one of the following value:
  • 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 )
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
SetAlignPercentCaption

SetCanBeLinked(value)

The SetCanBeLinked() method specifies whether the bar can be linked
Parameters:
Name Type Description
value boolean Indicates true if the bar can be linked
Example
false {boolean}, no link can start from, or end into the current bar
 true {boolean} or null {null}, the bar can be linked
SetCanBeLinked
The SetCanEndLink() method specifies whether a link can end to this bar
Parameters:
Name Type Description
value boolean Indicates true if link can end to this bar
Example
false {boolean}, no link can end on this bar
 true {boolean} or null {null}, any link can end on this bar
SetCanEndLink

SetCanMove(value)

The SetCanMove() method specifies whether the user can move the bar within the same item by drag (requires to be selectable too)
Parameters:
Name Type Description
value boolean Indicates whether the item-bar is movable
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
SetCanMove

SetCanMoveToAnother(value)

The SetCanMoveToAnother() method specifies whether the bar can be moved to another item by drag and drop (requires to be selectable too)
Parameters:
Name Type Description
value boolean Indicates whether the item-bar is movable
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
SetCanMoveToAnother

SetCanResize(value)

The SetCanResize() method specifies whether the user can resize the bar on specifies whether the user can resize the bar on both margins by drag (requires to be selectable too)
Parameters:
Name Type Description
value number Specifies a value that determines whether the item-bar is resizable 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
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
SetCanResize

SetCanResizePercent(value)

The SetCanResizePercent() method shows or hides the bar's percent-caption (Only bars of percent-type ("A%B") display and handle the inner progress-bar)
Parameters:
Name Type Description
value boolean Indicates whether the user can resize the bar's percent at runtime
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
SetCanResizePercent
The SetCanStartLink() method specifies whether a link can start from this bar
Parameters:
Name Type Description
value boolean Indicates true if link can start from this bar
Example
false {boolean}, no link can start from the current bar
 true {boolean} or null {null}, any link can start from the current bar
SetCanStartLink

SetCaption(value)

The SetCaption() method sets the bar's caption. 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, ...
Parameters:
Name Type Description
value string Specifies bar's caption
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 )
SetCaption

SetCaptionHOffset(value)

The SetCaptionHOffset() method changes the bar's caption horizontal-offset (relative to its alignment/default-position)
Parameters:
Name Type Description
value number Specifies the bar's caption horizontal-offset (relative to its alignment/default-position)
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
SetCaptionHOffset

SetCaptionVOffset(value)

The SetCaptionVOffset() method changes the bar's caption vertical-offset (relative to its alignment/default-position)
Parameters:
Name Type Description
value number Specifies the bar's caption vertical-offset (relative to its alignment/default-position)
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
SetCaptionVOffset

SetDuration(value)

The SetDuration() method sets the item-bar's duration or length in days
Parameters:
Name Type Description
value number Specifes the item-bar's duration or length in days (or hours if including the decimal point, for instance 0.5 indicates a 12 hours lenght). The item-bar's start/end margins are computed as explained:
  • 0 {number}, specifies the zero-length, so the item-bar's end margins is set to start
  • positive {number}, the item-bar's end margins is set to start + duration
  • negative {number}, the item-bar's start margins is set to end + duration
SetDuration

SetEffort(value)

The SetEffort() method sets the bar's effort
Parameters:
Name Type Description
value number | string Specifies bar's effort, or the effort to execute an unit within the bar (bar's histogram value) 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
SetEffort

SetEnd(value)

The SetEnd() method changes the date-time the bar ends to
Parameters:
Name Type Description
value any Specifies date-time the bar ends to, as one of the following:
  • value {null}, indicates the current date and time (equivalent of Now)
  • 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
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
SetEnd

SetExtraCaption(value)

The SetExtraCaption() method sets the bar's extra caption. 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, ...
Parameters:
Name Type Description
value string Specifies bar's extra caption
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 )
SetExtraCaption

SetExtraCaptionHAlign(value)

The SetExtraCaptionHAlign() method sets the horizontal-alignment / clipping of the item-bar's extra caption inside / outside the bar
Parameters:
Name Type Description
value number Indicates 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).
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 )
SetExtraCaptionHAlign

SetExtraCaptionHOffset(value)

The SetExtraCaptionHOffset() method changes the bar's extra-caption horizontal-offset (relative to its alignment/default-position)
Parameters:
Name Type Description
value number Specifies the bar's extra-caption horizontal-offset (relative to its alignment/default-position)
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
SetExtraCaptionHOffset

SetExtraCaptionVAlign(value)

The SetExtraCaptionVAlign() method sets the vertical-alignment of the item-bar's extra caption inside / outside the bar
Parameters:
Name Type Description
value number Indicates 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).
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
SetExtraCaptionVAlign

SetExtraCaptionVOffset(value)

The SetExtraCaptionVOffset() method changes the bar's extra-caption vertical-offset (relative to its alignment/default-position)
Parameters:
Name Type Description
value number Specifies the bar's extra-caption vertical-offset (relative to its alignment/default-position)
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
SetExtraCaptionVOffset

SetHAlignCaption(value)

The SetHAlignCaption() method sets the horizontal-alignment / clipping of the item-bar's caption inside / outside the bar
Parameters:
Name Type Description
value number Indicates 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).
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 )
SetHAlignCaption

SetHeight(value)

The SetHeight() method sets the bar's individual height
Parameters:
Name Type Description
value number Specifies the bar's individual height
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
SetHeight

SetHistLegend(value)

The SetHistLegend() method sets the bar's description in histogram-legend. The histogram-legend 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 histogram-legend-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, ...
Parameters:
Name Type Description
value string Specifies bar's description in histogram-legend
Since:
  • 1.6
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
SetHistLegend

SetKey(value)

The SetKey() method changes the bar's key
Parameters:
Name Type Description
value string Specifies bar's key
Example
"A" {string}, defines a bar with the key "A"
SetKey

SetMove(value)

The SetMove() method moves the item-bar by days
Parameters:
Name Type Description
value number Specifies the number of days to move the item-bar (or hours if including the decimal point, for instance 0.5 moves by 12 hours)
SetMove

SetName(value)

The SetName() method changes the bar's name
Parameters:
Name Type Description
value string Specifies bar's name
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.
SetName

SetOffset(value)

The SetOffset() method sets the bar's vertical-offset
Parameters:
Name Type Description
value number Specifies bar's vertical-offset
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
SetOffset

SetOptions(oOptions)

The SetOptions() method changes the bar's options (visibility, name, ...) at once
Parameters:
Name Type Description
oOptions object Specifies an object of ItemBarOptions type that holds information about the bar, such as name, shape and so on. If the oOptions parameter is not-of object type it indicates the bar's name instead
SetOptions

SetOverlaidKey(value)

The SetOverlaidKey() method sets the z-order of the bar when it overlaps other bars (exOverlaidBarsCascade type)
Parameters:
Name Type Description
value string Specifies the z-order of the bar when it overlaps other bars (exOverlaidBarsCascade type)
Example
"Z" {string}, all overlaid-bars of the same overlaid-key "Z" are displayed on the same level
SetOverlaidKey

SetOverviewColor(value)

The SetOverviewColor() method sets the item-bar's individual overview-color
Parameters:
Name Type Description
value string Specifies the item-bar's individual overview-color
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
SetOverviewColor

SetParent(item)

The SetParent() method sets the item to host the item-bar (moves the item-bar from an item to another). The SetParent() method is equivalent with SetItem() method.
Parameters:
Name Type Description
item any The item parameter could be any of the following:
  • item {number}, indicates a numeric value that defines the index of the item to request
  • item {string}, specifies a string expression that defines the identifier/key of the item to request
  • item {Item}, specifies the object reference to the item to request for
SetParent

SetPercent(value)

The SetPercent() method sets the bar's percent as a value from 0(0%) to 1(100%) (Only bars of percent-type ("A%B") display and handle the inner progress-bar)
Parameters:
Name Type Description
value number Specifies bar's percent
Example
0 {number} or null {null}, the bar's percent is set to 0%
 1 {number}, the bar's percent is set to 100%
SetPercent

SetPercentCaptionFormat(value)

The SetPercentCaptionFormat() method sets the HTML format to display the bar's percent (%p keyword defines the bar's percent)
Parameters:
Name Type Description
value string Indicates the HTML format to display the bar's percent
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
SetPercentCaptionFormat

SetPredecessor(value)

The SetPredecessor() method sets the list of predecessor bars, separated by comma.
Parameters:
Name Type Description
value string Specifies 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). 
Since:
  • 2.3
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
SetPredecessor

SetResourceFormat(value)

The SetResourceFormat() method specifies the format for displaying a bar's resource. To get the HTML value of the formatted string using the bar's resources, use resourcesFormat(266) (note: not 'resourceFormat', which lacks the 's').
Parameters:
Name Type Description
value string Specifies the format to display the bar's resource. The expression supports the following keywords:
  • name, for the resource's 'name'
  • percent, for the usage percentage, which is a double value between 0 and 1
      The <%=%266%> sequence within the item-bar's caption displays the item's bar resource usage according to 'resourceFormat' field.
Since:
  • 3.2
Example
null {null}, displays the default format, equivalent of "name + ((percent - 1)? `[` + round(percent*100) + `%]` : ``)"
 "name" {string}, displays just the name of the resource
 "name + ((percent - 1)? `(` + round(percent*100) + `%)` : ``)" {string}, displays the name of the resource followed by its percentage in parentheses
SetResourceFormat

SetResources(value)

The SetResources() method 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%.
Parameters:
Name Type Description
value string Specifies the resources of the current bar, separated by commas
  • 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.
The <%=%49%> sequence within the item-bar's caption displays the item's bar resource usage, including the percentage if applicable.
Since:
  • 3.2
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
SetResources

SetSelectable(value)

The SetSelectable() method specifies whether the bar is selectable or unselectable
Parameters:
Name Type Description
value boolean Indicates whether the bar is selectable or unselectable
Example
false {boolean}, the item-bar is unselectable (the user can select the item-bar)
 true {boolean}, the item-bar is selectable
SetSelectable

SetSelected(value)

The SetSelected() method selects or unselects the current-bar
Parameters:
Name Type Description
value boolean Specifies whether the bar gets selected or unselected
Example
false {boolean}, unselects the bar
 true {boolean}, selects the bar
SetSelected

SetShape(value)

The SetShape() method changes the bar's individual shape
Parameters:
Name Type Description
value string Specifies bar's individual shape, as one 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
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
SetShape

SetShowCaption(value)

The SetShowCaption() method shows or hides the item-bar's caption
Parameters:
Name Type Description
value boolean Indicates whether the item-bar's caption is visible or hidden
Example
false {boolean}, hides the item-bar's caption
true {boolean}, shows the item-bar's caption
SetShowCaption

SetShowExtraCaption(value)

The SetShowExtraCaption() method shows or hides the item-bar's extra caption
Parameters:
Name Type Description
value boolean Indicates whether the item-bar's extra caption is visible or hidden
Example
false {boolean}, hides the item-bar's extra caption
true {boolean}, shows the item-bar's extra caption
SetShowExtraCaption

SetShowPercentCaption(value)

The SetShowPercentCaption() method shows or hides the bar's percent-caption (Only bars of percent-type ("A%B") display and handle the inner progress-bar)
Parameters:
Name Type Description
value boolean Indicates whether the bar's percent-caption is visible or hidden
Example
false {boolean} or null {null}, the bar's percent-caption is hidden
 true {boolean}, the bar's percent-caption is shown
SetShowPercentCaption

SetStart(value)

The SetStart() method changes the date-time the bar starts from
Parameters:
Name Type Description
value any Specifies date-time the bar starts from, as one of the following:
  • value {null}, indicates the current date and time (equivalent of Now)
  • 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
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
SetStart

SetSuccessor(value)

The SetSuccessor() method sets the list of successor bars, separated by comma.
Parameters:
Name Type Description
value string Specifies 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). 
Since:
  • 2.3
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
SetSuccessor

SetSummaryBarShape(value)

The SetSummaryBarShape() method changes the shape to apply on the background of all summary-bar's child item-bars
Parameters:
Name Type Description
value string Specifies the shape to apply on the background of all summary-bar's child item-bars, as one 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
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
SetSummaryBarShape

SetToolTip(value)

The SetToolTip() method sets the bar's tool-tip. 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, ...
Parameters:
Name Type Description
value string Specifies bar's tool-tip
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
SetToolTip

SetVAlignCaption(value)

The SetVAlignCaption() method sets the vertical-alignment of the item-bar's caption inside / outside the bar
Parameters:
Name Type Description
value number Indicates 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).
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
SetVAlignCaption

UndefineSummaryBars(itemRemove, keyRemove)

The UndefineSummaryBars() method undefines bars of the summary bar. The DefineSummaryBars(itemAdd, keyAdd) method defines bars of the summary bar.
Parameters:
Name Type Description
itemRemove any Indicates an item-bar itself (one argument), or the item that hosts the item-bar (two arguments), as explained:
  • itemRemove {ItemBar}, specifies the item-bar itself, as an object of ItemBar type (keyRemove parameter has no effect)
  • itemRemove {ItemBar[]}, specifies a collection of item-bars, as an array of [ItemBar] type (keyRemove parameter has no effect)
  • itemRemove {object}, specifies a collection of item-bars, as an object of exontrol.Arr([ItemBar]) type (keyRemove parameter has no effect)
  • itemRemove {Item}, specifies the item itself, as an object of Item type
  • itemRemove {Item[]}, specifies a collection of items, as an array of [Item] type
  • itemRemove {object}, specifies a collection of items, as an object of exontrol.Arr([Item]) type
  • itemRemove {Items}, specifies all items, as an object of Items type
  • 0 {number}, indicates all items
  • -1 {number}, indicates the direct descendents/children items of the current item
  • -2 {number}, indicates the leaf descendents/items of the current item (where a leaf or terminal item is an item with no child items)
  • -3 {number}, indicates all descendents/children items of the current item (recursively)
keyRemove any indicates the key of the bar to exclude from the summary bar (null/undefined for keyMatch equivalent of all or "<*>"). The keyRemove parameter supports pattern if specified such as "", where the pattern may contain wild card characters such as:
  • '?' for any single character
  • '*' for zero or more occurrences of any character
  • '#' for any digit character
(for instance, UndefineSummaryBars(,"") excludes bars whose key start with character K from the summary bar)
UndefineSummaryBars