Excel.Range class

Диапазон представляет собой набор из одной или более состояных ячеек, таких как ячейка, строка, столбец или блок ячеек. Чтобы узнать больше о том, как диапазоны используются в API, начните с диапазонов в Excel API JavaScript.

Extends

Комментарии

[Набор API: ExcelApi 1.1 ]

Свойства

address

Указывает ссылку диапазона в стиле A1. Значение адреса содержит ссылку на лист (например, "Sheet1! A1:B4").

addressLocal

Представляет ссылку диапазона для указанного диапазона на языке пользователя.

cellCount

Указывает количество ячеек в диапазоне. Этот API возвращает значение -1, если количество ячеек превышает 2^31-1 (2,147,483,647).

columnCount

Указывает общее количество столбцов в диапазоне.

columnHidden

Представляет, скрыты ли все столбцы текущего диапазона. Значение — true это когда все столбцы в диапазоне скрыты. Значение — false это когда столбцы в диапазоне не скрыты. Значение — когда некоторые столбцы в диапазоне скрыты, а другие столбцы в том null же диапазоне не скрыты.

columnIndex

Указывает номер столбца первой ячейки в диапазоне. Используется нулевой индекс.

conditionalFormats

Эта коллекция ConditionalFormats пересекает диапазон.

context

Контекст запроса, связанный с объектом. Это связывает процесс надстройки с процессом Office хост-приложения.

dataValidation

Возвращает объект проверки данных.

format

Возвращает объект формата, в который включены шрифт, заливка, границы, выравнивание и другие свойства диапазона.

formulas

Представляет формулу в формате A1. Если ячейка не имеет формулы, вместо нее возвращается ее значение.

formulasLocal

Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если ячейка не имеет формулы, вместо нее возвращается ее значение.

formulasR1C1

Представляет формулу в формате R1C1. Если ячейка не имеет формулы, вместо нее возвращается ее значение.

hasSpill

Указывает, есть ли во всех ячейках граница переноса. Возвращается, если у всех ячеек есть граница разлива или если у всех ячеек нет границы true false разлива. Возвращается, если в диапазоне есть ячейки как с границами разлива, так и без null них.

height

Возвращает расстояние в точках для 100% масштабирования от верхнего края диапазона до нижнего края диапазона.

hidden

Представляет, скрыты ли все ячейки текущего диапазона. Значение — true это когда все ячейки в диапазоне скрыты. Значение — false это когда ячейки в диапазоне не скрыты. Значение — когда некоторые ячейки в диапазоне скрыты, а другие ячейки в том же диапазоне null не скрыты.

hyperlink

Представляет гиперссылку для текущего диапазона.

isEntireColumn

Указывает, является ли текущий диапазон целым столбцом.

isEntireRow

Указывает, является ли текущий диапазон целой строкой.

left

Возвращает расстояние в точках для 100% масштабирования от левого края таблицы до левого края диапазона.

linkedDataTypeState

Представляет состояние типа данных каждой ячейки.

numberFormat

Представляет Excel формата номеров для данного диапазона.

numberFormatCategories

Представляет категорию формата номеров каждой ячейки.

numberFormatLocal

Представляет Excel формата номера для данного диапазона в зависимости от языковых параметров пользователя. Excel не выполняет принуждение языка или формата при получении или настройке numberFormatLocal свойства. Любой возвращенный текст использует локально отформатированные строки на основе языка, указанного в параметрах системы.

rowCount

Возвращает общее количество строк в диапазоне.

rowHidden

Представляет, если все строки в текущем диапазоне скрыты. Значение — true это когда все строки в диапазоне скрыты. Значение — false это когда строки в диапазоне не скрыты. Значение — когда некоторые строки в диапазоне скрыты, а другие строки в том же диапазоне null не скрыты.

rowIndex

Возвращает номер строки первой ячейки диапазона. Используется нулевой индекс.

savedAsArray

Представляет, будут ли сохранены все ячейки в качестве формулы массива. Возвращается, если все ячейки будут сохранены в качестве формулы массива, или если все ячейки не будут сохранены true false в качестве формулы массива. nullВозвращается, если некоторые ячейки будут сохранены в качестве формулы массива, а некоторые не будут.

sort

Представляет порядок сортировки текущего диапазона.

style

Представляет стиль текущего диапазона. Если стили ячеек несовместимы, null они будут возвращены. Для пользовательских стилей будет возвращено имя стиля. Для встроенных стилей будет возвращена строка, представляющая значение в BuiltInStyle enum.

text

Текстовые значения указанного диапазона. Текстовое значение не зависит от ширины ячейки. Замена знака номера () в пользовательском интерфейсе Excel не повлияет на текстовое значение, возвращаемого # API.

top

Возвращает расстояние в точках для 100% масштабирования от верхнего края таблицы до верхнего края диапазона.

values

Представляет необработанные значения указанного диапазона. Возвращенные данные могут быть строкой, номером или boolean. Ячейки, содержащие ошибку, вернут строку ошибки. Если возвращенное значение начинается с плюса ("+"), минуса ("-"), или равного знака ("="), Excel интерпретирует это значение как формулу.

valuesAsJson

Представление JSON значений в ячейках этого диапазона. В отличие от Range.valuesподдерживает Range.valuesAsJson все типы данных, которые могут быть в ячейке.

valueTypes

Указывает тип данных в каждой ячейке.

width

Возвращает расстояние в точках для 100% масштабирования от левого края диапазона до правого края диапазона.

worksheet

Лист, содержащий текущий диапазон.

Методы

autoFill(destinationRange, autoFillType)

Заполняет диапазон от текущего диапазона до диапазона назначения с помощью указанной логики AutoFill. Диапазон назначения может быть или может расширять исходный диапазон либо null по горизонтали, либо по вертикали. Дисконтные диапазоны не поддерживаются.

Дополнительные сведения см. в дополнительных сведениях: Использование автозаполненки и флэш-заполнения.

autoFill(destinationRange, autoFillTypeString)

Заполняет диапазон от текущего диапазона до диапазона назначения с помощью указанной логики AutoFill. Диапазон назначения может быть или может расширять исходный диапазон либо null по горизонтали, либо по вертикали. Дисконтные диапазоны не поддерживаются.

Дополнительные сведения см. в дополнительных сведениях: Использование автозаполненки и флэш-заполнения.

calculate()

Вычисляет диапазон ячеек на листе.

clear(applyTo)

Очищает значения, формат, заливку, границу диапазона и т. д.

clear(applyToString)

Очищает значения, формат, заливку, границу диапазона и т. д.

convertDataTypeToText()

Преобразует ячейки диапазона с типами данных в текст.

convertToLinkedDataType(serviceID, languageCulture)

Преобразует ячейки диапазона в связанные типы данных в таблице.

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Копирует данные ячейки или форматирование из диапазона исходных данных или RangeAreas текущего диапазона. Диапазон назначения может быть иным размером, чем исходный диапазон или RangeAreas. Назначение будет расширяться автоматически, если оно меньше источника.

copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)

Копирует данные ячейки или форматирование из диапазона исходных данных или RangeAreas текущего диапазона. Диапазон назначения может быть иным размером, чем исходный диапазон или RangeAreas. Назначение будет расширяться автоматически, если оно меньше источника.

delete(shift)

Удаляет ячейки, связанные с диапазоном.

delete(shiftString)

Удаляет ячейки, связанные с диапазоном.

find(text, criteria)

Находит определенную строку на основе указанных условий. Если текущий диапазон больше одной ячейки, поиск будет ограничен этим диапазоном, иначе поиск будет охватывать весь лист, начиная с этой ячейки.

findOrNullObject(text, criteria)

Находит определенную строку на основе указанных условий. Если текущий диапазон больше одной ячейки, поиск будет ограничен этим диапазоном, иначе поиск будет охватывать весь лист, начиная с этой ячейки. Если совпадений нет, этот метод возвращает объект с его isNullObject свойством true. Дополнительные сведения см. в методе и свойствах *OrNullObject.

flashFill()

Делает флэш-заполнение для текущего диапазона. Flash Fill автоматически заполняет данные, когда он чувствует шаблон, поэтому диапазон должен быть одним диапазоном столбцов и иметь данные вокруг него, чтобы найти шаблон.

getAbsoluteResizedRange(numRows, numColumns)

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

getBoundingRect(anotherRange)

Возвращает наименьший объект диапазона, включающий в себя заданные диапазоны. Например, GetBoundingRect "B2:C5" и "D10:E15" — это "B2:E15".

getCell(row, column)

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

getCellProperties(cellPropertiesLoadOptions)

Возвращает двумерный массив, в который включены данные для шрифта, заливки, границ, выравнивания и других свойств каждой ячейки.

getColumn(column)

Возвращает столбец в диапазоне.

getColumnProperties(columnPropertiesLoadOptions)

Возвращает одномерный массив, в который включены данные для шрифта, заливки, границ, выравнивания и других свойств каждого столбца. Для свойств, не являющихся одинаковыми в каждой ячейке определенного столбца, возвращается значение null.

getColumnsAfter(count)

Получает определенное количество столбцов справа от текущего Range объекта.

getColumnsBefore(count)

Получает определенное количество столбцов слева от текущего Range объекта.

getDependents()

Возвращает объект, представляющего диапазон, содержащий все иждивенцы ячейки в одной и той же таблице или WorkbookRangeAreas в нескольких таблицах.

getDirectDependents()

Возвращает объект, представляющего диапазон, содержащий все прямые иждивенцы ячейки в одной и той же таблице или в нескольких WorkbookRangeAreas таблицах.

getDirectPrecedents()

Возвращает объект, представляющего диапазон, содержащий все прямые прецеденты ячейки в одной и той же таблице или WorkbookRangeAreas в нескольких таблицах.

getEntireColumn()

Получает объект, который представляет весь столбец диапазона (например, если текущий диапазон представляет ячейки "B4:E11", он представляет столбцы getEntireColumn "B:E").

getEntireRow()

Получает объект, который представляет весь ряд диапазона (например, если текущий диапазон представляет ячейки "B4:E11", это диапазон, который представляет строки GetEntireRow "4:11").

getExtendedRange(direction, activeCell)

Возвращает объект диапазона, который включает текущий диапазон и до края диапазона, в зависимости от предоставленного направления. Это соответствует поведению ключа Ctrl+Shift+Arrow в Excel Windows пользовательского интерфейса.

getExtendedRange(directionString, activeCell)

Возвращает объект диапазона, который включает текущий диапазон и до края диапазона, в зависимости от предоставленного направления. Это соответствует поведению ключа Ctrl+Shift+Arrow в Excel Windows пользовательского интерфейса.

getImage()

Отрисовка диапазона в качестве изображения png с кодом base64. Important*: Этот API в настоящее время неподтверчен в Excel для Mac. Для текущего состояния посетите OfficeDev/office-js Issue # 235.

getIntersection(anotherRange)

Возвращает объект диапазона, представляющий прямоугольное пересечение заданных диапазонов.

