Gantt resources

TreeGrid documentation

The resource list is defined globally for whole chart in <Resources> root tag.
The individual resources can be assigned to tasks to compute their price.
The tasks can filtered according to the assigned resources.
TreeGrid provides various calculations for resources and prices.

Resources list

Resources are defined globally for the whole project in root tag <Resources>, individual resources are defined in nested <R> tags.

For example simple definition can be:
<Grid>

...

<Resources>

<R Name='Resource1' Price='100'/>
<R Name='Resource2' Price='200'/>

</Resources>

</Grid> One resource definition. It can be placed only in root <Resources> tag.
Unique name of the resource.
Text displayed for the resource in the popup menu for assigning resources to the task.
If not set, the Name is used.
Type of the resource.
1 - Work, not consumed resource. The Availability is the maximal count per time unit.
2 - Material, consumed resource. The Availability is calculated from start and consumed per every used time unit.
How the Material type resource is consumed.
0 - a part per every used time unit
1 - all on start
2 - all on end
3 - all on middle
Price per one resource unit.
The resource units are set by GanttDataUnits.
Resource availability. Maximal summary count of resource units assigned to all tasks at one time unit (Type=1) or for whole project (Type=2).
Since 7.0 it can contain more values for given date ranges, in format: repeater1#date1a~date1b#count1;repeater2#date2a~date2b#count2;....
The possible values of repeater are the same as GanttUnits, e.g. "w", "d", "h" or "1", "0.5", "2", ... If the repeater is not present, the date range is not repeated
The date range is range where the count of resources is available. The date range can be periodically repeated by the repeater.
For Material Type resources is used only the first date from date range as date when the count of resources arrives.
If some date ranges are overlapped, the count values are summed. The count can be also negative to reduce the count for some range.
For example "3;w#1/3/2011~1/4/2011#-1" - The resource count is 3 except Mondays when is 2.
It is possible to limit the repeating - when the date range is wider than the repeater, the range is rounded to the repeater range and repeated only between the dates.
For example 'w#1/5/2008~12/29/2008#1' marks all weekends, but only in year 2008.
The availability can be easily edited by users in dialog for Dates type Button.
Renamed to Availability
The array of all resources in grid, accessible by its name.
The resource objects contain all the XML attributes like Price or Availability.
Example: Grid.Resources.Worker.Price = 150;

Resources assign

Every task can have assigned one or more resources from global <Resources> list. It can have also specified how many resource units it uses.
The resources assigned to the main bar task. It can be column name or string.
It is used only for Gantt tasks listed in GanttTask (by default it is only the first main bar plan)
Since 10.0 it is not used for run, for run bar use GanttRunResources, for run box use Resources.
The X is main bar plan, for the first main plan is empty (GanttResources, GanttResources1, GanttResources2, ...). See GanttCount.
It is in format: name1*amount1+extra1;name2*amount2+extra2;...
Resources are separated by semicolon (defined by <Format ValueSeparator/>) (note, in Run box Resources is used '#' instead of the semicolon)
The name and amount are separated by asterisk (defined by <Format CountSeparator/>)
The extra is separated by plus (defined by <Format AddSeparator/>)
The name is resource Name.
The amount is amount of resource units per task data unit. The amount can be omitted if it is 1 and extra is not defined. Or is 0 and extra is defined.
The extra is extra amount of resource units independent on the task duration. The extra can be omitted if it is 0. This item changed its meaning in 7.0!
If the name and amount are both omitted, the extra is extra price for the task independent on resources and task duration. There should be only one such extra price per task.
The GanttResources can be also just plain text to display it next to task, without filtering and pricing functionality.
Resources assigned to run bar task, only if set Run in GanttTask.
For resources added to run box use box Resources instead.
Format is the same as GanttResources.
How the resources can be assigned to the task, affects the menu for assigning resources.
The behavior can be more modified also by GanttResourcesMenu.
0 - Only one resource can be assigned to the task, the menu is clickable. The Extra prices are not shown.
1 - The resources can be assigned only as 0/1, the checkboxes are shown - set Default: { Bool:1 }
2 - The resources can be assigned as 0 - 10, the enums are shown - set Default: { Enum:1, Width:22, Items:["","1","2","3","4","5","6","7","8","9","10"] }
3 - The resources can be assigned as integers, the edits are shown - set Default: { Edit:1, Width:40, Type:”Int”, Size:5 }
4 - The resources can be assigned as floats, the edits are shown -
set Default: { Edit:1, Width:60, Type:"Float", Format:"0.##;;", DisplayFormat:"0.00;;", EditMask:"^\\d{0,5}(\\.\\d{0,2})?$"}
5 - Only extra price and resource units permitted by GanttResourcesExtra are shown.
If and how will be possible to add extra prices and resource units to tasks when editing resources from menu.
0 - no extra price possible.
1 - one extra price per whole task
2 - extra resource units per task
3 - both extra price and extra units
If set to 1 or 3, the resource names should not be numbers.
Optional menu to assign the resources to the task. Here is possible to specify which resources and how can be assigned to the individual task.
It is standard TreeGrid menu.
The items must be named (Name attribute) as resource names to be correctly assigned.
The Name of the extra task price item must be "Extra", the names of extra resource units must be name+"Extra"
Lets a user to assign resources for the task in popup menu

