Version 27 (modified by Adrian Fritz, 11 years ago) (diff)

Organize options alphabetically, more example options in configuration file. Formatting.

Trac jsGantt plugin


A plugin which allows Trac ticket data to be displayed in a jsGantt chart in a wiki page. Tasks and milestones are links to the corresponding ticket or milestone.

Configurable field names allow integration with other plugins such as MasterTicketsPlugin (for dependencies), SubticketsPlugin (for parent/child relationships) and TimingAndEstimationPlugin (for estimated and total hours).


[[TracJSGanttChart(sample=1)]] displays the sample project from [[TracJSGanttChart(milestone=Test)]] displays all the tickets in the Test milestone.

jsGantt sample tasks in a wiki page


The chart display can be controlled with a number of macro arguments:

Argument Version Description Default
caption Caption to place to right of tasks: None, Caption, Resource, Duration, %Complete Resource
comp Show (1) percent complete column, or do not (0). 1
colorBy Field to use to color tasks. Useful fields are priority, owner and milestone but any field can be used. priority
dur Show (1) duration colunn, or do not (0). 1
dateDisplay Format to display dates: mm/dd/yyyy, dd/mm/yyyy, or yyyy-mm-dd mm/dd/yyyy
endDate Show (1) end date column, or do not (0). 1
expandClosedTickets0.9Show (1) children of closed tickets in the task hierarchy or collapse the subtree (0). 1
format Initial display format, one of those listed in formats day
formatsFormats to show for Gantt chart. A pipe-separated list of minute, hour, day, week, month, and quarter. day|week|month|quarter
goal 0.9 Ticket(s) to show predecessors of. When using something like MasterTicketsPlugin to maintain ticket dependencies, you may create a Gantt showing a ticket and all of its predecessors with goal=<ticket#>. The macro uses the configured succ field to find all predecessor tasks and build an id= argument for Trac's native query handler.

Multiple goals may be provided like goal=1|12|32.

When used in a ticket description or comment, goal=self will display the current ticket's predecessors.
hoursPerDay Hours worked per day 8.0
lwidth Width (in pixels) of left table (The one contains task names, etc. on the left of the Gantt chart.) None
omitMilestones0.8Show milestones for displayed tickets (0) or only those specified by milestone= (1). 0
openLevel How many levels of task hierarchy to show open. 1 = only top level task. 999
res Show (1) resource column, or do not (0). 1
root Ticket(s) to show descendants of. When using something like Subtickets plugin to maintain a tree of tickets and subtickets, you may create a Gantt showing a ticket and all of its descendants with root=<ticket#>. The macro uses the configured parent field to find all descendant tasks and build an id= argument for Trac's native query handler.

Multiple roots may be provided like root=1|12|32.

When used in a ticket description or comment, root=self will display the current ticket's descendants.
sample Display (1) sample tasks in Gantt, or do not (0) 0
schedule Schedule algorithm: as-last-as-possible (alap) or as-soon-as-possible (asap) alap
showdep Show (1) dependencies in Gantt, or do not (0). 1
startDate Show (1) start date column, or do not (0). 1
userMap0.8Map (1) user IDs to full names, or do not (0). 1

Site-wide defaults for macro arguments may be set in trac.ini. option.<opt> overrides the built-in default for <opt> from the table above.

All other macro arguments are treated as TracQuery specification (e.g., milestone=MS1|MS2) to control which tickets are displayed.


  1. Install globally with:
      sudo easy_install
  2. Enable the plugin by updating TracIni file (..../trac.ini) as follows:
      tracjsgantt.* = enabled
  3. Configure the plugin at its own configuration section, placed into 'trac.ini' file as follows:
      # To work with Timing and Estimation for percent complete
      ## Ticket field to use as the data source for estimated work (default: None)
      fields.estimate = estimatedhours
      ## Ticket field to use as the data source for completed work (default: None)
      fields.worked = totalhours
      # Each unit in estimate is 1/8 of a day
      days_per_estimate = 0.125
      # To work with Master Tickets for dependencies
      ## Ticket field to use as the data source for predecessor list
      fields.pred = blockedby
      ## Ticket field to use as the data source for successor list
      fields.succ = blocking
      # To work with Subtickets for parent/child relationships
      ## Ticket field to use as the data source for the parent parent_format', '%s', Format of ticket IDs in parent field (default: None).
      fields.parent = parents
      # To work with ChildTickets plugin
      # parent_format = #%s
      # Custom fields for start and due dates
      ## Ticket field to use as the data source for start date (default: None)
      fields.start = userstart
      ## Ticket field to use as the data source for finish date (default: None)
      fields.finish = userfinish
      # Format for ''start'' and ''finish'' date strings (default: '%Y-%m-%d')
      date_format = %Y-%m-%d
      # Ticket type for milestone-like tickets (default: 'milestone')
      milestone_type = milestone
      # Ticket field to use as the data source for the percent complete column (default: None).
      # fields.percent =
      # Hours represented by each unit of estimated work (default: 1).
      # hours_per_estimate = 1
      # Default work for an unestimated task, same units as estimate  (default: 4.0).
      # default_estimate = 4.0
      # How much work may be remaining when a task goes over estimate, same units as estimate (default: 0.0)..
      # estimate_pad = 0.0
  4. Restart web server on command line:
        $ sudo /etc/init.d/apache2 restart