getIntersectionOrNullObject(anotherRange)

Возвращает объект диапазона, представляющий прямоугольное пересечение заданных диапазонов. Если пересечение не обнаружено, этот метод возвращает объект с его isNullObject свойством, заданной true. Дополнительные сведения см. в методе и свойствах *OrNullObject.

getLastCell()

Возвращает последнюю ячейку в диапазоне. Например, последняя ячейка диапазона B2:D5 — D5.

getLastColumn()

Возвращает последний столбец в диапазоне. Например, последний столбец диапазона B2:D5 — D2:D5.

getLastRow()

Возвращает последнюю строку в диапазоне. Например, последняя строка в диапазоне "B2:D5" — "B5:D5".

getMergedAreasOrNullObject()

Возвращает RangeAreas объект, который представляет объединенные области в этом диапазоне. Обратите внимание, что если количество объединенных областей в этом диапазоне превышает 512, то этот метод не сможет вернуть результат. Если объекта не существует, эта функция возвращает объект с RangeAreas его isNullObject свойством true. Дополнительные сведения см. в методе и свойствах *OrNullObject.

getOffsetRange(rowOffset, columnOffset)

Возвращает объект, представляющий диапазон, который смещен от указанного диапазона. Измерение возвращаемого диапазона будет соответствовать этому диапазону. Если результирующий диапазон выходит за пределы таблицы листа, возникнет ошибка.

getPivotTables(fullyContained)

Получает объемную коллекцию pivotTables, которые пересекаются с диапазоном.

getPrecedents()

Возвращает объект, представляющего диапазон, содержащий все прецеденты ячейки в одной и той же таблице или WorkbookRangeAreas в нескольких таблицах.

getRangeEdge(direction, activeCell)

Возвращает объект диапазона, который является краеугольным элементом области данных, соответствующей предоставленной направлению. Это соответствует поведению ключа Ctrl+Arrow в Excel Windows пользовательского интерфейса.

getRangeEdge(directionString, activeCell)

Возвращает объект диапазона, который является краеугольным элементом области данных, соответствующей предоставленной направлению. Это соответствует поведению ключа Ctrl+Arrow в Excel Windows пользовательского интерфейса.

getResizedRange(deltaRows, deltaColumns)

Получает объект, похожий на текущий объект, но с его нижним правым углом, расширенным (или законтрактованым) рядом строк Range Range и столбцов.

getRow(row)

Возвращает строку из диапазона.

getRowProperties(rowPropertiesLoadOptions)

Возвращает одномерный массив, в который включены данные для шрифта, заливки, границ, выравнивания и других свойств каждой строки. Для свойств, которые не соответствуют каждой ячейке в данной строке, null будут возвращены.

getRowsAbove(count)

Получает определенное количество строк выше текущего Range объекта.

getRowsBelow(count)

Получает определенное количество строк ниже текущего Range объекта.

getSpecialCells(cellType, cellValueType)

Получает объект, состоящий из одного или нескольких прямоугольных диапазонов, который представляет все ячейки, которые соответствуют указанному RangeAreas типу и значению. Если специальные ячейки не найдены, ItemNotFound будет выброшена ошибка.

getSpecialCells(cellTypeString, cellValueType)

Получает объект, состоящий из одного или нескольких прямоугольных диапазонов, который представляет все ячейки, которые соответствуют указанному RangeAreas типу и значению. Если специальные ячейки не найдены, ItemNotFound будет выброшена ошибка.

getSpecialCellsOrNullObject(cellType, cellValueType)

Получает объект, состоящий из одного или нескольких диапазонов, который представляет все ячейки, которые соответствуют указанному RangeAreas типу и значению. Если специальных ячеек не обнаружено, этот метод возвращает объект с его isNullObject свойством true. Дополнительные сведения см. в методе и свойствах *OrNullObject.

getSpecialCellsOrNullObject(cellTypeString, cellValueType)

Получает объект, состоящий из одного или нескольких диапазонов, который представляет все ячейки, которые соответствуют указанному RangeAreas типу и значению. Если специальных ячеек не обнаружено, этот метод возвращает объект с его isNullObject свойством true. Дополнительные сведения см. в методе и свойствах *OrNullObject.

getSpillingToRange()

Получает объект range, содержащий диапазон переноса при вызове для базовой ячейки. Возвращает ошибку, если применяется к диапазону с несколькими ячейками.

getSpillingToRangeOrNullObject()

Получает объект range, содержащий диапазон переноса при вызове для базовой ячейки. Если диапазон не является якорной ячейкой или диапазон разлива не может быть найден, этот метод возвращает объект с его isNullObject свойством true. Дополнительные сведения см. в методе и свойствах *OrNullObject.

getSpillParent()

Получает объект диапазона, содержащий базовую ячейку для переносимой ячейки. Возвращает ошибку, если применяется к диапазону с несколькими ячейками.

getSpillParentOrNullObject()

Получает объект диапазона, содержащий якорную ячейку для пролитой ячейки. Если это не пролитая ячейка или не дается несколько клеток, этот метод возвращает объект с его isNullObject свойством, заданным для true. Дополнительные сведения см. в методе и свойствах *OrNullObject.

getSurroundingRegion()

Возвращает Range объект, который представляет окружающий регион для верхнего левого элемента в этом диапазоне. Это диапазон, ограниченный любым сочетанием пустых строк и столбцов, относящихся к этому диапазону.

getTables(fullyContained)

Получает коллекцию таблиц с заданной областью, перекрывающую диапазон.

getUsedRange(valuesOnly)

Возвращает используемый диапазон заданного объекта диапазона. Если в диапазоне нет используемых ячеек, эта функция будет выбрасывать ItemNotFound ошибку.

getUsedRangeOrNullObject(valuesOnly)

Возвращает используемый диапазон заданного объекта диапазона. Если в диапазоне нет используемых ячеек, этот метод возвращает объект с его isNullObject свойством true. Дополнительные сведения см. в методе и свойствах *OrNullObject.

getVisibleView()

Представляет видимые строки текущего диапазона.

group(groupOption)

Группы столбцов и строк для контура.

group(groupOptionString)

Группы столбцов и строк для контура.

hideGroupDetails(groupOption)

Скрывает сведения о группе строки или столбца.

hideGroupDetails(groupOptionString)

Скрывает сведения о группе строки или столбца.

insert(shift)

Вставляет ячейку или диапазон ячеек на лист вместо этого диапазона, а также сдвигает другие ячейки, чтобы освободить место. Возвращает новый объект Range в пустом пространстве.

insert(shiftString)

Вставляет ячейку или диапазон ячеек на лист вместо этого диапазона, а также сдвигает другие ячейки, чтобы освободить место. Возвращает новый объект Range в пустом пространстве.

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

merge(across)

Объединяет ячейки диапазона в одну область на листе.

moveTo(destinationRange)

Перемещает значения ячейки, форматирование и формулы из текущего диапазона в диапазон назначения, заменяя старые сведения в этих ячейках. Диапазон назначения будет автоматически расширяться, если он меньше текущего диапазона. Все ячейки в диапазоне назначения, которые находятся за пределами области исходного диапазона, не меняются.

removeDuplicates(columns, includesHeader)

Удаляет повторяющиеся значения из диапазона, заданного столбцами.

replaceAll(text, replacement, criteria)

Находит и заменяет определенную строку на основе условий, указанных в текущем диапазоне.

select()

Выбирает указанный диапазон в пользовательском интерфейсе Excel.

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать либо обычный объект с соответствующими свойствами, либо другой объект API того же типа.

set(properties)

Задает несколько свойств на объекте одновременно на основе существующего загруженного объекта.

setCellProperties(cellPropertiesData)

Обновляет диапазон на основе 2D-массива свойств ячейки, инкапсулируя такие вещи, как шрифт, заливка, границы и выравнивание.

setColumnProperties(columnPropertiesData)

Обновляет диапазон на основе одномерного массива свойств столбцов, инкапсулируя такие вещи, как шрифт, заливка, границы и выравнивание.

setDirty()

Устанавливает диапазон, предназначенный для пересчета при выполнении следующего пересчета.

setRowProperties(rowPropertiesData)

Обновляет диапазон на основе одномерного массива свойств строки, инкапсулируя такие вещи, как шрифт, заливка, границы и выравнивание.

showCard()

Отображает карточку для активной ячейки, если она имеет содержимое c форматированным значением.

showGroupDetails(groupOption)

Отображает сведения о группе строки или столбца.

showGroupDetails(groupOptionString)

Отображает сведения о группе строки или столбца.

toJSON()

Переопределяет метод JavaScript, чтобы обеспечить более полезный выход, когда объект toJSON() API передается JSON.stringify(). (JSON.stringify, в свою очередь, вызывает метод объекта, который toJSON передается ему.) В то время как исходный Excel. Объект Range — это объект API, метод возвращает простой toJSON объект JavaScript (введите какExcel.Interfaces.RangeData), содержащий неглубокие копии любых загруженных свойств ребенка из исходного объекта.

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является кратким для context.trackedObjects.add(thisObject). Если вы используете этот объект во время вызовов и вне последовательного выполнения пакета ".run" и получаете ошибку "InvalidObjectPath" при настройке свойства или вызове метода на объекте, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании .sync объекта.

ungroup(groupOption)

Разгруппировка столбцов и строк для контура.

ungroup(groupOptionString)

Разгруппировка столбцов и строк для контура.

unmerge()

Разъединяет ячейки диапазона на отдельные ячейки.

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является коротким для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам потребуется позвонить до context.sync() того, как вступает в силу выпуск памяти.

Сведения о свойстве

address

Указывает ссылку диапазона в стиле A1. Значение адреса содержит ссылку на лист (например, "Sheet1! A1:B4").

readonly address: string;

Значение свойства

string

Комментарии

[Набор API: ExcelApi 1.1 ]

addressLocal

Представляет ссылку диапазона для указанного диапазона на языке пользователя.

readonly addressLocal: string;

Значение свойства

string

Комментарии

[Набор API: ExcelApi 1.1 ]

cellCount

Указывает количество ячеек в диапазоне. Этот API возвращает значение -1, если количество ячеек превышает 2^31-1 (2,147,483,647).

readonly cellCount: number;

Значение свойства

number

Комментарии

[Набор API: ExcelApi 1.1 ]

columnCount

Указывает общее количество столбцов в диапазоне.

readonly columnCount: number;

Значение свойства

number

Комментарии

[Набор API: ExcelApi 1.1 ]

columnHidden

Представляет, скрыты ли все столбцы текущего диапазона. Значение — true это когда все столбцы в диапазоне скрыты. Значение — false это когда столбцы в диапазоне не скрыты. Значение — когда некоторые столбцы в диапазоне скрыты, а другие столбцы в том null же диапазоне не скрыты.

columnHidden: boolean;

Значение свойства

boolean

Комментарии

[Набор API: ExcelApi 1.2 ]

