Render a chart using workbook data

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Body

application/json

Options for rendering a chart from workbook data.

chart

ChartRenderOptions · object

required

Options for rendering a chart from workbook data. Specify the data range, chart type, image output format, and title and axis labels.

Show child attributes

chart.data

string | null

Chart data range, prefixed with an equals sign

Example:

"=C2:C142"

chart.dataLines

string | null

Chart data range, prefixed with an equals sign, used for lines in a combo chart

Example:

"=C2:C142"

chart.type

enum<string> | null

default:line

Type of chart to render

Available options:

area,

bar,

column,

combo,

line,

pie,

scatterplot,

waterfall

chart.format

enum<string> | null

default:png

File format to use for the chart image

Available options:

png,

svg

chart.numberFormat

string | null

default:""

Number format pattern used for formatting labels on the chart.

Example:

"#,##0.0"

chart.values

enum<string> | null

default:none

How to label individual data values on the chart

Available options:

none,

selective,

all

chart.labels

string | null

Range of cells to use as the chart's x-axis labels, prefixed with an equals sign

Example:

"=B2:B142"

chart.legend

string | null

Range of cells to use as the chart's legend labels, prefixed with an equals sign

Example:

"=D2:D142"

chart.legendLines

string | null

Range of cells to use as the chart's line labels in the legend, prefixed with an equals sign

Example:

"=E2:E142"

chart.title

string | null

Cell reference to use as the chart's title. Can also be plain text.

Example:

"=A1"

chart.subtitle

string | null

Cell reference to use as the chart's subtitle. Can also be plain text.

Example:

"=B4"

chart.footnote

string | null

Cell reference to use as the chart's footnote text. Can also be plain text.

Example:

"=H13"

chart.colorByPoint

string | null

default:false

Vary colors by point rather than series.

chart.dir

enum<string> | null

Series orientation when reading data.

Available options:

col,

row

Example:

"row"

chart.stacked

enum<string> | null

default:false

Whether to display series stacked or grouped

Available options:

false,

true

chart.legendVisible

enum<string> | null

Whether to display a chart legend

Available options:

false,

true

chart.blanks

enum<string> | null

default:gap

How breaks or gaps in the series are handled

Available options:

gap,

zero,

span

chart.interpolate

enum<string> | null

default:linear

How a line is interpolated between values

Available options:

linear,

step,

step-after,

step-before,

monotone,

basis

chart.chartColors

string | null

An Excel array expression that returns a 1-dimensional list of HTML color strings

Example:

"={\"#C40\";\"#03F\"}"

chart.sortBy

integer | null

The number of which series the data should be sorted by (e.g. 1 for the first series).

chart.sortOrder

enum<string> | null

The sorting direction when the sortBy property is set.

Available options:

ascending,

descending

chart.axisValue

ValueAxisOptions · object

How an axis representing value magnitudes is presented.

Show child attributes

chart.axisValue.title

string | null

Cell reference to use as the axis title. Can also be plain text.

Example:

"=C4"

chart.axisValue.type

enum<string> | null

default:linear

The type of scale used by the axis.

Available options:

linear,

log

chart.axisValue.numberFormat

string | null

Number format pattern used for formatting the axis labels.

Example:

"#,##0.0"

chart.axisValue.reverse

enum<string> | null

default:false

Draw the axis in ascending or descending order.

Available options:

false,

true

chart.axisValue.min

number | null

A minimum value for the axis.

chart.axisValue.max

number | null

A maximum value for the axis.

chart.axisValue.clip

enum<string> | null

default:false

If true, any graphics outside the min or max boundaries of the axes are truncated.

Available options:

false,

true

chart.axisDim

DimAxisOptions · object

How an axis representing dimensional categories is presented.

Show child attributes

chart.axisDim.title

string | null

Cell reference to use as the axis title. Can also be plain text.

Example:

"=C4"

chart.axisDim.numberFormat

string | null

Number format pattern used for formatting the axis labels.

Example:

"#,##0.0"

chart.axisDim.reverse

enum<string> | null

default:false

If true, invert the scale of the axis. If false, keep the order untouched.

Available options:

false,

true

apply

DataTransformation · object[] | null

Cells to update before rendering the chart.

Show child attributes

apply.target

required

Reference for the cell to write to

Example:

"Sheet1!A1:B2"

apply.value

required

Value to write to the target cell

Example:

[{ "target": "A2", "value": 1234 }]

width

integer | null

Width of the chart image in pixels. If not given, a width of 764px is used. A chart's height cannot be set explicitly because it will differ depending upon chart type, title, legend, axis labels, and so on.

matte

string | null

default:""

Hex color code for the chart's background matte, e.g. '#FFFFFF' for white, if not specified, the chart will have a transparent background. Note, this is currently only supported for PNG images.

Example:

"#FFFFFF"

Response

Chart rendered as an image

The response is of type file.

GRID API

Workbooks

Data operations

Semantic metadata

Advanced

Render a chart using workbook data

Authorizations

Path Parameters

Body

Response