ExcelScript.Range interface

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

Методы

addConditionalFormat(type)

Добавляет новое условное форматирование в коллекцию по первому или верхнему приоритету.

autoFill(destinationRange, autoFillType)

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

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

calculate()

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

clear(applyTo)

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

clearAllConditionalFormats()

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

convertDataTypeToText()

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

copyFrom(sourceRange, copyType, skipBlanks, transpose)

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

delete(shift)

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

find(text, criteria)

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

flashFill()

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

getAbsoluteResizedRange(numRows, numColumns)

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

getAddress()

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

getAddressLocal()

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

getBoundingRect(anotherRange)

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

getCell(row, column)

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

getCellCount()

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

getColumn(column)

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

getColumnCount()

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

getColumnHidden()

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

getColumnIndex()

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

getColumnsAfter(count)

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

getColumnsBefore(count)

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

getConditionalFormat(id)

Возвращает условное форматирование для указанного идентификатора.

getConditionalFormats()

Коллекция объектов Кондитионалформатс, пересекающих диапазон.

getDataValidation()

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

getEntireColumn()

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

getEntireRow()

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

getFormat()

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

getFormula()

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

getFormulaLocal()

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

getFormulaR1C1()

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

getFormulas()

Представляет формулу в формате A1.

getFormulasLocal()

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

getFormulasR1C1()

Представляет формулу в формате R1C1.

getHeight()

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

getHidden()

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

getHyperlink()

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

getImage()

Отрисовывает диапазон в виде PNG-изображения в кодировке Base64.

getIntersection(anotherRange)

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

getIsEntireColumn()

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

getIsEntireRow()

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

getLastCell()

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

getLastColumn()

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

getLastRow()

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

getLeft()

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

getLinkedDataTypeState()

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

getLinkedDataTypeStates()

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

getNumberFormat()

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

getNumberFormatLocal()

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

getNumberFormats()

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

getNumberFormatsLocal()

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

getOffsetRange(rowOffset, columnOffset)

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

getPivotTables(fullyContained)

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

getPredefinedCellStyle()

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

getResizedRange(deltaRows, deltaColumns)

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

getRow(row)

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

getRowCount()

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

getRowHidden()

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

getRowIndex()

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

getRowsAbove(count)

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

getRowsBelow(count)

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

getSort()

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

getSpecialCells(cellType, cellValueType)

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

getSurroundingRegion()

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

getTables(fullyContained)

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

getText()

Представляет текстовое значение указанного диапазона. Текстовое значение не зависит от ширины ячейки. #Подстановка знаков, которая происходит в пользовательском интерфейсе Excel, не влияет на текстовое значение, возвращенное API. Если диапазон содержит несколько ячеек, будут возвращены данные из первой ячейки (представленные с помощью индекса строки 0 и индекса столбца 0).

getTexts()

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

getTop()

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

getUsedRange(valuesOnly)

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

getValue()

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

getValues()

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

getValueType()

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

getValueTypes()

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

getVisibleView()

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

getWidth()

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

getWorksheet()

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

group(groupOption)

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

hideGroupDetails(groupOption)

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

insert(shift)

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

merge(across)

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

moveTo(destinationRange)

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

removeDuplicates(columns, includesHeader)

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

replaceAll(text, replacement, criteria)

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

select()

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

setColumnHidden(columnHidden)

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

setDirty()

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

setFormula(formula)

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

setFormulaLocal(formulaLocal)

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

setFormulaR1C1(formulaR1C1)

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

setFormulas(formulas)

Представляет формулу в формате A1.

setFormulasLocal(formulasLocal)

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

setFormulasR1C1(formulasR1C1)

Представляет формулу в формате R1C1.

setHyperlink(hyperlink)

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

setNumberFormat(numberFormat)

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

setNumberFormatLocal(numberFormatLocal)

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

setNumberFormats(numberFormats)

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

setNumberFormatsLocal(numberFormatsLocal)

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

setPredefinedCellStyle(predefinedCellStyle)

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

setRowHidden(rowHidden)

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

setValue(value)