columnIndex

Указывает номер столбца первой ячейки в диапазоне. Используется нулевой индекс.

readonly columnIndex: number;

Значение свойства

number

Комментарии

[Набор API: ExcelApi 1.1 ]

conditionalFormats

Эта коллекция ConditionalFormats пересекает диапазон.

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Значение свойства

Комментарии

[Набор API: ExcelApi 1.6 ]

context

Контекст запроса, связанный с объектом. Это связывает процесс надстройки с процессом Office хост-приложения.

context: RequestContext;

Значение свойства

dataValidation

Возвращает объект проверки данных.

readonly dataValidation: Excel.DataValidation;

Значение свойства

Комментарии

[Набор API: ExcelApi 1.8 ]

format

Возвращает объект формата, в который включены шрифт, заливка, границы, выравнивание и другие свойства диапазона.

readonly format: Excel.RangeFormat;

Значение свойства

Комментарии

[Набор API: ExcelApi 1.1 ]

formulas

Представляет формулу в формате A1. Если ячейка не имеет формулы, вместо нее возвращается ее значение.

formulas: any[][];

Значение свойства

any[][]

Комментарии

[Набор API: ExcelApi 1.1 ]

formulasLocal

Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если ячейка не имеет формулы, вместо нее возвращается ее значение.

formulasLocal: any[][];

Значение свойства

any[][]

Комментарии

[Набор API: ExcelApi 1.1 ]

formulasR1C1

Представляет формулу в формате R1C1. Если ячейка не имеет формулы, вместо нее возвращается ее значение.

formulasR1C1: any[][];

Значение свойства

any[][]

Комментарии

[Набор API: ExcelApi 1.2 ]

hasSpill

Указывает, есть ли во всех ячейках граница переноса. Возвращается, если у всех ячеек есть граница разлива или если у всех ячеек нет границы true false разлива. Возвращается, если в диапазоне есть ячейки как с границами разлива, так и без null них.

readonly hasSpill: boolean;

Значение свойства

boolean

Комментарии

[Набор API: ExcelApi 1.12 ]

height

Возвращает расстояние в точках для 100% масштабирования от верхнего края диапазона до нижнего края диапазона.

readonly height: number;

Значение свойства

number

Комментарии

[Набор API: ExcelApi 1.10 ]

hidden

Представляет, скрыты ли все ячейки текущего диапазона. Значение — true это когда все ячейки в диапазоне скрыты. Значение — false это когда ячейки в диапазоне не скрыты. Значение — когда некоторые ячейки в диапазоне скрыты, а другие ячейки в том же диапазоне null не скрыты.

readonly hidden: boolean;

Значение свойства

boolean

Комментарии

[Набор API: ExcelApi 1.2 ]

Представляет гиперссылку для текущего диапазона.

hyperlink: Excel.RangeHyperlink;

Значение свойства

Комментарии

[Набор API: ExcelApi 1.7 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-hyperlink.yaml
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Orders");

    let productsRange = sheet.getRange("A3:A5");
    productsRange.load("values");

    await context.sync();

    // Create a hyperlink to a URL 
    // for each product name in the first table.
    for (let i = 0; i < productsRange.values.length; i++) {
        let cellRange = productsRange.getCell(i, 0);
        let cellText = productsRange.values[i][0];

        let hyperlink = {
            textToDisplay: cellText,
            screenTip: "Search Bing for '" + cellText + "'",
            address: "https://www.bing.com?q=" + cellText
        }
        cellRange.hyperlink = hyperlink;
    }

    await context.sync();
});

isEntireColumn

Указывает, является ли текущий диапазон целым столбцом.

readonly isEntireColumn: boolean;

Значение свойства

boolean

Комментарии

[Набор API: ExcelApi 1.7 ]

isEntireRow

Указывает, является ли текущий диапазон целой строкой.

readonly isEntireRow: boolean;

Значение свойства

boolean

Комментарии

[Набор API: ExcelApi 1.7 ]

left

Возвращает расстояние в точках для 100% масштабирования от левого края таблицы до левого края диапазона.

readonly left: number;

Значение свойства

number

Комментарии

[Набор API: ExcelApi 1.10 ]

linkedDataTypeState

Представляет состояние типа данных каждой ячейки.

readonly linkedDataTypeState: Excel.LinkedDataTypeState[][];

Значение свойства

Комментарии

[Набор API: ExcelApi 1.9 ]

numberFormat

Представляет Excel формата номеров для данного диапазона.

numberFormat: any[][];

Значение свойства

any[][]

Комментарии

[Набор API: ExcelApi 1.1 ]

Примеры

// The example below sets number-format, values and formulas on a grid that contains 2x3 grid.
Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "F5:G7";
    var numberFormat = [[null, "d-mmm"], [null, "d-mmm"], [null, null]]
    var values = [["Today", 42147], ["Tomorrow", "5/24"], ["Difference in days", null]];
    var formulas = [[null,null], [null,null], [null,"=G6-G5"]];
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.numberFormat = numberFormat;
    range.values = values;
    range.formulas= formulas;
    range.load('text');
    return ctx.sync().then(function() {
        console.log(range.text);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

numberFormatCategories

Представляет категорию формата номеров каждой ячейки.

readonly numberFormatCategories: Excel.NumberFormatCategory[][];

Значение свойства

Комментарии

[Набор API: ExcelApi 1.12 ]

numberFormatLocal

Представляет Excel формата номера для данного диапазона в зависимости от языковых параметров пользователя. Excel не выполняет принуждение языка или формата при получении или настройке numberFormatLocal свойства. Любой возвращенный текст использует локально отформатированные строки на основе языка, указанного в параметрах системы.

numberFormatLocal: any[][];

Значение свойства

any[][]

Комментарии

[Набор API: ExcelApi 1.7 ]

rowCount

Возвращает общее количество строк в диапазоне.

readonly rowCount: number;

Значение свойства

number

Комментарии

[Набор API: ExcelApi 1.1 ]

rowHidden

Представляет, если все строки в текущем диапазоне скрыты. Значение — true это когда все строки в диапазоне скрыты. Значение — false это когда строки в диапазоне не скрыты. Значение — когда некоторые строки в диапазоне скрыты, а другие строки в том же диапазоне null не скрыты.

rowHidden: boolean;

Значение свойства

boolean

Комментарии

[Набор API: ExcelApi 1.2 ]

rowIndex

Возвращает номер строки первой ячейки диапазона. Используется нулевой индекс.

readonly rowIndex: number;

Значение свойства

number

Комментарии

[Набор API: ExcelApi 1.1 ]

savedAsArray

Представляет, будут ли сохранены все ячейки в качестве формулы массива. Возвращается, если все ячейки будут сохранены в качестве формулы массива, или если все ячейки не будут сохранены true false в качестве формулы массива. nullВозвращается, если некоторые ячейки будут сохранены в качестве формулы массива, а некоторые не будут.

readonly savedAsArray: boolean;

Значение свойства

boolean

Комментарии

[Набор API: ExcelApi 1.12 ]

sort

Представляет порядок сортировки текущего диапазона.

readonly sort: Excel.RangeSort;

Значение свойства

Комментарии

[Набор API: ExcelApi 1.2 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml
async function sortTopToBottom(criteria: string) {
    await Excel.run(async (context) => {
        const sheet = context.workbook.worksheets.getActiveWorksheet();
        const range = sheet.getRange("A1:E5");

        // Find the column header that provides the sort criteria.
        const header = range.find(criteria, {});
        header.load("columnIndex");
        await context.sync();

        range.sort.apply(
            [
                {
                    key: header.columnIndex,
                    sortOn: Excel.SortOn.value
                }
            ],
            false /*matchCase*/,
            true /*hasHeaders*/,
            Excel.SortOrientation.rows
        );
        await context.sync();
    });
}

style

Представляет стиль текущего диапазона. Если стили ячеек несовместимы, null они будут возвращены. Для пользовательских стилей будет возвращено имя стиля. Для встроенных стилей будет возвращена строка, представляющая значение в BuiltInStyle enum.

style: string;

Значение свойства

string

Комментарии

[Набор API: ExcelApi 1.7 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
    let worksheet = context.workbook.worksheets.getItem("Sample");
    let range = worksheet.getRange("A1:E1");

    // Apply built-in style. 
    // Styles are in the Home tab ribbon.
    range.style = Excel.BuiltInStyle.neutral;
    range.format.horizontalAlignment = "Right";

    await context.sync();
});

text

Текстовые значения указанного диапазона. Текстовое значение не зависит от ширины ячейки. Замена знака номера () в пользовательском интерфейсе Excel не повлияет на текстовое значение, возвращаемого # API.

readonly text: string[][];

Значение свойства

string[][]

Комментарии

[Набор API: ExcelApi 1.1 ]

top

Возвращает расстояние в точках для 100% масштабирования от верхнего края таблицы до верхнего края диапазона.

readonly top: number;

Значение свойства

number

Комментарии

[Набор API: ExcelApi 1.10 ]

values

Представляет необработанные значения указанного диапазона. Возвращенные данные могут быть строкой, номером или boolean. Ячейки, содержащие ошибку, вернут строку ошибки. Если возвращенное значение начинается с плюса ("+"), минуса ("-"), или равного знака ("="), Excel интерпретирует это значение как формулу.

values: any[][];

Значение свойства

any[][]

Комментарии

[Набор API: ExcelApi 1.1 ]

valuesAsJson

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Представление JSON значений в ячейках этого диапазона. В отличие от Range.valuesподдерживает Range.valuesAsJson все типы данных, которые могут быть в ячейке.

valuesAsJson: ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | BlockedErrorCellValue | BusyErrorCellValue | CalcErrorCellValue | ConnectErrorCellValue | Div0ErrorCellValue | FieldErrorCellValue | GettingDataErrorCellValue | NotAvailableErrorCellValue | NameErrorCellValue | NullErrorCellValue | NumErrorCellValue | RefErrorCellValue | SpillErrorCellValue | ValueErrorCellValue | FormattedNumberCellValue | LinkedEntityCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue & {
            writable?: boolean;
            writableNote?: string;
        }[][];

Значение свойства

Комментарии

[API set: ExcelApi BETA (PREVIEW ONLY) ]

valueTypes

Указывает тип данных в каждой ячейке.

readonly valueTypes: Excel.RangeValueType[][];

Значение свойства

Комментарии

[Набор API: ExcelApi 1.1 ]

width

Возвращает расстояние в точках для 100% масштабирования от левого края диапазона до правого края диапазона.

readonly width: number;

Значение свойства

number

Комментарии

[Набор API: ExcelApi 1.10 ]

worksheet

Лист, содержащий текущий диапазон.

readonly worksheet: Excel.Worksheet;

Значение свойства

Комментарии

[Набор API: ExcelApi 1.1 ]

Сведения о методе

autoFill(destinationRange, autoFillType)

Заполняет диапазон от текущего диапазона до диапазона назначения с помощью указанной логики AutoFill. Диапазон назначения может быть или может расширять исходный диапазон либо null по горизонтали, либо по вертикали. Дисконтные диапазоны не поддерживаются.

Дополнительные сведения см. в дополнительных сведениях: Использование автозаполненки и флэш-заполнения.

autoFill(destinationRange?: Range | string, autoFillType?: Excel.AutoFillType): void;

Параметры

destinationRange

Excel.Range | string

Диапазон назначения для AutoFill. Если диапазон назначения null, данные заполняются на основе окружающих ячеек (это поведение при двойном нажатии ручки заполнения диапазона пользовательского интерфейса).

autoFillType
Excel.AutoFillType

Тип AutoFill. Указывает, как должен быть заполнен диапазон назначения в зависимости от содержимого текущего диапазона. По умолчанию это "FillDefault".

Возвращаемое значение

void

Комментарии

[API set: ExcelApi 1.9, ExcelApi destinationRange Preview for null ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-auto-fill.yaml
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const sumCell = sheet.getRange("P4");
  
  // Copy everything. The formulas will be contextually updated based on their new locations.
  sumCell.autoFill("P4:P7", Excel.AutoFillType.fillCopy);
  sumCell.format.autofitColumns();
  await context.sync();
});

autoFill(destinationRange, autoFillTypeString)

Заполняет диапазон от текущего диапазона до диапазона назначения с помощью указанной логики AutoFill. Диапазон назначения может быть или может расширять исходный диапазон либо null по горизонтали, либо по вертикали. Дисконтные диапазоны не поддерживаются.

Дополнительные сведения см. в дополнительных сведениях: Использование автозаполненки и флэш-заполнения.

autoFill(destinationRange?: Range | string, autoFillTypeString?: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"): void;

Параметры

destinationRange

Excel.Range | string

Диапазон назначения для AutoFill. Если диапазон назначения null, данные заполняются на основе окружающих ячеек (это поведение при двойном нажатии ручки заполнения диапазона пользовательского интерфейса).

autoFillTypeString

"FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"

Тип AutoFill. Указывает, как должен быть заполнен диапазон назначения в зависимости от содержимого текущего диапазона. По умолчанию это "FillDefault".

Возвращаемое значение

void

Комментарии

[API set: ExcelApi 1.9, ExcelApi destinationRange Preview for null ]

calculate()

Вычисляет диапазон ячеек на листе.

calculate(): void;

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.6 ]

clear(applyTo)

Очищает значения, формат, заливку, границу диапазона и т. д.

clear(applyTo?: Excel.ClearApplyTo): void;

Параметры

applyTo
Excel.ClearApplyTo

Необязательный параметр. Определяет тип действия очистки. Подробные Excel.ClearApplyTo сведения см. в материале.

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.1 ]

