The drawing API Marker2 object

Summary: The drawing API Marker2 object can be added to your chart and provides a way for you to bring attention to a point or provide extra information to your users.

• Properties
• Methods
• Custom RGraph events that are available

The marker2 object allows you to add extra information to your charts in the form of markers. These markers can then give even more information in the form of tooltips or by using the event properties.

Usage example

<script>
    line = new RGraph.Line({
        id: 'cvs',
        data: [4,9,1,3,2,6,5],
        options: {
            xaxisLabels: ['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'],
            marginInner: 5,
            colors: ['black'],
            tooltips: ['A'],
            marginBottom: 35,
            shadow: false,
            tickmarksStyle: 'none',
            spline: true
        }
    }).draw();

    x = line.coords[3][0];
    y = line.coords[3][1];

    new RGraph.Drawing.Marker2({
        id: 'cvs',
        x: x,
        y: y,
        text: 'Note',
        options: {
            textSize: 18,
            tooltips: ['<b>Note</b><br />Extra information can be displayed'],
            tooltipsCss: {
                lineHeight: '15px',
                textAlign: 'left'
            },
            highlightFill: 'rgba(255,0,0,0.5)',
            shadow: false
        }
    }).draw();
</script>

Properties

• Color properties
• Text properties
• Shadow properties
• Interactive features properties
• Miscellaneous properties

Color properties

Text properties

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

tooltips: {
    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;
}

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

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

Miscellaneous properties

Methods

<script>
    marker2.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 Marker2 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 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:

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.Marker2({
    id: 'cvs',
    x: 100,
    y: 100,
    text: 'Note',
}).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.

Custom RGraph events that are available

Custom RGraph events are events that RGraph fires when certain actions occur. There is a more comprehensive list of these events here . Here's some example code that show you how to add these events to your chart.

• click
• mousemove
• mouseover
• mouseout

There's more documentation about events available here: Summary of events documentation

<script>
    marker2 = new RGraph.Drawing.Marker2({
        id: 'cvs',
        x: 50,
        y: 50,
        text: 'Some example text!',
        options: {
        }
    }).draw().on('click', function (e, shape)
    {
        // Add your click event listener code here

    }).on('mousemove', function (e, shape)
    {
        // Add your mousemove event listener code here

    }).on('mouseover', function (e, shape)
    {
        // Add your mouseover event listener code here

    }).on('mouseout', function (obj)
    {
        // Add your mouseout event listener code here
    });
</script>