Задает необработанное значение указанного диапазона. Заданные значения могут иметь тип String, number или Boolean. null значение будет игнорироваться (не задано или перезаписано в Excel). Если диапазон содержит несколько ячеек, каждая ячейка в заданном диапазоне будет обновлена входными данными.

setValues(values)

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

showCard()

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

showGroupDetails(groupOption)

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

ungroup(groupOption)

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

unmerge()

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

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

addConditionalFormat(type)

Добавляет новое условное форматирование в коллекцию по первому или верхнему приоритету.

addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;

Параметры

type
ConditionalFormatType

Тип добавляемого условного форматирования. Дополнительные сведения см. в статье Excel. Кондитионалформаттипе.

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

Примеры

/**
 * This sample applies conditional formatting to the currently used range in the worksheet. 
 * The conditional formatting is a green fill for the top 10% of values.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the used range in the worksheet.
  let range = selectedSheet.getUsedRange();

  // Set the fill color to green for the top 10% of values in the range.
  let conditionalFormat = range.addConditionalFormat(ExcelScript.ConditionalFormatType.topBottom)
  conditionalFormat.getTopBottom().getFormat().getFill().setColor("green");
  conditionalFormat.getTopBottom().setRule({
    rank: 10, // The percentage threshold.
    type: ExcelScript.ConditionalTopBottomCriterionType.topPercent // The type of the top/bottom condition.
  });
}

autoFill(destinationRange, autoFillType)

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

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

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

Параметры

destinationRange
Range | string

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

autoFillType
AutoFillType

Тип автозаполнения. Задает способ заполнения конечного диапазона на основе содержимого текущего диапазона. Значение по умолчанию — "Филлдефаулт".

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

void

calculate()

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

calculate(): void;

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

void

clear(applyTo)

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

clear(applyTo?: ClearApplyTo): void;

Параметры

applyTo
ClearApplyTo

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

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

void

Примеры

/**
 * This script removes all the formatting from the selected range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected range.
  let range = workbook.getSelectedRange();

  // Clear all the formatting in that range.
  range.clear(ExcelScript.ClearApplyTo.formats);
}

clearAllConditionalFormats()

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

clearAllConditionalFormats(): void;

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

void

convertDataTypeToText()

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

convertDataTypeToText(): void;

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

void

copyFrom(sourceRange, copyType, skipBlanks, transpose)

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

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

Параметры

sourceRange
Range | RangeAreas | string

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

copyType
RangeCopyType

Тип данных или форматирования ячеек, которые необходимо скопировать. Значение по умолчанию — "ALL".

skipBlanks
boolean

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

transpose
boolean

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

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

void

delete(shift)

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

delete(shift: DeleteShiftDirection): void;

Параметры

shift
DeleteShiftDirection

Определяет способ сдвига ячеек. Дополнительные сведения см. в статье Excel. Делетешифтдиректион.

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

void

find(text, criteria)

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

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

Параметры

text
string

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

criteria
SearchCriteria

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

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

flashFill()

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

flashFill(): void;

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

void

getAbsoluteResizedRange(numRows, numColumns)

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

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

Параметры

numRows
number

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

numColumns
number

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

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

getAddress()

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

getAddress(): string;

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

string

getAddressLocal()

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

getAddressLocal(): string;

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

string

getBoundingRect(anotherRange)

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

getBoundingRect(anotherRange: Range | string): Range;

Параметры

anotherRange
Range | string

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

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

getCell(row, column)

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

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

Параметры

row
number

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

column
number

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

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

getCellCount()

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

getCellCount(): number;

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

number

getColumn(column)

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

getColumn(column: number): Range;

Параметры

column
number

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

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

getColumnCount()

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

getColumnCount(): number;

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

number

Примеры

/**
 * This sample provides the count of negative numbers that are present
 * in the used range of the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the working range.
  let usedRange = workbook.getActiveWorksheet().getUsedRange();
  let rowCount = usedRange.getRowCount();
  let columnCount = usedRange.getColumnCount();

  // Save the values locally to avoid repeatedly asking the workbook.
  let usedRangeValues = usedRange.getValues();

  // Start the negative number counter.
  let negativeCount = 0;

  // Iterate over the entire range looking for negative numbers.
  for (let i = 0; i < rowCount; i++) {
    for (let j = 0; j < columnCount; j++) {
      if (usedRangeValues[i][j] < 0) {
        negativeCount++;
      }
    }
  }

  // Log the negative number count to the console.
  console.log(negativeCount);
}

getColumnHidden()

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

getColumnHidden(): boolean;

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

boolean

getColumnIndex()

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

getColumnIndex(): number;

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

number

getColumnsAfter(count)

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

getColumnsAfter(count?: number): Range;

Параметры

count
number

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

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

getColumnsBefore(count)

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

getColumnsBefore(count?: number): Range;

Параметры

count
number

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

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

getConditionalFormat(id)

Возвращает условное форматирование для указанного идентификатора.

getConditionalFormat(id: string): ConditionalFormat;

Параметры

id
string

Идентификатор условного форматирования.

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

getConditionalFormats()

Коллекция объектов Кондитионалформатс, пересекающих диапазон.

getConditionalFormats(): ConditionalFormat[];

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

getDataValidation()

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

getDataValidation(): DataValidation;

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

getEntireColumn()

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

getEntireColumn(): Range;

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

getEntireRow()

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

getEntireRow(): Range;

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

getFormat()

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

getFormat(): RangeFormat;

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

getFormula()

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

getFormula(): string;

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

string

Примеры

/*
 * This script sets a cell's formula, 
 * then displays how Excel stores the cell's formula and value separately.
 */