Resources filter

The tasks can be easily filtered according to assigned resources.
User interface for filtering by resources can be added to grid by cell Type='SelectGanttResources'
Special combo box to choose resources to display in grid. It hides all rows that do not contain any selected resources.
It presets these cell attribute: Type="Html" Button="Defaults" Defaults= "|*None|-|*RowsVariableCol"+resource col+"*"
OnChange= "Grid.FilterTextRange('"+ resource col +"',Value);" Range="1"
Requires GanttResources to be defined in <C> tag.
Predefined filter for the resources, contains the resource names separated by semicolon.
The grid will show only tasks containing these resources.

Resources calculations

Returns price of the bar according to its duration and assigned resources.
plan meaning changed in 10.0.
plan is main bar plan or run box id or '-' for run bar.
If plan is null, calculates sum of all prices of all main bar plans and run boxes/bar in GanttTask.
If plan is '-' calculates the whole run bar if GanttTask is 'Run', or calculates sum of all prices of all run boxes if GanttTask is 'Box'.
In Formula it can be called as Grid.GetGanttPrice(Row,"XXX") where XXX is Gantt column name.
Returns information about the resource res usage between dates start and end.
The start and end can be Date object, number of milliseconds or date string in English.
def - name of default row (Def attribute). Only variable rows with this default will be iterated. If not set, all variable rows are iterated.
col - gantt column to use, if not set, the first gantt column in grid will be used.
type = 0 - returns Peak - Maximum count of the resource in the range at the same time
type = 1 - returns Total - Sum of all resource units used in the range
type = 2 - returns Average - Average usage of the resource in the range
Returns all errors or usage in grid for the resource name.
Returns two dimensional array [[Start1,End1,Count1], [Start2,End2,Count2], [Start3,End3,Count3],...]
In date range Start-End there is resource available Count. Negative Count means resource error.

type =	1 - resources usage (only usage)
	3 - resource availability (only availability),
	5 - free resources (availability - usage),
	6 - only resource errors (availability - usage, only negative Count),
	Other values reserved.

Returns Availability string as usage of given resource in chart.
Use it in formulas for own calculation and showing Availability chart.
The returned string can differ from standard availability format, but it is supported in availability chart and in negav.
name is the name of the resource. It does not need to be defined by <R> tag, it just checks the GanttResource attribute values of given tasks.
type is type of the resource, 1 - work, 2 - material.
consume (new 11.0) is consume type of material type resource, 0 per time unit, 1 all on start, 2 all on end, 3 all in the middle.
opt specifies which rows will be iterated: 0 - only the row, or the bit array:
def if set, only rows with Def attribute named def will be iterated
col the Gantt column
Called for every source row if its data will be added to the resource usage chart. It is called for every iterated rows (hidden, deleted, with different default).
use is true if the row would be added to the resource usage chart if this event would not be defined.
def is expected row def name, set in resource usage chart definition.
return true to use this row, false to ignore it or another row to be used instead.
Returns semicolon separated all resources used in the GanttRun in the row when GanttTask contains Box. col is Gantt column.
Usable to filter the row by this string in resources filter.
Removed, replaced by GetResourceErrors.
Removed, replaced by GetResourceErrors.
Returns maximal count of the resource used in grid at one time.
resource is Name of the resource.
def is name of default row (Def attribute). Only variable rows with this default will be iterated. If not set, all variable rows are iterated.
Returns count of all allocated units for given resource in the whole grid.
If the value is multiplied by resource price, you will get the summary cost of the resource in the project.
def is name of default row (Def attribute). Only variable rows with this default will be iterated. If not set, all variable rows are iterated.
Returns summary of extra prices assigned to all tasks.
def is name of default row (Def attribute). Only variable rows with this default will be iterated. If not set, all variable rows are iterated.
Since 7.0 version there are no extra prices per resource, only per task.

