Class Chart
Stay organized with collections
Save and categorize content based on your preferences.
Chart
A Chart object, which can be converted to a static image. For charts embedded in spreadsheets,
see EmbeddedChart.
Methods
| Method | Return type | Brief description |
getAs(contentType) | Blob | Return the data inside this object as a blob converted to the specified content type. |
getBlob() | Blob | Return the data inside this object as a blob. |
getOptions() | ChartOptions | Returns the options for this chart, such as height, colors, and axes. |
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, "ShoppingList.12.25.2014" becomes
"ShoppingList.12.25.pdf".
To view the daily quotas for conversions, see Quotas for Google
Services. Newly created Google Workspace domains might be temporarily subject to stricter
quotas.
Parameters
| Name | Type | Description |
contentType | String | The 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. For a Google Docs document, 'text/markdown' is 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.
getOptions()
Returns the options for this chart, such as height, colors, and axes.
The returned options are immutable.
Return
ChartOptions — The options for this chart, such as height, colors, and axes.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003eA Chart object can be converted into a static image and offers methods to manipulate its data and appearance.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egetAs()\u003c/code\u003e method allows for data export in various formats like PDF, BMP, GIF, JPEG, or PNG, applying appropriate filename extensions.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egetBlob()\u003c/code\u003e method returns the chart's data as a blob, providing a general way to access its raw content.\u003c/p\u003e\n"],["\u003cp\u003eChart customization is enabled through the \u003ccode\u003egetOptions()\u003c/code\u003e method, which gives access to properties such as height, colors, and axes but in an immutable format.\u003c/p\u003e\n"]]],[],null,["# Class Chart\n\nChart\n\nA Chart object, which can be converted to a static image. For charts embedded in spreadsheets,\nsee [EmbeddedChart](../spreadsheet/embedded-chart.html). \n\n### Methods\n\n| Method | Return type | Brief description |\n|--------------------------------------|-------------------------------------------------------------|---------------------------------------------------------------------------------------|\n| [getAs(contentType)](#getAs(String)) | [Blob](../base/blob.html) | Return the data inside this object as a blob converted to the specified content type. |\n| [getBlob()](#getBlob()) | [Blob](../base/blob.html) | Return the data inside this object as a blob. |\n| [getOptions()](#getOptions()) | [ChartOptions](/apps-script/reference/charts/chart-options) | Returns the options for this chart, such as height, colors, and axes. |\n\nDetailed documentation\n----------------------\n\n### `get``As(contentType)`\n\nReturn the data inside this object as a blob converted to the specified content type. This\nmethod adds the appropriate extension to the filename---for example, \"myfile.pdf\". However, it\nassumes that the part of the filename that follows the last period (if any) is an existing\nextension that should be replaced. Consequently, \"ShoppingList.12.25.2014\" becomes\n\"ShoppingList.12.25.pdf\".\n\nTo view the daily quotas for conversions, see [Quotas for Google\nServices](https://developers.google.com/apps-script/guides/services/quotas). Newly created Google Workspace domains might be temporarily subject to stricter\nquotas.\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `content``Type` | `String` | The 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. For a Google Docs document, `'text/markdown'` is also valid. |\n\n#### Return\n\n\n[Blob](../base/blob.html) --- The data as a blob.\n\n*** ** * ** ***\n\n### `get``Blob()`\n\nReturn the data inside this object as a blob.\n\n#### Return\n\n\n[Blob](../base/blob.html) --- The data as a blob.\n\n*** ** * ** ***\n\n### `get``Options()`\n\nReturns the options for this chart, such as height, colors, and axes.\n\nThe returned options are immutable.\n\n#### Return\n\n\n[ChartOptions](/apps-script/reference/charts/chart-options) --- The options for this chart, such as height, colors, and axes."]]
