Overview
An area chart that is rendered within the browser using SVG or VML. Displays tips when hovering over points.
A Simple 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([ ['Year', 'Sales', 'Expenses'], ['2013', 1000, 400], ['2014', 1170, 460], ['2015', 660, 1120], ['2016', 1030, 540] ]); var options = { title: 'Company Performance', hAxis: {title: 'Year', titleTextStyle: {color: '#333'}}, vAxis: {minValue: 0} }; var chart = new google.visualization.AreaChart(document.getElementById('chart_div')); chart.draw(data, options); } </script> </head> <body> <div id="chart_div" style="width: 100%; height: 500px;"></div> </body> </html>
Stacking Areas
By default, the area chart draws the series on top of one another. You can stack them atop one
another instead, so that the data values at each x-value are summed. In an area chart, the value
for each series will always be stacked relative to the preceding series value. Stacking a mix of
negative and positive values will cause the areas to overlap. It is important to note that the
interpolateNulls
option does not work with stacked area charts.
On the left, isStacked
is set to false (the default), and on the right it's set to
true:
Note that the order of the legend entries is different. In the second, stacked chart, the order is reversed, placing series 0 at the bottom, to better correspond with the stacking of the series elements, making the legend correspond to the data.
Stacked area charts also support 100% stacking, where the stacks of elements at each
domain-value are rescaled such that they add up to 100%. The options for this are
isStacked: 'percent'
, which formats each value as a percentage of 100%, and
isStacked: 'relative'
, which formats each value as a fraction of 1. There is also
an isStacked: 'absolute'
option, which is functionally equivalent to
isStacked: true
.
Note in the 100% stacked chart on the right, the tick values are based on the relative 0-1 scale as fractions of 1.
var options_stacked = { isStacked: true, height: 300, legend: {position: 'top', maxLines: 3}, vAxis: {minValue: 0} };
var options_fullStacked = { isStacked: 'relative', height: 300, legend: {position: 'top', maxLines: 3}, vAxis: { minValue: 0, ticks: [0, .3, .6, .9, 1] } };
Suppose one of your series has no data for some of your x-values. For instance, in the charts above, let's assume that drones aren't available until 2015, and Segways are not available in 2014. Note that we use null values where data is lacking, so the chart would look like this:
If those discontinuities don't appeal, you can substitute zeros for the nulls, and/or set the interpolateNulls option to true:
Loading
The google.charts.load
package name is "corechart".
google.charts.load("current", {packages: ["corechart"]});
The visualization's class name is google.visualization.AreaChart
.
var visualization = new google.visualization.AreaChart(container);
Data Format
Rows: Each row in the table represents a set of data points with the same x-axis location.
Columns:
Column 0 | Column 1 | ... | Column N | |
---|---|---|---|---|
Purpose: |
|
Line 1 values | ... | Line N values |
Data Type: |
|
number | ... | number |
Role: | domain | data | ... | data |
Optional column roles: | ... |
Configuration Options
Name | |
---|---|
aggregationTarget |
How multiple data selections are rolled up into tooltips:
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', }; Type: string
Default: 'auto'
|
animation.duration |
The duration of the animation, in milliseconds. For details, see the animation documentation. Type: number
Default: 0
|
animation.easing |
The easing function applied to the animation. The following options are available:
Type: string
Default: 'linear'
|
animation.startup |
Determines if the chart will animate on the initial draw. If Type: boolean
Default false
|
annotations.boxStyle |
For charts that support
annotations,
the 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. Type: object
Default: null
|
annotations.datum |
For charts that support
annotations,
the
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 .
Type: object
Default: color is "black"; length is 12; style is "point".
|
annotations.domain |
For charts that support
annotations,
the
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 .
Type: object
Default: color is "black"; length is 5; style is "point".
|
annotations.highContrast |
For charts that support
annotations,
the
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:
Type: boolean
Default: true
|
annotations.stem |
For charts that support
annotations,
the
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.
Type: object
Default: color is "black"; length is 5 for domain annotations and 12 for datum annotations.
|
annotations.style |
For charts that support
annotations,
the
annotations.style option lets you override
Google Charts' choice of the annotation type. It can be
either 'line' or 'point' .
Type: string
Default: 'point'
|
annotations.textStyle |
For charts that support
annotations,
the
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 . Type: object
Default: null
|
areaOpacity |
The default opacity of the colored area under an area chart series, where 0.0 is fully
transparent and 1.0 is fully opaque. To specify opacity for an individual series, set the
areaOpacity value in the Type: number, 0.0–1.0
Default: 0.3
|
axisTitlesPosition |
Where to place the axis titles, compared to the chart area. Supported values:
Type: string
Default: 'out'
|
backgroundColor |
The background color for the main area of the chart. Can be either a simple HTML color string,
for example: Type: string or object
Default: 'white'
|
backgroundColor.stroke |
The color of the chart border, as an HTML color string. Type: string
Default: '#666'
|
backgroundColor.strokeWidth |
The border width, in pixels. Type: number
Default: 0
|
backgroundColor.fill |
The chart fill color, as an HTML color string. Type: string
Default: 'white'
|
chartArea |
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: Type: object
Default: null
|
chartArea.backgroundColor |
Chart area background color. When a string is used, it can be either a hex string
(e.g., '#fdc') or an English color name. When an object is used, the following properties can
be provided:
Type: string or object
Default: 'white'
|
chartArea.left |
How far to draw the chart from the left border. Type: number or string
Default: auto
|
chartArea.top |
How far to draw the chart from the top border. Type: number or string
Default: auto
|
chartArea.width |
Chart area width. Type: number or string
Default: auto
|
chartArea.height |
Chart area height. Type: number or string
Default: auto
|
colors |
The colors to use for the chart elements. An array of strings, where each element is an HTML
color string, for example: Type: Array of strings
Default: default colors
|
crosshair |
An object containing the crosshair properties for the chart. Type: object
Default: null
|
crosshair.color |
The crosshair color, expressed as either a color name (e.g., "blue") or an RGB value (e.g., "#adf"). Type: string
Type: default
|
crosshair.focused |
An object containing the crosshair properties upon focus. Type: object
Default: default
|
crosshair.opacity |
The crosshair opacity, with Type: number
Default: 1.0
|
crosshair.orientation |
The crosshair orientation, which can be 'vertical' for vertical hairs only, 'horizontal' for horizontal hairs only, or 'both' for traditional crosshairs. Type: string
Default: 'both'
|
crosshair.selected |
An object containing the crosshair properties upon selection. Type: object
Default: default
|
crosshair.trigger |
When to display crosshairs: on Type: string
Default: 'both'
|
dataOpacity |
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 .) Type: number
Default: 1.0
|
enableInteractivity |
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. Type: boolean
Default: true
|
explorer |
The This feature is experimental and may change in future releases. Note: The explorer only works with continuous axes (such as numbers or dates). Type: object
Default: null
|
explorer.actions |
The Google Charts explorer supports three actions:
Type: Array of strings
Default: ['dragToPan', 'rightClickToReset']
|
explorer.axis |
By default, users can pan both horizontally and vertically when the Type: string
Default: both horizontal and vertical panning
|
explorer.keepInBounds |
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 Type: boolean
Default: false
|
explorer.maxZoomIn |
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
Type: number
Default: 0.25
|
explorer.maxZoomOut |
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
Type: number
Default: 4
|
explorer.zoomDelta |
When users zoom in or out, Type: number
Default: 1.5
|
focusTarget |
The type of the entity that receives focus on mouse hover. Also affects which entity is selected by mouse click, and which data table element is associated with events. Can be one of the following:
In focusTarget 'category' the tooltip displays all the category values. This may be useful for comparing values of different series. Type: string
Default: 'datum'
|
fontSize |
The default font size, in pixels, of all text in the chart. You can override this using properties for specific chart elements. Type: number
Default: automatic
|
fontName |
The default font face for all text in the chart. You can override this using properties for specific chart elements. Type: string
Default: 'Arial'
|
forceIFrame |
Draws the chart inside an inline frame. (Note that on IE8, this option is ignored; all IE8 charts are drawn in i-frames.) Type: boolean
Default: false
|
hAxis |
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' } } Type: object
Default: null
|
hAxis.baseline |
The baseline for the horizontal axis. This option is only supported for a Type: number
Default: automatic
|
hAxis.baselineColor |
The color of the baseline for the horizontal axis. Can be any HTML color string, for example:
This option is only supported for a Type: number
Default: 'black'
|
hAxis.direction |
The direction in which the values along the horizontal axis grow. Specify Type: 1 or -1
Default: 1
|
hAxis.format |
A format string for numeric or date axis labels.
For number axis labels, this is a subset of the decimal formatting
ICU pattern set
. For instance,
For date axis labels, this is a subset of the date formatting
ICU pattern set
. For instance, 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
This option is only supported for a
Type: string
Default: auto
|
hAxis.gridlines |
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}
This option is only supported for a
Type: object
Default: null
|
hAxis.gridlines.color |
The color of the horizontal gridlines inside the chart area. Specify a valid HTML color string. Type: string
Default: '#CCC'
|
hAxis.gridlines.count |
The approximate number of horizontal gridlines inside the chart area.
If you specify a positive number for Type: number
Default: -1
|
hAxis.gridlines.interval |
An array of sizes (as data values, not pixels) between adjacent
gridlines. This option is only for numeric axes at this time,
but it is analogous to the
Type: number between 1 and 10, not including 10.
Default: computed
|
hAxis.gridlines.minSpacing |
The minimum screen space, in pixels, between hAxis major gridlines.
The default for major gridlines is Type: number
Default: computed
|
hAxis.gridlines.multiple |
All gridline and tick values must be a multiple of this
option's value. Note that, unlike for intervals, powers of 10
times the multiple are not considered.
So you can force ticks to be integers by specifying
Type: number
Default: 1
|
hAxis.gridlines.units |
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. Type: object
Default: null
|
hAxis.minorGridlines |
An object with members to configure the minor gridlines on the horizontal axis, similar to the hAxis.gridlines option.
This option is only supported for a
Type: object
Default: null
|
hAxis.minorGridlines.color |
The color of the horizontal minor gridlines inside the chart area. Specify a valid HTML color string. Type: string
Default: A blend of the gridline and background colors
|
hAxis.minorGridlines.count |
The Type: number
Default:1
|
hAxis.minorGridlines.interval |
The minorGridlines.interval option is like the major gridlines
interval option, but the interval that is chosen will always
be an even divisor of the major gridline interval.
The default interval for linear scales is
Type: number
Default:1
|
hAxis.minorGridlines.minSpacing |
The minimum required space, in pixels, between adjacent minor gridlines, and between minor and major gridlines. The default value is 1/2 the minSpacing of major gridlines for linear scales, and 1/5 the minSpacing for log scales. Type: number
Default:computed
|
hAxis.minorGridlines.multiple |
Same as for major Type: number
Default: 1
|
hAxis.minorGridlines.units |
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. Type: object
Default: null
|
hAxis.logScale |
This option is only supported for a Type: boolean
Default: false
|
hAxis.scaleType |
This option is only supported for a Type: string
Default: null
|
hAxis.textPosition |
Position of the horizontal axis text, relative to the chart area. Supported values: 'out', 'in', 'none'. Type: string
Default: 'out'
|
hAxis.textStyle |
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 Type: object
Default:
{color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>}
|
hAxis.ticks |
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
The viewWindow will be automatically expanded to
include the min and max ticks unless you specify a
Examples:
This option is only supported for a
Type: Array of elements
Default: auto
|
hAxis.title |
Type: string
Default: null
|
hAxis.titleTextStyle |
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 Type: object
Default:
{color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>}
|
hAxis.allowContainerBoundaryTextCutoff |
If false, will hide outermost labels rather than allow them to be cropped by the chart container. If true, will allow label cropping. This option is only supported for a Type: boolean
Default: false
|
hAxis.slantedText |
If true, draw the horizontal axis text at an angle, to help fit more text along the axis; if
false, draw horizontal axis text upright. Default behavior is to slant text if it cannot all
fit when drawn upright. Notice that this option is available only when the
Type: boolean
Default: automatic
|
hAxis.slantedTextAngle |
The angle of the horizontal axis text, if it's drawn slanted. Ignored if
Type: number, -90—90
Default: 30
|
hAxis.maxAlternation |
Maximum number of levels of horizontal axis text. If axis text labels become too crowded, the server might shift neighboring labels up or down in order to fit labels closer together. This value specifies the most number of levels to use; the server can use fewer levels, if labels can fit without overlapping. For dates and times, the default is 1. Type: number
Default: 2
|
hAxis.maxTextLines |
Maximum number of lines allowed for the text labels. Labels can span multiple lines if they are too long, and the number of lines is, by default, limited by the height of the available space. Type: number
Default: auto
|
hAxis.minTextSpacing |
Minimum horizontal spacing, in pixels, allowed between two adjacent text labels. If the labels are spaced too densely, or they are too long, the spacing can drop below this threshold, and in this case one of the label-unclutter measures will be applied (e.g, truncating the labels or dropping some of them). Type: number
Default: The value of
hAxis.textStyle.fontSize |
hAxis.showTextEvery |
How many horizontal axis labels to show, where 1 means show every label, 2 means show every other label, and so on. Default is to try to show as many labels as possible without overlapping. Type: number
Default: automatic
|
hAxis.maxValue |
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.
This option is only supported for a
Type: number
Default: automatic
|
hAxis.minValue |
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.
This option is only supported for a
Type: number
Default: automatic
|
hAxis.viewWindowMode |
Specifies how to scale the horizontal axis to render the values within the chart area. The following string values are supported:
This option is only supported for a
Type: string
Default:
Equivalent to 'pretty', but
haxis.viewWindow.min and
haxis.viewWindow.max take precedence if used.
|
hAxis.viewWindow |
Specifies the cropping range of the horizontal axis. Type: object
Default: null
|
hAxis.viewWindow.max |
Ignored when Type: number
Default: auto
|
hAxis.viewWindow.min |
Ignored when Type: number
Default: auto
|
height |
Height of the chart, in pixels. Type: number
Default: height of the containing element
|
interpolateNulls |
Whether to guess the value of missing points. If true, it will guess the value of any missing data based on neighboring points. If false, it will leave a break in the line at the unknown point.
This is not supported by
Area charts with the
Type: boolean
Default: false
|
isStacked |
If set to true, stacks the elements for all series at each domain value. Note: In Column, Area, and SteppedArea charts, Google Charts reverses the order of legend items to better correspond with the stacking of the series elements (E.g. series 0 will be the bottom-most legend item). This does not apply to Bar Charts.
The The options for
For 100% stacking, the calculated value for each element will appear in the tooltip after its actual value.
The target axis will default to tick values based on the relative 0-1 scale as fractions
of 1 for
100% stacking only supports data values of type Type: boolean/string
Default: false
|
legend |
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}} Type: object
Default: null
|
legend.alignment |
Alignment of the legend. Can be one of the following:
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'. Type: string
Default: automatic
|
legend.maxLines |
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'. Type: number
Default: 1
|
legend.pageIndex |
Initial selected zero-based page index of the legend. Type: number
Default: 0
|
legend.position |
Position of the legend. Can be one of the following:
Type: string
Default: 'right'
|
legend.textStyle |
An object that specifies the legend text style. The object has this format: { color: <string>, fontName: <string>, fontSize: <number>, bold: <boolean>, italic: <boolean> }
The Type: object
Default:
{color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>}
|
lineDashStyle |
The on-and-off pattern for dashed lines. For instance, Type: Array of numbers
Default: null
|
lineWidth |
Data line width in pixels. Use zero to hide all lines and show only the points. You can
override values for individual series using the Type: number
Default: 2
|
orientation |
The orientation of the chart. When set to Type: string
Default: 'horizontal'
|
pointShape |
The shape of individual data elements: 'circle', 'triangle', 'square', 'diamond', 'star', or 'polygon'. See the points documentation for examples. Type: string
Default: 'circle'
|
pointSize |
Diameter of displayed points in pixels. Use zero to hide all points. You can override values
for individual series using the Type: number
Default: 0
|
pointsVisible |
Determines whether points will be displayed. Set to
This can also be overridden using the
style role in the form of
Type: boolean
Default: true
|
reverseCategories |
If set to true, will draw series from right to left. The default is to draw left-to-right.
This option is only supported for a
Type: boolean
Default: false
|
selectionMode |
When Type: string
Default: 'single'
|
series |
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:
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} } Type: Array of objects, or object with nested objects
Default: {}
|
theme |
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:
Type: string
Default: null
|
title |
Text to display above the chart. Type: string
Default: no title
|
titlePosition |
Where to place the chart title, compared to the chart area. Supported values:
Type: string
Default: 'out'
|
titleTextStyle |
An object that specifies the title text style. The object has this format: { color: <string>, fontName: <string>, fontSize: <number>, bold: <boolean>, italic: <boolean> }
The Type: object
Default:
{color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>}
|
tooltip |
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} Type: object
Default: null
|
tooltip.ignoreBounds |
If set to 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. Type: boolean
Default: false
|
tooltip.isHtml |
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 not supported by the Bubble Chart visualization. Type: boolean
Default: false
|
tooltip.showColorCode |
If true, show colored squares next to the series information in the tooltip. The default is
true when Type: boolean
Default: automatic
|
tooltip.textStyle |
An object that specifies the tooltip text style. The object has this format: { color: <string>, fontName: <string>, fontSize: <number>, bold: <boolean>, italic: <boolean> }
The Type: object
Default:
{color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>}
|
tooltip.trigger |
The user interaction that causes the tooltip to be displayed:
Type: string
Default: 'focus'
|
vAxes |
Specifies properties for individual vertical axes, if the chart has multiple vertical axes.
Each child object is a
To specify a chart with multiple vertical axes, first define a new axis using
{ series: { 2: { targetAxisIndex:1 } }, vAxes: { 1: { title:'Losses', textStyle: {color: 'red'} } } }
This property can be either an object or an array: the object is a collection of objects,
each with a numeric label that specifies the axis that it defines--this is the format shown
above; the array is an array of objects, one per axis. For example, the following array-style
notation is identical to the vAxes: [ {}, // Nothing specified for axis 0 { title:'Losses', textStyle: {color: 'red'} // Axis 1 } ] Type: Array of object, or object with child objects
Default: null
|
vAxis |
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'}} Type: object
Default: null
|
vAxis.baseline |
Type: number
Default: automatic
|
vAxis.baselineColor |
Specifies the color of the baseline for the vertical axis. Can be any HTML color string, for
example: Type: number
Default: 'black'
|
vAxis.direction |
The direction in which the values along the vertical axis grow. By default, low values
are on the bottom of the chart. Specify Type: 1 or -1
Default: 1
|
vAxis.format |
A format string for numeric axis labels. This is a subset of the
ICU pattern set
.
For instance,
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 Type: string
Default: auto
|
vAxis.gridlines |
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} Type: object
Default: null
|
vAxis.gridlines.color |
The color of the vertical gridlines inside the chart area. Specify a valid HTML color string. Type: string
Default: '#CCC'
|
vAxis.gridlines.count |
The approximate number of horizontal gridlines inside the chart area.
If you specify a positive number for Type: number
Default: -1
|
vAxis.gridlines.interval |
An array of sizes (as data values, not pixels) between adjacent
gridlines. This option is only for numeric axes at this time,
but it is analogous to the
Type: number between 1 and 10, not including 10.
Default: computed
|
vAxis.gridlines.minSpacing |
The minimum screen space, in pixels, between hAxis major gridlines.
The default for major gridlines is Type: number
Default: computed
|
vAxis.gridlines.multiple |
All gridline and tick values must be a multiple of this
option's value. Note that, unlike for intervals, powers of 10
times the multiple are not considered.
So you can force ticks to be integers by specifying
Type: number
Default: 1
|
vAxis.gridlines.units |
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. Type: object
Default: null
|
vAxis.minorGridlines |
An object with members to configure the minor gridlines on the vertical axis, similar to the vAxis.gridlines option. Type: object
Default: null
|
vAxis.minorGridlines.color |
The color of the vertical minor gridlines inside the chart area. Specify a valid HTML color string. Type: string
Default: A blend of the gridline and background colors
|
vAxis.minorGridlines.interval |
The minorGridlines.interval option is like the major gridlines
interval option, but the interval that is chosen will always
be an even divisor of the major gridline interval.
The default interval for linear scales is
Type: number
Default:1
|
vAxis.minorGridlines.minSpacing |
The minimum required space, in pixels, between adjacent minor gridlines, and between minor and major gridlines. The default value is 1/2 the minSpacing of major gridlines for linear scales, and 1/5 the minSpacing for log scales. Type: number
Default:computed
|
vAxis.minorGridlines.multiple |
Same as for major Type: number
Default: 1
|
vAxis.minorGridlines.count |
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). Type: number
Default: 1
|
vAxis.minorGridlines.units |
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. Type: object
Default: null
|
vAxis.logScale |
If true, makes the vertical axis a logarithmic scale. Note: All values must be positive. Type: boolean
Default: false
|
vAxis.scaleType |
This option is only supported for a Type: string
Default: null
|
vAxis.textPosition |
Position of the vertical axis text, relative to the chart area. Supported values: 'out', 'in', 'none'. Type: string
Default: 'out'
|
vAxis.textStyle |
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 Type: object
Default:
{color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>}
|
vAxis.ticks |
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
The viewWindow will be automatically expanded to
include the min and max ticks unless you specify a
Examples:
Type: Array of elements
Default: auto
|
vAxis.title |
Type: string
Default: no title
|
vAxis.titleTextStyle |
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 Type: object
Default:
{color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>}
|
vAxis.maxValue |
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.
Type: number
Default: automatic
|
vAxis.minValue |
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.
Type: number
Default: null
|
vAxis.viewWindowMode |
Specifies how to scale the vertical axis to render the values within the chart area. The following string values are supported:
Type: string
Default:
Equivalent to 'pretty', but
vaxis.viewWindow.min and
vaxis.viewWindow.max take precedence if used.
|
vAxis.viewWindow |
Specifies the cropping range of the vertical axis. Type: object
Default: null
|
vAxis.viewWindow.max |
The maximum vertical data value to render. Ignored when Type: number
Default: auto
|
vAxis.viewWindow.min |
The minimum vertical data value to render. Ignored when Type: number
Default: auto
|
width |
Width of the chart, in pixels. Type: number
Default: width of the containing element
|
Methods
Method | |
---|---|
draw(data, options) |
Draws the chart. The chart accepts further method calls only after the
Return Type: none
|
getAction(actionID) |
Returns the tooltip action object with the requested Return Type: object
|
getBoundingBox(id) |
Returns an object containing the left, top, width, and height of chart element
Values are relative to the container of the chart. Call this after the chart is drawn. Return Type: object
|
getChartAreaBoundingBox() |
Returns an object containing the left, top, width, and height of the chart content (i.e., excluding labels and legend):
Values are relative to the container of the chart. Call this after the chart is drawn. Return Type: object
|
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:
Call this after the chart is drawn. Return Type: object
|
getHAxisValue(xPosition, optional_axis_index) |
Returns the horizontal data value at Example: Call this after the chart is drawn. Return Type: number
|
getImageURI() |
Returns the chart serialized as an image URI. Call this after the chart is drawn. See Printing PNG Charts. Return Type: string
|
getSelection() |
Returns an array of the selected chart entities.
Selectable entities are points, annotations, legend entries and categories.
A point or annotation corresponds to a cell in the data table, a legend entry to a column
(row index is null), and a category to a row (column index is null).
For this chart, only one entity can be selected at any given moment.
Return Type: Array of selection elements
|
getVAxisValue(yPosition, optional_axis_index) |
Returns the vertical data value at Example: Call this after the chart is drawn. Return Type: number
|
getXLocation(dataValue, optional_axis_index) |
Returns the pixel x-coordinate of Example: Call this after the chart is drawn. Return Type: number
|
getYLocation(dataValue, optional_axis_index) |
Returns the pixel y-coordinate of Example: Call this after the chart is drawn. Return Type: number
|
removeAction(actionID) |
Removes the tooltip action with the requested Return Type:
none |
setAction(action) |
Sets a tooltip action to be executed when the user clicks on the action text.
The
Any and all tooltip actions should be set prior to calling the chart's Return Type:
none |
setSelection() |
Selects the specified chart entities. Cancels any previous selection.
Selectable entities are points, annotations, legend entries and categories.
A point or annotation corresponds to a cell in the data table, a legend entry to a column
(row index is null), and a category to a row (column index is null).
For this chart, only one entity can be selected at a time.
Return Type: none
|
clearChart() |
Clears the chart, and releases all of its allocated resources. Return Type: none
|
Events
For more information on how to use these events, see Basic Interactivity, Handling Events, and Firing Events.
Name | |
---|---|
animationfinish |
Fired when transition animation is complete. Properties: none
|
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. Properties: targetID
|
error |
Fired when an error occurs when attempting to render the chart. Properties: id, message
|
legendpagination |
Fired when the user clicks legend pagination arrows. Passes back the current legend zero-based page index and the total number of pages. Properties: currentPageIndex, totalPages
|
onmouseover |
Fired when the user mouses over a visual entity. Passes back the row and column indices of the corresponding data table element. Properties: row, column
|
onmouseout |
Fired when the user mouses away from a visual entity. Passes back the row and column indices of the corresponding data table element. Properties: row, column
|
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 Properties: none
|
select |
Fired when the user clicks a visual entity. To learn what has been selected, call
Properties: none
|
Data Policy
All code and data are processed and rendered in the browser. No data is sent to any server.