function main(workbook: ExcelScript.Workbook) {
  let selectedSheet = workbook.getActiveWorksheet();

  // Set A1 to 2.
  let a1 = selectedSheet.getRange("A1");
  a1.setValue(2);

  // Set B1 to the formula =(2*A1), which should equal 4.
  let b1 = selectedSheet.getRange("B1")
  b1.setFormula("=(2*A1)");

  // Log the current results for `getFormula` and `getValue` at B1.
  console.log(`B1 - Formula: ${b1.getFormula()} | Value: ${b1.getValue()}`);
}

getFormulaLocal()

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

getFormulaLocal(): string;

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

string

getFormulaR1C1()

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

getFormulaR1C1(): string;

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

string

getFormulas()

Представляет формулу в формате A1.

getFormulas(): string[][];

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

string[][]

getFormulasLocal()

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

getFormulasLocal(): string[][];

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

string[][]

getFormulasR1C1()

Представляет формулу в формате R1C1.

getFormulasR1C1(): string[][];

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

string[][]

getHeight()

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

getHeight(): number;

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

number

getHidden()

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

getHidden(): boolean;

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

boolean

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

getHyperlink(): RangeHyperlink;

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

getImage()

Отрисовывает диапазон в виде PNG-изображения в кодировке Base64.

getImage(): string;

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

string

getIntersection(anotherRange)

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

getIntersection(anotherRange: Range | string): Range;

Параметры

anotherRange
Range | string

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

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

getIsEntireColumn()

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

getIsEntireColumn(): boolean;

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

boolean

getIsEntireRow()

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

getIsEntireRow(): boolean;

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

boolean

getLastCell()

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

getLastCell(): Range;

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

getLastColumn()

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

getLastColumn(): Range;

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

getLastRow()

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

getLastRow(): Range;

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

getLeft()

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

getLeft(): number;

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

number

getLinkedDataTypeState()

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

getLinkedDataTypeState(): LinkedDataTypeState;

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

getLinkedDataTypeStates()

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

getLinkedDataTypeStates(): LinkedDataTypeState[][];

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

getNumberFormat()

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

getNumberFormat(): string;

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

string

getNumberFormatLocal()

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

getNumberFormatLocal(): string;

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

string

getNumberFormats()

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

getNumberFormats(): string[][];

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

string[][]

getNumberFormatsLocal()

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

getNumberFormatsLocal(): string[][];

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

string[][]

getOffsetRange(rowOffset, columnOffset)

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

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

Параметры

rowOffset
number

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

columnOffset
number

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

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

Примеры

