# Candlestick Charts

## Overview


An interactive candlestick chart.

A candlestick chart is used to show an opening and closing value
overlaid on top of a total variance. Candlestick charts are often
used to show stock value behavior. In this chart, items where the
opening value is less than the closing value (a gain) are drawn as
filled boxes, and items where the opening value is more than the
closing value (a loss) are drawn as hollow boxes.

## Example

<br />

\<script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"\>\</script\> \<div id="chart_div" style="width: 900px; height: 500px;"\>\</div\> google.charts.load('current', {'packages':\['corechart'\]}); google.charts.setOnLoadCallback(drawChart); function drawChart() { var data = google.visualization.arrayToDataTable(\[ \['Mon', 20, 28, 38, 45\], \['Tue', 31, 38, 55, 66\], \['Wed', 50, 55, 77, 80\], \['Thu', 77, 77, 66, 50\], \['Fri', 68, 66, 22, 15\] // Treat first row as data as well. \], true); var options = { legend:'none' }; var chart = new google.visualization.CandlestickChart(document.getElementById('chart_div')); chart.draw(data, options); }

```html
<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([
      ['Mon', 20, 28, 38, 45],
      ['Tue', 31, 38, 55, 66],
      ['Wed', 50, 55, 77, 80],
      ['Thu', 77, 77, 66, 50],
      ['Fri', 68, 66, 22, 15]
      // Treat first row as data as well.
    ], true);

    var options = {
      legend:'none'
    };

    var chart = new google.visualization.CandlestickChart(document.getElementById('chart_div'));

    chart.draw(data, options);
  }
    </script>
  </head>
  <body>
    <div id="chart_div" style="width: 900px; height: 500px;"></div>
  </body>
</html>
```

## Waterfall charts

With the right set of options, candlestick charts can be made to
resemble simple waterfall charts.
\<script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"\>\</script\> \<div id="chart_div" style="width: 900px; height: 500px;"\>\</div\> google.charts.load('current', {'packages':\['corechart'\]}); google.charts.setOnLoadCallback(drawChart); function drawChart() { var data = google.visualization.arrayToDataTable(\[ \['Mon', 28, 28, 38, 38\], \['Tue', 38, 38, 55, 55\], \['Wed', 55, 55, 77, 77\], \['Thu', 77, 77, 66, 66\], \['Fri', 66, 66, 22, 22\] // Treat the first row as data. \], true); var options = { legend: 'none', bar: { groupWidth: '100%' }, // Remove space between bars. candlestick: { fallingColor: { strokeWidth: 0, fill: '#a52714' }, // red risingColor: { strokeWidth: 0, fill: '#0f9d58' } // green } }; var chart = new google.visualization.CandlestickChart(document.getElementById('chart_div')); chart.draw(data, options); }

In the code below, we're eliminating the top wicks by having the
same values in the first and second columns, and the bottom wicks by
having the same values in the third and fourth columns. We
set `bar.groupWidth` to `'100%'` to remove the
space between the bars.

```html
<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([
          ['Mon', 28, 28, 38, 38],
          ['Tue', 38, 38, 55, 55],
          ['Wed', 55, 55, 77, 77],
          ['Thu', 77, 77, 66, 66],
          ['Fri', 66, 66, 22, 22]
          // Treat the first row as data.
        ], true);

        var options = {
          legend: 'none',
          bar: { groupWidth: '100%' }, // Remove space between bars.
          candlestick: {
            fallingColor: { strokeWidth: 0, fill: '#a52714' }, // red
            risingColor: { strokeWidth: 0, fill: '#0f9d58' }   // green
          }
        };

        var chart = new google.visualization.CandlestickChart(document.getElementById('chart_div'));
        chart.draw(data, options);
      }
    </script>
  </head>
  <body>
    <div id="chart_div" style="width: 900px; height: 500px;"></div>
  </body>
</html>
```

