Bipolar charts documentation

Share RGraph:   

 

 

Example

<script>
    // The Bipolar chart takes two arrays of data - one for the left side and one for the right.
    var left  = [5,6,8,9,12,13,4,9];
    var right = [5,8,4,11,15,26,13,16];
    
    var bipolar = new RGraph.Bipolar({
        id: 'cvs',
        left: left,
        right: right,
        options: {
            colors: ['red'],
            hmargin: 3,
            labels: ['Barry', 'John', 'Fred', 'George', 'Rich', 'Larry', 'John', 'Mike'],
            titleLeft: '2007',
            titleRight: '2008',
            gutterBottom: 45
        }
    }).draw();
</script>

The example file is here.

 

 

Properties

You can use these properties to control how the chart apears. You can set them by using the Set() method. Eg:

myBipolar.set('name', 'value');

 

Margins

gutterLeft
The left gutter of the chart.
Default: 25

gutterRight
The right gutter of the chart.
Default: 25

gutterTop
The top gutter of the chart.
Default: 25

gutterBottom
The bottom gutter of the chart.
Default: 25

gutterCenter
The center area of the chart that the labels sit in. If your labels are large then you may need to increase this.
Default: 60

margin
The space above and below each bar.
Default: 2

 

Background

backgroundGrid
Whether the background grid is enabled or not
Default: true

backgroundGridColor
The color of the background grid
Default: #ddd

backgroundGridLinewidth
The linewidth of the background grid
Default: 1

backgroundGridHlines
Whether the grid has horizontal lines
Default: true

backgroundGridVlines
Whether the grid has vertical lines
Default: true

backgroundGridAutofitNumvlines

Default: null (linked to the number of scale points there is)

backgroundGridAutofitNumhlines