/**
 * This script gets adjacent cells using relative references.
 * Note that if the active cell is on the top row, part of the script fails, 
 * because it references the cell above the currently selected one.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the currently active cell in the workbook.
  let activeCell = workbook.getActiveCell();
  console.log(`The active cell's address is: ${activeCell.getAddress()}`);

  // Get the cell to the right of the active cell and set its value and color.
  let rightCell = activeCell.getOffsetRange(0,1);
  rightCell.setValue("Right cell");
  console.log(`The right cell's address is: ${rightCell.getAddress()}`);
  rightCell.getFormat().getFont().setColor("Magenta");
  rightCell.getFormat().getFill().setColor("Cyan");

  // Get the cell to the above of the active cell and set its value and color.
  // Note that this operation will fail if the active cell is in the top row.
  let aboveCell = activeCell.getOffsetRange(-1, 0);
  aboveCell.setValue("Above cell");
  console.log(`The above cell's address is: ${aboveCell.getAddress()}`);
  aboveCell.getFormat().getFont().setColor("White");
  aboveCell.getFormat().getFill().setColor("Black");
}

getPivotTables(fullyContained)

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

getPivotTables(fullyContained?: boolean): PivotTable[];

Параметры

fullyContained
boolean

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

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

getPredefinedCellStyle()

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

getPredefinedCellStyle(): string;

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

string

getResizedRange(deltaRows, deltaColumns)

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

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

Параметры

deltaRows
number

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

deltaColumns
number

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

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

Примеры

/**
 * This script copies the formatting in the active cell to the neighboring cells.
 * Note that this script only works when the active cell isn't on an edge of the worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active cell.
  let activeCell = workbook.getActiveCell();

  // Get the cell that's one row above and one column to the left of the active cell.
  let cornerCell = activeCell.getOffsetRange(-1,-1);

  // Get a range that includes all the cells surrounding the active cell.
  let surroundingRange = cornerCell.getResizedRange(2, 2)

  // Copy the formatting from the active cell to the new range.
  surroundingRange.copyFrom(
    activeCell, /* The source range. */
    ExcelScript.RangeCopyType.formats /* What to copy. */
    );
}

getRow(row)

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

getRow(row: number): Range;

Параметры

row
number

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

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

getRowCount()

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

getRowCount(): number;

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

number

Примеры

