Overview
Scatter charts plot points on a graph. When the user hovers over the points, tooltips are displayed with more information.
Google scatter charts are rendered within the browser using SVG or VML depending on browser capabilities.
Example
<html> <head> <script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script> <script type="text/javascript"> google.charts.load('current', {'packages':['corechart']}); google.charts.setOnLoadCallback(drawChart); function drawChart() { var data = google.visualization.arrayToDataTable([ ['Age', 'Weight'], [ 8, 12], [ 4, 5.5], [ 11, 14], [ 4, 5], [ 3, 3.5], [ 6.5, 7] ]); var options = { title: 'Age vs. Weight comparison', hAxis: {title: 'Age', minValue: 0, maxValue: 15}, vAxis: {title: 'Weight', minValue: 0, maxValue: 15}, legend: 'none' }; var chart = new google.visualization.ScatterChart(document.getElementById('chart_div')); chart.draw(data, options); } </script> </head> <body> <div id="chart_div" style="width: 900px; height: 500px;"></div> </body> </html>
Changing and animating shapes
By default, scatter charts represent the elements of your dataset
with circles. You can specify other shapes with
the pointShape
option, detailed in
the Customizing
Points
documentation.
As with most other Google Charts, you can animate them using events
. You can add an
event listener for the first ready
event and redraw the chart
after making the desired modifications. After the first ready
event, you can listen
to the animationfinish
event to repeat the process, resulting in a continuous
animation. The animation
option controls how the redraw occurs: immediately
(no animation) or smoothly, and if smoothly how quickly and with what behavior.
var options = { legend : 'none' , colors : [ '#087037' ], pointShape : 'star' , pointSize : 18 , animation : { duration : 200 , easing : 'inAndOut' , } }; // Start the animation by listening to the first 'ready' event. google . visualization . events . addOneTimeListener ( chart , 'ready' , randomWalk ); // Control all other animations by listening to the 'animationfinish' event. google . visualization . events . addListener ( chart , 'animationfinish' , randomWalk ); ... function randomWalk () { ... }
< html > < head > < script type = "text/javascript" src = "https://www.gstatic.com/charts/loader.js" >< / script > < script type = "text/javascript" > google . charts . load ( "current" , { packages :[ "corechart" ]}); google . charts . setOnLoadCallback ( drawChart ); function drawChart () { var data = new google . visualization . DataTable (); data . addColumn ( 'number' ); data . addColumn ( 'number' ); var radius = 100 ; for ( var i = 0 ; i < 6.28 ; i += 0.1 ) { data . addRow ([ radius * Math . cos ( i ), radius * Math . sin ( i )]); } // Our central point , which will jiggle . data . addRow ([ 0 , 0 ]); var options = { legend : 'none' , colors : [ '#087037' ], pointShape : 'star' , pointSize : 18 , animation : { duration : 200 , easing : 'inAndOut' , } }; var chart = new google . visualization . ScatterChart ( document . getElementById ( 'animatedshapes_div' )); // Start the animation by listening to the first 'ready' event . google . visualization . events . addOneTimeListener ( chart , 'ready' , randomWalk ); // Control all other animations by listening to the 'animationfinish' event . google . visualization . events . addListener ( chart , 'animationfinish' , randomWalk ); chart . draw ( data , options ); function randomWalk () { var x = data . getValue ( data . getNumberOfRows () - 1 , 0 ); var y = data . getValue ( data . getNumberOfRows () - 1 , 1 ); x += 5 * ( Math . random () - 0.5 ); y += 5 * ( Math . random () - 0.5 ); if ( x * x + y * y > radius * radius ) { // Out of bounds . Bump toward center . x += Math . random () * (( x < 0 ) ? 5 : - 5 ); y += Math . random () * (( y < 0 ) ? 5 : - 5 ); } data . setValue ( data . getNumberOfRows () - 1 , 0 , x ); data . setValue ( data . getNumberOfRows () - 1 , 1 , y ); chart . draw ( data , options ); } } < / script > < / head > < body > < div id = "animatedshapes_div" style = "width: 500px; height: 500px;" >< / div > < / body > < / html >
Creating Material scatter charts
In 2014, Google announced guidelines intended to support a common look and feel across its properties and apps (such as Android apps) that run on Google platforms. We call this effort Material Design . We'll be providing "Material" versions of all our core charts; you're welcome to use them if you like how they look.
Creating a Material Scatter Chart is similar to creating what we'll now call a "Classic" Scatter
Chart. You load the Google Visualization API (although with the 'scatter'
package
instead of the 'corechart'
package), define your datatable, and then create an object
(but of class google.charts.Scatter
instead of google.visualization.ScatterChart
).
Note: Material Charts will not work in old versions of Internet Explorer. (IE8 and earlier versions don't support SVG, which Material Charts require.)
Material Scatter Charts have many small improvements over Classic Scatter Charts, including variable opacity for legibility of overlapping points, an improved color palette, clearer label formatting, tighter default spacing, softer gridlines and titles (and the addition of subtitles).
google . charts . load ( 'current' , { 'packages' :[ 'scatter' ]}); google . charts . setOnLoadCallback ( drawChart ); function drawChart () { var data = new google . visualization . DataTable (); data . addColumn ( 'number' , 'Hours Studied' ); data . addColumn ( 'number' , 'Final' ); data . addRows ([ [ 0 , 67 ], [ 1 , 88 ], [ 2 , 77 ], [ 3 , 93 ], [ 4 , 85 ], [ 5 , 91 ], [ 6 , 71 ], [ 7 , 78 ], [ 8 , 93 ], [ 9 , 80 ], [ 10 , 82 ],[ 0 , 75 ], [ 5 , 80 ], [ 3 , 90 ], [ 1 , 72 ], [ 5 , 75 ], [ 6 , 68 ], [ 7 , 98 ], [ 3 , 82 ], [ 9 , 94 ], [ 2 , 79 ], [ 2 , 95 ], [ 2 , 86 ], [ 3 , 67 ], [ 4 , 60 ], [ 2 , 80 ], [ 6 , 92 ], [ 2 , 81 ], [ 8 , 79 ], [ 9 , 83 ], [ 3 , 75 ], [ 1 , 80 ], [ 3 , 71 ], [ 3 , 89 ], [ 4 , 92 ], [ 5 , 85 ], [ 6 , 92 ], [ 7 , 78 ], [ 6 , 95 ], [ 3 , 81 ], [ 0 , 64 ], [ 4 , 85 ], [ 2 , 83 ], [ 3 , 96 ], [ 4 , 77 ], [ 5 , 89 ], [ 4 , 89 ], [ 7 , 84 ], [ 4 , 92 ], [ 9 , 98 ] ]); var options = { width : 800 , height : 500 , chart : { title : 'Students \' Final Grades' , subtitle : 'based on hours studied' }, hAxis : { title : 'Hours Studied' }, vAxis : { title : 'Grade' } }; var chart = new google . charts . Scatter ( document . getElementById ( 'scatterchart_material' )); chart . draw ( data , google . charts . Scatter . convertOptions ( options )); }
The Material Charts are in beta
. The appearance and
interactivity are largely final, but many of the options available in Classic Charts are not yet
available in them. You can find a list of options that are not yet supported in this issue
.
Also, the way options are declared is not finalized, so if you are using any of
the classic options, you must convert them to material options by replacing this line:
chart.draw(data, options);
...with this:
chart.draw(data, google.charts.Scatter.convertOptions(options));
Dual-Y charts
Sometimes you'll want to display two series in a scatter chart, with two independent y-axes: a left axis for one series, and a right axis for another:
Note that not only are our two y-axes labeled differently ("Final Exam Grade" versus
"Hours Studied") but they each have their own independent scales and gridlines. If you want to
customize this behavior, use the vAxis.gridlines
options.
In the code below, the axes
and series
options together specify the
dual-Y appearance of the chart. The series
option specifies which axis to use for
each ( 'final grade'
and 'hours studied'
; they needn't have any
relation to the column names in the datatable). The axes
option then makes this
chart a dual-Y chart, placing the 'Final Exam Grade'
axis on the left and the 'Hours Studied'
axis on the right.
google . charts . load ( 'current' , { 'packages' :[ 'corechart' , 'scatter' ]}); google . charts . setOnLoadCallback ( drawStuff ); function drawStuff () { var button = document . getElementById ( 'change-chart' ); var chartDiv = document . getElementById ( 'chart_div' ); var data = new google . visualization . DataTable (); data . addColumn ( 'number' , 'Student ID' ); data . addColumn ( 'number' , 'Hours Studied' ); data . addColumn ( 'number' , 'Final' ); data . addRows ([ [ 0 , 0 , 67 ], [ 1 , 1 , 88 ], [ 2 , 2 , 77 ], [ 3 , 3 , 93 ], [ 4 , 4 , 85 ], [ 5 , 5 , 91 ], [ 6 , 6 , 71 ], [ 7 , 7 , 78 ], [ 8 , 8 , 93 ], [ 9 , 9 , 80 ], [ 10 , 10 , 82 ], [ 11 , 0 , 75 ], [ 12 , 5 , 80 ], [ 13 , 3 , 90 ], [ 14 , 1 , 72 ], [ 15 , 5 , 75 ], [ 16 , 6 , 68 ], [ 17 , 7 , 98 ], [ 18 , 3 , 82 ], [ 19 , 9 , 94 ], [ 20 , 2 , 79 ], [ 21 , 2 , 95 ], [ 22 , 2 , 86 ], [ 23 , 3 , 67 ], [ 24 , 4 , 60 ], [ 25 , 2 , 80 ], [ 26 , 6 , 92 ], [ 27 , 2 , 81 ], [ 28 , 8 , 79 ], [ 29 , 9 , 83 ] ]); var materialOptions = { chart : { title : 'Students \' Final Grades' , subtitle : 'based on hours studied' }, width : 800 , height : 500 , series : { 0 : { axis : 'hours studied' }, 1 : { axis : 'final grade' } }, axes : { y : { 'hours studied' : { label : 'Hours Studied' }, 'final grade' : { label : 'Final Exam Grade' } } } }; var classicOptions = { width : 800 , series : { 0 : { targetAxisIndex : 0 }, 1 : { targetAxisIndex : 1 } }, title : 'Students \' Final Grades - based on hours studied' , vAxes : { // Adds titles to each axis . 0 : { title : 'Hours Studied' }, 1 : { title : 'Final Exam Grade' } } }; function drawMaterialChart () { var materialChart = new google . charts . Scatter ( chartDiv ); materialChart . draw ( data , google . charts . Scatter . convertOptions ( materialOptions )); button . innerText = 'Change to Classic' ; button . onclick = drawClassicChart ; } function drawClassicChart () { var classicChart = new google . visualization . ScatterChart ( chartDiv ); classicChart . draw ( data , classicOptions ); button . innerText = 'Change to Material' ; button . onclick = drawMaterialChart ; } drawMaterialChart (); };
Top-X charts
Note:
Top-X axes are available only for Material charts (i.e., those with package scatter
).
If you want to put the X-axis labels and title on the top of your chart rather than the bottom,
you can do that in Material charts with the axes.x
option:
google . charts . load ( 'current' , { 'packages' :[ 'scatter' ]}); google . charts . setOnLoadCallback ( drawChart ); function drawChart () { var data = new google . visualization . DataTable (); data . addColumn ( 'number' , 'Hours Studied' ); data . addColumn ( 'number' , 'Final' ); data . addRows ([ [ 0 , 67 ], [ 1 , 88 ], [ 2 , 77 ], [ 3 , 93 ], [ 4 , 85 ], [ 5 , 91 ], [ 6 , 71 ], [ 7 , 78 ], [ 8 , 93 ], [ 9 , 80 ], [ 10 , 82 ], [ 0 , 75 ], [ 5 , 80 ], [ 3 , 90 ], [ 1 , 72 ], [ 5 , 75 ], [ 6 , 68 ], [ 7 , 98 ], [ 3 , 82 ], [ 9 , 94 ], [ 2 , 79 ], [ 2 , 95 ], [ 2 , 86 ], [ 3 , 67 ], [ 4 , 60 ], [ 2 , 80 ], [ 6 , 92 ], [ 2 , 81 ], [ 8 , 79 ], [ 9 , 83 ], [ 3 , 75 ], [ 1 , 80 ], [ 3 , 71 ], [ 3 , 89 ], [ 4 , 92 ], [ 5 , 85 ], [ 6 , 92 ], [ 7 , 78 ], [ 6 , 95 ], [ 3 , 81 ], [ 0 , 64 ], [ 4 , 85 ], [ 2 , 83 ], [ 3 , 96 ], [ 4 , 77 ], [ 5 , 89 ], [ 4 , 89 ], [ 7 , 84 ], [ 4 , 92 ], [ 9 , 98 ] ]); var options = { width : 800 , height : 500 , chart : { title : 'Students \' Final Grades' , subtitle : 'based on hours studied' }, axes : { x : { 0 : { side : 'top' } } } }; var chart = new google . charts . Scatter ( document . getElementById ( 'scatter_top_x' )); chart . draw ( data , google . charts . Scatter . convertOptions ( options )); }
Loading
The google.charts.load
package name is "corechart"
,
and the visualization's class name is google.visualization.ScatterChart
.
google . charts . load ( "current" , { packages : [ "corechart" ]});
var visualization = new google . visualization . ScatterChart ( container );
For Material Scatter Charts, the google.charts.load
package name is "scatter"
,
and the visualization's class name is google.charts.Scatter
.
google . charts . load ( "current" , { packages : [ "scatter" ]});
var visualization = new google . charts . Scatter ( container );
Data format
Rows:Each row in the table represents a set of data points with the same x-axis value.
Columns:
To specify multiple series, specify two or more Y-axis columns, and specify Y values in only one Y column:
X-values | Series 1 Y Values | Series 2 Y Values |
---|---|---|
10
|
null | 75 |
20
|
null | 18 |
33
|
null | 22 |
55
|
16 | null |
14
|
61 | null |
48
|
3 | null |
Configuration options
-
'category'
: Group selected data by x-value. -
'series'
: Group selected data by series. -
'auto'
: Group selected data by x-value if all selections have the same x-value, and by series otherwise. -
'none'
: Show only one tooltip per selection.
aggregationTarget
will often be used in tandem with selectionMode
and tooltip.trigger
, e.g.:var options = { // Allow multiple // simultaneous selections . selectionMode : 'multiple' , // Trigger tooltips // on selections . tooltip : { trigger : 'selection' }, // Group selections // by x - value . aggregationTarget : 'category' , };
The duration of the animation, in milliseconds. For details, see the animation documentation .
The easing function applied to the animation. The following options are available:
- 'linear' - Constant speed.
- 'in' - Ease in - Start slow and speed up.
- 'out' - Ease out - Start fast and slow down.
- 'inAndOut' - Ease in and out - Start slow, speed up, then slow down.
Determines if the chart will animate on the initial draw. If true
, the chart will
start at the baseline and animate to its final state.
For charts that support annotations
,
the annotations.boxStyle
object controls the appearance of the boxes
surrounding annotations:
var options = { annotations : { boxStyle : { // Color of the box outline . stroke : '#888' , // Thickness of the box outline . strokeWidth : 1 , // x - radius of the corner curvature . rx : 10 , // y - radius of the corner curvature . ry : 10 , // Attributes for linear gradient fill . gradient : { // Start color for gradient . color1 : '#fbf6a7' , // Finish color for gradient . color2 : '#33b679' , // Where on the boundary to start and // end the color1 / color2 gradient , // relative to the upper left corner // of the boundary . x1 : '0%' , y1 : '0%' , x2 : '100%' , y2 : '100%' , // If true , the boundary for x1 , // y1 , x2 , and y2 is the box . If // false , it 's the entire chart. useObjectBoundingBoxUnits : true } } } };
This option is currently supported for area, bar, column, combo, line, and scatter charts. It is not supported by the Annotation Chart .
annotations.datum
object lets you override
Google Charts' choice for annotations provided for individual
data elements (such as values displayed with each bar on a bar
chart). You can control the color
with annotations.datum.stem.color
, the stem length
with annotations.datum.stem.length
, and the style with annotations.datum.style
.annotations.domain
object lets you override
Google Charts' choice for annotations provided for a domain (the
major axis of the chart, such as the X axis on a typical line
chart). You can control the color
with annotations.domain.stem.color
, the stem length
with annotations.domain.stem.length
, and the style with annotations.domain.style
.annotations.highContrast
boolean lets you override Google Charts' choice of
the annotation color. By default, annotations.highContrast
is true, which causes
Charts to select an annotation color with good contrast: light colors on dark backgrounds, and
dark on light. If you set annotations.highContrast
to false and don't specify
your own annotation color, Google Charts will use the default series color for the annotation:annotations.stem
object lets you override
Google Charts' choice for the stem style. You can control color
with annotations.stem.color
and the stem length
with annotations.stem.length
. Note that the stem
length option has no effect on annotations with
style 'line'
: for 'line'
datum
annotations, the stem length is always the same as the text, and
for 'line'
domain annotations, the stem extends
across the entire chart.annotations.style
option lets you override
Google Charts' choice of the annotation type. It can be
either 'line'
or 'point'
.annotations.textStyle
object controls the appearance of the text of
the annotation:var options = { annotations : { textStyle : { fontName : 'Times-Roman' , fontSize : 18 , bold : true , italic : true , // The color of the text . color : '#871b47' , // The color of the text outline . auraColor : '#d799ae' , // The transparency of the text . opacity : 0.8 } } };
This option is currently supported for area, bar, column, combo, line, and scatter charts. It is not supported by the Annotation Chart .
Where to place the axis titles, compared to the chart area. Supported values:
- in - Draw the axis titles inside the chart area.
- out - Draw the axis titles outside the chart area.
- none - Omit the axis titles.
The background color for the main area of the chart. Can be either a simple HTML color string,
for example: 'red'
or '#00cc00'
, or an object with the following
properties.
The color of the chart border, as an HTML color string.
The border width, in pixels.
The chart fill color, as an HTML color string.
For Material Charts , this option specifies the subtitle. Only Material Charts support subtitles.
An object with members to configure the placement and size of the chart area (where the chart
itself is drawn, excluding axis and legends). Two formats are supported: a number, or a
number followed by %. A simple number is a value in pixels; a number followed by % is a
percentage. Example: chartArea:{left:20,top:0,width:'50%',height:'75%'}
-
stroke
: the color, provided as a hex string or English color name. -
strokeWidth
: if provided, draws a border around the chart area of the given width (and with the color ofstroke
).
How far to draw the chart from the left border.
How far to draw the chart from the top border.
Chart area width.
Chart area height.
The colors to use for the chart elements. An array of strings, where each element is an HTML
color string, for example: colors:['red','#004411']
.
The crosshair color, expressed as either a color name (e.g., "blue") or an RGB value (e.g., "#adf").
An object containing the crosshair properties upon focus.
Example: crosshair: { focused: { color: '#3bc', opacity: 0.8 } }
The crosshair opacity, with 0.0
being fully transparent and 1.0
fully opaque.
The crosshair orientation, which can be 'vertical' for vertical hairs only, 'horizontal' for horizontal hairs only, or 'both' for traditional crosshairs.
An object containing the crosshair properties upon selection.
Example: crosshair: { selected: { color: '#3bc', opacity: 0.8 } }
When to display crosshairs: on 'focus'
, 'selection'
, or 'both'
.
Controls the curve of the lines when the line width is not zero. Can be one of the following:
- 'none' - Straight lines without curve.
- 'function' - The angles of the line will be smoothed.
The transparency of data points, with 1.0 being completely opaque and 0.0 fully transparent. In scatter, histogram, bar, and column charts, this refers to the visible data: dots in the scatter chart and rectangles in the others. In charts where selecting data creates a dot, such as the line and area charts, this refers to the circles that appear upon hover or selection. The combo chart exhibits both behaviors, and this option has no effect on other charts. (To change the opacity of a trendline, see trendline opacity .)
Whether the chart throws user-based events or reacts to user interaction. If false, the chart will not throw 'select' or other interaction-based events (but will throw ready or error events), and will not display hovertext or otherwise change depending on user input.
The explorer
option allows users to pan and zoom Google charts. explorer: {}
provides the default explorer behavior, enabling users to pan
horizontally and vertically by dragging, and to zoom in and out by scrolling.
This feature is experimental and may change in future releases.
Note: The explorer only works with continuous axes (such as numbers or dates).
The Google Charts explorer supports three actions:
-
dragToPan
: Drag to pan around the chart horizontally and vertically. To pan only along the horizontal axis, useexplorer: { axis: 'horizontal' }
. Similarly for the vertical axis. -
dragToZoom
: The explorer's default behavior is to zoom in and out when the user scrolls. Ifexplorer: { actions: ['dragToZoom', 'rightClickToReset'] }
is used, dragging across a rectangular area zooms into that area. We recommend usingrightClickToReset
wheneverdragToZoom
is used. Seeexplorer.maxZoomIn
,explorer.maxZoomOut
, andexplorer.zoomDelta
for zoom customizations. -
rightClickToReset
: Right clicking on the chart returns it to the original pan and zoom level.
By default, users can pan both horizontally and vertically when the explorer
option is used. If you want to users to only pan horizontally, use explorer: { axis: 'horizontal' }
. Similarly, explorer: { axis: 'vertical' }
enables vertical-only panning.
By default, users can pan all around, regardless of where the data is. To ensure that users
don't pan beyond the original chart, use explorer: { keepInBounds: true }
.
The maximum that the explorer can zoom in. By default, users will be able to zoom in enough
that they'll see only 25% of the original view. Setting explorer: { maxZoomIn: .5 }
would let users zoom in only far enough to see half
of the original view.
The maximum that the explorer can zoom out. By default, users will be able to zoom out far
enough that the chart will take up only 1/4 of the available space. Setting explorer: { maxZoomOut: 8 }
would let users zoom out far enough that the chart
would take up only 1/8 of the available space.
When users zoom in or out, explorer.zoomDelta
determines how much they zoom by.
The smaller the number, the smoother and slower the zoom.
The default font size, in pixels, of all text in the chart. You can override this using properties for specific chart elements.
The default font face for all text in the chart. You can override this using properties for specific chart elements.
Draws the chart inside an inline frame. (Note that on IE8, this option is ignored; all IE8 charts are drawn in i-frames.)
An object with members to configure various horizontal axis elements. To specify properties of this object, you can use object literal notation, as shown here:
{ title: 'Hello', titleTextStyle: { color: '#FF0000' } }
The baseline for the horizontal axis.
The color of the baseline for the horizontal axis. Can be any HTML color string, for example: 'red'
or '#00cc00'
.
The direction in which the values along the horizontal axis grow. Specify -1
to
reverse the order of the values.
A format string for numeric axis labels. This is a subset of the ICU pattern set
. For instance, {format:'#,###%'}
will display values "1,000%",
"750%", and "50%" for values 10, 7.5, and 0.5. You can also supply any of
the following:
-
{format: 'none'}
: displays numbers with no formatting (e.g., 8000000) -
{format: 'decimal'}
: displays numbers with thousands separators (e.g., 8,000,000) -
{format: 'scientific'}
: displays numbers in scientific notation (e.g., 8e6) -
{format: 'currency'}
: displays numbers in the local currency (e.g., $8,000,000.00) -
{format: 'percent'}
: displays numbers as percentages (e.g., 800,000,000%) -
{format: 'short'}
: displays abbreviated numbers (e.g., 8M) -
{format: 'long'}
: displays numbers as full words (e.g., 8 million)
The actual formatting applied to the label is derived from the locale the API has been loaded with. For more details, see loading charts with a specific locale .
In computing tick values and gridlines, several alternative
combinations of all the relevant gridline
options will be considered and alternatives will be rejected if the
formatted tick labels would be duplicated or overlap.
So you can specify format:"#"
if you want to only show integer tick values,
but be aware that if no alternative satisfies this condition,
no gridlines or ticks will be shown.
An object with properties to configure the gridlines on the horizontal axis. Note that horizontal axis gridlines are drawn vertically. To specify properties of this object, you can use object literal notation, as shown here:
{color: '#333', minSpacing: 20}
The color of the horizontal gridlines inside the chart area. Specify a valid HTML color string.
The approximate number of horizontal gridlines inside the chart area.
If you specify a positive number for gridlines.count
,
it will be used to compute the minSpacing
between gridlines.
You can specify a value of 1
to only draw one gridline,
or 0
to draw no gridlines.
Specify -1, which is the default,
to automatically compute the number of gridlines
based on other options.
Overrides the default format for various aspects of date/datetime/timeofday data types when used with chart computed gridlines. Allows formatting for years, months, days, hours, minutes, seconds, and milliseconds.
General format is:
gridlines: { units: { years: {format: [/*format strings here*/]}, months: {format: [/*format strings here*/]}, days: {format: [/*format strings here*/]} hours: {format: [/*format strings here*/]} minutes: {format: [/*format strings here*/]} seconds: {format: [/*format strings here*/]}, milliseconds: {format: [/*format strings here*/]}, } }
Additional information can be found in Dates and Times .
An object with members to configure the minor gridlines on the horizontal axis, similar to the hAxis.gridlines option.
The color of the horizontal minor gridlines inside the chart area. Specify a valid HTML color string.
The minorGridlines.count
option is mostly deprecated, except for disabling minor gridlines
by setting the count to 0. The number of minor gridlines now depends
entirely on the interval between
major gridlines (see hAxis.gridlines.interval
)
and the minimum required space
(see hAxis.minorGridlines.minSpacing
).
Overrides the default format for various aspects of date/datetime/timeofday data types when used with chart computed minorGridlines. Allows formatting for years, months, days, hours, minutes, seconds, and milliseconds.
General format is:
gridlines: { units: { years: {format: [/*format strings here*/]}, months: {format: [/*format strings here*/]}, days: {format: [/*format strings here*/]} hours: {format: [/*format strings here*/]} minutes: {format: [/*format strings here*/]} seconds: {format: [/*format strings here*/]}, milliseconds: {format: [/*format strings here*/]}, } }
Additional information can be found in Dates and Times .
hAxis
property that makes the horizontal axis a logarithmic scale (requires all
values to be positive). Set to true for yes.
hAxis
property that makes the horizontal axis a logarithmic scale. Can be one of the following:
- null - No logarithmic scaling is performed.
- 'log' - Logarithmic scaling. Negative and zero values are not plotted. This option is the same as setting
hAxis: { logscale: true }
. - 'mirrorLog' - Logarithmic scaling in which negative and zero values are plotted. The plotted value of a negative number is the negative of the log of the absolute value. Values close to 0 are plotted on a linear scale.
Position of the horizontal axis text, relative to the chart area. Supported values: 'out', 'in', 'none'.
An object that specifies the horizontal axis text style. The object has this format:
{ color: <string>, fontName: <string>, fontSize: <number>, bold: <boolean>, italic: <boolean> }
The color
can be any HTML color string, for example: 'red'
or '#00cc00'
. Also see fontName
and fontSize
.
{color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>}
Replaces the automatically generated X-axis ticks with the specified array. Each element of
the array should be either a valid tick value (such as a number, date, datetime, or
timeofday), or an object. If it's an object, it should have a v
property for
the tick value, and an optional f
property containing the literal string to be
displayed as the label.
The viewWindow will be automatically expanded to
include the min and max ticks unless you specify a viewWindow.min
or viewWindow.max
to override.
Examples:
-
hAxis: { ticks: [5,10,15,20] }
-
hAxis: { ticks: [{v:32, f:'thirty two'}, {v:64, f:'sixty four'}] }
-
hAxis: { ticks: [new Date(2014,3,15), new Date(2013,5,15)] }
-
hAxis: { ticks: [16, {v:32, f:'thirty two'}, {v:64, f:'sixty four'}, 128] }
hAxis
property that specifies the title of the horizontal axis.
An object that specifies the horizontal axis title text style. The object has this format:
{ color: <string>, fontName: <string>, fontSize: <number>, bold: <boolean>, italic: <boolean> }
The color
can be any HTML color string, for example: 'red'
or '#00cc00'
. Also see fontName
and fontSize
.
{color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>}
Moves the max value of the horizontal axis to the specified value; this will be rightward in
most charts. Ignored if this is set to a value smaller than the maximum x-value of the data. hAxis.viewWindow.max
overrides this property.
Moves the min value of the horizontal axis to the specified value; this will be leftward in
most charts. Ignored if this is set to a value greater than the minimum x-value of the data. hAxis.viewWindow.min
overrides this property.
Specifies how to scale the horizontal axis to render the values within the chart area. The following string values are supported:
- 'pretty' - Scale the horizontal values so that the maximum and minimum data values are rendered a bit inside the left and right of the chart area. The viewWindow is expanded to the nearest major gridline for numbers, or the nearest minor gridline for dates and times.
- 'maximized' - Scale the horizontal values so that the maximum and minimum data values touch
the left and right of the chart area. This will cause
haxis.viewWindow.min
andhaxis.viewWindow.max
to be ignored. - 'explicit' - A deprecated option for specifying the left and right scale values of the
chart area. (Deprecated because it's redundant with
haxis.viewWindow.min
andhaxis.viewWindow.max
.) Data values outside these values will be cropped. You must specify anhAxis.viewWindow
object describing the maximum and minimum values to show.
haxis.viewWindow.min
and haxis.viewWindow.max
take precedence if used.Specifies the cropping range of the horizontal axis.
The maximum horizontal data value to render.
Ignored when hAxis.viewWindowMode
is 'pretty' or 'maximized'.
The minimum horizontal data value to render.
Ignored when hAxis.viewWindowMode
is 'pretty' or 'maximized'.
Height of the chart, in pixels.
An object with members to configure various aspects of the legend. To specify properties of this object, you can use object literal notation, as shown here:
{position: 'top', textStyle: {color: 'blue', fontSize: 16}}
Alignment of the legend. Can be one of the following:
- 'start' - Aligned to the start of the area allocated for the legend.
- 'center' - Centered in the area allocated for the legend.
- 'end' - Aligned to the end of the area allocated for the legend.
Start, center, and end are relative to the style -- vertical or horizontal -- of the legend. For example, in a 'right' legend, 'start' and 'end' are at the top and bottom, respectively; for a 'top' legend, 'start' and 'end' would be at the left and right of the area, respectively.
The default value depends on the legend's position. For 'bottom' legends, the default is 'center'; other legends default to 'start'.
Maximum number of lines in the legend. Set this to a number greater than one to add lines to your legend. Note: The exact logic used to determine the actual number of lines rendered is still in flux.
This option currently works only when legend.position is 'top'.
Initial selected zero-based page index of the legend.
Position of the legend. Can be one of the following:
- 'bottom' - Below the chart.
- 'left' - To the left of the chart, provided the left axis has no series associated with it.
So if you want the legend on the left, use the option
targetAxisIndex: 1
. - 'in' - Inside the chart, by the top left corner.
- 'none' - No legend is displayed.
- 'right' - To the right of the chart. Incompatible with the
vAxes
option. - 'top' - Above the chart.
An object that specifies the legend text style. The object has this format:
{ color: <string>, fontName: <string>, fontSize: <number>, bold: <boolean>, italic: <boolean> }
The color
can be any HTML color string, for example: 'red'
or '#00cc00'
. Also see fontName
and fontSize
.
{color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>}
Line width in pixels. Use zero to hide all lines and show only the points.
The orientation of the chart. When set to 'vertical'
, rotates the axes of the
chart so that (for instance) a column chart becomes a bar chart, and an area chart grows
rightward instead of up:
The shape of individual data elements: 'circle', 'triangle', 'square', 'diamond', 'star', or 'polygon'. See the points documentation for examples.
Diameter of data points, in pixels. Use zero to hide all points. You can override values
for individual series using the series
property. If you're using a trendline
, this option will also
affect the pointSize
of the points comprising it, which will change the
apparent width of the trendline. To avoid this, you can override it with the trendlines.n.pointsize
option.
Determines whether points will be displayed. Set to false
to hide all points.
You can override values for individual series using the series
property. If
you're using a trendline
, the pointsVisible
option will affect the visibility of the points on all trendlines
unless you override it with the trendlines.n.pointsVisible
option.
This can also be overridden using the style role
in the form of "point {visible: true}"
.
When selectionMode
is 'multiple'
, users may select multiple data
points.
An array of objects, each describing the format of the corresponding series in the chart. To use default values for a series, specify an empty object {}. If a series or a value is not specified, the global value will be used. Each object supports the following properties:
-
color
- The color to use for this series. Specify a valid HTML color string. -
labelInLegend
- The description of the series to appear in the chart legend. -
lineWidth
- Overrides the globallineWidth
value for this series. -
pointShape
- Overrides the globalpointShape
value for this series. -
pointSize
- Overrides the globalpointSize
value for this series. -
pointsVisible
- Overrides the globalpointsVisible
value for this series. -
visibleInLegend
- A boolean value, where true means that the series should have a legend entry, and false means that it should not. Default is true.
You can specify either an array of objects, each of which applies to the series in the order given, or you can specify an object where each child has a numeric key indicating which series it applies to. For example, the following two declarations are identical, and declare the first series as black and absent from the legend, and the fourth as red and absent from the legend:
series: [ {color: 'black', visibleInLegend: false}, {}, {}, {color: 'red', visibleInLegend: false} ] series: { 0:{color: 'black', visibleInLegend: false}, 3:{color: 'red', visibleInLegend: false} }
A theme is a set of predefined option values that work together to achieve a specific chart behavior or visual effect. Currently only one theme is available:
- 'maximized' - Maximizes the area of the chart, and draws the legend and all of the labels
inside the chart area. Sets the following options:
chartArea: {width: '100%', height: '100%'}, legend: {position: 'in'}, titlePosition: 'in', axisTitlesPosition: 'in', hAxis: {textPosition: 'in'}, vAxis: {textPosition: 'in'}
Text to display above the chart.
Where to place the chart title, compared to the chart area. Supported values:
- in - Draw the title inside the chart area.
- out - Draw the title outside the chart area.
- none - Omit the title.
An object that specifies the title text style. The object has this format:
{ color: <string>, fontName: <string>, fontSize: <number>, bold: <boolean>, italic: <boolean> }
The color
can be any HTML color string, for example: 'red'
or '#00cc00'
. Also see fontName
and fontSize
.
{color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>}
An object with members to configure various tooltip elements. To specify properties of this object, you can use object literal notation, as shown here:
{textStyle: {color: '#FF0000'}, showColorCode: true}
If set to true
, allows the drawing of tooltips to flow outside of the bounds of
the chart on all sides.
Note: This only applies to HTML tooltips. If this is enabled with SVG tooltips, any overflow outside of the chart bounds will be cropped. See Customizing Tooltip Content for more details.
If set to true, use HTML-rendered (rather than SVG-rendered) tooltips. See Customizing Tooltip Content for more details.
Note:customization of the HTML tooltip content via the tooltip column data role is notsupported by the Bubble Chart visualization.
If true, show colored squares next to the series information in the tooltip.
An object that specifies the tooltip text style. The object has this format:
{ color: <string>, fontName: <string>, fontSize: <number>, bold: <boolean>, italic: <boolean> }
The color
can be any HTML color string, for example: 'red'
or '#00cc00'
. Also see fontName
and fontSize
.
{color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>}
The user interaction that causes the tooltip to be displayed:
- 'focus' - The tooltip will be displayed when the user hovers over the element.
- 'none' - The tooltip will not be displayed.
- 'selection' - The tooltip will be displayed when the user selects the element.
Displays trendlines
on the charts that support them. By default, linear trendlines are
used, but this can be customized with the trendlines. n
.type
option.
Trendlines are specified on a per-series basis, so most of the time your options will look like this:
var options = { trendlines: { 0: { type: 'linear', color: 'green', lineWidth: 3, opacity: 0.3, showR2: true, visibleInLegend: true } } }
The color of the trendline , expressed as either an English color name or a hex string.
For trendlines
of type: 'polynomial'
, the degree of the polynomial ( 2
for
quadratic, 3
for cubic, and so on). (The default degree may change from 3 to 2
in an upcoming release of Google Charts.)
The transparency of the trendline , from 0.0 (transparent) to 1.0 (opaque).
Trendlines
are constucted by stamping a bunch of dots on the chart; this rarely-needed option lets you
customize the size of the dots. The trendline's lineWidth
option will usually be
preferable. However, you'll need this option if you're using the global pointSize
option and want a different point size for your trendlines.
Trendlines
are constucted by stamping a bunch of dots on the chart. The trendline's pointsVisible
option determines whether the points for a particular trendline are
visible.
Whether to show the coefficient of determination in the legend or trendline tooltip.
Whether the trendlines
is 'linear'
(the default), 'exponential'
, or 'polynomial'
.
Whether the trendline equation appears in the legend. (It will appear in the trendline tooltip.)
An object with members to configure various vertical axis elements. To specify properties of this object, you can use object literal notation, as shown here:
{title: 'Hello', titleTextStyle: {color: '#FF0000'}}
vAxis
property that specifies the baseline for the vertical axis. If the
baseline is larger than the highest grid line or smaller than the lowest grid line, it will
be rounded to the closest gridline.
Specifies the color of the baseline for the vertical axis. Can be any HTML color string, for
example: 'red'
or '#00cc00'
.
The direction in which the values along the vertical axis grow. By default, low values
are on the bottom of the chart. Specify -1
to
reverse the order of the values.
A format string for numeric axis labels. This is a subset of the ICU pattern set
.
For instance, {format:'#,###%'}
will display values "1,000%",
"750%", and "50%" for values 10, 7.5, and 0.5. You can also supply any of
the following:
-
{format: 'none'}
: displays numbers with no formatting (e.g., 8000000) -
{format: 'decimal'}
: displays numbers with thousands separators (e.g., 8,000,000) -
{format: 'scientific'}
: displays numbers in scientific notation (e.g., 8e6) -
{format: 'currency'}
: displays numbers in the local currency (e.g., $8,000,000.00) -
{format: 'percent'}
: displays numbers as percentages (e.g., 800,000,000%) -
{format: 'short'}
: displays abbreviated numbers (e.g., 8M) -
{format: 'long'}
: displays numbers as full words (e.g., 8 million)
The actual formatting applied to the label is derived from the locale the API has been loaded with. For more details, see loading charts with a specific locale .
In computing tick values and gridlines, several alternative
combinations of all the relevant gridline
options will be considered and alternatives will be rejected if the
formatted tick labels would be duplicated or overlap.
So you can specify format:"#"
if you want to only show integer tick values,
but be aware that if no alternative satisfies this condition,
no gridlines or ticks will be shown.
An object with members to configure the gridlines on the vertical axis. Note that vertical axis gridlines are drawn horizontally. To specify properties of this object, you can use object literal notation, as shown here:
{color: '#333', minSpacing: 20}
The color of the vertical gridlines inside the chart area. Specify a valid HTML color string.
The approximate number of horizontal gridlines inside the chart area.
If you specify a positive number for gridlines.count
,
it will be used to compute the minSpacing
between gridlines.
You can specify a value of 1
to only draw one gridline,
or 0
to draw no gridlines.
Specify -1, which is the default,
to automatically compute the number of gridlines
based on other options.
Overrides the default format for various aspects of date/datetime/timeofday data types when used with chart computed gridlines. Allows formatting for years, months, days, hours, minutes, seconds, and milliseconds.
General format is:
gridlines: { units: { years: {format: [/*format strings here*/]}, months: {format: [/*format strings here*/]}, days: {format: [/*format strings here*/]}, hours: {format: [/*format strings here*/]}, minutes: {format: [/*format strings here*/]}, seconds: {format: [/*format strings here*/]}, milliseconds: {format: [/*format strings here*/]} } }
Additional information can be found in Dates and Times .
An object with members to configure the minor gridlines on the vertical axis, similar to the vAxis.gridlines option.
The color of the vertical minor gridlines inside the chart area. Specify a valid HTML color string.
The minorGridlines.count option is mostly deprecated, except for disabling minor gridlines by setting the count to 0. The number of minor gridlines depends on the interval between major gridlines (see vAxis.gridlines.interval) and the minimum required space (see vAxis.minorGridlines.minSpacing).
Overrides the default format for various aspects of date/datetime/timeofday data types when used with chart computed minorGridlines. Allows formatting for years, months, days, hours, minutes, seconds, and milliseconds.
General format is:
gridlines: { units: { years: {format: [/*format strings here*/]}, months: {format: [/*format strings here*/]}, days: {format: [/*format strings here*/]} hours: {format: [/*format strings here*/]} minutes: {format: [/*format strings here*/]} seconds: {format: [/*format strings here*/]}, milliseconds: {format: [/*format strings here*/]}, } }
Additional information can be found in Dates and Times .
If true, makes the vertical axis a logarithmic scale. Note: All values must be positive.
vAxis
property that makes the vertical axis a logarithmic scale. Can be one of the following:
- null - No logarithmic scaling is performed.
- 'log' - Logarithmic scaling. Negative and zero values are not plotted. This option is the same as setting
vAxis: { logscale: true }
. - 'mirrorLog' - Logarithmic scaling in which negative and zero values are plotted. The plotted value of a negative number is the negative of the log of the absolute value. Values close to 0 are plotted on a linear scale.
Position of the vertical axis text, relative to the chart area. Supported values: 'out', 'in', 'none'.
An object that specifies the vertical axis text style. The object has this format:
{ color: <string>, fontName: <string>, fontSize: <number>, bold: <boolean>, italic: <boolean> }
The color
can be any HTML color string, for example: 'red'
or '#00cc00'
. Also see fontName
and fontSize
.
{color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>}
Replaces the automatically generated Y-axis ticks with the specified array. Each element of
the array should be either a valid tick value (such as a number, date, datetime, or
timeofday), or an object. If it's an object, it should have a v
property for the
tick value, and an optional f
property containing the literal string to be
displayed as the label.
The viewWindow will be automatically expanded to
include the min and max ticks unless you specify a viewWindow.min
or viewWindow.max
to override.
Examples:
-
vAxis: { ticks: [5,10,15,20] }
-
vAxis: { ticks: [{v:32, f:'thirty two'}, {v:64, f:'sixty four'}] }
-
vAxis: { ticks: [new Date(2014,3,15), new Date(2013,5,15)] }
-
vAxis: { ticks: [16, {v:32, f:'thirty two'}, {v:64, f:'sixty four'}, 128] }
vAxis
property that specifies a title for the vertical axis.
An object that specifies the vertical axis title text style. The object has this format:
{ color: <string>, fontName: <string>, fontSize: <number>, bold: <boolean>, italic: <boolean> }
The color
can be any HTML color string, for example: 'red'
or '#00cc00'
. Also see fontName
and fontSize
.
{color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>}
Moves the max value of the vertical axis to the specified value; this will be upward in most
charts. Ignored if this is set to a value smaller than the maximum y-value of the data. vAxis.viewWindow.max
overrides this property.
Moves the min value of the vertical axis to the specified value; this will be downward in
most charts. Ignored if this is set to a value greater than the minimum y-value of the data. vAxis.viewWindow.min
overrides this property.
Specifies how to scale the vertical axis to render the values within the chart area. The following string values are supported:
- 'pretty' - Scale the vertical values so that the maximum and minimum data values are rendered a bit inside the bottom and top of the chart area. The viewWindow is expanded to the nearest major gridline for numbers, or the nearest minor gridline for dates and times.
- 'maximized' - Scale the vertical values so that the maximum and minimum data values touch
the top and bottom of the chart area. This will cause
vaxis.viewWindow.min
andvaxis.viewWindow.max
to be ignored. - 'explicit' - A deprecated option for specifying the top and bottom scale values of the
chart area. (Deprecated because it's redundant with
vaxis.viewWindow.min
andvaxis.viewWindow.max
. Data values outside these values will be cropped. You must specify avAxis.viewWindow
object describing the maximum and minimum values to show.
vaxis.viewWindow.min
and vaxis.viewWindow.max
take precedence if used.Specifies the cropping range of the vertical axis.
The maximum vertical data value to render.
Ignored when vAxis.viewWindowMode
is 'pretty' or 'maximized'.
The minimum vertical data value to render.
Ignored when vAxis.viewWindowMode
is 'pretty' or 'maximized'.
Width of the chart, in pixels.
Methods
draw(data, options)
Draws the chart. The chart accepts further method calls only after the ready
event is fired. Extended description
.
getAction(actionID)
Returns the tooltip action object with the requested actionID
.
getBoundingBox(id)
Returns an object containing the left, top, width, and height of chart element id
. The format for id
isn't yet documented (they're the return
values of event handlers
),
but here are some examples:
var cli = chart.getChartLayoutInterface();
- Height of the chart area
cli.getBoundingBox('chartarea').height
- Width of the third bar in the first series of a bar or column chart
cli.getBoundingBox('bar#0#2').width
- Bounding box of the fifth wedge of a pie chart
cli.getBoundingBox('slice#4')
- Bounding box of the chart data of a vertical (e.g., column) chart:
cli.getBoundingBox('vAxis#0#gridline')
- Bounding box of the chart data of a horizontal (e.g., bar) chart:
cli.getBoundingBox('hAxis#0#gridline')
Values are relative to the container of the chart. Call this after the chart is drawn.
getChartAreaBoundingBox()
Returns an object containing the left, top, width, and height of the chart content (i.e., excluding labels and legend):
var cli = chart.getChartLayoutInterface();
cli.getChartAreaBoundingBox().left
cli.getChartAreaBoundingBox().top
cli.getChartAreaBoundingBox().height
cli.getChartAreaBoundingBox().width
Values are relative to the container of the chart. Call this after the chart is drawn.
getChartLayoutInterface()
Returns an object containing information about the onscreen placement of the chart and its elements.
The following methods can be called on the returned object:
-
getBoundingBox
-
getChartAreaBoundingBox
-
getHAxisValue
-
getVAxisValue
-
getXLocation
-
getYLocation
Call this after the chart is drawn.
getHAxisValue(xPosition, optional_axis_index)
Returns the horizontal data value at xPosition
, which is a pixel offset from the
chart container's left edge. Can be negative.
Example: chart.getChartLayoutInterface().getHAxisValue(400)
.
Call this after the chart is drawn.
getImageURI()
Returns the chart serialized as an image URI.
Call this after the chart is drawn.
See Printing PNG Charts .
getSelection()
Returns an array of the selected chart entities.
Selectable entities are points and legend entries.
A point corresponds to a cell in the data table, and a legend entry to a column
(row index is null).
For this chart, only one entity can be selected at any given moment. Extended description
.
getVAxisValue(yPosition, optional_axis_index)
Returns the vertical data value at yPosition
, which is a pixel offset down
from the chart container's top edge. Can be negative.
Example: chart.getChartLayoutInterface().getVAxisValue(300)
.
Call this after the chart is drawn.
getXLocation(dataValue, optional_axis_index)
Returns the pixel x-coordinate of dataValue
relative to the left edge of the
chart's container.
Example: chart.getChartLayoutInterface().getXLocation(400)
.
Call this after the chart is drawn.
getYLocation(dataValue, optional_axis_index)
Returns the pixel y-coordinate of dataValue
relative to the top edge of the
chart's container.
Example: chart.getChartLayoutInterface().getYLocation(300)
.
Call this after the chart is drawn.
removeAction(actionID)
Removes the tooltip action with the requested actionID
from the chart.
none
setAction(action)
Sets a tooltip action to be executed when the user clicks on the action text.
The setAction
method takes an object as its action parameter. This object should
specify 3 properties: id
— the ID of the action being set, text
—the text that should appear in the tooltip for the action, and action
— the function that should be run when a user clicks on the action text.
Any and all tooltip actions should be set prior to calling the chart's draw()
method. Extended description
.
none
setSelection()
Selects the specified chart entities. Cancels any previous selection.
Selectable entities are points and legend entries.
A point corresponds to a cell in the data table, and a legend entry to a column
(row index is null).
For this chart, only one entity can be selected at a time. Extended description
.
clearChart()
Clears the chart, and releases all of its allocated resources.
Events
For more information on how to use these events, see Basic Interactivity , Handling Events , and Firing Events .
animationfinish
Fired when transition animation is complete.
click
Fired when the user clicks inside the chart. Can be used to identify when the title, data elements, legend entries, axes, gridlines, or labels are clicked.
error
Fired when an error occurs when attempting to render the chart.
legendpagination
Fired when the user clicks legend pagination arrows. Passes back the current legend zero-based page index and the total number of pages.
onmouseover
Fired when the user mouses over a visual entity. Passes back the row and column indices of the corresponding data table element.
onmouseout
Fired when the user mouses away from a visual entity. Passes back the row and column indices of the corresponding data table element.
ready
The chart is ready for external method calls. If you want to interact with the chart, and
call methods after you draw it, you should set up a listener for this event before
you
call the draw
method, and call them only after the event was fired.
select
Fired when the user clicks a visual entity. To learn what has been selected, call getSelection()
.
Data policy
All code and data are processed and rendered in the browser. No data is sent to any server.