The drawing API rect object

Summary: The drawing API rect object which be added to your chart and provides a way for you to give your charts extra interactivity

The rect object allows you to add a rectangle to your charts. The rectangle can be used as a way to provide an extra tooltip (for example) to your users.

Usage example

<script>
    var line = new RGraph.Line({
        id: 'cvs',
        data: [4,9,1,3,2,6,5],
        options: {
            axes: false,
            backgroundGridVlines: false,
            backgroundGridBorder: false,
            xaxisLabels: ['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'],
            marginInner: 5,
            tickmarksStyle: 'none',
            shadow: false,
            spline: true,
            colors: ['black']
        }
    }).draw()
    
    var rect = new RGraph.Drawing.Rect({
        id: 'cvs',
        x: 35,
        y: line.canvas.height - 35 - 50,
        width: 50,
        height: 50,
        options: {
            colorsStroke: 'transparent',
            colorsFill: 'rgba(255,255,0,0.7)',
            shadow: true,
            shadowColor: '#aaa',
            shadowBlur: 2,
            shadowOffsetx: 2,
            shadowOffsety: 2,
            tooltips: ['<b>Example</b><br />This is an example tooltip'],
            highlightStroke: 'transparent'
        }
    }).draw()
</script>

Color properties

Property	Description	Default
colorsStroke	The color used to stroke the circle.	transparent
colorsFill	The color used to fill the circle.	red

colorsStroke
The color used to stroke the circle.
Default: transparent

colorsFill
The color used to fill the circle.
Default: red

Shadow properties

Property	Description	Default
shadow	This controls whether the shadow is enabled or not.	false
shadowColor	The color of the shadow.	gray
shadowOffsetx	The X offset that the shadow is drawn at.	3
shadowOffsety	The Y offset that the shadow is drawn at.	3
shadowBlur	The severity of the shadow blur.	5

shadow
This controls whether the shadow is enabled or not.
Default: false

shadowColor
The color of the shadow.
Default: gray

shadowOffsetx
The X offset that the shadow is drawn at.
Default: 3

shadowOffsety
The Y offset that the shadow is drawn at.
Default: 3

shadowBlur
The severity of the shadow blur.
Default: 5

Interactive features properties

Property	Description	Default
tooltips	The tooltip for the circle. Even though you can only have one - this should still be an array: `obj.set('tooltips', ['The tooltip']);`	null
tooltipsEvent	This can be `click` or `mousemove` and controls what event is used to trigger the tooltip.	click
tooltipsHighlight	This stipulates whether the circle will be highlighted when the tooltip is shown.	true
tooltipsNohideonclear	Not 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 the tooltip DOES NOT get hidden.	false

tooltips
The tooltip for the circle. Even though you can only have one - this should still be an array: obj.set('tooltips', ['The tooltip']);
Default: null

tooltipsEvent
This can be click or mousemove and controls what event is used to trigger the tooltip.
Default: click

tooltipsHighlight
This stipulates whether the circle will be highlighted when the tooltip is shown.
Default: true

tooltipsNohideonclear
Not 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 the tooltip DOES NOT get hidden.
Default: false

Event properties

Property	Description	Default
eventsClick	If you want to add your own `click` function you can do so by assigning it to this property. See here for details.	null
eventsMousemove	If you want to add your own `mousemove` function you can do so by assigning it to this property. See here for details.	null
eventsMouseover	If you want to add your own `mouseover` function you can do so by assigning it to this property. See here for details.	null
eventsMouseout	If you want to add your own `mouseout` function you can do so by assigning it to this property. See here for details.	null

eventsClick
If you want to add your own click function you can do so by assigning it to this property. See here for details.
Default: null

eventsMousemove
If you want to add your own mousemove function you can do so by assigning it to this property. See here for details.
Default: null

eventsMouseover
If you want to add your own mouseover function you can do so by assigning it to this property. See here for details.
Default: null

eventsMouseout
If you want to add your own mouseout function you can do so by assigning it to this property. See here for details.
Default: null

Miscellaneous properties

Property	Description	Default
highlightStyle	By 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. It's passed the shape object as an argument.	null
highlightStroke	This is the color that the circle is highlighted (the stroke) in when the tooltip is shown.	black
highlightFill	This is the color that the circle is highlighted in (the fill) when the tooltip is shown.	rgba(255,255,255,0.7)

highlightStyle
By 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. It's passed the shape object as an argument.
Default: null

highlightStroke
This is the color that the circle is highlighted (the stroke) in when the tooltip is shown.
Default: black

highlightFill
This is the color that the circle is highlighted in (the fill) when the tooltip is shown.
Default: rgba(255,255,255,0.7)