Bar class (Gantt)

Type:

• ItemBarOptions

Example

null {null}, resets all default-options
 {selectable: false} {object}, makes unselectable all bars of the current type
 {caption: "<%=%C0%>"} {object}, all bars of the current type displays the caption of the first column

 The following example shows how to set the default options of a "Task%Progress" bar of percent-type, so all item-bars of "Task%Progress" type will display their inner progress-bar's percent value using the caption format defined by percentCaptionFormat field, and the percent caption will be aligned to the left of the progress-bar:

 oGantt.Chart.Bars.Add(
 {
   name: "Task%Progress",
   shortcut: "Task",
   def:
   {
     percent: 0,
     showPercentCaption: true,
     percentCaptionFormat: "<fgcolor white><sha black;2;0>%p%",
     alignPercentCaption: 0
   }
 })

The following statements are equivalents:

 oGantt.Bar("Task").SetDef({selectable: false}) {void}, makes unselectable all bars of "Task" type
 oGantt.Bar("Task").Def = {selectable: false} {void}, makes unselectable all bars of "Task" type

where oGantt is an object of Chart type

Type:

• string

Example

"" or "value" {string}, specifies that the bar's histogram value is displayed as it is (unformatted)
"value + '%'" {string}, displays the value followed by an percent character
"value format '1'" {string}, displays the value using a single digit
"value = int(value) ? value : value format ''" {string}, displays the value without digits if integer (.00), and with two digits for any other type

Type:

• number

Example

null {null}, the bar's height is 18 by default
-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

Type:

• string

Example

"" {string}, hides the critical value
"red" {string}, shows bars that exceed the critical value in red
"rgba(255,0,0,0.5)" {string}, shows bars that exceed the critical value in partial-transparent red

Type:

• number

Example

0 {number}, any bar is critical
 10 {number}, any bar that exceeds the value of 10 into histogram is critical

The following statements are equivalents:

 oGantt.Bar("Task").SetHistogramCriticalValue(10), sets the critical value of "Task" bar to 10
 oGantt.Bar("Task").HistogramCriticalValue = 10, sets the critical value of "Task" bar to 10

where oGantt is an object of Chart type

Type:

• string

Example

"" {string}, no cumulative-color is applied
"red,green,blue" {string}, the histogram shows the bars of the current type, in red, green and blue

Type:

• Gantt.HistogramCumulativeOriginalColorBarsEnum

Example

null {null} or 0 or exontrol.Gantt.HistogramCumulativeOriginalColorBarsEnum.exChangeColor {number}, the color for the bar and its reflection in the histogram is showing the corresponding cumulative color
1 or exontrol.Gantt.HistogramCumulativeOriginalColorBarsEnum.exChangeColor {number}, the color for the bar and its reflection in the histogram is not changed

Type:

• number

Example

-1 {number}, no histogram-legend is displayed for the current type of bars
1 {number}, the column with the index 1, provides the histogram-legend for the current type of bars.

Type:

• string

Example

"" {string}, no grid lines are shown
"gray" {string}, shows the histogram's grid lines in gray
"rgba(0,0,0,0.5)" {string}, shows the histogram's grid lines in partial-transparent black

Type:

• number

Example

0 {number}, re-scales the histogram to fit all histogram-units
10 {number}, prepares the histogram to display up to 10 items (rescales the histogram to fit all, if it requires more)
-10 {number}, the histogram always displays 10 items

Type:

• string

Example

"" {string}, no ruler lines are shown
"black" {string}, shows the histogram's ruler lines in black
"rgba(0,0,0,0.5)" {string}, shows the histogram's ruler lines in partial-transparent black

Type:

• any

Example

