The Marker2 object

Usage example
Properties
Methods

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: {
            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.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>

View example on CodePen

Properties

Color properties
Text properties
Shadow properties
Interactive features properties
Miscellaneous properties

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

Text properties

Property	Description	Default
textFont	This is the font that the text is rendered in.	Arial, Verdana, sans-serif
textSize	The size of the text.	12
textColor	The color that the text is rendered in.	black
textBold	Whether the text is bold or not.	false
textItalic	Whether the text is italic or not.	false
textAccessible	A new feature in 2016 that allows you to use `DOM` text in place of `canvas` text. It makes for much higher quality text that you can also select if desired (for copy/paste operations). It won't fit all situations and you can read more about the `DOM` text feature here. A good way to control borders/margins/padding etc is not to set them on the `canvas` but to wrap the `canvas` in a `div` and set them on that like this: <div style="margin-left: 50px; display: inline-block"> <canvas id="cvs" width="650" height="250"></canvas> </div>	false
text	This allows you to add custom text to your chart if you want to. There's a dedicated page that describes this option here.	null

textFont
This is the font that the text is rendered in.
Default: Arial, Verdana, sans-serif

textSize
The size of the text.
Default: 12

textColor
The color that the text is rendered in.
Default: black

textBold
Whether the text is bold or not.
Default: false

textItalic
Whether the text is italic or not.
Default: false

textAccessible
A new feature in 2016 that allows you to use DOM text in place of canvas text. It makes for much higher quality text that you can also select if desired (for copy/paste operations). It won't fit all situations and you can read more about the DOM text feature here. A good way to control borders/margins/padding etc is not to set them on the canvas but to wrap the canvas in a div and set them on that like this:

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

Default: false

text
This allows you to add custom text to your chart if you want to. There's a dedicated page that describes this option here.
Default: null

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
tooltipsFormattedPoint	When using formatted tooltip strings this is used as the point when using the `%{value_formatted}` option.	.
tooltipsFormattedThousand	When using formatted tooltip strings this is used as the thousand separator when using the `%{value_formatted}` option.	,
tooltipsFormattedDecimals	When using formatted tooltip strings this specifies the number of decimals when using the `%{value_formatted}` option.	0
tooltipsFormattedUnitsPre	When using formatted tooltip strings these units are prepended to the number when using the `%{value_formatted}` option.	(an empty string)
tooltipsFormattedUnitsPost	When using formatted tooltip strings these units are appended to the number when using the `%{value_formatted}` option.	(an empty string)
tooltipsFormattedListType	With this property you can switch between an unordered list (the default) and an ordered list. Possible values are `ul` and `ol`.	ul
tooltipsFormattedListItems	This should be a two-dimensional array of the list items that are to be shown for all of the tooltips. An example of this property is: tooltipsFormattedListItems: [ ['Bill','Jerry','Berty'], // First tooltip ['Gill','Carrie','Lucy'], // Second tooltip ['Pob','Nobby','Hilda'] // Third tooltip ] You can use `CSS` to style this list - for example: .RGraph_tooltip ul#rgraph_formatted_tooltips_list li { text-align: left; color: yellow; }	null
tooltipsFormattedTableHeaders	When showing a table in the tooltips this can be an array of headers for the table. These are added to the tooltip using `th` tags.	null
tooltipsFormattedTableData	This is the data that is added to the table. This is a 3-dimensional array so it's easy to make a mistake. See the example, copy the code from it and then modify it suit. You'll create fewer bugs this way.	null)
tooltipsPointer	By default the tooltips have a small triangular pointer that points to the shape that was clicked on. You can turn this off with this property.	true
tooltipsPointerCss	If you want any `CSS` values applied to the tooltips pointer (a `CSS` border, for example) then specify an object containing those values to this property. For example: tooltips: { borderLeft: 'gray 2px solid', borderBottom: 'gray 2px solid' }	null
tooltipsPositionStatic	The new default (as of August 2020) is for tooltips to be positioned statically and not be dependent on the mouse position. If you don't want this for whatever reason, you can disable it with this setting. When you set it to `false` tooltips are positioned next to the mouse pointer.	true
tooltipsCss	If you want to specify some `CSS` that gets applied to all of the tooltips, but don't want to use the `RGraph.tooltips.style` object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object `CSS` for the tooltips. These are `CSS` styles that get applied to all of the tooltips for the specific object only. It should look like this: tooltipsCss: { fontFamily: 'Verdana', fontSize: '20pt', }	null
tooltipsOffsetx	This property allows you to shift the tooltips left or right.	0
tooltipsOffsety	This property allows you to shift the tooltips up or down.	0

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

tooltipsFormattedPoint
When using formatted tooltip strings this is used as the point when using the %{value_formatted} option.
Default: .

tooltipsFormattedThousand
When using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.
Default: ,

tooltipsFormattedDecimals
When using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option.
Default: 0

tooltipsFormattedUnitsPre
When using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.
Default: (an empty string)

tooltipsFormattedUnitsPost
When using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.
Default: (an empty string)

tooltipsFormattedListType
With this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol.
Default: ul

tooltipsFormattedListItems
This should be a two-dimensional array of the list items that are to be shown for all of the tooltips. An example of this property is:

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

You can use CSS to style this list - for example:

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

Default: null

tooltipsFormattedTableHeaders
When showing a table in the tooltips this can be an array of headers for the table. These are added to the tooltip using th tags.
Default: null

tooltipsFormattedTableData
This is the data that is added to the table. This is a 3-dimensional array so it's easy to make a mistake. See the example, copy the code from it and then modify it suit. You'll create fewer bugs this way.
Default: null)

