Sets the ⟨format⟩ of time slot specifiers. A time slot specifier (abbreviated “tss”) denotes a certain time slot along the horizontal axis. pgfgantt defines a range of formats:

• • simple – positive integers (the single format used by pgfgantt prior to v4.0). See also the time slot format/start date key below.
  Examples: 1, 3, 24

• • isodate – dates in ISO-standard format (yyyy-mm-dd). In this format and any other, you may omit the leading zero if month or day are less than 10.
  Examples: 2013-03-14, 2013-5-1

• • isodate-yearmonth – ISO-standard dates without days (yyyy-mm). Such dates are automatically converted to the first day of the respective month.
  Examples: 2013-03, 2013-5

• • isodate-year – year only (yyyy). Such dates are automatically converted to the first day of January.
  Examples: 2013, 2014

• • little-endian – Gregorian little-endian, i. e. day–month–year (the common German date format). Valid day/month and month/year separators are the hyphen (-), slash (/) and period (.). If you enter a two-digit year (for example, 13 instead of 2013), it will be completed according to the value of time slot format/base century (see below).
  Examples: 14-03-2013, 14/03/13, 14.3.2013

• • middle-endian – middle-endian, i. e. month–day–year (the common US date format). For valid separators and automatic year completion, see little-endian.
  Examples: 03-14-2013, 03/14/13, 3.14.2013

• • big-endian – Gregorian big-endian, i. e. year–month–day (the ISO”=standard order). For valid separators and automatic year completion, see little-endian.
  Examples: 2013-03-14, 13/03/14, 2013.3.14

Sets the century for auto-completion of two-digit years (used by the time slot formats little-endian, middle-endian and big-endian). Consequently, default settings convert a year like 13 to 2013.

Numbers denoting time slots in the simple format are internally converted to a date, where 1 is converted to ⟨ISO-standard date⟩, 2 to \(\meta {ISO-standard date} + 1\) etc.

The canvas key changes the appearance of the canvas. ⟨style⟩ is a list of TikZ keys suitable for the ⟨options⟩ of a TikZ node (such as shape=rectangle, fill or draw; see chapter 16 of the TikZ manual). By default, the canvas is a white rectangle with a black frame.

These keys specify the width of a time slot and the height of title or chart lines, respectively. Typically, the \(x/y\)-dimension ratio approximates \(1:2\), and the line height is equal over the whole chart. Other dimensions are well possible, but you might have to change several spacing-related keys in order to obtain a pleasing chart.

If the value of this key differs from none, the Gantt chart will expand horizontally to ⟨dimension⟩. Use this key to produce charts that automatically expand to the text width. Two LaTeX runs are required to calculate the correct size of the chart.

hgrid draws a horizontal grid which starts immediately below the last title element. The key can be specified in four different ways: Firstly, hgrid=false eliminates the horizontal grid. You may omit this declaration, since it is the default. Secondly, both hgrid and hgrid=true activate the horizontal grid, which is then drawn in the default style dotted. Finally, hgrid=⟨style list⟩ draws the horizontal grid in the given ⟨style list⟩ (see below).

hgrid style changes the style of single horizontal grid lines that are drawn with \ganttnewline[grid] (see section 2.4).

The vgrid key governs the vertical grid; otherwise, use it exactly like hgrid.

Style lists allow you to draw the grid lines in different styles. Each style list consists of several style list items separated by a comma. A style list item has the general syntax *{⟨n⟩}{⟨style⟩} and orders the package to repeat the ⟨style⟩ ⟨n⟩-times. (This syntax is reminiscent of column specifications in a tabular environment.) Thus, the list *2{red}, *1{green}, *{10}{blue, dashed} instructs pgfgantt to draw first two red vertical grid lines, then a green one and finally ten dashed blue lines. If any grid lines remain to be drawn at the end of the list, the package starts again at the beginning of the list.

In most situations, you can omit the multiplier *1. Hence, the following style lists are equal:
{*1{red}, *1{blue, dashed}}
{{red}, {blue, dashed}}
{red, {blue, dashed}}
However, if you wish to use a single style comprising two or more keys for all grid lines, e. g. red, dotted, you must retain the multiplier (i. e., {*1{red, dotted}}).

In a chart with many time slots, drawing vertical grid lines between all of them will lead to a confusing appearance. In such a case, you can pass an appropriate ⟨style list⟩ to vgrid in order to draw every second grid line, for example.

Sometimes, you may wish to indicate the current day, month or the like on a Gantt chart. In order to do so, pass an integer value to the today key, which draws a vertical rule at the corresponding ⟨tss⟩. today offset determines the exact \(y\)-coordinate in the time slot and should lie between 0.0 (left border) and 1.0 (right border). The today rule appears in the ⟨style⟩ denoted by today rule. The node that contains the ⟨text⟩ given by today label appears below the rule. It is formatted by today label font and today label node.

If true, \\ \\ is defined as a shortcut for \ganttnewline within a ganttchart environment, so that the syntax is reminiscent of LaTeX’s tabular enviroment.

