Gantt chart

• Example
• Properties
• Methods
• Adding events to your Gantt charts
• Adding vertical and horizontal bars to your Gantt chart
• 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

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

tooltipsFormattedListItems: [
    ['Bill','Jerry','Berty'], // First tooltip
    ['Gill','Carrie','Lucy'], // Second tooltip
    ['Pob','Nobby','Hilda']   // Third tooltip
]

.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
    text-align: left;
    color: yellow;
}

tooltipsPointerCss: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}

tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt'
}

tooltipsFormattedListItems: [
    ['Bill','Jerry','Berty'], // First tooltip
    ['Gill','Carrie','Lucy'], // Second tooltip
    ['Pob','Nobby','Hilda']   // Third tooltip
]

.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
    text-align: left;
    color: yellow;
}

tooltipsPointerCss: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}

tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt'
}

Miscellaneous properties

Methods

An accessor function that you can use to retrieve the values of properties.

An accessor that you can use to set the values of properties.

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

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

The exec function is documented here.

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.

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 standard mousedown event.
• adjust This event fires (repeatedly) during adjusting - like the standard mousemove event.
• adjustend This event fires at the end of adjusting - like the standard mouseup event.
• annotatebegin This event fires at the start of annotating - like the standard mousedown event.
• annotate This event fires (repeatedly) during annotating - like the standard mousemove event.
• annotateend This event fires at the end of annotating - like the standard mouseup event.
• annotateclear This event fires at the end of the RGraph.clearAnnotations function.
• beforeclear This event fires at the start of the RGraph.clear function.
• clear This event fires at the end of the RGraph.clear function.
• click This is similar to the standard canvas click event but this only fires when you click on a bar - not the whole canvas.
• 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 the draw method before anything has been done.
• firstdraw This event fires at the end of the draw function - but only the first time that the draw function is called.
• draw This event fires at the end of the draw function.
• mousemove This event is similar to the standard mousemove event but only fires when you move the mouse over a bar on the chart.
• mouseover This event is similar to the standard mouseover event but only fires when you move the mouse over a bar on the chart.
• mouseout This event is similar to the standard mouseout 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.

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

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