Chart: Image

Important: APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported.

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


The following scopes are required to execute this API:

* Files.ReadWrite

HTTP request

GET /workbook/worksheets/{id|name}/charts(<name>)/Image(width=0,height=0,fittingMode='fit')

Request headers

Name Description
Authorization Bearer {token}. Required.

Request body

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

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


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


Here is an example of how to call this API.


Here is an example of the request.

Content-type: application/json
Content-length: 77

  "height": {
  "width": {
  "fittingMode": "fittingMode-value"

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 3

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