Availability chart

Universal chart to show availability or usage of normal or custom/not defined resource.
Defines the Availability chart sources.
Comma separated column (or row attribute) names, every value represents one chart.
For example GanttAvailability='A,B,C' shows three availability charts according to cell values in A, B and C column.

The Availability format (in the individual sources, e.g. in the cells A, B and C):
repeater1#date1a~date1b#count1;repeater2#date2a~date2b#count2;...
The possible values of repeater are the same as GanttUnits, e.g. "w", "d", "h" or "1", "0.5", "2", ... If the repeater is not present, the date range is not repeated.
The date range is range where the count of resources is available. The date range can be periodically repeated by the repeater.
For Material type resources is used only the first date from date range as date when the count of resources arrives.
If some date ranges are overlapped, the count values are summed. The count can be also negative to reduce the count for some range.
(Since 11.0) If count starts with '=', it resets the value in the range exactly to the count. For material it sets actual resource amount to the count. It affects only availability ranges before (in the Availability string).
If count is missing, it is 1.
All possible format combinations:

a)	Set repeater, date1, date2 and the date range is less than repeater range	e.g. "w#1/2/2016~1/4/2016#10", note 1/2/2016 is Saturday
Work:	The date12 range is periodically repeated in the whole chart	e.g. the count 10 is available on all weekends in the chart, on all workdays is 0
Material:	The material arrives on every date1, periodically repeated, date2 is ignored, the first batch arrives before or on the chart start	e.g. the count 10 arrives every Saturday in chart
b)	Set repeater, date1, date2 and the date range is greater than or equal to the repeater range	e.g. "w#1/2/2016~1/18/2016#10", note 1/2/2016 is Saturday, 1/18/2016 is Monday
Work:	The date12 range is rounded to the repeater range and repeated only between the dates	e.g. the count 10 is available on three weekends (1/2, 1/9 and 1/16), on other weekends and all workdays is 0
Material:	The material arrives on date1 and next dates periodically repeated, until it reaches date2. The date1 can be even less than chart start.	e.g. the count 10 arrives three times, on Saturdays 1/2, 1/9 and 1/16
c)	Set repeater and date1 (date2 is missing)	e.g. "w#1/2/2016#10", note 1/2/2016 is Saturday
Work:	It is not repeated range starting on date1 and lasting one repeater unit	e.g. the count 10 is available on one week 1/2/2016 - 1/11/2016
Material:	The material arrives on the date1 and every next repeated date till chart end/td>	e.g. the count 10 arrives on 1/2/2016 and every next Saturday
d)	Set date1 and date2 (repeater is missing)	e.g. "1/2/2016~1/4/2016#10", note 1/2/2016 is Saturday
Work:	It is not repeated range between the dates	e.g. the count 10 is available on one weekend 1/2/2016 - 1/4/2016
Material:	The material arrives once on the date1, the date2 is ignored	e.g. the count 10 arrives once on 1/2/2016
e)	Set date1 (repeater and date2 is missing)	e.g. "1/2/2016#10", note 1/2/2016 is Saturday
Work:	It is not repeated range from date1 to chart end	e.g. the count 10 is available since 1/2/2016 to chart end
Material:	The material arrives once on the date1	e.g. the count 10 arrives once on 1/2/2016
f)	Set repeater (date1 and date2 is missing)	e.g. "w##10"
Work:	The repeater is ignored, the count is available in the whole chart. It has sense only if set GanttAvailabilityDivide, to use the repeater as the range length for dividing by.	e.g. the count 10 is available in the whole chart
Material:	The material arrives on start of every repeated range in chart, the first batch arrives before or on the chart start	e.g. if the chart starts on 1/1/2016 the count 10 arrives on Sundays 12/27/2015, 1/3/2016, 1/10/2016 and so on
g)	Set nothing (only number as count)
Work:	The count is available in the whole chart	e.g. the count 10 is available in the whole chart
Material:	The material arrives once on the chart start	e.g. if the chart starts on 1/1/2016 the count 10 arrives on 1/1/2016

