图表:图像

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

通过缩放图表以适应指定的尺寸,将图表呈现为 base64 编码的图像。

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Files.ReadWrite 不可用。
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 不支持。 不支持。

HTTP 请求

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

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
Workbook-Session-Id 确定是否保留更改的工作簿会话 ID。 可选。

请求正文

在请求正文中,提供具有以下参数的 JSON 对象。

参数 类型 说明
height number 可选。 生成的图像的所需高度。
width number 可选。 生成的图像的所需宽度。
fittingMode string 可选。 如果高度和宽度都设置为) ,则用于将图表缩放为指定维度的方法 (。”可能的值为: FitFitAndCenterFill

响应

如果成功,此方法在响应正文中返回 200 OK 响应代码和 base-64 图像字符串。

示例

下面是一个如何调用此 API 的示例。

请求

以下示例显示了一个请求。

GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/worksheets/{id|name}/charts/{name}/Image(width=0,height=0,fittingMode='fit')
响应

以下示例显示了相应的响应。 注意:为了提高可读性,可能缩短了此处显示的响应对象。

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

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

可以在 HTML 图像标记内显示 base-64 字符串:<img src="data:image/png;base64,{base-64 chart image string}/>

对于默认行为,请使用 Image(width=0,height=0,fittingMode='fit')。 以下示例显示了使用默认参数返回的图表图像。

显示具有默认高度和宽度的 Excel 图表图像的屏幕截图。

若要自定义图像的显示方式,请指定高度、宽度和调整模式。 以下示例显示了使用相同的图表图像(如果使用以下参数检索它): Image(width=500,height=500,fittingMode='Fill')

显示具有指定高度和宽度的 Excel 图表图像的屏幕截图。