tooltipsPointer
By default the tooltips have a small triangular pointer that points to the shape that was clicked on. You can turn this off with this property.
Default: true

tooltipsPointerCss
If you want any CSS values applied to the tooltips pointer (a CSS border, for example) then specify an object containing those values to this property. For example:

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

Default: null

tooltipsPositionStatic
The new default (as of August 2020) is for tooltips to be positioned statically and not be dependent on the mouse position. If you don't want this for whatever reason, you can disable it with this setting. When you set it to false tooltips are positioned next to the mouse pointer.
Default: true

tooltipsCss
If you want to specify some CSS that gets applied to all of the tooltips, but don't want to use the RGraph.tooltips.style object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object CSS for the tooltips. These are CSS styles that get applied to all of the tooltips for the specific object only. It should look like this:

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

Default: null

tooltipsOffsetx
This property allows you to shift the tooltips left or right.
Default: 0

tooltipsOffsety
This property allows you to shift the tooltips up or down.
Default: 0

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.	#fc
linewidth	This is the `linewidth` used to draw the marker.	2
voffset	This allows you to control how "high" the flag is from the bottom of the "flag pole".	20

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: #fc

linewidth
This is the linewidth used to draw the marker.
Default: 2

voffset
This allows you to control how "high" the flag is from the bottom of the "flag pole".
Default: 20

Methods

obj.get(name)
An accessor that you can use to retrieve the values of properties.

obj.set(name, value)
An accessor that you can use to set the values of properties.

obj.getShape(event)
This method makes it easy to get hold of the marker when it has been clicked on or hovered over. It returns an object which has the following indexes available:

`object`	The chart object.
`x`	The X coordinate for the marker.
`Y`	The Y coordinate for the marker.
`width`	The width of the marker.
`height`	The height of the marker.
`dataset`	As there's only ever one element this is always zero.
`index`	As there's only ever one element this is always zero.
`sequentialIndex`	As there's only ever one element this is always zero.
`tooltip`	If a tooltip is associated with the Marker2 object this will be it.`id:` strings are expanded for you (where the tooltip text is retrieved from the `HTML` tag with the matching ID).

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

obj.on(event, function)

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.Marker2({
    id: 'cvs',
    x: 100,
    y: 100,
    text: 'Note',
    options: {
    }
}).on('draw', function (obj)
{
    // Put your draw event code here

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

}).draw();

obj.exec(function)

The exec function is documented here.