Получить все фигуры на листе Excel

Этот REST API позволяет получить все фигуры на листе Excel.

Безопасность и аутентификация

API облачной платформы Aspose.Cells защищены и требуют аутентификации на основе JWT-токена.

REST API

GET https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/shapes

Параметры запроса

Имя параметра	Тип	Расположение	Описание
name	string	path	Имя файла Excel.
sheetName	string	path	Имя листа.
folder	string	query	Папка, содержащая документ.
storageName	string	query	Имя используемого облачного хранилища.
include	string	query	Установите значение `details`, чтобы вернуть полные свойства фигур; иначе возвращаются только объекты `link`.

Необязательно: параметры folder, storageName и include можно опустить, если файл находится в корневом хранилище.

Для доступа к веб-сервисам Aspose.Cells можно использовать утилиту командной строки cURL. Пример ниже демонстрирует запрос с необязательными параметрами запроса.

Запрос

curl -v "https://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/Sheet1/shapes?folder=Samples&storageName=MyStorage" \
-X GET \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>"

Ответ

{
  "Shapes": {
    "ShapeList": [
      {
        "link": {
          "Href": "/0",
          "Rel": "self",
          "Type": null,
          "Title": null
        }
      },
      {
        "link": {
          "Href": "/1",
          "Rel": "self",
          "Type": null,
          "Title": null
        }
      },
      {
        "link": {
          "Href": "/2",
          "Rel": "self",
          "Type": null,
          "Title": null
        }
      },
      {
        "link": {
          "Href": "/3",
          "Rel": "self",
          "Type": null,
          "Title": null
        }
      }
    ],
    "link": {
      "Href": "https://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/Sheet1/shapes",
      "Rel": "self",
      "Type": null,
      "Title": null
    }
  },
  "Code": 200,
  "Status": "OK"
}

Поля ответа

Объект Shapes содержит список элементов Shape. Каждая фигура включает следующие свойства (если используется флаг include=details; иначе возвращается только объект link).

Свойство	Тип	Описание
Name	string	Имя, присвоенное фигуре (например, «Chart 1»).
Type	string	Тип фигуры (например, `Chart`, `Picture`, `TextBox`).
Top	number	Расстояние в пунктах от верхнего края листа до фигуры.
Left	number	Расстояние в пунктах от левого края листа до фигуры.
Width	number	Ширина фигуры в пунктах.
Height	number	Высота фигуры в пунктах.
Link	object	Информация о гиперссылке (`Href`, `Rel`, `Type`, `Title`).

Обработка ошибок

HTTP-статус	Описание	Пример тела ошибки
400	Неверный запрос — некорректные параметры.	`{ "Code": 400, "Message": "Некорректное значение параметра." }`
401	Неавторизован — отсутствует или недействителен токен.	`{ "Code": 401, "Message": "Отсутствует или недействителен токен доступа." }`
404	Не найдено — рабочая книга или лист не существуют.	`{ "Code": 404, "Message": "Файл или лист не найден." }`
500	Внутренняя ошибка сервера — непредвиденное условие.	`{ "Code": 500, "Message": "Произошла непредвиденная ошибка." }`

Успешный запрос возвращает HTTP 200 с объектом Shapes, содержащим список фигур, как показано в примере ответа выше.

API ограничивает количество запросов до 150 запросов в минуту на один JWT-токен. Превышение этого лимита возвращает HTTP 429 с заголовком Retry-After, указывающим, когда можно повторить запрос.

Семейство облачных SDK

Использование SDK — лучший способ ускорить разработку. SDK обрабатывает низкоуровневые детали и позволяет сосредоточиться на задачах проекта. Полный список SDK облачной платформы Aspose.Cells представлен в репозитории на GitHub.

Примеры кода ниже демонстрируют, как вызывать веб-сервисы Aspose.Cells с использованием различных SDK:

C#

Java

PHP

Ruby

Node.js

Python

Perl

Go

Получение фигуры по индексу на листе Excel