The drawing API Text object API reference

• Usage example
• Properties
• Methods

The drawing api text object makes it easy to add text to your charts and being a drawing api object - you can also easily add event listeners or tooltips to it too. The chart to the right shows an example chart where the title is drawn using the drawing api text object.

Usage example

<script>
    line = new RGraph.Line({
        id: 'cvs',
        data: [4,9,1,3,2,6,5],
        options: {
            spline: true,
            backgroundGridVlines:false,
            backgroundGridBorder:false,
            xaxis: false,
            yaxis: false,
            xaxisLabels: ['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'],
            marginInner: 5,
            tickmarksStyle: 'endcircle',
            tickmarksSize: 10,
            colors: ['black'],
            textSize: 16
        }
    }).draw();


    x = line.canvas.width / 2;
    y = line.get('marginTop') + 5;

    text = new RGraph.Drawing.Text({
        id: 'cvs',
        x: x,
        y: y,
        text: 'An example of the \r\ndrawing API text object',
        options: {
            valign: 'top',
            halign: 'center',
            textSize: 18,
            tooltips: ['The drawing API text object'],
            tooltipsHighlight: false,
            tooltipsEvent: 'mousemove',
            shadow: true,
            shadowColor: 'red',
            shadowOffsetx: 0,
            shadowOffsety: 0,
            shadowBlur: 5
        }
    }).on('beforedraw', function (obj)
    {
        RGraph.setShadow(obj,'#aaa',2,2,5);
    }).on('draw', function (obj)
    {
        RGraph.noShadow(obj);
    }).draw();
</script>

Properties

• Configuration properties
• Color properties
• Bounding box properties
• Interactive features properties
• Link properties
• Shadow properties
• Other text properties
• Miscellaneous 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;
}

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

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

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

Methods

<script>
    text.canvas.onclick = function (e)
    {
        RGraph.redraw();
    
        var canvas = e.target,
            obj    = canvas.__object__,
            shape  = obj.getShape(e);

        if (shape) {            
            // Highlight the main body of the Text object.
            obj.path(
                'lw 10 b r % % % % s black f rgba(255,0,0,0.25)',
                shape.x, shape.y, shape.width, shape.height
            );
        }
    }
</script>

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:

obj.on('draw', function (obj)
{
    // Put your event code here
});

The function is useful if you use method chaining when creating your charts:

obj = new RGraph.Drawing.Text({
    
    id: 'cvs',
    x: 100,
    y: 100,
    text: 'Some sample text!',
    options: {
    }

}).on('draw', function (obj)
{
    // Put your draw event code here

}).on('click', function (e, shape)
{
    // Handle the click event

}).draw();

The exec function is documented here.