Gantt chart API reference
- Example
- Properties
- Methods
- Adding events to your Gantt charts
- Adding vertical and horizontal bars to your Gantt chart
- The coordinates properties
- Events
- Effects
Example
<script> new RGraph.Gantt({ id: 'cvs', data: [ [ {start: 31, duration: 28, complete: null, label: 'Richard', background: null, color: null, border: 'rgba(0,0,0,0)'}, {start: 91, duration: 2, complete: null, label: 'Richard', background: null, color: null, border: 'rgba(0,0,0,0)'} ], {start: 31, duration: 28, complete: null, label: 'Fred', background: null, color: null, border: 'rgba(0,0,0,0)'}, {start: 59, duration: 14, complete: null, label: 'Barney', background: null, color: null, border: 'rgba(0,0,0,0)'}, {start: 59, duration: 21, complete: null, label: 'Gloria', background: null, color: null, border: 'rgba(0,0,0,0)'}, {start: 59, duration: 31, complete: null, label: 'Paul', background: null, color: null, border: 'rgba(0,0,0,0)'}, {start: 80, duration: 21, complete: null, label: 'Harry', background: null, color: null, border: 'rgba(0,0,0,0)'}, {start: 94, duration: 7, complete: null, label: 'Shane', background: null, color: null, border: 'rgba(0,0,0,0)'}, {start: 120, duration: 14, complete: null, label: 'Barry', background: null, color: null, border: 'rgba(0,0,0,0)'}, {start: 130, duration: 14, complete: null, label: 'Cynthia', background: null, color: null, border: 'rgba(0,0,0,0)'}, {start: 211, duration: 61, complete: null, label: 'Graham', background: null, color: null, border: 'rgba(0,0,0,0)'}, {start: 334, duration: 31, complete: null, label: 'Paul', background: null, color: null, border: 'rgba(0,0,0,0)'} ], options: { backgroundGridVlinesCount: 12, titleBold: true, titleSize: 16, xaxisScaleMax: 365, marginLeft: 75, xaxisLabels: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'], title: 'Holiday schedule for Xyz Ltd', colorsDefault: 'rgba(255,0,0,1)', names: ['Richard','Fred','Barney','Gloria','Paul','Harry','Shane','Barry','Cynthia','Graham','Paul'], durations: ['28 days','2 days', '28 days','two weeks','3 weeks','31 days','three weeks','one week','two weeks','two weeks','August and September','31 days'], tooltips: '<b>%{property:names[%{dataset}]}</b><br />%{property:names[%{dataset}]} is off work for %{property:durations[%{sequential_index}]}', tooltipsCss: { fontSize: '16pt', textAlign: 'left' }, backgroundVbars: [ [0, 31, 'rgba(192,255,192,0.5)'], [59, 31, 'rgba(192,255,192,0.5)'], [120, 31, 'rgba(192,255,192,0.5)'], [181, 31, 'rgba(192,255,192,0.5)'], [243, 30, 'rgba(192,255,192,0.5)'], [304, 30, 'rgba(192,255,192,0.5)'] ] } }).draw(); </script>
Properties
You can use these properties to control how the chart appears. You can set them by including them in the options section of the configuration as shown above.
- Background properties
- X-axis properties
- Y-axis properties
- Color properties
- Margin properties
- Labels and text properties
- Title properties
- Interactive features properties
- Miscellaneous properties
Background properties
css
background color to the canvas
tag.linewidth
of the border that goes around the chart area.X-axis properties
Gantt chart
is. For example, to represent a year, you would use 365, giving a granularity of one day.Gantt chart
spread over several pages easier.x-axis
labels are positioned.linewidth
used for the x-axis
and the x-axis
tickmarks (if they're displayed).x-axis
.x-axis
labels. For example, you could set this to 45 to get angled labels.section
for most chart types and edge
for Line charts
. You probably won't need to change this.css
class to the x-axis
labels which you can then use for styling purposes or to make retrieving the span
tags easier (the dom
elements). If you inspect the labels in your browser's javascript
console (you will first need to enable the textAccessiblePointerevents
property) you will be able to see the other css
classes that are assigned to the labels.x-axis
title.x-axis
title.x-axis
title is bold or not.x-axis
title is italic or not.x-axis
title.Y-axis properties
y-axis
. It has no effect on a scale.y-axis
title.y-axis
title.y-axis
title is bold or not.y-axis
title is italic or not.y-axis
title.y-axis
titles X coordinate.y-axis
titles Y coordinate.y-axis
title.Color properties
Margin properties
Labels and text properties
dom
text in place of canvas
text. It makes for much higher quality text that you can also select if desired (for copy/paste operations). It won't fit all situations and you can read more about the DOM text feature here. A good way to control borders/margins/padding etc is not to set them on the canvas
but to wrap the canvas
in a div
and set them on that like this:
<div style="margin-left: 50px; display: inline-block"> <canvas id="cvs" width="650" height="250"></canvas> </div>
visible
or hidden
and it controls whether the text is clipped to the edges of the canvas
. It defaults to be visible and means you can set small margins if you wish.dom
text responds to mouse-based events or not (it sets the pointer-events
css
property to none
).array
of labels that are drawn inside the Gantt chart
bars. These labels can also be drawn on the right of these bars.left
, center
or right
when the labels are drawn inside the bars.api
compatibility it's called "above").Title properties
textFont
setting is used (usually Arial
).4pt
bigger than the textSize
setting."-5"
- in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate."-5"
- in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.marginTop
value.Interactive features properties
html
.click
or mousemove
.slide
fade
or none
.%{value_formatted}
option.%{value_formatted}
option.%{value_formatted}
option.%{value_formatted}
option.%{value_formatted}
option.ul
and ol
.tooltipsFormattedListItems: [ ['Bill','Jerry','Berty'], // First tooltip ['Gill','Carrie','Lucy'], // Second tooltip ['Pob','Nobby','Hilda'] // Third tooltip ]You can use
css
to style this list - for example:.RGraph_tooltip ul#rgraph_formatted_tooltips_list li { text-align: left; color: yellow; }
th
tags.css
values applied to the tooltips pointer (for example, a css
border) then specify an object containing those values to this property. For example: tooltipsPointerCss: { borderLeft: 'gray 2px solid', borderBottom: 'gray 2px solid' }
false
tooltips are positioned next to the mouse pointer.css
that gets applied to all of the tooltips, but don't want to use the RGraph.tooltips.style
object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object css
for the tooltips. These are css
styles that get applied to all of the tooltips for the specific object only. It should look like this:tooltipsCss: { fontFamily: 'Verdana', fontSize: '20pt' }
css
class the chart uses.pie-tooltipshotspotignore.html
. You can use the transparent
color to allow the rear chart to be seen in such a case. It can be:
- A single
boolean
value (ietrue
orfalse
) to enable or disable all of the hotspots -true
means the hotspot will be ignored - A single number (the zero-indexed number corresponding to the hotspot to ignore)
- An array of numbers (the numbers are the indexes of hotspots to ignore)
- An array of
boolean
true
orfalse
values - the position of these values correspond to the index(es) of the segments to ignore (for example[false, false, true, false, false]
-true
means the corresponding hotspot will be ignored)
Miscellaneous properties
null
but you can set it to a function if you wish so that function is called to do the chart highlighting. It's passed the shape object as an argument. As of version 5.23 you can also set this to invert
as well. If you do this on a dark background you may find that you need to change the highlightFill
color setting as well.canvas
is cleared.round
or square
. To use rounded corners set this to round
Gantt chart
which uses rounding to good effect in the download archive called gantt-dark.html
Methods
obj.get(name)
An accessor function that you can use to retrieve the values of properties.
obj.set(name, value)
An accessor that you can use to set the values of properties.
obj.getShape(event)
This method makes it easy to get hold of which bar has been clicked on or hovered over. It returns an object which has the following indexes available:
object |
The chart object |
x |
The X coordinate for the bar that was clicked on. |
y |
The Y coordinate for the bar that was clicked on. |
width |
The width of the bar that was clicked on. |
height |
The height of the bar that was clicked on. |
dataset |
This is the numerical index that represents the relevant "row" of the
Gantt chart . The group in effect.
|
index |
This is the index in the group. If you only have one bar per row then this
will always be zero. If you have two bars in a row then the getShape
function will return zero for the first bar and one for the second bar.
|
sequentialIndex |
The sequential index of the bar. This number can be used to find the relevant tooltip for example. |
tooltip |
If a tooltip is associated with this bar this will be it. id
strings are expanded for you (where the tooltip text is retrieved from the html
tag with the matching ID).
|
<script> gantt.canvas.onclick = function (e) { RGraph.redraw(); var canvas = e.target, obj = canvas.__object__, shape = obj.getShape(e); if (shape) { var x = shape.x, y = shape.y, width = shape.width, height = shape.height; obj.path( 'b r % % % % s black f red', x, y, width, height ); } } </script>
obj.getXCoord(value)
This method can be used to get an appropriate X coordinate for a value
when you're doing custom drawing on the chart. It
returns null
if the value is out of range.
obj.getValue(mixed)
This method can be used to get the value when the chart has been clicked on. The argument is the event object. You can also use this method outside of an event listener by giving the function an array as the argument containing the X/Y coordinates.
obj.canvas.onclick = function (e)
{
var obj = e.target.__object__;
var value = obj.getValue(e);
// ...
}
obj.on(event, function)
This method can be used to set an event listener on an object. It
operates similarly to the jquery
on
function.
The first argument is the event that you wish to attach to and the second
is the handler function. For example:
.on('draw', function (obj)
{
// Put your event code here
});
obj.exec(function)
The exec function is documented here.
obj.responsive(configuration)
The responsive
function helps your charts
respond to different browser window sizes and screen
resolutions. For example, for smaller screens, you
might want to have angled labels or show shorter
versions of them completely.
Update: There is now the responsive configuration option available to you and this is now the preferred method of configuration.
The responsive function and configuration option are documented on their own page here.
Adding events (the information represented on the chart) to your Gantt chart
To add events (the information represented on the chart), you now specify them as an argument to the constructor - it's no longer the events property.
myGantt = new RGraph.Gantt({ id: 'cvs', data: [ {start: 31, duration: 28, complete: 75, label: 'Richard'}, {start: 12, duration: 28, complete: 67, label: 'Fred'}, {start: 59, duration: 14, complete: 0, label: 'Barney'}, {start: 59, duration: 21, complete: 5, label: 'Gloria'}, {start: 46, duration: 31, complete: 94, label: 'Paul'}] {start: 80, duration: 21, complete: 46, label: 'Harry'}, {start: 94, duration: 17, complete: 84, label: 'Shane'}, {start: 34, duration: 14, complete: 32, label: 'Barry'}, {start: 64, duration: 14, complete: 28, label: 'Cynthia', background: 'red', color: 'yellow'}, {start: 13, duration: 61, complete: 74, label: 'Graham'}, {start: 84, duration: 31, complete: 16, label: 'Paul'} ], options: { } );
The start
value is the (zero-indexed) start number relative to your
xaxisScaleMax
value. So if you have set your
xaxisScaleMax
to 62, (to represent
two months), and this value is 31, the start will be the start of the
second month. In this case, you could give two labels -
['July', 'August']
.
The duration
value is the duration. So using the previous example,
if you set this to 7, you would have an event lasting a week.
The complete
value is the "percentage complete" indicator. This is
shown to the right of the event and is optional - you can
specify null
if you wish.
The label
value is the label that is used on the left-hand-side.
The optional background
value stipulates the background color
that the bar is. The default is white.
The optional color
value is the foreground color of the bar.
This defaults to #0c0
.
The optional border
value is the border color, defaulting to black
And the optional linewidth
value is the numerical linewidth
of the
border. The default for this is 1.
Adding vertical and horizontal bars to your Gantt chart
You can add decorative vertical or horizontal bars like so:
... vbars: [ [0, 31, 'rgba(192,255,192,0.5)'], [59, 31, 'rgba(192,255,192,0.5)'], [120, 31, 'rgba(192,255,192,0.5)'], [181, 31, 'rgba(192,255,192,0.5)'], [243, 30, 'rgba(192,255,192,0.5)'], [304, 30, 'rgba(192,255,192,0.5)'], ], hbars: [,'red',,,,'green'], ...
You can use these for decorative purposes, or to mark events/limits. For the vertical bars, the first value is the start index, the same as above. The second value is the unit length, again, the same as above. The third value is the color of the vertical bar.
And for the horizontal bars you can specify the color of the bar - they
automatically extend across the entire Gantt chart
area. If you don't
specify a color (as is demonstrated above) then there won't be a bar for
that entry.
The coordinates properties
There's only two coordinates properties on the
Gantt chart
and that's the
obj.coords
property and the
obj.coordsText
property.
-
obj.coords
This holds the coordinates of all of the bars that have been added to the chart. It consists of:- The
x
coordinate - The
y
coordinate - The
width
of the bar - The
height
of the bar - The event object that's given as part of your data array
- The sequential index of the event
- The
-
obj.coordsText
This holds the coordinates of all of the text that has been added to the chart. Even if the text is blank (ie no text) then the coordinates will be added to this variable.
Events
RGraph supports custom events that allow you to easily add interactivity to your charts if required. The following events are available:
adjustbegin
This event fires at the start of adjusting - like the standardmousedown
event.adjust
This event fires (repeatedly) during adjusting - like the standardmousemove
event.adjustend
This event fires at the end of adjusting - like the standardmouseup
event.annotatebegin
This event fires at the start of annotating - like the standardmousedown
event.annotate
This event fires (repeatedly) during annotating - like the standardmousemove
event.annotateend
This event fires at the end of annotating - like the standardmouseup
event.annotateclear
This event fires at the end of theRGraph.clearAnnotations
function.beforeclear
This event fires at the start of theRGraph.clear
function.clear
This event fires at the end of theRGraph.clear
function.click
This is similar to the standardcanvas
click
event but this only fires when you click on a bar - not the wholecanvas
.beforecontextmenu
This event fires when you have the contextmenu enabled and it is about to appear.contextmenu
This event fires when you have the contextmenu enabled and it has been displayed.beforedraw
This event fires at the start of thedraw
method before anything has been done.firstdraw
This event fires at the end of thedraw
function - but only the first time that thedraw
function is called.draw
This event fires at the end of thedraw
function.mousemove
This event is similar to the standardmousemove
event but only fires when you move the mouse over a bar on the chart.mouseover
This event is similar to the standardmouseover
event but only fires when you move the mouse over a bar on the chart.mouseout
This event is similar to the standardmouseout
event but only fires when you move the mouse away from a bar on the chart that you've previously hovered over.beforetooltip
This event fires at the start of the tooltip showing process.tooltip
This event fires after a tooltip has been shown.beforebackground
This event fires before the background (grid, image, bars etc) has been drawn.background
This event fires after the background (grid, image, bars etc) has been drawn.
new RGraph.Gantt({ id: 'cvs', data: [ {start: 0, duration: 5, complete: null, label: 'Graham'}, {start: 5, duration: 5, complete: null, label: 'Paul'} ], options: { xaxisScaleMax: 10 } }).on('draw', function (obj) { console.log('The draw event has fired'); }).draw();
Effects
These effects are available and can be used instead of thedraw
function. There are also generic effects available which
you can see here:
Generic effects and transitions
- The
grow
effect (effects-gantt-grow.html
in the download archive
<script> // // Optional callback function that's called when the effect is complete // function myCallback (obj) { // ... } obj = new RGraph.Gantt({ id: 'cvs', data: [ {start: 0, duration: 30}, {start: 30, duration: 60}, {start: 60, duration: 90} ], options: { marginLeft: 35, xaxisScaleMax: 90 } }).grow({frames: 60}, myCallback) </script>