Changes the ⟨pgffor options⟩ of the \foreach command called by \gantttitlelist (see section 56 of the TikZ manual). The macro that yields the labels to be printed by \gantttitlelist must be called \x.

Changes the text displayed in a week title element. In ⟨format⟩, four additional macros are available: \currentweek \currentweek is the current week number; \startyear \startyear, \startmonth \startmonth and \startday \startday expand to the year, month and day of the current week’s Monday.

By default, one calendar day is one time slot wide. With time slot unit=month, one month corresponds to one time slot. Consequently, in such calendars only year and month are sensible line types for \gantttitlecalendar, and the time slot format isodate-yearmonth is especially suited.

With time slot unit=year, one year corresponds to one time slot. Consequently, in such calendars only decade and year are sensible line types for \gantttitlecalendar, and the time slot format isodate-year is especially suited.

Sets the appearance of a title element.

The ⟨font commands⟩ and ⟨options⟩ are applied to the title label node, which is positioned at the center of each title element. ⟨text⟩ should contain a single parameter token (#1), which is replaced by the first mandatory argument of \gantttitle. The \strut in the standard value ensures equal vertical spacing of the labels.

The first three keys shift the coordinates of a title element’s borders (or rather of its corners), while title height changes its height. By default, the left upper corner of a title element coincides with the origin of the start time slot; its right lower corner touches the right border of the end time slot 0.6 units below the upper line border:

The figure below shows a Gantt chart with two lines and one (large) time slot and indicates the distances modified by these keys. For example, you might devise a layout where the title element does not touch the borders of the start and end time slot.

The canvas normally comprises all lines of the chart. However, you may wish that your title elements only consist of text lacking any frame or background. In this case, the canvas probably should exclude all lines containing title elements, which you achieve by include title in canvas=false.

vrule offset determines the exact \(y\)-coordinate in the time slot and should lie between 0.0 (left border) and 1.0 (right border). The vertical rule appears in the ⟨style⟩ denoted by vrule. The label is formatted by vrule label font and vrule label node.

Determines which border of the start time slot a chart element touches. left is the behavior usually expected, while right strictly interprets the start time slot as an \(x\)-coordinate.

Determines the appearance of the chart element. The shapes ganttbar, ganttgroup and ganttmilestone are described below.

The … label text keys configure the label ⟨text⟩ next to each chart element. Each of these keys should contain a single parameter token (#1), which is replaced by the first mandatory argument of \ganttbar etc. The \strut in the standard value ensures equal vertical spacing of the labels. The ⟨font commands⟩ of … label font and the ⟨options⟩ of … label node are applied to the label node at the left border of the chart (see inline below).

If two or more chart elements appear in a single line, their labels will overlap at the left border of the chart. Thus, you can place the label adjacent to a chart element by setting the boolean key inline to true. This key instructs the package to draw the label node at the … inline label anchor of the respective chart element and apply the ⟨options⟩ given by … inline label node.

Shift the coordinates of a chart element’s borders (… shift) and change its height (… height).

The three following figures illustrate the distances modified by these keys. The first figure shows a Gantt chart with a bar, two lines and one time slot. The second one shows a Gantt chart with a group, two lines and one time slot. The third one shows a Gantt chart with a milestone, two lines and two time slots.

For example, you might devise the following layout: Bars are small and rounded; they do not touch the borders of their start and end time slots. Groups stay within the start and end time slot, and the peaks are more acute.

Indicates that a chart element is ⟨number⟩ percent complete. The value none turns progress calculations off.

The value today instructs pgfgantt to calculate progress according to the value of the today key. Thus, if the current date \(T\) is earlier than the start date \(S\) of a chart element, its progress is 0 %; if the current date is later than the end date \(E\) of a chart element, its progress is 100 %; otherwise, its progress \(P\) is calculated according to

\begin{equation} P = \frac {T - S}{E - S} \times 100\,\% \end{equation}

If \(P\) is the progress of a chart element, \(P\,\%\) of its area (starting from the left) appear in the basic style (i. e., bar, group, …), while the remainder is drawn in style bar incomplete, group incomplete etc.

The progress label text key sets the ⟨text⟩ that appears beside each progress element in order to indicate its completeness. This key may contain a single parameter token (#1), which is replaced by the (possibly calculated) value of progress. The progress label node is drawn at the … progress label anchor of the respective chart element, with the ⟨font commands⟩ given by … progress label font and the ⟨options⟩ given by … progress label node.

In the following figures, on top/bottom fraction is 0.7, whereas on left/right fraction is 0.1.

The \ganttlink \ganttlink macro connects two elements, which are specified by their ⟨name⟩s. By default, chart elements are named automatically: The first one receives the name elem0, the second one is called elem1 and so on. However, the name key allows you to assign a name to each chart element.

Sets the appearance of the link.

Link types fall into several categories:

• 1. Automatic links are arrow-like. As you can see from the examples above, they consist of three segments (two horizontal, one vertical) if their start and end time slots are sufficiently separated. Otherwise, they comprise five segments (three horizontal, two vertical). Three keys further modify the appearance of automatic links:

  /pgfgantt/link mid =⟨factor⟩0.5 ¶

  Changes the position of the single vertical segment (in three-part links) or of the middle horizontal segment (in five-part links). By default, these segments are horizontally centered between the left and the right vertical segment, or vertically centered between the upper and the lower horizontal segment, respectively.

  /pgfgantt/link bulge =⟨factor⟩0.4 ¶

  In five-part links, the upper and lower vertical segments are shifted along the \(x\)-axis by \(+\)⟨factor⟩ and \(-\)⟨factor⟩, respectively.

  /pgfgantt/link tolerance =⟨factor⟩0.6 ¶

  Decides whether pgfgantt draws a five- or a three-part link. If the true \(x\)-coordinates of the link start and end differ by at least ⟨factor⟩ (this is the case for the second link in the example below), the package draws a five-part link.

  

  copy \begin{ganttchart}[vgrid, hgrid, link mid=.25, link bulge=1.3]{1}{12} \gantttitle{Title}{12} \\ \ganttbar{Task 1}{1}{4} \\ \ganttbar{Task 2}{5}{7} \\ \ganttbar{Task 3}{10}{12} \ganttlink{elem0}{elem1} \ganttlink[link mid=.8]{elem1}{elem2} \end{ganttchart}

• 2. Straight links are only meant for connecting two bars in order to establish start-to-finish relations (s-f), start-to-start relations (s-s) etc. Their ⟨type⟩ identifiers are reminiscent of the syntax for specifying arrow tips in TikZ: Each identifier is composed of two letters separated by a hyphen.

  

  copy \begin{ganttchart}[ vgrid, hgrid, link/.style={-latex, draw=red, fill=red} ]{1}{12} \gantttitle{Title}{12} \\ \ganttbar{Task 1}{2}{3} \\ \ganttbar{Task 2}{2}{5} \\ \ganttbar{Task 3}{6}{11} \\ \ganttbar{Task 4}{8}{11} \ganttlink[link type=s-s]{elem0}{elem1} \ganttlink[link type=f-s]{elem1}{elem2} \ganttlink[link type=f-f]{elem2}{elem3} \end{ganttchart}

• 3. Custom links allow you to define completely new link types. Strictly speaking, automatic and straight links are predefined custom links whose code supports the keys mentioned above (section 3.11 presents the TikZ code of these links).

  For instance, pgfgantt provides one additional link type, dr (short for “down-right”). This type is convenient for connecting inline-labeled bars if the label of the start bar protrudes from its right border.

  

  copy \begin{ganttchart}[ vgrid, hgrid, inline, link/.style={->, ultra thick} ]{1}{15} \gantttitle{Title}{15} \\ \ganttbar{A really long label}{1}{3} \ganttbar{Another really long label}{10}{12} \\ \ganttbar{Task 3}{4}{6} \ganttbar{Task 4}{13}{15} \ganttlink[link/.append style=red]{elem0}{elem2} \ganttlink[link/.append style=green, link type=dr]{elem1}{elem3} \end{ganttchart}

  The following macro creates new link types:

  copy \newganttlinktype`\marg{type}\marg{TikZ code}'

  \newganttlinktype It defines a new link ⟨type⟩ which is drawn by the given ⟨TikZ code⟩. When you write this code, you do not have to know the final absolute coordinates of each link type instance. On the contrary, several commands that are only available in the second argument of \newganttlinktype help you to design generic link types:

  • • First, you have to choose the border points of the chart elements the link will connect. For this purpose, \ganttsetstartanchor \ganttsetstartanchor{⟨anchor⟩} and \ganttsetendanchor \ganttsetendanchor{⟨anchor⟩} select an ⟨anchor⟩ of the start and end element, respectively. See the figures in section 2.7.5 for possible ⟨anchor⟩s of the default chart element shapes. You may specify a certain ⟨fraction⟩ for anchors like on top by \ganttsetstartanchor{on top=⟨fraction⟩}.

    pgfgantt sets the default anchors to \ganttsetstartanchor{east} and \ganttsetendanchor{west}, so you even may omit these two commands.

  • • The two macro pairs \xLeft \xLeft/\yUpper \yUpper and \xRight \xRight/\yLower \yLower provide the \(x\)- and \(y\)-coordinates of the link start and end points, respectively.

  • • \ganttlinklabel \ganttlinklabel contains the label that you may assign to each link type via \setganttlinklabel or the link label key (see below).

  • • You can access any values stored in the package’s ⟨key⟩s with the macro \ganttvalueof \ganttvalueof{⟨key⟩}.

  • • Remember that you can use the style /pgfgantt/link to ensure a uniform appearance of all your link types.

The link label key locally overrides any label specified by \setganttlinklabel. The ⟨font commands⟩ and ⟨options⟩ are applied to the link label node. By default, the label appears to the right of the straight link’s center.