Bipolar charts documentation

 

 

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');

Layout style:     
  

Margins

PropertyDescriptionDefault
gutterLeftThe left gutter of the chart.25
gutterRightThe right gutter of the chart.25
gutterTopThe top gutter of the chart.25
gutterBottomThe bottom gutter of the chart.25
gutterCenterThe center area of the chart that the labels sit in. If your labels are large then you may need to increase this.60
marginThe space above and below each bar.2

Background

PropertyDescriptionDefault
backgroundGridWhether the background grid is enabled or nottrue
backgroundGridColorThe color of the background grid#ddd
backgroundGridLinewidthThe linewidth of the background grid1
backgroundGridHlinesWhether the grid has horizontal linestrue
backgroundGridVlinesWhether the grid has vertical linestrue
backgroundGridAutofitNumvlinesnull (linked to the number of scale points there is)
backgroundGridAutofitNumhlinesnull (linked to the number of data items you've specified)

Titles

PropertyDescriptionDefault
titleThe main title of the chart.(An empty string)
titleBackgroundThe background color (if any) for the title.null
titleXTo give the exact X coordinate for the title - use thisnull
titleYTo give the exact Y coordinate for the title - use thisnull
titleColorThe color of the title.black
titleFontThe font that the title is rendered in. If not specified the text.font setting is used (usually Arial)null
titleSizeThe size of the title. If not specified the size is usually 2pt bigger than the text.size setting.null
titleBoldWhather the title is bold or not.true
titleItalicWhether the title is italic or not.false
titleLeftThe left title.An empty string
titleRightThe right title.An empty string

Colors

PropertyDescriptionDefault
colorsAn array of colors. These too can be gradients that you make if you wish.['#fcf', '#00f', '#f00', '#0f0', '#ff0', '#0ff', '#f0f', '#ff6101', '#b401ff', '#e4ff01', '#fb8195', '#ccc']
colorsSequentialIf 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.false
strokestyleThis is the color used as the stroke style. If you didn't want it, you could set this to rgba(0,0,0,0)#333

Labels, text and axes

PropertyDescriptionDefault
xtickintervalThe X tick mark interval.null
axisColorThe color of the axes.black
axisLinewidthThe linewidth of the axes.1
noaxesSet to true if you don't want any axes drawn.false
noxaxisSet this to true if you don't want a X axis.false
noyaxisSet this to true if you don't want a Y axis.false
xmaxThis allows you to set the maximum X value that the chart uses, instead of it being auto-generated.null
labelsAn array of the charts labels (they go in the middle).null
labelsColorThe color of the labelsnull (same as textColor)
labelsAboveSet this to true if you want labels drawn above the bars.false
labelsCountThis controls how many scale labels that are displayed5
xlabelsWhether the X labels (the scale) are drawn.true
textAccessibleA 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>
true
textAccessibleOverflowThis 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.visible
textAccessiblePointereventsThis controls whether the DOM text responds to mouse based events or not (it sets the pointer-events CSS property to none).true
textSizeThe size of the text used (in points).10
textFontThe font used to render the text.Arial
textColorThe color of the labels.black

Scale

PropertyDescriptionDefault
scaleFormatterTo 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);
null
scaleDecimalsThe number of decimal places to display for the Y scale.0
scalePointThe character used as the decimal point..
scaleThousandThe character used as the thousand separator,
scaleRoundWhether to round the maximum scale value up or not. This will produce slightly better scales in some instances.null
scaleZerostartWhether to show zero on the scale or nottrue
unitsPreThe units that are applied to the X axis labels (these are pre-pended to the number).none
unitsPostThe units that are applied to the X axis labels (these are appended to the number).none

Interactive features

PropertyDescriptionDefault
tooltipsA numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML.An empty array
tooltipsEffectThe effect used for showing tooltips. Can be either fade or none.fade
tooltipsCssClassThis is the name of the CSS class the chart uses.RGraph_tooltip
tooltipsOverrideIf 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 pagenull
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
contextmenuAn array of context menu items. Cannot be used in conjunction with tooltips.[] (An empty array)
annotatableWhether annotations are enabled for the chart (ie you can draw on the chart interactively.false
annotateColorIf you do not allow the use of the palette, then this will be the only colour allowed for annotations.black
annotateLinewidthThis is the line width of the annotations.1
resizableDefaulting 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).false
resizeHandleBackgroundWith 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.null
resizableMaxwidthThis allows you to set a maximum width that the chart can be resized to.null
resizableMaxheightThis allows you to set a maximum height that the chart can be resized to.null

Shadow

PropertyDescriptionDefault
shadowTurns the shadow on or off.false
shadowColorThe color of the shadow.#666
shadowOffsetxThe horizontal offset of the shadow.3
shadowOffsetyThe vertical offset of the shadow.3
shadowBlurHow severe the blurring effect is for the shadow.3

Zoom

PropertyDescriptionDefault
zoomFactorThis is the factor that the chart will be zoomed by (bigger values means more zoom)1.5
zoomFadeInWhether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.true
zoomFadeOutWhether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.true
zoomHdirThe horizontal direction of the zoom. Possible values are: left, center, rightright
zoomVdirThe vertical direction of the zoom. Possible values are: up, center, downdown
zoomDelayThe delay (in milliseconds) between frames.50
zoomFramesThe number of frames in the zoom animation.10
zoomShadowWhether or not the zoomed canvas has a shadow or not.true

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
eventsMouseoverIf you want to add your own onmouseover function you can do so by assigning it to this property. See here for details.null
eventsMouseoutIf you want to add your own onmouseout 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
highlightStrokeIf you use tooltips, this controls the colour of the highlight stroke.black
highlightFillIf you use tooltips, this controls the colour of the highlight fill.rgba(255,255,255,0.5)
linewidthThe thickness of the strokes used.1
cleartoThis is used in animations and effects as the default color to use when the canvas.null
variantThis stipulates whether you want a regular bar chart or a 3D chart. Possible values are:
  • bipolar
  • 3d
bipolar
variantThreedOffsetxThis determines the size of the offset in the X direction10
variantThreedOffsetyThis determines the size of the offset in the Y direction5

 

 

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>
RGraph on social media