Примеры

// Below example clears format and contents of the range. 
Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "D:F";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.clear();
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

clear(applyToString)

Очищает значения, формат, заливку, границу диапазона и т. д.

clear(applyToString?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"): void;

Параметры

applyToString

"All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"

Необязательный параметр. Определяет тип действия очистки. Подробные Excel.ClearApplyTo сведения см. в материале.

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.1 ]

convertDataTypeToText()

Преобразует ячейки диапазона с типами данных в текст.

convertDataTypeToText(): void;

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.9 ]

convertToLinkedDataType(serviceID, languageCulture)

Преобразует ячейки диапазона в связанные типы данных в таблице.

convertToLinkedDataType(serviceID: number, languageCulture: string): void;

Параметры

serviceID

number

ID службы, который будет использоваться для запроса данных.

languageCulture

string

Языковая культура для запроса службы.

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.9 ]

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Копирует данные ячейки или форматирование из диапазона исходных данных или RangeAreas текущего диапазона. Диапазон назначения может быть иным размером, чем исходный диапазон или RangeAreas. Назначение будет расширяться автоматически, если оно меньше источника.

copyFrom(sourceRange: Range | RangeAreas | string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void;

Параметры

sourceRange

Excel.Range | Excel.RangeAreas | string

Диапазон источника или RangeAreas копирование. Если источник имеет несколько диапазонов, их форму необходимо создать путем удаления полных рядов или столбцов RangeAreas из прямоугольного диапазона.

copyType
Excel.RangeCopyType

Тип данных ячейки или форматирование для копирования. По умолчанию это "Все".

skipBlanks

boolean

True, если пропустить пустые ячейки в диапазоне исходных источников. Значение по умолчанию: false.

transpose

boolean

True, если перенаправление ячеек в диапазоне назначения. Значение по умолчанию: false.

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.9 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-copyfrom.yaml
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    // Place a label in front of the copied data.
    sheet.getRange("F2").values = [["Copied Formula"]];

    // Copy a range preserving the formulas.
    // Note: non-formula values are copied over as is.
    sheet.getRange("G2").copyFrom("A1:E1", Excel.RangeCopyType.formulas);
    await context.sync();
});

copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)

Копирует данные ячейки или форматирование из диапазона исходных данных или RangeAreas текущего диапазона. Диапазон назначения может быть иным размером, чем исходный диапазон или RangeAreas. Назначение будет расширяться автоматически, если оно меньше источника.

copyFrom(sourceRange: Range | RangeAreas | string, copyTypeString?: "All" | "Formulas" | "Values" | "Formats", skipBlanks?: boolean, transpose?: boolean): void;

Параметры

sourceRange

Excel.Range | Excel.RangeAreas | string

Диапазон источника или RangeAreas копирование. Если источник имеет несколько диапазонов, их форму необходимо создать путем удаления полных рядов или столбцов RangeAreas из прямоугольного диапазона.

copyTypeString

"All" | "Formulas" | "Values" | "Formats"

Тип данных ячейки или форматирование для копирования. По умолчанию это "Все".

skipBlanks

boolean

True, если пропустить пустые ячейки в диапазоне исходных источников. Значение по умолчанию: false.

transpose

boolean

True, если перенаправление ячеек в диапазоне назначения. Значение по умолчанию: false.

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.9 ]

delete(shift)

Удаляет ячейки, связанные с диапазоном.

delete(shift: Excel.DeleteShiftDirection): void;

Параметры

shift
Excel.DeleteShiftDirection

Определяет способ сдвига ячеек. Подробные Excel.DeleteShiftDirection сведения см. в материале.

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.1 ]

Примеры

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "D:F";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.delete("Left");
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

delete(shiftString)

Удаляет ячейки, связанные с диапазоном.

delete(shiftString: "Up" | "Left"): void;

Параметры

shiftString

"Up" | "Left"

Определяет способ сдвига ячеек. Подробные Excel.DeleteShiftDirection сведения см. в материале.

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.1 ]

find(text, criteria)

Находит определенную строку на основе указанных условий. Если текущий диапазон больше одной ячейки, поиск будет ограничен этим диапазоном, иначе поиск будет охватывать весь лист, начиная с этой ячейки.

find(text: string, criteria: Excel.SearchCriteria): Excel.Range;

Параметры

text

string

Строка для поиска.

criteria
Excel.SearchCriteria

Дополнительные критерии поиска, включая направление поиска и соответствие поиска всей ячейке или учет учетных данных.

Возвращаемое значение

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

Комментарии

[Набор API: ExcelApi 1.9 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-find.yaml
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const table = sheet.tables.getItem("ExpensesTable");
    const searchRange = table.getRange();

    // NOTE: If no match is found, an ItemNotFound error
    // is thrown when Range.find is evaluated.
    const foundRange = searchRange.find($("#searchText").text(), {
        completeMatch: isCompleteMatchToggle,
        matchCase: isMatchCaseToggle,
        searchDirection: searchDirectionToggle
    });
    
    foundRange.load("address");
    await context.sync();


    console.log(foundRange.address);
});

findOrNullObject(text, criteria)

Находит определенную строку на основе указанных условий. Если текущий диапазон больше одной ячейки, поиск будет ограничен этим диапазоном, иначе поиск будет охватывать весь лист, начиная с этой ячейки. Если совпадений нет, этот метод возвращает объект с его isNullObject свойством true. Дополнительные сведения см. в методе и свойствах *OrNullObject.

findOrNullObject(text: string, criteria: Excel.SearchCriteria): Excel.Range;

Параметры

text

string

Строка для поиска.

criteria
Excel.SearchCriteria

Дополнительные критерии поиска, включая направление поиска и соответствие поиска всей ячейке или учет учетных данных.

Возвращаемое значение

Тот, Range который соответствует критериям поиска.

Комментарии

[Набор API: ExcelApi 1.9 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-find.yaml
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const table = sheet.tables.getItem("ExpensesTable");
    const searchRange = table.getRange();
    const foundRange = searchRange.findOrNullObject($("#searchText").text(), {
        completeMatch: isCompleteMatchToggle,
        matchCase: isMatchCaseToggle,
        searchDirection: searchDirectionToggle
    });
    
    foundRange.load("address");
    await context.sync();

    if (foundRange.isNullObject) {
        console.log("Text not found");
    } else {
        console.log(foundRange.address);
    }
});

flashFill()

Делает флэш-заполнение для текущего диапазона. Flash Fill автоматически заполняет данные, когда он чувствует шаблон, поэтому диапазон должен быть одним диапазоном столбцов и иметь данные вокруг него, чтобы найти шаблон.

flashFill(): void;

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.9 ]

getAbsoluteResizedRange(numRows, numColumns)

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

getAbsoluteResizedRange(numRows: number, numColumns: number): Excel.Range;

Параметры

numRows

number

Количество строк нового размера диапазона.

numColumns

number

Количество столбцов нового размера диапазона.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.7 ]

getBoundingRect(anotherRange)

Возвращает наименьший объект диапазона, включающий в себя заданные диапазоны. Например, GetBoundingRect "B2:C5" и "D10:E15" — это "B2:E15".

getBoundingRect(anotherRange: Range | string): Excel.Range;

Параметры

anotherRange

Excel.Range | string

Имя объекта диапазона, адреса или диапазона.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.1 ]

Примеры

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "D4:G6";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    var range = range.getBoundingRect("G4:H8");
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address); // Prints Sheet1!D4:H8
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getCell(row, column)

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

getCell(row: number, column: number): Excel.Range;

Параметры

row

number

Номер строки ячейки, которую требуется извлечь. Используется нулевой индекс.

column

number

Номер столбца ячейки, которую требуется извлечь. Используется нулевой индекс.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.1 ]