There is currently no easy way to label the bars. The best option
is to use [overlays](https://developers.google.com/chart/interactive/docs/overlays).

## Loading

`google.charts.load` package name is `"corechart"`.

```
  google.charts.load('current', {packages: ['corechart']});
```


The visualization's class name is
`google.visualization.CandlestickChart.`

```
  var visualization = new google.visualization.CandlestickChart(container);
```

## Data format

Five or more columns, where the first column defines X-axis values or group labels,
and each multiple of four data columns after that defines a different series.

- **Col 0:** String ([discrete](https://developers.google.com/chart/interactive/docs/customizing_axes#Discrete_vs_Continuous)) used as a group label on the X axis, or number, date, datetime, or timeofday ([continuous](https://developers.google.com/chart/interactive/docs/customizing_axes#Discrete_vs_Continuous)) used as a value on the X axis.
- **Col 1:** Number specifying the low/minimum value of this marker. This is the base of the candle's center line. The column label is used as the series label in the legend (while the labels of the other columns are ignored).
- **Col 2:** Number specifying the opening/initial value of this marker. This is one vertical border of the candle. If less than the column 3 value, the candle will be filled; otherwise it will be hollow.
- **Col 3:** Number specifying the closing/final value of this marker. This is the second vertical border of the candle. If less than the column 2 value, the candle will be hollow; otherwise it will be filled.
- **Col 4:** Number specifying the high/maximum value of this marker. This is the top of the candle's center line.
- **Col 5** \[*Optional* \]: A [tooltip](https://developers.google.com/chart/interactive/docs/roles#tooltiprole) or [style](https://developers.google.com/chart/interactive/docs/roles#stylerole) column for the candlestick.

In order to have more series, it is possible to add additional sets of 4 columns, with a similar structure to columns 1-4. Each such set represents another series of candlesticks. The total number of columns should be 4 times the number of series plus 1 (and any optional tooltip columns).

## Configuration options

| Name ||
|---|---|
| aggregationTarget | How multiple data selections are rolled up into tooltips: - `'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', }; ``` **Type:** string **Default:** 'auto' |
| animation.duration | The duration of the animation, in milliseconds. For details, see the [animation documentation](https://developers.google.com/chart/interactive/docs/animation). **Type:** number **Default:** 0 |
| animation.easing | 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. **Type:** string **Default:** 'linear' |
| animation.startup | 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. **Type:** boolean **Default** false |
| axisTitlesPosition | 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. **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: `'red'` or `'#00cc00'`, or an object with the following properties. **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' |
| bar.groupWidth | The width of a group of candlesticks, specified in either of these formats: - Pixels (e.g. 50). - Percentage of the available width for each group (e.g. '20%'), where '100%' means that groups have no space between them. **Type:** number or string **Default:** The [golden ratio](http://en.wikipedia.org/wiki/Golden_ratio), approximately '61.8%'. |
| candlestick.hollowIsRising | If true, rising candles will appear hollow and falling candles will appear solid, otherwise, the opposite. **Type:** boolean **Default:** false (will later be changed to true) |
| candlestick.fallingColor.fill | The fill color of falling candles, as an HTML color string. **Type:** string **Default:** auto (depends on the series color and hollowIsRising) |
| candlestick.fallingColor.stroke | The stroke color of falling candles, as an HTML color string. **Type:** string **Default:** auto (the series color) |
| candlestick.fallingColor.strokeWidth | The stroke width of falling candles, as an HTML color string. **Type:** 2 **Default:** number |
| candlestick.risingColor.fill | The fill color of rising candles, as an HTML color string. **Type:** string **Default:** auto (white or the series color, depending on hollowIsRising) |
| candlestick.risingColor.stroke | The stroke color of rising candles, as an HTML color string. **Type:** string **Default:** auto (the series color or white, depending on hollowIsRising) |
| candlestick.risingColor.strokeWidth | The stroke width of rising candles, as an HTML color string. **Type:** number **Default:** 2 |
| 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: `chartArea:{left:20,top:0,width:'50%',height:'75%'}` **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: - `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 of `stroke`). **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: `colors:['red','#004411']`. **Type:** Array of strings **Default:** default colors |
| 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 |
| 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: - 'datum' - Focus on a single data point. Correlates to a cell in the data table. - 'category' - Focus on a grouping of all data points along the major axis. Correlates to a row in the data table. 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 [`continuous`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis. **Type:** number **Default:** automatic |
| hAxis.baselineColor | The color of the baseline for the horizontal axis. Can be any HTML color string, for example: `'red'` or `'#00cc00'`. This option is only supported for a [`continuous`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis. **Type:** number **Default:** 'black' |
| hAxis.direction | The direction in which the values along the horizontal axis grow. Specify `-1` to reverse the order of the values. **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](http://icu-project.org/apiref/icu4c/classDecimalFormat.html#_details). 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) For date axis labels, this is a subset of the date formatting [ICU pattern set](http://icu-project.org/apiref/icu4c/classSimpleDateFormat.html#_details). For instance, `{format:'MMM d, y'}` will display the value "Jul 1, 2011" for the date of July first in 2011. 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](https://developers.google.com/chart/interactive/docs/library_loading_enhancements#loadwithlocale). 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. This option is only supported for a [`continuous`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis. **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 [`continuous`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis. **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 `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. **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 `gridlines.units.<unit>.interval` options which are used only for dates and times. For linear scales, the default is `[1, 2, 2.5, 5]` which means the gridline values can fall on every unit (1), on even units (2), or on multiples of 2.5 or 5. Any power of 10 times these values is also considered (e.g. \[10, 20, 25, 50\] and \[.1, .2, .25, .5\]). For log scales, the default is `[1, 2, 5]`. **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 `40` for linear scales, and `20` for log scales. If you specify the `count` and not the `minSpacing`, the minSpacing is computed from the count. And conversely, if you specify the `minSpacing` and not the `count`, the count is computed from the minSpacing. If you specify both, the `minSpacing` overrides. **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 `gridlines.multiple = 1`, or force ticks to be multiples of 1000 by specifying `gridlines.multiple = 1000`. **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](https://developers.google.com/chart/interactive/docs/datesandtimes#axesgridlinesticks). **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 [`continuous`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis. **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.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 `[1, 1.5, 2, 2.5, 5]`, and for log scales is `[1, 2, 5]`. **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 `gridlines.multiple`. **Type:** number **Default:** 1 |
| hAxis.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 now depends entirely on the interval between major gridlines (see `hAxis.gridlines.interval`) and the minimum required space (see `hAxis.minorGridlines.minSpacing`). **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](https://developers.google.com/chart/interactive/docs/datesandtimes#axesgridlinesticks). **Type:** object **Default:** null |
| hAxis.logScale | `hAxis` property that makes the horizontal axis a logarithmic scale (requires all values to be positive). Set to true for yes. This option is only supported for a [`continuous`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis. **Type:** boolean **Default:** false |
| hAxis.scaleType | `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. This option is only supported for a [`continuous`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis. **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 `color` can be any HTML color string, for example: `'red'` or `'#00cc00'`. Also see `fontName` and `fontSize`. **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 `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] }` This option is only supported for a [`continuous`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis. **Type:** Array of elements **Default:** auto |
| hAxis.title | `hAxis` property that specifies the title of the horizontal axis. **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 `color` can be any HTML color string, for example: `'red'` or `'#00cc00'`. Also see `fontName` and `fontSize`. **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 [`discrete`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis. **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 `hAxis.textPosition` is set to 'out' (which is the default). The default is `false` for dates and times. **Type:** boolean **Default:** automatic |
| hAxis.slantedTextAngle | The angle of the horizontal axis text, if it's drawn slanted. Ignored if `hAxis.slantedText` is `false`, or is in auto mode, and the chart decided to draw the text horizontally. If the angle is positive, the rotation is counter-clockwise, and if negative, it is clockwise. **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. `hAxis.viewWindow.max` overrides this property. This option is only supported for a [`continuous`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis. **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. `hAxis.viewWindow.min` overrides this property. This option is only supported for a [`continuous`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis. **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: - '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` and `haxis.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` and `haxis.viewWindow.max`.) Data values outside these values will be cropped. You must specify an `hAxis.viewWindow` object describing the maximum and minimum values to show. This option is only supported for a [`continuous`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis. **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 | - For a [`continuous`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis: The maximum horizontal data value to render. - For a [`discrete`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis: The zero-based row index where the cropping window ends. Data points at this index and higher will be cropped out. In conjunction with `vAxis.viewWindowMode.min`, it defines a half-opened range \[min, max) that denotes the element indices to display. In other words, every index such that `min <= index < max` will be displayed. Ignored when `hAxis.viewWindowMode` is 'pretty' or 'maximized'. **Type:** number **Default:** auto |
| hAxis.viewWindow.min | - For a [`continuous`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis: The minimum horizontal data value to render. - For a [`discrete`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis: The zero-based row index where the cropping window begins. Data points at indices lower than this will be cropped out. In conjunction with `vAxis.viewWindowMode.max`, it defines a half-opened range \[min, max) that denotes the element indices to display. In other words, every index such that `min <= index < max` will be displayed. Ignored when `hAxis.viewWindowMode` is 'pretty' or 'maximized'. **Type:** number **Default:** auto |
| height | Height of the chart, in pixels. **Type:** number **Default:** height of the containing element |
| 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' - 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'. **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: - '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. **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 `color` can be any HTML color string, for example: `'red'` or `'#00cc00'`. Also see `fontName` and `fontSize`. **Type:** object **Default:** ` {color: 'black', fontName: <global-font-name>, fontSize: <global-font-size>} ` |
| orientation | 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: **Type:** string **Default:** 'horizontal' |
| 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 [`discrete`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) [`major`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis. **Type:** boolean **Default:** false |
| selectionMode | When `selectionMode` is `'multiple'`, users may select multiple data points. **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: - `color` - The color to use for this series. Specify a valid HTML color string. - `fallingColor.fill` - Overrides the global `candlestick.fallingColor.fill` value for this series. - `fallingColor.stroke` - Overrides the global `candlestick.fallingColor.stroke` value for this series. - `fallingColor.strokeWidth` - Overrides the global `candlestick.fallingColor.strokeWidth` value for this series. - `labelInLegend` - The description of the series to appear in the chart legend. - `risingColor.fill` - Overrides the global `candlestick.risingColor.fill` value for this series. - `risingColor.stroke` - Overrides the global `candlestick.risingColor.stroke` value for this series. - `risingColor.strokeWidth` - Overrides the global `candlestick.risingColor.strokeWidth` value for this series. - `targetAxisIndex` - Which axis to assign this series to, where 0 is the default axis, and 1 is the opposite axis. Default value is 0; set to 1 to define a chart where different series are rendered against different axes. At least one series much be allocated to the default axis. You can define a different scale for different axes. - `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} } ``` **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: - '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'} ``` **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: - in - Draw the title inside the chart area. - out - Draw the title outside the chart area. - none - Omit the title. **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 `color` can be any HTML color string, for example: `'red'` or `'#00cc00'`. Also see `fontName` and `fontSize`. **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 `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](https://developers.google.com/chart/interactive/docs/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](https://developers.google.com/chart/interactive/docs/customizing_tooltip_content) for more details. **Note:** customization of the HTML tooltip content via the [tooltip column data role](https://developers.google.com/chart/interactive/docs/roles#tooltiprole) is **not** supported by the [Bubble Chart](https://developers.google.com/chart/interactive/docs/gallery/bubblechart) 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 `focusTarget` is set to 'category', otherwise the default is false. **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 `color` can be any HTML color string, for example: `'red'` or `'#00cc00'`. Also see `fontName` and `fontSize`. **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: - 'focus' - The tooltip will be displayed when the user hovers over the element. - 'none' - The tooltip will not 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 `vAxis` object, and can contain all the properties supported by `vAxis`. These property values override any global settings for the same property. To specify a chart with multiple vertical axes, first define a new axis using `series.targetAxisIndex`, then configure the axis using `vAxes`. The following example assigns series 2 to the right axis and specifies a custom title and text style for it: ``` { 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 `vAxis` object shown above: ``` 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 | `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. **Type:** number **Default:** automatic |
| vAxis.baselineColor | Specifies the color of the baseline for the vertical axis. Can be any HTML color string, for example: `'red'` or `'#00cc00'`. **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 `-1` to reverse the order of the values. **Type:** 1 or -1 **Default:** 1 |
| vAxis.format | A format string for numeric axis labels. This is a subset of the [ICU pattern set](http://icu-project.org/apiref/icu4c/classDecimalFormat.html#_details). 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](https://developers.google.com/chart/interactive/docs/library_loading_enhancements#loadwithlocale). 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. **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 `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. **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 `gridlines.units.<unit>.interval` options which are used only for dates and times. For linear scales, the default is `[1, 2, 2.5, 5]` which means the gridline values can fall on every unit (1), on even units (2), or on multiples of 2.5 or 5. Any power of 10 times these values is also considered (e.g. \[10, 20, 25, 50\] and \[.1, .2, .25, .5\]). For log scales, the default is `[1, 2, 5]`. **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 `40` for linear scales, and `20` for log scales. If you specify the `count` and not the `minSpacing`, the minSpacing is computed from the count. And conversely, if you specify the `minSpacing` and not the `count`, the count is computed from the minSpacing. If you specify both, the `minSpacing` overrides. **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 `gridlines.multiple = 1`, or force ticks to be multiples of 1000 by specifying `gridlines.multiple = 1000`. **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](https://developers.google.com/chart/interactive/docs/datesandtimes#axesgridlinesticks). **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.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.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 `[1, 1.5, 2, 2.5, 5]`, and for log scales is `[1, 2, 5]`. **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 `gridlines.multiple`. **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](https://developers.google.com/chart/interactive/docs/datesandtimes#axesgridlinesticks). **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 | `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. This option is only supported for a [`continuous`](https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology) axis. **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 `color` can be any HTML color string, for example: `'red'` or `'#00cc00'`. Also see `fontName` and `fontSize`. **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 `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] }` **Type:** Array of elements **Default:** auto |
| vAxis.title | `vAxis` property that specifies a title for the vertical axis. **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 `color` can be any HTML color string, for example: `'red'` or `'#00cc00'`. Also see `fontName` and `fontSize`. **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. `vAxis.viewWindow.max` overrides this property. **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. `vAxis.viewWindow.min` overrides this property. **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: - '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` and `vaxis.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` and `vaxis.viewWindow.max`. Data values outside these values will be cropped. You must specify a `vAxis.viewWindow` object describing the maximum and minimum values to show. **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 `vAxis.viewWindowMode` is 'pretty' or 'maximized'. **Type:** number **Default:** auto |
| vAxis.viewWindow.min | The minimum vertical data value to render. Ignored when `vAxis.viewWindowMode` is 'pretty' or 'maximized'. **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 [`ready`](https://developers.google.com/chart/interactive/docs/gallery/candlestickchart#Events)event is fired. [`Extended description`](https://developers.google.com/chart/interactive/docs/reference#visdraw). **Return Type:** none |
| `getAction(actionID)` | Returns the tooltip action object with the requested `actionID`. **Return Type:** object |
| `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](https://developers.google.com/chart/interactive/docs/events)), 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. **Return Type:** object |
| `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. **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: - `getBoundingBox` - `getChartAreaBoundingBox` - `getHAxisValue` - `getVAxisValue` - `getXLocation` - `getYLocation` Call this *after* the chart is drawn. **Return Type:** object |
| `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. **Return Type:** number |
| `getImageURI()` | Returns the chart serialized as an image URI. Call this *after* the chart is drawn. See [Printing PNG Charts](https://developers.google.com/chart/interactive/docs/printing). **Return Type:** string |
| `getSelection()` | Returns an array of the selected chart entities. Selectable entities are candlesticks, legend entries and categories. For this chart, only one entity can be selected at any given moment. [`Extended description`](https://developers.google.com/chart/interactive/docs/reference#visgetselection). **Return Type:** Array of selection elements |
| `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. **Return Type:** number |
| `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. **Return Type:** number |
| `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. **Return Type:** number |
| `removeAction(actionID)` | Removes the tooltip action with the requested `actionID` from the chart. **Return Type:** `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](https://developers.google.com/chart/interactive/docs/reference#vissetaction). **Return Type:** `none` |
| `setSelection()` | Selects the specified chart entities. Cancels any previous selection. Selectable entities are candlesticks, legend entries and categories. For this chart, only one entity can be selected at a time. [`Extended description`](https://developers.google.com/chart/interactive/docs/reference#vissetselection). **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](https://developers.google.com/chart/interactive/docs/basic_interactivity),
[Handling Events](https://developers.google.com/chart/interactive/docs/events), and
[Firing Events](https://developers.google.com/chart/interactive/docs/dev/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. A candlestick correlates 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). **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. A candlestick correlates 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). **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 `draw` method, and call them only after the event was fired. **Properties:** none |
| `select` | Fired when the user clicks a visual entity. To learn what has been selected, call [`getSelection()`](https://developers.google.com/chart/interactive/docs/gallery/candlestickchart#Methods). **Properties:** none |

## Data policy

All code and data are processed and rendered in the browser. No data is sent to any server.