The drawing API marker2 object

Share RGraph:  
[No canvas support]

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>
    var line = new RGraph.Line({
        id: 'cvs',
        data: [4,9,1,3,2,6,5],
        options: {
            labels: ['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'],
            hmargin: 5,
            tickmarks: 'endcircle',
            colors: ['black'],
            tooltips: ['A','B','C','D','E','F','G'],
            gutterBottom: 35,
            textSize: 14
        }
    }).draw()

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

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

Properties

Layout style:     
  

Colors

PropertyDescriptionDefault
strokestyleThe color used to stroke the circle.transparent
fillstyleThe color used to fill the circle.red

Text

PropertyDescriptionDefault
textFontThis is the font that the text is rendered in.Arial
textSizeThe size of the text.12
textColorThe color that the text is rendered in.black

Shadow

PropertyDescriptionDefault
shadowThis controls whether the shadow is enabled or not.false
shadowColorThe color of the shadow.gray
shadowOffsetxThe X offset that the shadow is drawn at.3
shadowOffsetyThe Y offset that the shadow is drawn at.3
shadowBlurThe severity of the shadow blur.5

Interactive features

PropertyDescriptionDefault
tooltipsThe tooltip for the circle. Even though you can only have one - this should still be an array: mycircle.set('tooltips', ['The tooltip']);null
tooltipsEventThis can be onclick or onmousemove and controls what event is used to trigger the tooltip.onclick
tooltipsHighlightThis stipulates whether the circle will be highlighted when the tooltip is shown.true
tooltipsNohideonclearNot an option that you'll need particularly often if at all. Setting this to true means that when you call the RGraph.clear() API function tooltip DO NOT get hidden.false

Events

PropertyDescriptionDefault
eventsClickIf you want to add your own onclick function you can do so by assigning it to this property. See here for details.null
eventsMousemoveIf you want to add your own onmousemove function you can do so by assigning it to this property. See here for details.null

Miscellaneous

PropertyDescriptionDefault
highlightStyleBy default this is null but you can set it to a function if you wish so that function is called to do the chart highlighting. Its passed the shape object as an argument.null
highlightStrokeThis is the color that the circle is highlighted (the stroke) in when the tooltip is shown.black
highlightFillThis is the color that the circle is highlighted in (the fill) when the tooltip is shown.rgba(255,255,255,0.7)
linewidthThis is the linewidth used to draw the marker.2
voffsetThis allows you to control how "high" the flag is from the bottom of the "flag pole".20

Comments

© Copyright Richard Heyes 2008-2017