Примеры

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var worksheet = ctx.workbook.worksheets.getItem(sheetName);
    var range = worksheet.getRange(rangeAddress);
    var cell = range.getCell(0,0);
    cell.load('address');
    return ctx.sync().then(function() {
        console.log(cell.address);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getCellProperties(cellPropertiesLoadOptions)

Возвращает двумерный массив, в который включены данные для шрифта, заливки, границ, выравнивания и других свойств каждой ячейки.

getCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions): OfficeExtension.ClientResult<CellProperties[][]>;

Параметры

cellPropertiesLoadOptions
Excel.CellPropertiesLoadOptions

Объект, который представляет свойства ячейки для загрузки.

Возвращаемое значение

Массив 2D, в котором каждый элемент представляет запрашиваемую свойства соответствующей ячейки.

Комментарии

[Набор API: ExcelApi 1.9 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml
await Excel.run(async (context) => {
    const cell = context.workbook.getActiveCell();

    // Define the cell properties to get by setting the matching LoadOptions to true.
    const propertiesToGet = cell.getCellProperties({
        address: true,
        format: {
            fill: {
                color: true
            },
            font: {
                color: true
            }
        },
        style: true
    });

    // Sync to get the data from the workbook.
    await context.sync();
    const cellProperties = propertiesToGet.value[0][0];
    console.log(
        `Address: ${cellProperties.address}\nStyle: ${cellProperties.style}\nFill Color: ${cellProperties.format.fill.color}\nFont Color: ${cellProperties.format.font.color}`);
});

getColumn(column)

Возвращает столбец в диапазоне.

getColumn(column: number): Excel.Range;

Параметры

column

number

Номер столбца диапазона, который требуется извлечь. Используется нулевой индекс.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.1 ]

Примеры

Excel.run(function (ctx) { 
    var sheetName = "Sheet19";
    var rangeAddress = "A1:F8";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getColumn(1);
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address); // prints Sheet1!B1:B8
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getColumnProperties(columnPropertiesLoadOptions)

Возвращает одномерный массив, в который включены данные для шрифта, заливки, границ, выравнивания и других свойств каждого столбца. Для свойств, не являющихся одинаковыми в каждой ячейке определенного столбца, возвращается значение null.

getColumnProperties(columnPropertiesLoadOptions: ColumnPropertiesLoadOptions): OfficeExtension.ClientResult<ColumnProperties[]>;

Параметры

columnPropertiesLoadOptions
Excel.ColumnPropertiesLoadOptions

Объект, который представляет свойства столбца для загрузки.

Возвращаемое значение

Массив, в котором каждый элемент представляет запрашиваемую свойства соответствующего столбца.

Комментарии

[Набор API: ExcelApi 1.9 ]

getColumnsAfter(count)

Получает определенное количество столбцов справа от текущего Range объекта.

getColumnsAfter(count?: number): Excel.Range;

Параметры

count

number

Необязательный. Количество столбцов, включаемых в полученный диапазон. Чтобы создать диапазон за пределами текущего диапазона, используйте положительное число. Вы также можете использовать отрицательное число, чтобы создать диапазон в рамках текущего диапазона. Значение по умолчанию — 1.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.2 ]

getColumnsBefore(count)

Получает определенное количество столбцов слева от текущего Range объекта.

getColumnsBefore(count?: number): Excel.Range;

Параметры

count

number

Необязательный. Количество столбцов, включаемых в полученный диапазон. Чтобы создать диапазон за пределами текущего диапазона, используйте положительное число. Вы также можете использовать отрицательное число, чтобы создать диапазон в рамках текущего диапазона. Значение по умолчанию — 1.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.2 ]

getDependents()

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает объект, представляющего диапазон, содержащий все иждивенцы ячейки в одной и той же таблице или WorkbookRangeAreas в нескольких таблицах.

getDependents(): Excel.WorkbookRangeAreas;

Возвращаемое значение

Комментарии

[API set: ExcelApi BETA (PREVIEW ONLY) ]

getDirectDependents()

Возвращает объект, представляющего диапазон, содержащий все прямые иждивенцы ячейки в одной и той же таблице или в нескольких WorkbookRangeAreas таблицах.

getDirectDependents(): Excel.WorkbookRangeAreas;

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.13 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-direct-dependents.yaml
await Excel.run(async (context) => {
  // Direct dependents are cells that contain formulas that refer to other cells.
  let range = context.workbook.getActiveCell();
  let directDependents = range.getDirectDependents();
  range.load("address");
  directDependents.areas.load("address");
  await context.sync();
  
  console.log(`Direct dependent cells of ${range.address}:`);
  
  // Use the direct dependents API to loop through direct dependents of the active cell.
  for (let i = 0; i < directDependents.areas.items.length; i++) {
    // Highlight and print the address of each dependent cell.
    directDependents.areas.items[i].format.fill.color = "Yellow";
    console.log(`  ${directDependents.areas.items[i].address}`);
  }
  await context.sync();
});

getDirectPrecedents()

Возвращает объект, представляющего диапазон, содержащий все прямые прецеденты ячейки в одной и той же таблице или WorkbookRangeAreas в нескольких таблицах.

getDirectPrecedents(): Excel.WorkbookRangeAreas;

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.12 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/precedents.yaml
await Excel.run(async (context) => {
  // Precedents are cells referenced by the formula in a cell.
  // A "direct precedent" is a cell directly referenced by the selected formula.
  let range = context.workbook.getActiveCell();
  let directPrecedents = range.getDirectPrecedents();
  range.load("address");
  directPrecedents.areas.load("address");
  await context.sync();

  console.log(`Direct precedent cells of ${range.address}:`);

  // Use the direct precedents API to loop through precedents of the active cell.
  for (var i = 0; i < directPrecedents.areas.items.length; i++) {
    // Highlight and console the address of each precedent cell.
    directPrecedents.areas.items[i].format.fill.color = "Yellow";
    console.log(`  ${directPrecedents.areas.items[i].address}`);
  }
  await context.sync();
});

getEntireColumn()

Получает объект, который представляет весь столбец диапазона (например, если текущий диапазон представляет ячейки "B4:E11", он представляет столбцы getEntireColumn "B:E").

getEntireColumn(): Excel.Range;

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.1 ]

Примеры

// Note: the grid properties of the Range (values, numberFormat, formulas) 
// contains null since the Range in question is unbounded.
Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "D:F";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    var rangeEC = range.getEntireColumn();
    rangeEC.load('address');
    return ctx.sync().then(function() {
        console.log(rangeEC.address);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getEntireRow()

Получает объект, который представляет весь ряд диапазона (например, если текущий диапазон представляет ячейки "B4:E11", это диапазон, который представляет строки GetEntireRow "4:11").

getEntireRow(): Excel.Range;

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.1 ]

Примеры

// Gets an object that represents the entire row of the range 
// (for example, if the current range represents cells "B4:E11", 
// its GetEntireRow is a range that represents rows "4:11").
Excel.run(function (ctx) {
    var sheetName = "Sheet1";
    var rangeAddress = "D:F"; 
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    var rangeER = range.getEntireRow();
    rangeER.load('address');
    return ctx.sync().then(function() {
        console.log(rangeER.address);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getExtendedRange(direction, activeCell)

Возвращает объект диапазона, который включает текущий диапазон и до края диапазона, в зависимости от предоставленного направления. Это соответствует поведению ключа Ctrl+Shift+Arrow в Excel Windows пользовательского интерфейса.

getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;

Параметры

direction
Excel.KeyboardDirection

Направление от активной ячейки.

activeCell

Excel.Range | string

Активная ячейка в этом диапазоне. По умолчанию активная ячейка является верхней левой ячейкой диапазона. Ошибка выброшена, если активная ячейка не находится в этом диапазоне.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.13 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-get-range-edge.yaml
await Excel.run(async (context) => {
  // Get the selected range.
  const range = context.workbook.getSelectedRange();

  // Specify the direction with the `KeyboardDirection` enum.
  const direction = Excel.KeyboardDirection.down;

  // Get the active cell in the workbook.
  const activeCell = context.workbook.getActiveCell();

  // Get all the cells from the currently selected range to the bottom-most edge of the used range.
  // This method acts like the Ctrl+Shift+Arrow key keyboard shortcut while a range is selected.
  const extendedRange = range.getExtendedRange(
    direction,
    activeCell // If the selected range contains more than one cell, the active cell must be defined.
  );
  extendedRange.select();

  await context.sync();
});

getExtendedRange(directionString, activeCell)

Возвращает объект диапазона, который включает текущий диапазон и до края диапазона, в зависимости от предоставленного направления. Это соответствует поведению ключа Ctrl+Shift+Arrow в Excel Windows пользовательского интерфейса.

getExtendedRange(directionString: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range;

Параметры

directionString

"Left" | "Right" | "Up" | "Down"

Направление от активной ячейки.

activeCell

Excel.Range | string

Активная ячейка в этом диапазоне. По умолчанию активная ячейка является верхней левой ячейкой диапазона. Ошибка выброшена, если активная ячейка не находится в этом диапазоне.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.13 ]

getImage()

Отрисовка диапазона в качестве изображения png с кодом base64. Important*: Этот API в настоящее время неподтверчен в Excel для Mac. Для текущего состояния посетите OfficeDev/office-js Issue # 235.

getImage(): OfficeExtension.ClientResult<string>;

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.7 ]

getIntersection(anotherRange)

Возвращает объект диапазона, представляющий прямоугольное пересечение заданных диапазонов.

getIntersection(anotherRange: Range | string): Excel.Range;

Параметры

anotherRange

Excel.Range | string

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

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.1 ]

Примеры

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var range = 
        ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getIntersection("D4:G6");
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address); // prints Sheet1!D4:F6
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getIntersectionOrNullObject(anotherRange)

Возвращает объект диапазона, представляющий прямоугольное пересечение заданных диапазонов. Если пересечение не обнаружено, этот метод возвращает объект с его isNullObject свойством, заданной true. Дополнительные сведения см. в методе и свойствах *OrNullObject.

getIntersectionOrNullObject(anotherRange: Range | string): Excel.Range;

Параметры

anotherRange

Excel.Range | string

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

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.4 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-relationships.yaml
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // We want the most recent quarter that has data, so
    // exclude quarters without data and get the last of
    // the remaining columns.
    const usedDataRange = dataRange.getUsedRange(true /* valuesOnly */);
    const currentQuarterRange = usedDataRange.getLastColumn();

    // Asian and European teams have separate contests.
    const asianSalesRange = sheet.getRange("A2:E4");
    const europeanSalesRange = sheet.getRange("A5:E7");

    // The data for each chart is the intersection of the
    // current quarter column and the rows for the continent.
    const asianContestRange = asianSalesRange.getIntersectionOrNullObject(currentQuarterRange);
    const europeanContestRange = europeanSalesRange.getIntersectionOrNullObject(currentQuarterRange);

    // Must sync before you can test the output of *OrNullObject
    // method/property.
    await context.sync();

    if (asianContestRange.isNullObject) {
        // See the declaration of this method for how to
        // test this code path.
        reportMissingData("Asian");
    } else {
        createContinentChart(
            sheet,
            "Asian",
            asianContestRange,
            "A9",
            "F24"
        );
    }

    if (europeanContestRange.isNullObject) {
        // See the declaration of this method for how to
        // test this code path.
        reportMissingData("European");
    } else {
        createContinentChart(
            sheet,
            "European",
            europeanContestRange,
            "A25",
            "F40"
        );
    }

    await context.sync();
});