There are special settings to display global resource (defined in <R> tags) usage and availability charts. The resources are assigned to the Gantt tasks defined by GanttTask (main bar by default).
Instead of the column name use: resource_name#chart_type#def_name. It is possible to mix the resource and standard availability charts.
For example "R1#3,CellR2#1,A,B" it shows four charts, two for the resources R1 and R2 and two for the availability definition in cells A and B.
The resource_name can be direct resource name or column name where the resource name is stored.
The chart_type is:

The def_name is optional and if set, the resource usage chart iterates only rows with given Def name.
The resource usage for fixed row it counts all tasks in chart, for variable row it counts only children.
List of availability groups, comma separated. The groups are rendered in the specified order.
By default there is one availability group called "Availability". It is possible to define more separated groups of availability charts, every the group can contain also more individual charts.
The item in the list sets the part of every availability attribute name, it replaces the word "Availability" in the names.
For example, if set GanttAvailabilityGroups="A1,A2", there will be read the GanttAvailability attribute as GanttA1 and GanttA2. And similarly GanttAvailabilityType as GanttA1Type and GanttA2Type and so on.
If set, stacks the availability groups horizontally.
If set to 2, it uses / calculates the GanttAvailabilityMax / GanttAvailabilityMin from the first availability group.
The availability groups must be defined / joined or split to the same Gantt units to show correct charts, see GanttAvailabilitySplit.
The individual availability groups can be also horizontally or vertically stacked by GanttAvailabilityStack.
The GanttAvailabilityGroupsStack is defined for all availability groups together.
Type of the resource.
1 - Work, not consumed resource. Work resource is available only in defined range. It can be defined absolute (e.g. workers) or per range (e.g. budget), see GanttAvailabilityDivide
2 - Material, consumed resource. Material resource arrives on defined date and is available forever.
It can be: Name of custom CSS class to be used for the availability chart(s). To this name is added prefix GxGanttAvailability, where Gx is grid style prefix, e.g. GW.
There are predefined color classes: Aqua, Black, Blue, Fuchsia, Gray, Green, Lime, Maroon, Navy, Olive, Orange, Purple, Red, Silver, Teal, White, Yellow.
If no Class is defined, the chart is blue for positive numbers and red for negative number. These color classes provide the same color for both positive and negative numbers.
It can be:
Called to compute Availability CSS class dynamically according to the value.
value is the value to be shown in the chart, cls is predefined class.
src is source column, one part from GanttAvailability.
group (since 12.0) is actual item from GanttAvailabilityGroups.
Return new CSS class to be used as full class name including all prefixes, e.g. "GWGanttAvailabilityRed"
Called to modify one Availability rectangle or value in Values array.
Values is a JavaScript array of [string text, int y, int left, int width, string cls]. It is possible to modify one or more of the values in Values array.
row, col is actual Gantt cell.
value is the number from that is calculated the y and shown in text.
src is source column, one part from GanttAvailability.
start is start date of the rectangle, end is end date of the rectangle. In milliseconds.
min is minimal value permitted for the y. Usually negative or zero. In pixels.
max is maximal value permitted for the y. Usually positive or zero. In pixels.
group (since 12.0) is actual item from GanttAvailabilityGroups.
Return false to not display the rectangle at all.
How the GanttExclude in the target row will be applied to the chart.
It can be: a) one number as value for all Availability charts, b) comma separated numbers (the same count as the Availability definition), one value per availability chart.
Ignored for Material resources.
Format of the numbers shown in the availability chart.
The same as TreeGrid number format.
It can be: a) one number as value for all Availability charts, b) comma separated numbers (the same count as the Availability definition), one value per availability chart
Approximate width of one text label in the chart, in pixels.
Controls how many text values (the numbers), will be show in chart, the bigger value, the less texts.
It can be: a) one number as value for all Availability charts, b) comma separated numbers (the same count as the Availability definition), one value per availability chart
Vertical position of the individual Availability charts, in pixels. Similar to GanttTop.
It can be: a) one number as value for all Availability charts, b) since 12.0 comma separated numbers (the same count as the Availability definition), one value per availability chart
Height of every the availability chart, in pixels. If not set it set as row height minus the biggest GanttAvailabilityShift value.
The charts are not overflowed to this space, it is used just to calculate height of the charts.
If and how the charts will be stacked to one bar. 0 no, 1 vertically, 2 horizontally.
If stacked, all the charts are automatically split to the smallest parts among the charts.
To display summary label for vertically stacked chart, define another availability chart that sums all the charts and set its GanttAvailabilityVPos to 16 to show only its label.
To stack some charts vertically and some horizontally, define more GanttAvailabilityGroups and set GanttAvailabilityGroupsSpread for horizontal stacking.
How the text will be vertically positioned. Bit array.
It can be: a) one number as value for all Availability charts, b) comma separated numbers (the same count as the Availability definition), one value per availability chart

