Получение диапазона с помощью API JavaScript для Excel

  • Статья

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

Примечание.

В API JavaScript для Excel нет объекта или класса Cell. Вместо этого API JavaScript для Excel определяет все ячейки Excel как объекты Range. Отдельные ячейки в пользовательском интерфейсе Excel преобразуются в объект Range с одной ячейкой в API JavaScript для Excel. Один объект Range также может содержать несколько смежных ячеек. Дополнительные сведения см. в статье Работа с ячейками с использованием API JavaScript для Excel.

Получение диапазона по адресу

Следующий пример кода получает диапазон с адресом B2:C5 из листа с именем Sample, загружает его address свойство и записывает сообщение в консоль.

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    
    let range = sheet.getRange("B2:C5");
    range.load("address");
    await context.sync();
    
    console.log(`The address of the range B2:C5 is "${range.address}"`);
});

Получение диапазона по имени

Следующий пример кода получает диапазон с именем MyRange из листа Sample, загружает его address свойство и записывает сообщение в консоль.

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");

    let range = sheet.getRange("MyRange");
    range.load("address");
    await context.sync();

    console.log(`The address of the range "MyRange" is "${range.address}"`);
});

Получение используемого диапазона

Следующий пример кода получает используемый диапазон из листа с именем Sample, загружает его address свойство и записывает сообщение в консоль. Используемый диапазон — это наименьший диапазон, включающий в себя все ячейки листа, которые содержат значение или форматирование. Если весь лист пуст, getUsedRange() метод возвращает диапазон, состоящий только из левой верхней ячейки.

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");

    let range = sheet.getUsedRange();
    range.load("address");
    await context.sync();
    
    console.log(`The address of the used range in the worksheet is "${range.address}"`);
});

Получение всего диапазона

Следующий пример кода получает весь диапазон листа с именем Sample, загружает его address свойство и записывает сообщение в консоль.

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");

    let range = sheet.getRange();
    range.load("address");
    await context.sync();
    
    console.log(`The address of the entire worksheet range is "${range.address}"`);
});

См. также