Chart: Image

Namespace: microsoft.graph

Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Files.ReadWrite
Delegated (personal Microsoft account)	Not supported.
Application	Not supported.

HTTP request

GET /me/drive/items/{id}/workbook/worksheets/{id|name}/charts/{name}/image
GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/{name}/image
GET /me/drive/items/{id}/workbook/worksheets/{id|name}/charts/{name}/image(width=640)
GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/{name}/image(width=640)
GET /me/drive/items/{id}/workbook/worksheets/{id|name}/charts/{name}/image(width=640,height=480)
GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/{name}/image(width=640,height=480)
GET /me/drive/items/{id}/workbook/worksheets/{id|name}/charts/{name}/image(width=640,height=480,fittingMode='fit')
GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/{name}/image(width=640,height=480,fittingMode='fit')

Request headers

Name	Description
Authorization	Bearer {token}. Required.
Workbook-Session-Id	Workbook session Id that determines if changes are persisted or not. Optional.

Path parameters

In the request body, provide a JSON object with the following parameters.

Parameter	Type	Description
height	Int32	The desired height of the resulting image. Optional.
width	Int32	The desired width of the resulting image. Optional.
fittingMode	string	The method used to scale the chart to the specified dimensions (if both height and width are set)." The possible values are: Fit, FitAndCenter, Fill.

Response

If successful, this method returns 200 OK response code and base-64 image string in the response body.

Example

Here is an example of how to call this API.

Request

Here is an example of the request.

GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/worksheets/{id|name}/charts/{name}/image(width=640,height=480,fittingMode='fit')

Response

Here is an example of the response. Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json;odata.metadata=minimal;odata.streaming=true

{
"value" : "base-64 chart image string"
}

Usage

You can display the base-64 string inside an HTML image tag: <img src="data:image/png;base64,{base-64 chart image string}/>.

For default behavior, use Image(width=0,height=0,fittingMode='fit'). Here is an example of a chart image returned with the default parameters.

If you want to customize the display of the image, specify a height, width, and a fitting mode. Here is what the same chart image looks like if you retrieve it with these parameters: Image(width=500,height=500,fittingMode='Fill').