getLastCell()

Возвращает последнюю ячейку в диапазоне. Например, последняя ячейка диапазона B2:D5 — D5.

getLastCell(): Excel.Range;

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.1 ]

Примеры

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastCell();
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address); // prints Sheet1!F8
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getLastColumn()

Возвращает последний столбец в диапазоне. Например, последний столбец диапазона B2:D5 — D2:D5.

getLastColumn(): Excel.Range;

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.1 ]

Примеры

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastColumn();
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address); // prints Sheet1!F1:F8
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getLastRow()

Возвращает последнюю строку в диапазоне. Например, последняя строка в диапазоне "B2:D5" — "B5:D5".

getLastRow(): Excel.Range;

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.1 ]

Примеры

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastRow();
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address); // prints Sheet1!A8:F8
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getMergedAreasOrNullObject()

Возвращает RangeAreas объект, который представляет объединенные области в этом диапазоне. Обратите внимание, что если количество объединенных областей в этом диапазоне превышает 512, то этот метод не сможет вернуть результат. Если объекта не существует, эта функция возвращает объект с RangeAreas его isNullObject свойством true. Дополнительные сведения см. в методе и свойствах *OrNullObject.

getMergedAreasOrNullObject(): Excel.RangeAreas;

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.13 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-merged-ranges.yaml
await Excel.run(async (context) => {
  // Retrieve the worksheet and the table in that worksheet.
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const tableRange = sheet.getRange("B2:E6");

  // Retrieve the merged range within the table and load its details.
  const mergedAreas = tableRange.getMergedAreasOrNullObject();
  mergedAreas.load("address");
  mergedAreas.load("cellCount");

  // Select the merged range.
  const range = mergedAreas.areas.getItemAt(0);
  range.select();
  await context.sync();

  // Print out the details of the `mergedAreas` range object.
  console.log(`Address of the merged range: ${mergedAreas.address}`);
  console.log(`Number of cells in the merged range: ${mergedAreas.cellCount}`);

  await context.sync();
});

getOffsetRange(rowOffset, columnOffset)

Возвращает объект, представляющий диапазон, который смещен от указанного диапазона. Измерение возвращаемого диапазона будет соответствовать этому диапазону. Если результирующий диапазон выходит за пределы таблицы листа, возникнет ошибка.

getOffsetRange(rowOffset: number, columnOffset: number): Excel.Range;

Параметры

rowOffset

number

Количество строк (положительное, отрицательное или нулевое), на которое необходимо сместить диапазон. Положительные значения соответствуют смещению вниз, а отрицательные — вверх.

columnOffset

number

Количество столбцов (положительное, отрицательное или 0), на который нужно сместить диапазон. Положительные значения соответствуют смещению вправо, а отрицательные — влево.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.1 ]

Примеры

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "D4:F6";
    var range = 
        ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getOffsetRange(-1,4);
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address); // prints Sheet1!H3:J5
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getPivotTables(fullyContained)

Получает объемную коллекцию pivotTables, которые пересекаются с диапазоном.

getPivotTables(fullyContained?: boolean): Excel.PivotTableScopedCollection;

Параметры

fullyContained

boolean

Если trueвозвращает только pivotTables, которые полностью содержатся в пределах диапазона. Значение по умолчанию false.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.12 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml
await Excel.run(async (context) => {
  const activeRange = context.workbook.getSelectedRange();

  // Get all the PivotTables that intersect with this range.
  const partiallyContainedPivotTables = activeRange.getPivotTables();
  // Get all the PivotTables that are completely contained within this range.
  const fullyContainedPivotTables = activeRange.getPivotTables(true);

  partiallyContainedPivotTables.load("name");
  fullyContainedPivotTables.load("name");
  await context.sync();

  // Display the names in the console.
  console.log("PivotTables in the current range:")
  partiallyContainedPivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
  console.log("PivotTables completely contained in the current range:")
  fullyContainedPivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
});

getPrecedents()

Возвращает объект, представляющего диапазон, содержащий все прецеденты ячейки в одной и той же таблице или WorkbookRangeAreas в нескольких таблицах.

getPrecedents(): Excel.WorkbookRangeAreas;

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.14 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/precedents.yaml
await Excel.run(async (context) => {
  // Precedents are cells referenced by the formula in a cell.
  let range = context.workbook.getActiveCell();
  let precedents = range.getPrecedents();
  range.load("address");
  precedents.areas.load("address");
  await context.sync();

  console.log(`All precedent cells of ${range.address}:`);

  // Use the precedents API to loop through precedents of the active cell.
  for (var i = 0; i < precedents.areas.items.length; i++) {
    // Highlight and console the address of each precedent cell.
    precedents.areas.items[i].format.fill.color = "Orange";
    console.log(`  ${precedents.areas.items[i].address}`);
  }
  await context.sync();
});

getRangeEdge(direction, activeCell)

Возвращает объект диапазона, который является краеугольным элементом области данных, соответствующей предоставленной направлению. Это соответствует поведению ключа Ctrl+Arrow в Excel Windows пользовательского интерфейса.

getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;

Параметры

direction
Excel.KeyboardDirection

Направление от активной ячейки.

activeCell

Excel.Range | string

Активная ячейка в этом диапазоне. По умолчанию активная ячейка является верхней левой ячейкой диапазона. Ошибка выброшена, если активная ячейка не находится в этом диапазоне.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.13 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-get-range-edge.yaml
await Excel.run(async (context) => {
  // Get the selected range.
  const range = context.workbook.getSelectedRange();

  // Specify the direction with the `KeyboardDirection` enum.
  const direction = Excel.KeyboardDirection.up;

  // Get the active cell in the workbook.
  const activeCell = context.workbook.getActiveCell();

  // Get the top-most cell of the current used range.
  // This method acts like the Ctrl+Arrow key keyboard shortcut while a range is selected.
  const rangeEdge = range.getRangeEdge(
    direction,
    activeCell // If the selected range contains more than one cell, the active cell must be defined.
  );
  rangeEdge.select();

  await context.sync();
});

getRangeEdge(directionString, activeCell)

Возвращает объект диапазона, который является краеугольным элементом области данных, соответствующей предоставленной направлению. Это соответствует поведению ключа Ctrl+Arrow в Excel Windows пользовательского интерфейса.

getRangeEdge(directionString: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range;

Параметры

directionString

"Left" | "Right" | "Up" | "Down"

Направление от активной ячейки.

activeCell

Excel.Range | string

Активная ячейка в этом диапазоне. По умолчанию активная ячейка является верхней левой ячейкой диапазона. Ошибка выброшена, если активная ячейка не находится в этом диапазоне.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.13 ]

getResizedRange(deltaRows, deltaColumns)

Получает объект, похожий на текущий объект, но с его нижним правым углом, расширенным (или законтрактованым) рядом строк Range Range и столбцов.

getResizedRange(deltaRows: number, deltaColumns: number): Excel.Range;

Параметры

deltaRows

number

Количество строк, добавляемых в правый нижний угол, относительно текущего диапазона. Используйте положительное число, чтобы расширить диапазон или отрицательное число, чтобы уменьшить его.

deltaColumns

number

Количество столбцов, с помощью которых можно расширить нижний правый угол по отношению к текущему диапазону. Используйте положительное число, чтобы расширить диапазон или отрицательное число, чтобы уменьшить его.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.2 ]

getRow(row)

Возвращает строку из диапазона.

getRow(row: number): Excel.Range;

Параметры

row

number

Номер строки диапазона, который требуется извлечь. Используется нулевой индекс.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.1 ]

Примеры

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getRow(1);
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address); // prints Sheet1!A2:F2
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getRowProperties(rowPropertiesLoadOptions)

Возвращает одномерный массив, в который включены данные для шрифта, заливки, границ, выравнивания и других свойств каждой строки. Для свойств, которые не соответствуют каждой ячейке в данной строке, null будут возвращены.

getRowProperties(rowPropertiesLoadOptions: RowPropertiesLoadOptions): OfficeExtension.ClientResult<RowProperties[]>;

Параметры

rowPropertiesLoadOptions
Excel.RowPropertiesLoadOptions

Объект, который представляет свойства строки для загрузки.

Возвращаемое значение

Массив, в котором каждый элемент представляет запрашиваемую свойства соответствующей строки.

Комментарии

[Набор API: ExcelApi 1.9 ]

getRowsAbove(count)

Получает определенное количество строк выше текущего Range объекта.

getRowsAbove(count?: number): Excel.Range;

Параметры

count

number

Необязательный. Количество строк, включаемых в полученный диапазон. Чтобы создать диапазон за пределами текущего диапазона, используйте положительное число. Вы также можете использовать отрицательное число, чтобы создать диапазон в рамках текущего диапазона. Значение по умолчанию — 1.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.2 ]

getRowsBelow(count)

Получает определенное количество строк ниже текущего Range объекта.

getRowsBelow(count?: number): Excel.Range;

Параметры

count

number

Необязательный. Количество строк, включаемых в полученный диапазон. Чтобы создать диапазон за пределами текущего диапазона, используйте положительное число. Вы также можете использовать отрицательное число, чтобы создать диапазон в рамках текущего диапазона. Значение по умолчанию — 1.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.2 ]

getSpecialCells(cellType, cellValueType)

Получает объект, состоящий из одного или нескольких прямоугольных диапазонов, который представляет все ячейки, которые соответствуют указанному RangeAreas типу и значению. Если специальные ячейки не найдены, ItemNotFound будет выброшена ошибка.

getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Параметры

cellType
Excel.SpecialCellType

Тип ячеек, которые необходимо включить.

cellValueType
Excel.SpecialCellValueType

Если cellType либо, constants либо formulasЭтот аргумент используется для определения типов ячеек, которые необходимо включить в результат. Эти значения можно объединить, чтобы вернуть несколько типов. По умолчанию необходимо выбрать все константы или формулы независимо от типа.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.9 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml
await Excel.run(async (context) => {

    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const usedRange = sheet.getUsedRange();

    // Find the ranges with either text or logical (boolean) values.
    const formulaRanges = usedRange.getSpecialCells("Constants", "LogicalText");
    formulaRanges.format.fill.color = "orange";

    return context.sync();
});

getSpecialCells(cellTypeString, cellValueType)

Получает объект, состоящий из одного или нескольких прямоугольных диапазонов, который представляет все ячейки, которые соответствуют указанному RangeAreas типу и значению. Если специальные ячейки не найдены, ItemNotFound будет выброшена ошибка.

getSpecialCells(cellTypeString: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Параметры

cellTypeString

"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

Тип ячеек, которые необходимо включить.

cellValueType

"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

Если cellType либо, constants либо formulasЭтот аргумент используется для определения типов ячеек, которые необходимо включить в результат. Эти значения можно объединить, чтобы вернуть несколько типов. По умолчанию необходимо выбрать все константы или формулы независимо от типа.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellType, cellValueType)