1.-3. bit (&7)	Vertical position of the text regarding to the bar.
	0 above, 1 top, 2 center, 3 bottom, 4 below
4. bit (&8)	If set, permits text showing outside the availability height
5. bit (&16)	If set, does not show the bar, only the text. For stacked bars it takes the bar height as zero.

It can be: a) one number as value for all Availability charts, b) comma separated numbers (the same count as the Availability definition), one value per availability chart
How the text will be horizontally positioned. 0 center, 1 left, 2 right, 3 center left half, 4 center right half
It can be: a) one number as value for all Availability charts, b) comma separated numbers (the same count as the Availability definition), one value per availability chart
Color class of the texts. If not set, it is used bar color set by GanttAvailabilityClass.
If set, it will repeat the text label every given pixels in large chart parts.
If overlaying texts are vertically shifted. 0 - no, 1 - yes, 2 yes, and displays all text, including near ones.
It can slow down the Gantt render! If set to 1, the zero values will be shown in chart too, as small positive boxes.
If set to 0, it can display adjacent ranges with the same value.
If set to 1, the adjacent ranges with the same value will be joined to longer range.
If set to 1, all the ranges will be split to GanttAvailabilityUnits.
If set to 2, it works like 1 and also the adjacent ranges inside one GanttAvailabilityUnits unit will be joined. The resulted value will be summary or maximum according to the GanttAvailabilitySum.
If set to 1, all the values shown on the chart will be multiplied by the length of the range in units set by GanttAvailabilityUnits.
If set to GanttUnits value, all the values shown on the chart will be multiplied by the length of the range in these units.
Since 11.0 it can be: a) one value as value for all Availability charts, b) comma separated values (the same count as the Availability definition), one value per availability chart
If set to 1, all the bars' heights on the chart will be multiplied by the length of the range in units set by GanttAvailabilityUnits.
If set to GanttUnits value, all the bars' heights on the chart will be multiplied by the length of the range in these units.
It can be: a) one value as value for all Availability charts, b) comma separated values (the same count as the Availability definition), one value per availability chart
If set to 1, all the counts in the availability string are divided by the date range length in GanttAvailabilityUnits.
If set to GanttUnits value, all the counts in the availability string are divided by the date range length in these units.
So it shows ratio counts instead of absolute counts. It affects both the availability bars and texts.
Can be used only for work type resource. It defines range resource like budget.
The divided values can be summed back in the same or different ranges by GanttAvailabilitySum (values) and / or by GanttAvailabilitySumBars (bars).
It can be: a) one value as value for all Availability charts, b) comma separated values (the same count as the Availability definition), one value per availability chart
Units (like GanttUnits) used for GanttAvailabilitySplit, GanttAvailabilityDivide and GanttAvailabilitySum.
If not set, it is GanttDataUnits value. If set to "0", it is GanttUnits value.
If the second and next level bars will be transparent to show also the bars under.
Showing many tags with opacity in Firefox can remarkably slow down the page.
0 - no, 1 - in all browsers except Firefox, 2 - in all browser
What will be shown in the chart: 0 - nothing, 1 - only bars, 2 - only texts, 3 - both bars and texts.
If set, calculates resources chart from all rows, including hidden / filtered rows.
Minimal value in the chart, specifies height of the chart, lower limit. Lower values will be displayed as high as this limit, their size label will be unchanged.
If not set, the lower limit will be calculated as the smallest value in all the Availability charts in the row.
Maximal value in the chart, specifies height of the chart, upper limit. Higher values will be displayed as high as this limit, their size label will be unchanged.
If not set, the upper limit will be calculated as the biggest value in all the Availability charts in the row.
Negates the Availability definition, just changes sign of all counts in the definition.
Use it in formulas to subtract Availability values.
Don't forget to add the ';' when summing or subtracting the Availability values!
For example Formula = " Col1 + ';' + Col2 + ";" + negav(Col3) ", all three columns contain the Availability definitions.