"" {string}, null {null}, no shape is applied (the bar is not represented into the control's histogram)
"red" {string}, shows rectangular-red histogram
'{"frameColor": "black", "primitive": "Spline"}' {string}, shows spline-curve histogram
'{"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.Gantt.xxx or exontrol.Shapes.xxx is applied on the object's background. If the xxx field is missing, no custom shape is applied (nodefault object's shape is be applied)
"Button" or exontrol.Shapes.Button {object}, applies the "Button" shape on the object as defined into exontrol.Shapes namespace (@since 5.2)
{frameColor: "blue", frameSize: 3, fillColor: "rgba(0,0,255,0.5)", primitive: "Spline"} {object}, shows filled spline-curve histogram

Type:

• Gantt.HistogramTypeEnum

Example

0 or exontrol.Gantt.HistogramTypeEnum.exHistOverload {Gantt.HistogramTypeEnum}, shows the overloads and subloads of your current planning situation (the histogram-graph shows the count of specified tasks day by day, or unit by unit)
257 or exontrol.Gantt.HistogramTypeEnum.exHistOverAllocation | exontrol.Gantt.HistogramTypeEnum.exHistCumulative {Gantt.HistogramTypeEnum}, shows in percents, the over-allocations of your current planning situation using the effort of the task divided by the length of the task (effort/length). Bars in the histogram show cumulative colors

Type:

• string

Example

"Task" {string}, names the bar to "Task"
"Task%Progress" {string}, defines a "Task" bar of percent-type, so it displays the bar's "percent" value using the "Progress" shape
"Summary%Task" {string}, defines a "Summary" bar of percent-type, so it displays the bar's "percent" value using another "Task" shape
"Task%red" {string}, defines a "Task" bar of percent-type, so it displays the bar's "percent" value using the "red" color
"Task%Button" {string}, defines a "Task" bar of percent-type, so it displays the bar's "percent" value using the "Button" already-defined shape
'Summary%{"fillColor": "rgba(0,0,0,0.5)", "client": "[,y+2*height/3+3,,height/3]", "primitive": "round"}' {string}, defines a "Summary" bar of percent-type, so it displays the bar's "percent" value using a predefined shape

Type:

• BarOptions

Example

The following statements are equivalents:

 oBar.SetOptions({name: "Task", shape: exontrol.Shapes.Button}), changes the bar's name to "Task" and its shape to exontrol.Shapes.Button
 oBar.Options = {name: "Task", shape: exontrol.Shapes.Button}, changes the bar's name to "Task" and its shape to exontrol.Shapes.Button
 oBar.Name = "Task"; oBar.Shape = exontrol.Shapes.Button, changes the bar's name to "Task" and its shape to exontrol.Shapes.Button

where oBar is an object of Bar type

Type:

• object

Example

null {null},  specifies the default option for all overlaid types
{cascade: 4} {object}, changes the vertical-distance between two bars that covers each other, when overlaidType is exOverlaidBarsCascade

Type:

• string

Example

"" {string} or null {null}, only bars of the same type get arranged based on the overlaidType property.
"Task,Milestone,Deadline" {string} , all these type of bars get arranged based on the overlaidType property.

Type:

• Gantt.OverlaidBarsTypeEnum

Example

0 {number} or null {null}, no overlaid bars are shown
4 or exontrol.Gantt.OverlaidBarsTypeEnum.exOverlaidBarsCascade {number}, the bars gets arranged as a cascade with the z-order being indicated by ItemBar(exBarOverlaidCascade) key.

Type:

• string

Example

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

Type:

• any

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.Gantt.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)
"Button" or exontrol.Shapes.Button {object}, applies the "Button" shape on the object as defined into exontrol.Shapes namespace (@since 5.2)

Type:

• string

Example

"Task" {string}, renames the bar to "Task"

The following sample adds a "Task%Progress" bar with "Task" shortcut, so the bar can be referred by its name "Task%Progress" or by its shortcut "Task":

 oGantt.Chart.Bars.Add(
 {
   name: "Task%Progress",
   shortcut: "Task",
   def:
   {
     percent: 0,
     showPercentCaption: true,
     percentCaptionFormat: "<fgcolor white><sha black;2;0>%p%",
     alignPercentCaption: 0
   }
 })

Type:

• string

Example

"0", "" {string} or null {null}, the bar's histogram value is never shown
"1" {string}, the bar's histogram value is always shown (#1)
"'green'" {string}, the bar's histogram value is always shown in green (please pay attention to green which is quoted by ' characters)
"value > 5 ? 'red' : 0" {string}, the bar's histogram value is displayed in red only if it greater than 5
"value < 5 ? '#FF' : 'rgba(0,0,0,0.5)'" {string}, shows the bar's histogram value in blue if it less than 5, else in partial-gray

Example

The following statements are equivalents:

 oBar.Remove(), removes the bar itself from its collection
 oGantt.Chart.Bars.Remove(oBar), removes the bar itself from its collection

where oBar is an object of Bar type