Получает объект, состоящий из одного или нескольких диапазонов, который представляет все ячейки, которые соответствуют указанному RangeAreas типу и значению. Если специальных ячеек не обнаружено, этот метод возвращает объект с его isNullObject свойством true. Дополнительные сведения см. в методе и свойствах *OrNullObject.

getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Параметры

cellType
Excel.SpecialCellType

Тип ячеек, которые необходимо включить.

cellValueType
Excel.SpecialCellValueType

Если cellType либо, constants либо formulasЭтот аргумент используется для определения типов ячеек, которые необходимо включить в результат. Эти значения можно объединить, чтобы вернуть несколько типов. По умолчанию необходимо выбрать все константы или формулы независимо от типа.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellTypeString, cellValueType)

Получает объект, состоящий из одного или нескольких диапазонов, который представляет все ячейки, которые соответствуют указанному RangeAreas типу и значению. Если специальных ячеек не обнаружено, этот метод возвращает объект с его isNullObject свойством true. Дополнительные сведения см. в методе и свойствах *OrNullObject.

getSpecialCellsOrNullObject(cellTypeString: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Параметры

cellTypeString

"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

Тип ячеек, которые необходимо включить.

cellValueType

"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

Если cellType либо, constants либо formulasЭтот аргумент используется для определения типов ячеек, которые необходимо включить в результат. Эти значения можно объединить, чтобы вернуть несколько типов. По умолчанию необходимо выбрать все константы или формулы независимо от типа.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.9 ]

getSpillingToRange()

Получает объект range, содержащий диапазон переноса при вызове для базовой ячейки. Возвращает ошибку, если применяется к диапазону с несколькими ячейками.

getSpillingToRange(): Excel.Range;

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.12 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/dynamic-arrays.yaml
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sample");

  // Set G4 to a formula that returns a dynamic array.
  const targetCell = sheet.getRange("G4");
  targetCell.formulas = [["=A4:D4"]];

  // Get the address of the cells that the dynamic array spilled into.
  const spillRange = targetCell.getSpillingToRange();
  spillRange.load("address");

  // Fit the columns for readability.
  sheet.getUsedRange().format.autofitColumns();
  await context.sync();

  console.log(`Copying the table headers spilled into ${spillRange.address}.`);
});

getSpillingToRangeOrNullObject()

Получает объект range, содержащий диапазон переноса при вызове для базовой ячейки. Если диапазон не является якорной ячейкой или диапазон разлива не может быть найден, этот метод возвращает объект с его isNullObject свойством true. Дополнительные сведения см. в методе и свойствах *OrNullObject.

getSpillingToRangeOrNullObject(): Excel.Range;

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.12 ]

getSpillParent()

Получает объект диапазона, содержащий базовую ячейку для переносимой ячейки. Возвращает ошибку, если применяется к диапазону с несколькими ячейками.

getSpillParent(): Excel.Range;

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.12 ]

getSpillParentOrNullObject()

Получает объект диапазона, содержащий якорную ячейку для пролитой ячейки. Если это не пролитая ячейка или не дается несколько клеток, этот метод возвращает объект с его isNullObject свойством, заданным для true. Дополнительные сведения см. в методе и свойствах *OrNullObject.

getSpillParentOrNullObject(): Excel.Range;

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.12 ]

getSurroundingRegion()

Возвращает Range объект, который представляет окружающий регион для верхнего левого элемента в этом диапазоне. Это диапазон, ограниченный любым сочетанием пустых строк и столбцов, относящихся к этому диапазону.

getSurroundingRegion(): Excel.Range;

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.7 ]

getTables(fullyContained)

Получает коллекцию таблиц с заданной областью, перекрывающую диапазон.

getTables(fullyContained?: boolean): Excel.TableScopedCollection;

Параметры

fullyContained

boolean

Если trueвозвращает только таблицы, полностью содержащиеся в пределах диапазона. Значение по умолчанию false.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.9 ]

getUsedRange(valuesOnly)

Возвращает используемый диапазон заданного объекта диапазона. Если в диапазоне нет используемых ячеек, эта функция будет выбрасывать ItemNotFound ошибку.

getUsedRange(valuesOnly?: boolean): Excel.Range;

Параметры

valuesOnly

boolean

Учитывает только ячейки со значениями. [Набор API: ExcelApi 1.2]

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.1 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-relationships.yaml
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // We want the most recent quarter that has data, so
    // exclude quarters without data and get the last of
    // the remaining columns.
    const usedDataRange = dataRange.getUsedRange(true /* valuesOnly */);
    const currentQuarterRange = usedDataRange.getLastColumn();

    // Asian and European teams have separate contests.
    const asianSalesRange = sheet.getRange("A2:E4");
    const europeanSalesRange = sheet.getRange("A5:E7");

    // The data for each chart is the intersection of the
    // current quarter column and the rows for the continent.
    const asianContestRange = asianSalesRange.getIntersectionOrNullObject(currentQuarterRange);
    const europeanContestRange = europeanSalesRange.getIntersectionOrNullObject(currentQuarterRange);

    // Must sync before you can test the output of *OrNullObject
    // method/property.
    await context.sync();

    if (asianContestRange.isNullObject) {
        // See the declaration of this method for how to
        // test this code path.
        reportMissingData("Asian");
    } else {
        createContinentChart(
            sheet,
            "Asian",
            asianContestRange,
            "A9",
            "F24"
        );
    }

    if (europeanContestRange.isNullObject) {
        // See the declaration of this method for how to
        // test this code path.
        reportMissingData("European");
    } else {
        createContinentChart(
            sheet,
            "European",
            europeanContestRange,
            "A25",
            "F40"
        );
    }

    await context.sync();
});

getUsedRangeOrNullObject(valuesOnly)

Возвращает используемый диапазон заданного объекта диапазона. Если в диапазоне нет используемых ячеек, этот метод возвращает объект с его isNullObject свойством true. Дополнительные сведения см. в методе и свойствах *OrNullObject.

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

Параметры

valuesOnly

boolean

Учитывает только ячейки со значениями.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.4 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/used-range.yaml
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // Pass true so only cells with values count as used
    const usedDataRange = dataRange.getUsedRangeOrNullObject(
        true /* valuesOnly */
    );

    //Must sync before reading value returned from *OrNullObject method/property.
    await context.sync();

    if (usedDataRange.isNullObject) {
        console.log("Need Data to Make Chart");
        console.log("To create a meaningful chart, press 'Fill the table' (or add names to the Product column and numbers to some of the other cells). Then press 'Try to create chart' again.");
    } else {
        const chart = sheet.charts.add(
            Excel.ChartType.columnClustered,
            dataRange,
            "Columns"
        );
        chart.setPosition("A15", "F30");
        chart.title.text = "Quarterly sales chart";
        chart.legend.position = "Right";
        chart.legend.format.fill.setSolidColor("white");
        chart.dataLabels.format.font.size = 15;
        chart.dataLabels.format.font.color = "black";
    }

    await context.sync();
});

getVisibleView()

Представляет видимые строки текущего диапазона.

getVisibleView(): Excel.RangeView;

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.3 ]

group(groupOption)

Группы столбцов и строк для контура.

group(groupOption: Excel.GroupOption): void;

Параметры

groupOption
Excel.GroupOption

Указывает, как диапазон можно сгруппить по строкам или столбцам. Ошибка выброшена, если групповой параметр отличается от диапазона или свойства (например, является верным и является "ByColumns" или является true и является InvalidArgument isEntireRow isEntireColumn range.isEntireRow groupOption range.isEntireColumn groupOption "ByRows").

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.10 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/outline.yaml
Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    
    // Group the larger, main level. Note that the outline controls
    // will be on row 10, meaning 4-9 will collapse and expand.
    sheet.getRange("4:9").group(Excel.GroupOption.byRows);

    // Group the smaller, sublevels. Note that the outline controls
    // will be on rows 6 and 9, meaning 4-5 and 7-8 will collapse and expand.
    sheet.getRange("4:5").group(Excel.GroupOption.byRows);
    sheet.getRange("7:8").group(Excel.GroupOption.byRows);
    await context.sync();
});

group(groupOptionString)

Группы столбцов и строк для контура.

group(groupOptionString: "ByRows" | "ByColumns"): void;

Параметры

groupOptionString

"ByRows" | "ByColumns"

Указывает, как диапазон можно сгруппить по строкам или столбцам. Ошибка выброшена, если групповой параметр отличается от диапазона или свойства (например, является верным и является "ByColumns" или является true и является InvalidArgument isEntireRow isEntireColumn range.isEntireRow groupOption range.isEntireColumn groupOption "ByRows").

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.10 ]

hideGroupDetails(groupOption)

Скрывает сведения о группе строки или столбца.

hideGroupDetails(groupOption: Excel.GroupOption): void;

Параметры

groupOption
Excel.GroupOption

Указывает, следует ли скрывать сведения о сгруппных строках или сгруппивных столбцах.

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.10 ]

hideGroupDetails(groupOptionString)

Скрывает сведения о группе строки или столбца.

hideGroupDetails(groupOptionString: "ByRows" | "ByColumns"): void;

Параметры

groupOptionString

"ByRows" | "ByColumns"

Указывает, следует ли скрывать сведения о сгруппных строках или сгруппивных столбцах.

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.10 ]

insert(shift)

Вставляет ячейку или диапазон ячеек на лист вместо этого диапазона, а также сдвигает другие ячейки, чтобы освободить место. Возвращает новый объект Range в пустом пространстве.

insert(shift: Excel.InsertShiftDirection): Excel.Range;

Параметры

shift
Excel.InsertShiftDirection

Определяет способ сдвига ячеек. Подробные Excel.InsertShiftDirection сведения см. в материале.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.1 ]

Примеры

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "F5:F10";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.insert();
    return ctx.sync(); 
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

insert(shiftString)

Вставляет ячейку или диапазон ячеек на лист вместо этого диапазона, а также сдвигает другие ячейки, чтобы освободить место. Возвращает новый объект Range в пустом пространстве.

insert(shiftString: "Down" | "Right"): Excel.Range;

Параметры

shiftString

"Down" | "Right"

Определяет способ сдвига ячеек. Подробные Excel.InsertShiftDirection сведения см. в материале.

Возвращаемое значение

Комментарии

[Набор API: ExcelApi 1.1 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.RangeLoadOptions): Excel.Range;

Параметры

options
Excel.Interfaces.RangeLoadOptions

Предоставляет параметры, для которых необходимо загрузить свойства объекта.

Возвращаемое значение

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.Range;

Параметры

propertyNames

string | string[]

Запятая или массив строк, которые указывают свойства для загрузки.

Возвращаемое значение

Примеры