Resource usage chart

Replaced by GanttAvailability with special resource format string.

The usage of individual resource in grid can be shown in row in gantt Chart object of type "Resources".
Set attribute GanttChart="Resources".
The resources usage chart can be combined also with other Gantt objects.
Shows the resource usage chart in the Gantt cell
Name of the resource to show in the resource usage chart.
What chart will be shown.
1 - resource usage, 2 - resource availability, 3 - both resource usage and availability
4 - resource errors, 6 - both resource errors and availability
The values 5 and 7 are also possible, but it has not sense to show both resource errors and usage charts.
If set, only rows with the given default name (Def attribute) are iterated for the resource usage.
Format of the number shown in the resource chart.
The same as TreeGrid number format.

Automatically generated resource usage chart

The resource usage chart can be automatically generated from another (even invisible) grid.
The resources list can be modified, the resources can be added, deleted, changed or renamed.

There are must be two grids on page, master and detail.

Detail grid is the grid displaying the resources usage chart.
It should have defined only layout XML source.
The body rows are automatically generated from master's <Resources> list. This way is defined by detail's attributes <Cfg GanttResources... /> attributes.
The detail grid can contain Gantt column to show the resources usage from the master grid. Use the attributes for Resources usage chart.
The detail's Gantt column reads these attributes from master's Gantt column:
  DataUnits,LastUnit,Exclude,Include,MaxExclude,HeaderTrim,Background,Zoom,SmoothZoom,ZoomList,Width,Units and the <Zoom> tag
Changes in the resources list should be uploaded from detail grid as normal changes in data rows.

Master grid is the source grid.
The master grid must contain standard Gantt chart with tasks with assigned resources and global resources list in <Resources>.
The master's <Resources> list is automatically updated after any change (add, deleted, modify, rename) in the detail grid.
The master grid be displayed and recalculated according to the changes in resources.
The resources assigned to tasks are not automatically changed after resource is renamed or deleted and should be done manually in some API event.
Or the master grid can be hidden (<treegrid Hidden='1') and used only as resources list source
Base attribute in automatically generated resource usage chart.
Specifies id of the master grid from where this detail grid's resource chart will be calculated.
Name of column in detail grid where the resource Name will be displayed and edited
Name of column in detail grid where the resource Type will be displayed and edited
Name of column in detail grid where the resource Price will be displayed and edited
Name of column in detail grid where the resource Availability will be displayed and edited
Renamed to GanttResourcesAvailability
The Gantt column in master grid where to read the resources usage (this attribute is still set in detail grid).
The Gantt column in detail grid where to display the resources chart
If set to 0, the detail grid rows are not automatically generated according to master grid resources.
If set to 1 the grid is never rendered and can be used as invisible data source for other grids or other page components.
The hidden grid has not set MainTag and cannot be shown at all.
It can be set in master grid to use it just as data source.