/**
 * This sample provides the count of negative numbers that are present
 * in the used range of the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the working range.
  let usedRange = workbook.getActiveWorksheet().getUsedRange();
  let rowCount = usedRange.getRowCount();
  let columnCount = usedRange.getColumnCount();

  // Save the values locally to avoid repeatedly asking the workbook.
  let usedRangeValues = usedRange.getValues();

  // Start the negative number counter.
  let negativeCount = 0;

  // Iterate over the entire range looking for negative numbers.
  for (let i = 0; i < rowCount; i++) {
    for (let j = 0; j < columnCount; j++) {
      if (usedRangeValues[i][j] < 0) {
        negativeCount++;
      }
    }
  }

  // Log the negative number count to the console.
  console.log(negativeCount);
}

getRowHidden()

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

getRowHidden(): boolean;

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

boolean

getRowIndex()

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

getRowIndex(): number;

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

number

getRowsAbove(count)

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

getRowsAbove(count?: number): Range;

Параметры

count
number

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

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

getRowsBelow(count)

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

getRowsBelow(count?: number): Range;

Параметры

count
number

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

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

getSort()

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

getSort(): RangeSort;

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

getSpecialCells(cellType, cellValueType)

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

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

Параметры

cellType
SpecialCellType

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

cellValueType
SpecialCellValueType

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

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

getSurroundingRegion()

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

getSurroundingRegion(): Range;

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

getTables(fullyContained)

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

getTables(fullyContained?: boolean): Table[];

Параметры

fullyContained
boolean

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

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

Table[]

getText()

Представляет текстовое значение указанного диапазона. Текстовое значение не зависит от ширины ячейки. #Подстановка знаков, которая происходит в пользовательском интерфейсе Excel, не влияет на текстовое значение, возвращенное API. Если диапазон содержит несколько ячеек, будут возвращены данные из первой ячейки (представленные с помощью индекса строки 0 и индекса столбца 0).

getText(): string;

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

string

getTexts()

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

getTexts(): string[][];

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

string[][]

getTop()

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

getTop(): number;

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

number

getUsedRange(valuesOnly)

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

getUsedRange(valuesOnly?: boolean): Range;

Параметры

valuesOnly
boolean

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

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

getValue()

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

getValue(): any;

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

any

Примеры

/**
 * This sample reads the value of A1 and prints it to the console.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the value of cell A1.
  let range = selectedSheet.getRange("A1");
  
  // Print the value of A1.
  console.log(range.getValue());
}

getValues()

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

getValues(): any[][];

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

any[][]

getValueType()

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

getValueType(): RangeValueType;

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

getValueTypes()

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

getValueTypes(): RangeValueType[][];

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

getVisibleView()

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

getVisibleView(): RangeView;

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

getWidth()

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

getWidth(): number;

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

number

getWorksheet()

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

getWorksheet(): Worksheet;

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

group(groupOption)

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

group(groupOption: GroupOption): void;

Параметры

groupOption
GroupOption

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

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

void

hideGroupDetails(groupOption)

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

hideGroupDetails(groupOption: GroupOption): void;

Параметры

groupOption
GroupOption

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

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

void

insert(shift)

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

insert(shift: InsertShiftDirection): Range;

Параметры

shift
InsertShiftDirection

Определяет способ сдвига ячеек. Дополнительные сведения см. в статье Excel. Инсертшифтдиректион.

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

merge(across)

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

merge(across?: boolean): void;

Параметры

across
boolean

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

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

void

moveTo(destinationRange)

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

moveTo(destinationRange: Range | string): void;

Параметры

destinationRange
Range | string

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

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

void

removeDuplicates(columns, includesHeader)

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

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

Параметры

columns
number[]

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

includesHeader
boolean

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

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

replaceAll(text, replacement, criteria)

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

replaceAll(
            text: string,
            replacement: string,
            criteria: ReplaceCriteria
        ): number;

Параметры

text
string

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

replacement
string

Строка для замены оригинала на.

criteria
ReplaceCriteria

Дополнительные условия замены.

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

number

select()

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

select(): void;

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

void

setColumnHidden(columnHidden)

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

setColumnHidden(columnHidden: boolean): void;

Параметры

columnHidden
boolean

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

void

setDirty()

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

setDirty(): void;

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

void

setFormula(formula)

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

setFormula(formula: string): void;

Параметры

formula
string

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

void

Примеры

/*
 * This script sets a cell's formula, 
 * then displays how Excel stores the cell's formula and value separately.
 */
function main(workbook: ExcelScript.Workbook) {
  let selectedSheet = workbook.getActiveWorksheet();

  // Set A1 to 2.
  let a1 = selectedSheet.getRange("A1");
  a1.setValue(2);

  // Set B1 to the formula =(2*A1), which should equal 4.
  let b1 = selectedSheet.getRange("B1")
  b1.setFormula("=(2*A1)");

  // Log the current results for `getFormula` and `getValue` at B1.
  console.log(`B1 - Formula: ${b1.getFormula()} | Value: ${b1.getValue()}`);
}

setFormulaLocal(formulaLocal)

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

setFormulaLocal(formulaLocal: string): void;

Параметры

formulaLocal
string

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

void

setFormulaR1C1(formulaR1C1)

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

setFormulaR1C1(formulaR1C1: string): void;

Параметры

formulaR1C1
string

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

void

setFormulas(formulas)

Представляет формулу в формате A1.

setFormulas(formulas: string[][]): void;

Параметры

formulas
string[][]

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

void

setFormulasLocal(formulasLocal)

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

setFormulasLocal(formulasLocal: string[][]): void;

Параметры

formulasLocal
string[][]

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

void

setFormulasR1C1(formulasR1C1)

Представляет формулу в формате R1C1.

setFormulasR1C1(formulasR1C1: string[][]): void;

Параметры

formulasR1C1
string[][]

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

void

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

setHyperlink(hyperlink: RangeHyperlink): void;

Параметры

hyperlink
RangeHyperlink

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