// Below example uses range address to get the range object.
Excel.run(function (ctx) {
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8"; 
    var worksheet = ctx.workbook.worksheets.getItem(sheetName);
    var range = worksheet.getRange(rangeAddress);
    range.load('cellCount');
    return ctx.sync().then(function() {
        console.log(range.cellCount);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Range;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select является запятой, которая указывает свойства для загрузки, и является строкой, запятой, которая указывает свойства навигации для propertyNamesAndPaths.expand загрузки.

Возвращаемое значение

merge(across)

Объединяет ячейки диапазона в одну область на листе.

merge(across?: boolean): void;

Параметры

across

boolean

Необязательно. Установите true для объединения ячеек в каждом ряду указанного диапазона в качестве отдельных объединенных ячеек. Значение по умолчанию false.

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.2 ]

Примеры

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:C3";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.merge(true);
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-merged-ranges.yaml
await Excel.run(async (context) => {
  // Retrieve the worksheet and the table in that worksheet.
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const tableRange = sheet.getRange("B2:E6");

  // Create a merged range in the first row of the table.
  const chartTitle = tableRange.getRow(0);
  chartTitle.merge(true);

  // Format the merged range.
  chartTitle.format.horizontalAlignment = "Center";

  await context.sync();
});

moveTo(destinationRange)

Перемещает значения ячейки, форматирование и формулы из текущего диапазона в диапазон назначения, заменяя старые сведения в этих ячейках. Диапазон назначения будет автоматически расширяться, если он меньше текущего диапазона. Все ячейки в диапазоне назначения, которые находятся за пределами области исходного диапазона, не меняются.

moveTo(destinationRange: Range | string): void;

Параметры

destinationRange

Excel.Range | string

destinationRange указывает диапазон, куда будут перемещены сведения в этом диапазоне.

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.11 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-copyfrom.yaml
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    // Place a label in front of the moved data.
    sheet.getRange("F12").values = [["Moved Range:"]];

    // Move the range from A1:E1 to G12:K12.
    sheet.getRange("A1:E1").moveTo("G12");
    await context.sync();
});

removeDuplicates(columns, includesHeader)

Удаляет повторяющиеся значения из диапазона, заданного столбцами.

removeDuplicates(columns: number[], includesHeader: boolean): Excel.RemoveDuplicatesResult;

Параметры

columns

number[]

Столбцы внутри диапазона, которые могут содержать дубликаты. Необходимо у указывается по крайней мере один столбец. Используется нулевой индекс.

includesHeader

boolean

True, если данные ввода содержат заглавную. Значение по умолчанию: false.

Возвращаемое значение

В результате объект содержит количество удаленных строк и количество оставшихся уникальных строк.

Комментарии

[Набор API: ExcelApi 1.9 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-remove-duplicates.yaml
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B2:D11");

    const deleteResult = range.removeDuplicates([0],true);    
    deleteResult.load();    
    await context.sync();

    console.log(deleteResult.removed + " entries with duplicate names removed.");
    console.log(deleteResult.uniqueRemaining + " entries with unique names remain in the range.");
});

replaceAll(text, replacement, criteria)

Находит и заменяет определенную строку на основе условий, указанных в текущем диапазоне.

replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;

Параметры

text

string

Строка, чтобы найти.

replacement

string

Строка, которая заменяет исходную строку.

criteria
Excel.ReplaceCriteria

Дополнительные критерии замены.

Возвращаемое значение

Количество выполняемой замены.

Комментарии

[Набор API: ExcelApi 1.9 ]

select()

Выбирает указанный диапазон в пользовательском интерфейсе Excel.

select(): void;

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.1 ]

Примеры

Excel.run(function (ctx) {
    var sheetName = "Sheet1";
    var rangeAddress = "F5:F10"; 
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.select();
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать либо обычный объект с соответствующими свойствами, либо другой объект API того же типа.

set(properties: Interfaces.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties
Excel.Interfaces.RangeUpdateData

Объект JavaScript со свойствами, структурированными изоморфно, с свойствами объекта, на который вызван метод.

options
OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается установить любые свойства только для чтения.

Возвращаемое значение

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/multiple-property-set.yaml
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    const range = sheet.getRange("B2:E2");
    range.set({
        format: {
            fill: {
                color: "#4472C4"
            },
            font: {
                name: "Verdana",
                color: "white"
            }
        }
    })
    range.format.autofitColumns();
    await context.sync();
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/multiple-property-set.yaml
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    const sourceRange = sheet.getRange("B2:E2");
    sourceRange.load("format/fill/color, format/font/name, format/font/color");
    await context.sync();

    // Set properties based on the loaded and synced 
    // source range.
    const targetRange = sheet.getRange("B7:E7");
    targetRange.set(sourceRange); 
    targetRange.format.autofitColumns();
    await context.sync();
});

set(properties)

Задает несколько свойств на объекте одновременно на основе существующего загруженного объекта.

set(properties: Excel.Range): void;

Параметры

properties
Excel.Range

Возвращаемое значение

void

setCellProperties(cellPropertiesData)

Обновляет диапазон на основе 2D-массива свойств ячейки, инкапсулируя такие вещи, как шрифт, заливка, границы и выравнивание.

setCellProperties(cellPropertiesData: SettableCellProperties[][]): void;

Параметры

cellPropertiesData

Excel.SettableCellProperties[][]

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

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.9 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // Creating the SettableCellProperties objects to use for the range.
    // In your add-in, these should be created once, outside the function.
    const topHeaderProps: Excel.SettableCellProperties = {
        // The style property takes a string matching the name of an Excel style.
        // Built-in style names are listed in the `BuiltInStyle` enum.
        // Note that a style will overwrite any formatting,
        // so do not use the format property with the style property.
        style: "Heading1"
    };

    const headerProps: Excel.SettableCellProperties = {
        // Any subproperties of format that are not set will not be changed when these cell properties are set.
        format: {
            fill: {
                color: "Blue"
            },
            font: {
                color: "White",
                bold: true
            }
        }
    };

    const nonApplicableProps: Excel.SettableCellProperties = {
        format: {
            fill: {
                pattern: Excel.FillPattern.gray25
            },
            font: {
                color: "Gray",
                italic: true
            }
        }
    };

    const matchupScoreProps: Excel.SettableCellProperties = {
        format: {
            borders: {
                bottom: {
                    style: Excel.BorderLineStyle.continuous
                },
                left: {
                    style: Excel.BorderLineStyle.continuous
                },
                right: {
                    style: Excel.BorderLineStyle.continuous
                },
                top: {
                    style: Excel.BorderLineStyle.continuous
                }
            }
        }
    };

    const range = sheet.getRange("A1:E5");

    // You can use empty JSON objects to avoid changing a cell's properties.
    range.setCellProperties([
        [topHeaderProps, {}, {}, {}, {}],
        [{}, {}, headerProps, headerProps, headerProps],
        [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps],
        [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps],
        [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps]
    ]);

    sheet.getUsedRange().format.autofitColumns();
    await context.sync();
});

setColumnProperties(columnPropertiesData)

Обновляет диапазон на основе одномерного массива свойств столбцов, инкапсулируя такие вещи, как шрифт, заливка, границы и выравнивание.

setColumnProperties(columnPropertiesData: SettableColumnProperties[]): void;

Параметры

columnPropertiesData

Excel.SettableColumnProperties[]

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

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.9 ]

setDirty()

Устанавливает диапазон, предназначенный для пересчета при выполнении следующего пересчета.

setDirty(): void;

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.9 ]

setRowProperties(rowPropertiesData)

Обновляет диапазон на основе одномерного массива свойств строки, инкапсулируя такие вещи, как шрифт, заливка, границы и выравнивание.

setRowProperties(rowPropertiesData: SettableRowProperties[]): void;

Параметры

rowPropertiesData

Excel.SettableRowProperties[]

Массив, который представляет свойства, которые необходимо установить в каждой строке.

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.9 ]

showCard()

Отображает карточку для активной ячейки, если она имеет содержимое c форматированным значением.

showCard(): void;

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.7 ]

showGroupDetails(groupOption)

Отображает сведения о группе строки или столбца.

showGroupDetails(groupOption: Excel.GroupOption): void;

Параметры

groupOption
Excel.GroupOption

Указывает, следует ли показывать сведения о сгруппных строках или сгруппивных столбцах.

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.10 ]

showGroupDetails(groupOptionString)

Отображает сведения о группе строки или столбца.

showGroupDetails(groupOptionString: "ByRows" | "ByColumns"): void;

Параметры

groupOptionString

"ByRows" | "ByColumns"

Указывает, следует ли показывать сведения о сгруппных строках или сгруппивных столбцах.

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.10 ]

toJSON()

Переопределяет метод JavaScript, чтобы обеспечить более полезный выход, когда объект toJSON() API передается JSON.stringify(). (JSON.stringify, в свою очередь, вызывает метод объекта, который toJSON передается ему.) В то время как исходный Excel. Объект Range — это объект API, метод возвращает простой toJSON объект JavaScript (введите какExcel.Interfaces.RangeData), содержащий неглубокие копии любых загруженных свойств ребенка из исходного объекта.

toJSON(): Excel.Interfaces.RangeData;

Возвращаемое значение

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является кратким для context.trackedObjects.add(thisObject). Если вы используете этот объект во время вызовов и вне последовательного выполнения пакета ".run" и получаете ошибку "InvalidObjectPath" при настройке свойства или вызове метода на объекте, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании .sync объекта.

track(): Excel.Range;

Возвращаемое значение

ungroup(groupOption)

Разгруппировка столбцов и строк для контура.

ungroup(groupOption: Excel.GroupOption): void;

Параметры

groupOption
Excel.GroupOption

Указывает, как диапазон можно разгруппировать по строкам или столбцам.

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.10 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/outline.yaml
Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    
    // This removes two levels of groups from the "A1-R10" range.
    // Any groups at the same level on the same dimension will be removed by a single call.
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byRows);
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byRows);
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byColumns);
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byColumns);
    await context.sync();
});

ungroup(groupOptionString)

Разгруппировка столбцов и строк для контура.

ungroup(groupOptionString: "ByRows" | "ByColumns"): void;

Параметры

groupOptionString

"ByRows" | "ByColumns"

Указывает, как диапазон можно разгруппировать по строкам или столбцам.

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.10 ]

unmerge()

Разъединяет ячейки диапазона на отдельные ячейки.

unmerge(): void;

Возвращаемое значение

void

Комментарии

[Набор API: ExcelApi 1.2 ]

Примеры

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:C3";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.unmerge();
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является коротким для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам потребуется позвонить до context.sync() того, как вступает в силу выпуск памяти.

untrack(): Excel.Range;

Возвращаемое значение

Примеры

Excel.run(async (context) => {
    const largeRange = context.workbook.getSelectedRange();
    largeRange.load(["rowCount", "columnCount"]);
    await context.sync();

    for (let i = 0; i < largeRange.rowCount; i++) {
        for (let j = 0; j < largeRange.columnCount; j++) {
            let cell = largeRange.getCell(i, j);
            cell.values = [[i *j]];

            // call untrack() to release the range from memory
            cell.untrack();
        }
    }

    await context.sync();
});