Hide
Apps Script

Class Chart

Chart

A Chart object, which can be embedded into documents, UI elements, or used as a static image. For charts embedded in spreadsheets, see EmbeddedChart.

Methods

MethodReturn typeBrief description
getAs(contentType)BlobReturn the data inside this object as a blob converted to the specified content type.
getBlob()BlobReturn the data inside this object as a blob.
getId()StringReturns the id that has been assigned to this object.
getOptions()ChartOptionsReturns the options for this chart, such as height, colors, axes, etc.
getType()StringGets the type of this object.
setId(id)ChartSets the id of this Chart to be used with UiApp.

Detailed documentation

getAs(contentType)

Return the data inside this object as a blob converted to the specified content type. This method adds the appropriate extension to the filename — for example, "myfile.pdf". However, it assumes that the part of the filename that follows the last period (if any) is an existing extension that should be replaced. Consequently, "ChristmasList.12.25.2014" will become "ChristmasList.12.25.pdf".

Parameters

NameTypeDescription
contentTypeStringthe MIME type to convert to. For most blobs, 'application/pdf' is the only valid option. For images in BMP, GIF, JPEG, or PNG format, any of 'image/bmp', 'image/gif', 'image/jpeg', or 'image/png' are also valid.

Return

Blob — the data as a blob


getBlob()

Return the data inside this object as a blob.

Return

Blob — the data as a blob


getId()

Returns the id that has been assigned to this object.

This can be used in conjunction with app.getElementById() to retrieve a reference to this object.

Return

String — the id that has been assigned to this object


getOptions()

Returns the options for this chart, such as height, colors, axes, etc.

The returned options are immutable.

Return

ChartOptions — the options for this chart, such as height, colors, axes, etc.


getType()

Gets the type of this object.

Return

String — the object type


setId(id)

Sets the id of this Chart to be used with UiApp.

Parameters

NameTypeDescription
idStringthe new id, which can be used to retrieve the Chart from app.getElementById(id).

Return

Chart — the Chart itself, useful for chaining.