Тип ресурса workbookRange

  • Статья

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Объект Range представляет собой набор из одной или нескольких смежных ячеек, например ячейку, строку, столбец, блок ячеек и т. д.

Методы

Метод Возвращаемый тип Описание
Получение объекта Range workbookRange Чтение свойств и связей объекта диапазона.
Обновление workbookRange Обновление объекта Range.
Boundingrect workbookRange Возвращает наименьший объект диапазона, включающий в себя заданные диапазоны. Например, GetBoundingRect для "B2:C5" и "D10:E15" — "B2:E16".
Cell workbookRange Получает объект диапазона, содержащий одну ячейку, на основе номеров строки и столбца. Ячейка может быть вне родительского диапазона, если она расположена в таблице листа. Возвращаемая ячейка располагается относительно верхней левой ячейки диапазона.
Column workbookRange Возвращает столбец в диапазоне.
Columnsafter workbookRangeView Возвращает несколько столбцов справа от заданного диапазона.
Columnsbefore workbookRangeView Возвращает несколько столбцов слева от заданного диапазона.
Entirecolumn workbookRange Возвращает объект, представляющий весь столбец диапазона.
Entirerow workbookRange Возвращает объект, представляющий всю строку диапазона.
Intersection workbookRange Возвращает объект диапазона, представляющий прямоугольное пересечение заданных диапазонов.
Lastcell Range Возвращает последнюю ячейку в диапазоне. Например, последняя ячейка диапазона B2:D5 — D5.
Lastcolumn workbookRange Возвращает последний столбец в диапазоне. Например, последний столбец диапазона B2:D5 — D2:D5.
Lastrow Range Возвращает последнюю строку в диапазоне. Например, последняя строка в диапазоне "B2:D5" — "B5:D5".
Offsetrange workbookRange Возвращает объект, представляющий диапазон, который смещен от указанного диапазона. Измерение возвращаемого диапазона соответствует этому диапазону. Если полученный диапазон выходит за пределы таблицы листа, вызывается исключение.
Row Range Возвращает строку из диапазона.
Rowsabove workbookRangeView Возвращает несколько строк выше заданного диапазона.
Rowsbelow workbookRangeView Возвращает несколько строк ниже заданного диапазона.
Usedrange workbookRange Возвращает используемый диапазон заданного объекта диапазона.
Clear Нет Очищает значения, формат, заливку, границу диапазона и т. д.
Delete Нет Удаляет ячейки, связанные с диапазоном.
Insert workbookRange Вставляет ячейку или диапазон ячеек на лист вместо этого диапазона, а также сдвигает другие ячейки, чтобы освободить место. Возвращает новый объект Range в пустом месте.
Merge Нет Объединяет ячейки диапазона в одну область на листе.
Resizedrange workbookRangeView Возвращает объект диапазона, подобный текущему объекту диапазона, но увеличенный (или уменьшенный) на некоторое количество строк и столбцов в правом нижнем углу.
Unmerge Нет Разъединяет ячейки диапазона на отдельные ячейки.
Visibleview workbookRangeView Обеспечивает отображение диапазона в отфильтрованном диапазоне.

Свойства

Свойство Тип Описание
address string Представляет ссылку на диапазон в стиле A1. Значение address содержит ссылку на лист (например, Лист1! A1:B4). Только для чтения.
addressLocal string Представляет ссылку на указанный диапазон на языке пользователя. Только для чтения.
cellCount int Количество ячеек в диапазоне. Только для чтения.
columnCount int Представляет общее количество столбцов в диапазоне. Только для чтения.
columnHidden boolean Указывает, скрыты ли все столбцы текущего диапазона.
columnIndex int Представляет номер столбца первой ячейки диапазона. Используется нулевой индекс. Только для чтения.
formulas Json Представляет формулу в формате A1.
formulasLocal Json Представляет формулу в формате A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке.
formulasR1C1 Json Представляет формулу в формате R1C1.
hidden boolean Указывает, скрыты ли все ячейки текущего диапазона. Только для чтения.
numberFormat Json Представляет код в числовом формате Excel для данной ячейки.
rowCount int Возвращает общее количество строк в диапазоне. Только для чтения.
rowHidden boolean Указывает, скрыты ли все строки текущего диапазона.
rowIndex int Возвращает номер строки первой ячейки диапазона. Используется нулевой индекс. Только для чтения.
text Json Текстовые значения указанного диапазона. Значение Text не зависит от ширины ячейки. Подстановка знака #, которая происходит в пользовательском интерфейсе Excel, не влияет на текстовое значение, возвращаемое API. Только для чтения.
valueTypes string Представляет тип данных каждой ячейки. Возможные значения: Unknown, Empty, String, Integer, Double, Boolean, Error. Только для чтения.
values Json Представляет необработанные значения указанного диапазона. Могут возвращаться строковые и числовые данные, а также логические значения. Ячейка, содержащая ошибку, возвращает строку ошибки.

Связи

Связь Тип Описание
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"
}