Configuration details

TracJsGanttPlugin is intended to be flexible enough to get data from various plugins by configuring the field names for those plugins in trac.ini. It is known to work with TimingAndEstimationPlugin (for estimated and total hours), MasterTicketsPlugin (for FS dependencies), and SubticketsPlugin for parent/child relationships. Custom fields for start and finish date are also supported.

Tasks are colored based on ticket attributes. When colored by priority colors are consistent with the colors used in Trac reports. Other coloring choices (e.g., by milestone or owner) use arbitrary, unique colors.

All of the fields.* items name custom fields which may contain data for the Gantt.

When estimate and worked are both configured, the plugin attempts to display (100 * worked/estimate) as the percent complete. The example works with TimingAndEstimationPlugin. Alternatively, if percent is configured, the plugin attempts to display it as the percent complete (it should be a number from 0 to 100). If none of those are configured, all tasks will be marked as 0% complete.

When pred and succ are configured the plugin uses them to determine the task dependencies. The example works with MasterTicketsPlugin. If these fields are not configured, no dependencies are shown.

When parent is configured, it is the field which holds the parent ticket number. The example works with Subtickets. If this field is not configured, no parent/child relationship will be displayed. If it is configured, the Gantt can be collapsed by the user to show or hide subtasks. (parent_format determines the format of the content of the parent field. Use "%s" (default) for SubticketsPlugin, "#%s" for ChildTicketsPlugin.)

When start and finish are configured, the plugin uses them to set task start and finish dates. The date_format field is a Python strptime() format specifier which describes the contents of start and finish. If these fields are not configured, all tasks end today and have a 1-day duration.

When estimate and finish are both configured (and start is not configured or not on the ticket), the plugin attempts to determine the start of the task from finish and estimate as start = finish - estimate with consideration for weekends and hours per day.

The milestone_type may be used to have a custom ticket type show up as milestones on the chart. If this field is not specified, only Trac milestones are displayed as milestones.

Bugs/Feature Requests

Existing bugs and feature requests for TracJsGanttPlugin are here.

If you have any issues, create a new ticket.

Known issues

  1. Only one chart can be displayed per page.

Planned enhancements

  1. Allow configuration of default task duration.
  2. Display a legend of task colors and their meaning (e.g., which milestone or owner they represent).
  3. Allow some tasks to be open or closed by default.
  4. Figure out finish date if start and estimate are provided.
  5. Display critical path
  6. Display slack time

Source & Download

You can check out TracJsGanttPlugin from here using Subversion, or browse the source with Trac.

Download the zipped source from [download:tracjsganttplugin here].

Recent Changes

17888 by rjollos on 2020-12-03 05:44:28
Trac-jsGantt Fix typo in section name
17707 by rjollos on 2020-04-29 19:05:19
Trac-jsGantt Handle milestone with no tickets

Refs #13627.

17638 by jun66j5 on 2019-12-19 18:34:55
Trac-jsGantt make compatible with Trac 1.4 (closes #13713)
17250 by rjollos on 2018-07-30 21:52:52
Trac-jsGantt Fix exception when ticket field is None

Patch by Rochi.

Fixes #13463.

17150 by rjollos on 2018-04-24 19:26:48
Trac-jsGantt Make compatible with Trac 1.2+

Fixes #13175.

17149 by rjollos on 2018-04-24 18:25:26
Trac-jsGantt Branch for Trac 1.2 and conform to PEP8

Refs #13175.

14208 by ChrisNelson on 2014-10-14 17:39:23
Fix a typo. Refs #9648.
14207 by ChrisNelson on 2014-10-14 17:18:33
Use Trac 1.0 DB API to find active tickets. Refs #9648.
14206 by ChrisNelson on 2014-10-14 17:18:28
Use Trac 1.0 DB API to find tickets by owner. Refs #9648.
14205 by ChrisNelson on 2014-10-14 17:18:23

Use Trac 1.0 DB API to find owners. Refs #9648.





Author: ChrisNelson
Maintainer: ChrisNelson
Contributors: rjollos, bof, Matt Sable

Attachments (1)

Download all attachments as: .zip