void

Примеры

/** 
 * This script inserts a hyperlink to the first cell of the last worksheet in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active cell.
  let cell = workbook.getActiveCell();

  // Get the last worksheet in the workbook.
  // Note that this might be the current sheet if there's only one worksheet.
  let lastSheet = workbook.getLastWorksheet();

  // Get sheet name. 
  let linkedSheetName = lastSheet.getName();
  console.log(`Setting hyperlink of ${cell.getAddress()} to the ${linkedSheetName} sheet's A1 cell`);

  // Set the text for the hyperlink.
  let value = `Click to go to: ${linkedSheetName}`;

  // Create the hyperlink using that cell's value.
  cell.setHyperlink({
    textToDisplay: value.toString(),
    screenTip: `Navigate to ${linkedSheetName}`,
    documentReference: `${linkedSheetName}!A1`
  });
}

setNumberFormat(numberFormat)

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

setNumberFormat(numberFormat: string): void;

Параметры

numberFormat
string

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

void

setNumberFormatLocal(numberFormatLocal)

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

setNumberFormatLocal(numberFormatLocal: string): void;

Параметры

numberFormatLocal
string

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

void

setNumberFormats(numberFormats)

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

setNumberFormats(numberFormats: string[][]): void;

Параметры

numberFormats
string[][]

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

void

setNumberFormatsLocal(numberFormatsLocal)

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

setNumberFormatsLocal(numberFormatsLocal: string[][]): void;

Параметры

numberFormatsLocal
string[][]

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

void

setPredefinedCellStyle(predefinedCellStyle)

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

setPredefinedCellStyle(predefinedCellStyle: string): void;

Параметры

predefinedCellStyle
string

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

void

setRowHidden(rowHidden)

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

setRowHidden(rowHidden: boolean): void;

Параметры

rowHidden
boolean

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

void

setValue(value)

Задает необработанное значение указанного диапазона. Заданные значения могут иметь тип String, number или Boolean. null значение будет игнорироваться (не задано или перезаписано в Excel). Если диапазон содержит несколько ячеек, каждая ячейка в заданном диапазоне будет обновлена входными данными.

setValue(value: any): void;

Параметры

value
any

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

void

setValues(values)

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

setValues(values: any[][]): void;

Параметры

values
any[][]

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

void

Примеры

/**
 * This sample inserts some pre-loaded data into a range.
 * It also shows how to get a range that fits the data.
 */
 function main(workbook: ExcelScript.Workbook) {
   // Get the active cell.
   let currentCell = workbook.getActiveCell();
   
   // Calculate the range needed to fit the given data.
   let targetRange = currentCell.getResizedRange(DATA.length - 1, DATA[0].length - 1);

   // Set range values to the data.
   targetRange.setValues(DATA);

   // Autofit the columns so the worksheet is readable. 
   targetRange.getFormat().autofitColumns();
 }

 /* 
  * This sample's data is in a static 2-dimensional array.
  * You could also get the input from other ranges or sources.
  * Note that each row must have the same number of columns to be valid. 
  */
 const DATA = [
   ['Date', 'Salesperson', 'Product', 'Amount']
   , ['3/2/2020', 'Anne', 'Pizza', '$1400']
   , ['3/2/2020', 'Mariya', 'Pizza', '$1700']
   , ['3/7/2020', 'Mark', 'Sandwiches', '$1010']
   , ['3/24/2020', 'Anne', 'Pizza', '$750']
   , ['3/28/2020', 'Mark', 'Salads', '$510']
   , ['4/17/2020', 'Laura', 'Salads', '$900']
   , ['4/17/2020', 'Mariya', 'Salads', '$1600']
   , ['4/28/2020', 'Laura', 'Sandwiches', '$680']
 ];

showCard()

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

showCard(): void;

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

void

showGroupDetails(groupOption)

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

showGroupDetails(groupOption: GroupOption): void;

Параметры

groupOption
GroupOption

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

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

void

ungroup(groupOption)

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

ungroup(groupOption: GroupOption): void;

Параметры

groupOption
GroupOption

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

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

void

unmerge()

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

unmerge(): void;

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

void