Default: null (linked to the number of data items you've specified)

 

Titles

title
The main title of the chart.
Default: (An empty string)

titleBackground
The background color (if any) for the title.
Default: null

titleX
To give the exact X coordinate for the title - use this
Default: null

titleY
To give the exact Y coordinate for the title - use this
Default: null

titleColor
The color of the title.
Default: black

titleFont
The font that the title is rendered in. If not specified the text.font setting is used (usually Arial)
Default: null

titleSize
The size of the title. If not specified the size is usually 2pt bigger than the text.size setting.
Default: null

titleBold
Whather the title is bold or not.
Default: true

titleItalic
Whether the title is italic or not.
Default: false

titleLeft
The left title.
Default: An empty string

titleRight
The right title.
Default: An empty string

 

Colors

colors
An array of colors. These too can be gradients that you make if you wish.
Default: ['#fcf', '#00f', '#f00', '#0f0', '#ff0', '#0ff', '#f0f', '#ff6101', '#b401ff', '#e4ff01', '#fb8195', '#ccc']

colorsSequential
If you want the colors to be used in a sequential fashion (they're used in a similar way to other charts by default) then set this to true.
Default: false

strokestyle
This is the color used as the stroke style. If you didn't want it, you could set this to rgba(0,0,0,0)
Default: #333

 

Labels, text and axes

xtickinterval
The X tick mark interval.
Default: null

axisColor
The color of the axes.
Default: black

axisLinewidth
The linewidth of the axes.
Default: 1

noaxes
Set to true if you don't want any axes drawn.
Default: false

noxaxis
Set this to true if you don't want a X axis.
Default: false

noyaxis
Set this to true if you don't want a Y axis.
Default: false

xmax
This allows you to set the maximum X value that the chart uses, instead of it being auto-generated.
Default: null

labels
An array of the charts labels (they go in the middle).
Default: null

labelsColor
The color of the labels
Default: null (same as textColor)

labelsAbove
Set this to true if you want labels drawn above the bars.
Default: false

labelsCount
This controls how many scale labels that are displayed
Default: 5

xlabels
Whether the X labels (the scale) are drawn.
Default: true

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

textAccessibleOverflow
This can be visible or hidden and it controls whether the text is clipped to the edges of the canvas. It defaults to be visible and means you can set small gutters if you wish.
Default: visible

textAccessiblePointerevents
This controls whether the DOM text responds to mouse based events or not (it sets the pointer-events CSS property to none).
Default: true

textSize
The size of the text used (in points).
Default: 10

textFont
The font used to render the text.
Default: Arial

textColor
The color of the labels.
Default: black

 

Scale

scaleFormatter
To allow thoroughly custom formats of numbers in the scale, you can use this option to specify a function that is used by RGraph to format numbers. This function should handle ALL of the formatting. Eg:

function myFormatter(obj, num)
{
    return num + 'F'; // An example of formatting
}
myGraph.set('scale.formatter', myFormatter);

Default: null

scaleDecimals
The number of decimal places to display for the Y scale.
Default: 0

scalePoint
The character used as the decimal point.
Default: .

scaleThousand
The character used as the thousand separator
Default: ,

scaleRound
Whether to round the maximum scale value up or not. This will produce slightly better scales in some instances.
Default: null

scaleZerostart
Whether to show zero on the scale or not
Default: true

unitsPre
The units that are applied to the X axis labels (these are pre-pended to the number).
Default: none

unitsPost
The units that are applied to the X axis labels (these are appended to the number).
Default: none

 

Interactive features

tooltips
A numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML.
Default: An empty array

tooltipsEffect
The effect used for showing tooltips. Can be either fade or none.
Default: fade

tooltipsCssClass
This is the name of the CSS class the chart uses.
Default: RGraph_tooltip

tooltipsOverride
If you wish to handle showing tooltips yourself, this should be a function object which does just that. There's more information on the tooltips documentation page
Default: null

tooltipsCoordsPage
If set to true the tooltips will be positioned using the .pageX and .pageY coordinates. If you use canvas tags that are offset from the .pageX and .pageY coordinates - this can help with tooltip positioning.
Default: false

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 tooltip DO NOT get hidden.
Default: false

contextmenu
An array of context menu items. Cannot be used in conjunction with tooltips.
Default: [] (An empty array)

annotatable
Whether annotations are enabled for the chart (ie you can draw on the chart interactively.
Default: false

annotateColor
If you do not allow the use of the palette, then this will be the only colour allowed for annotations.
Default: black

annotateLinewidth
This is the line width of the annotations.
Default: 1

resizable
Defaulting to false, this determines whether your chart will be resizable. Because of the numerous event handlers this has to install code on, This feature is unlikely to work with other dynamic features (the context menu is fine however).
Default: false

resizeHandleBackground
With this you can specify the background color for the resize handle. If you're adjusting the position of the handle then you may need this to make the handle stand out more.
Default: null

resizableMaxwidth
This allows you to set a maximum width that the chart can be resized to.
Default: null

resizableMaxheight
This allows you to set a maximum height that the chart can be resized to.
Default: null

 

Shadow

shadow
Turns the shadow on or off.
Default: false

shadowColor
The color of the shadow.
Default: #666

shadowOffsetx
The horizontal offset of the shadow.
Default: 3

shadowOffsety
The vertical offset of the shadow.
Default: 3

shadowBlur
How severe the blurring effect is for the shadow.
Default: 3

 

Zoom

zoomFactor
This is the factor that the chart will be zoomed by (bigger values means more zoom)
Default: 1.5

zoomFadeIn
Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.
Default: true

zoomFadeOut
Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.
Default: true

zoomHdir
The horizontal direction of the zoom. Possible values are: left, center, right
Default: right

zoomVdir
The vertical direction of the zoom. Possible values are: up, center, down
Default: down

zoomDelay
The delay (in milliseconds) between frames.
Default: 50

zoomFrames
The number of frames in the zoom animation.
Default: 10

zoomShadow
Whether or not the zoomed canvas has a shadow or not.
Default: true

 

Events

eventsClick
If you want to add your own onclick 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 onmousemove 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 onmouseover function you can do so by assigning it to this property. See here for details.
Default: null

 

Miscellaneous

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. Its passed the shape object as an argument.
Default: null

highlightStroke
If you use tooltips, this controls the colour of the highlight stroke.
Default: black

highlightFill
If you use tooltips, this controls the colour of the highlight fill.
Default: rgba(255,255,255,0.5)

linewidth
The thickness of the strokes used.
Default: 1

clearto
This is used in animations and effects as the default color to use when the canvas.
Default: null

variant
This stipulates whether you want a regular bar chart or a 3D chart. Possible values are:
Default: bipolar

variantThreedOffsetx
This determines the size of the offset in the X direction
Default: 10

variantThreedOffsety
This determines the size of the offset in the Y direction
Default: 5

 

 

Methods

 

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

 

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

 

obj.getShape(event)

This method when used in an event will return the details of the bar that was clicked on moused over (if any). It returns:

The shape also includes textual indexes like this: shape['object'] And they are:

 

obj.getXCoord(value)

This method can be used to get an appropriate X coordinate for a value when you're doing custom drawing on the chart. It returns an array containing two values - one for each side - and it returns null if the value is out of range.

 

obj.on(event, func)

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 you wish to attach to and the second is the handler function. For example:

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

 

The exec option and method

The exec function is documented here.

 

Animation Effects

These effects are available and can be used instead of the .draw() function. There are also generic effects available which you can see here: Generic effects and transitions
<script>
    window.onload = (function ()
    {
        /**
        * Optional callback function that's called when the effect is complete
        */
        function myCallback (obj)
        {
            // ...
        }
    
    
        var left  = [4,8,6,3,1,2,5];
        var right = [15,13,18,19,12,16,14];
    
        var bipolar = new RGraph.Bipolar({
            id: 'cvs',
            left: left,
            right: right,
            options: {
                gutterCenter: 135,
                titleLeft: 'August 2013',
                titleRight: 'August 2014',
                textSize: 16,
                textColor: '#666',
                labels: ['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'],
                colors: ['gradient(red:red:red:#a00:#a00:#a00:#600:#a00:red:red:red)']
            }
        }).grow({frames: 60}, myCallback);
        //}).wave({frames: 60}, myCallback);
    });
</script>

Comments

Add a new comment...