Chart: Image
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Отрисовывает диаграмму в виде изображения с кодировкой base64, масштабируя ее в соответствии с указанным размером.
Этот API доступен в следующих национальных облачных развертываниях.
| Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ✅ | ❌ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
| Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
|---|---|---|
| Делегированные (рабочая или учебная учетная запись) | Files.ReadWrite | Недоступно. |
| Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
| Для приложений | Не поддерживается. | Не поддерживается. |
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')
Заголовки запросов
| Имя | Описание |
|---|---|
| Авторизация | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
| Workbook-Session-Id | Идентификатор сеанса книги, определяющий, сохраняются ли изменения. Необязательный параметр. |
Текст запроса
В тексте запроса предоставьте JSON-объект с указанными ниже параметрами.
| Параметр | Тип | Описание |
|---|---|---|
| height | number | Необязательный. Нужная высота создаваемого изображения. |
| width | number | Необязательный. Нужная ширина создаваемого изображения. |
| fittingMode | string | Необязательный параметр. Метод, используемый для масштабирования диаграммы до заданных измерений (если заданы высота и ширина)." Возможные значения: Fit, FitAndCenter, Fill. |
Отклик
В случае успеха этот метод возвращает код отклика 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"
}
Применение
Вы можете обеспечить отображение строки Base64 в теге изображения HTML: <img src="data:image/png;base64,{base-64 chart image string}/>.
В случае поведения по умолчанию используйте Image(width=0,height=0,fittingMode='fit'). В следующем примере показано изображение диаграммы, возвращенное с параметрами по умолчанию.
Если вы хотите настроить отображение этого изображения, укажите высоту, ширину и режим подгонки. В следующем примере показано, как выглядит то же изображение диаграммы, если вы извлекаете его с помощью следующих параметров: Image(width=500,height=500,fittingMode='Fill').
