Тип ресурса workbookRange
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Представляет набор из одной или нескольких смежных ячеек в книге, таких как ячейка, строка, столбец или блок ячеек.
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
| Получение | workbookRange | Чтение свойств и связей объекта диапазона. |
| Обновление | workbookRange | Обновление объекта диапазона. |
| удаление; | Нет | Удалите ячейки, связанные с диапазоном. |
| Clear | Нет | Очистите значения диапазона, формат, заливку или границу. |
| Получение ограничивающегоrect | workbookRange | Получите наименьший объект диапазона, охватывающий заданные диапазоны. Например, GetBoundingRect для "B2:C5" и "D10:E15" — "B2:E16". |
| Получение ячейки | workbookRange | Возвращает объект диапазона, содержащий одну ячейку, на основе номеров строк и столбцов. Ячейка может находиться за пределами родительского диапазона, если она находится в сетке листа. Возвращаемая ячейка располагается относительно верхней левой ячейки диапазона. |
| Получение столбца | workbookRange | Получение столбца, содержащегося в диапазоне. |
| Получение столбцов после | workbookRangeView | Получение нескольких столбцов справа от заданного диапазона. |
| Получение столбцов до | workbookRangeView | Получение нескольких столбцов слева от заданного диапазона. |
| Получение всего столбца | workbookRange | Получите объект , представляющий весь столбец диапазона. |
| Получение всей строки | workbookRange | Возвращает объект, представляющий всю строку диапазона. |
| Получение пересечения | workbookRange | Получите объект диапазона, представляющий прямоугольное пересечение заданных диапазонов. |
| Получение последней ячейки | workbookRange | Получение последней ячейки в диапазоне. Например, последняя ячейка диапазона B2:D5 — D5. |
| Получение последнего столбца | workbookRange | Получение последнего столбца в диапазоне. Например, последний столбец диапазона B2:D5 — D2:D5. |
| Получение последней строки | workbookRange | Возвращает последнюю строку в диапазоне. Например, последняя строка в диапазоне "B2:D5" — "B5:D5". |
| Получение диапазона смещения | workbookRange | Получите объект , представляющий диапазон, который смещается от указанного диапазона. Измерение возвращаемого диапазона соответствует этому диапазону. Если полученный диапазон выходит за пределы таблицы листа, вызывается исключение. |
| Получение измененного диапазона | workbookRangeView | Получите объект диапазона, аналогичный текущему объекту диапазона, но с его правым нижним углом, развернутым (или с сокращением) на некоторое количество строк и столбцов. |
| Получение строки | workbookRange | Получение строки, содержащейся в диапазоне. |
| Получение строк выше | workbookRangeView | Получение нескольких строк выше заданного диапазона. |
| Получение строк ниже | workbookRangeView | Получение строк ниже заданного диапазона. |
| Получение используемого диапазона | workbookRange | Возвращает используемый диапазон заданного объекта диапазона. |
| Получение видимого представления | workbookRangeView | Обеспечивает отображение диапазона в отфильтрованном диапазоне. |
| Вставка диапазона | workbookRange | Вставьте ячейку или диапазон ячеек на лист вместо этого диапазона и перемещает другие ячейки, чтобы освободить место. Возвращает новый объект Range в пустом месте. |
| Merge | Нет | Объединяет ячейки диапазона в одну область на листе. |
| Unmerge | Нет | Разъединяет ячейки диапазона на отдельные ячейки. |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
| address | string | Представляет ссылку на диапазон в стиле A1. Значение address содержит ссылку на лист (например, Лист1! A1:B4). Только для чтения. |
| addressLocal | string | Представляет ссылку на указанный диапазон на языке пользователя. Только для чтения. |
| cellCount | int | Количество ячеек в диапазоне. Только для чтения. |
| columnCount | int | Представляет общее количество столбцов в диапазоне. Только для чтения. |
| columnHidden | Логический | Указывает, скрыты ли все столбцы текущего диапазона. |
| columnIndex | int | Представляет номер столбца первой ячейки диапазона. Используется нулевой индекс. Только для чтения. |
| formulas | Json | Представляет формулу в формате A1. |
| formulasLocal | Json | Представляет формулу в формате A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. |
| formulasR1C1 | Json | Представляет формулу в формате R1C1. |
| hidden | Логический | Указывает, скрыты ли все ячейки текущего диапазона. Только для чтения. |
| numberFormat | Json | Представляет код в числовом формате Excel для данной ячейки. |
| rowCount | int | Возвращает общее количество строк в диапазоне. Только для чтения. |
| rowHidden | Логический | Указывает, скрыты ли все строки текущего диапазона. |
| rowIndex | int | Возвращает номер строки первой ячейки диапазона. Используется нулевой индекс. Только для чтения. |
| text | Json | Текстовые значения указанного диапазона. Текстовое значение не зависит от ширины ячейки. Подстановка знака #, выполняемая в пользовательском интерфейсе Excel, не влияет на текстовое значение, возвращаемое API. Только для чтения. |
| valueTypes | string | Представляет тип данных каждой ячейки. Возможные значения: Unknown, Empty, String, Integer, Double, Boolean, Error. Только для чтения. |
| values | Json | Представляет необработанные значения указанного диапазона. Возвращаемые данные могут быть типа string, number или boolean. Ячейка, содержащая ошибку, возвращает строку ошибки. |
Связи
| Связь | Тип | Описание |
|---|---|---|
| format | workbookRangeFormat | Возвращает объект формата, в который включены шрифт, заливка, границы, выравнивание и другие свойства диапазона. Только для чтения. |
| sort | workbookRangeSort | Лист, содержащий текущий диапазон. Только для чтения. |
| лист | workbookWorksheet | Лист, содержащий текущий диапазон. Только для чтения. |
Представление JSON
В следующем представлении JSON показан тип ресурса.
{
"id": "string",
"address": "string",
"addressLocal": "string",
"cellCount": 1024,
"columnCount": 1024,
"columnHidden": true,
"columnIndex": 1024,
"formulas": "Json",
"formulasLocal": "Json",
"formulasR1C1": "Json",
"hidden": true,
"numberFormat": "Json",
"rowCount": 1024,
"rowHidden": true,
"rowIndex": 1024,
"text": "Json",
"valueTypes": "string",
"values": "json"
}