Gantt chart API reference

Summary: Documentation about the Gantt chart including information about all of the options that are available to you. The Gantt chart is commonly used to show scheduling information regarding timetables for people or events. There's a demo that shows an interactive Gantt chart.

• Example
• Properties
• Methods
• Adding events to your Gantt charts
• Adding vertical and horizontal bars to your Gantt chart
• 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: 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: {
            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)',
            tooltips: [
                "<b>Richard</b><br />Richard is going on holiday.<br />He'll be away for 28 days.",
                "<b>Fred</b><br />Fred is also going away for 28 days",
                "<b>Barney</b><br />Barney is off work for two weeks",
                "<b>Gloria</b><br />Gloria is off work for 3 weeks",
                "<b>Paul</b><br /> Away for 31 days",
                "<b>Harry</b><br />Away for three weeks",
                "<b>Shane</b><br />Away for one week",
                "<b>Barry</b><br />Away for two weeks",
                "<b>Cynthia</b><br />Away for two weeks",
                "<b>Graham</b><br />Away for August and September",
                "<b>Paul</b><br />Away for 31 days"
            ],
            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 above.

• Background properties
• X axis properties
• Y axis properties
• Other axis properties
• Color properties
• Margin properties
• Labels and text properties
• Title properties
• Interactive features properties
• Event properties
• Miscellaneous properties

Background properties

X axis properties

Y axis properties

Color properties

Margin properties

Labels and text properties

<div style="margin-left: 50px; display: inline-block">
    <canvas id="cvs" width="650" height="250"></canvas>
</div>

<div style="margin-left: 50px; display: inline-block">
    <canvas id="cvs" width="650" height="250"></canvas>
</div>

Title properties

Interactive features properties

Event properties

Miscellaneous properties

Methods

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 returns the details of a focused bar (ie clicked or hovered over). It returns:

• The chart object
• The X coordinate
• The Y coordinate
• The width of the bar
• The height of the bar
• The index of the bar (starting from 0)

The shape also includes textual indexes like this: shape['object'] And they are:

• object
• x
• y
• width
• height
• tooltip
• index

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.

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);
    
    // ...
}

This method can be used to set an event listener on an object. It operates in a similar way 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 event code here
});

The exec function is documented 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.

Animation effects

• 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)
    {
        // ...
    }

    var 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>