Obter um intervalo usando a API JavaScript do Excel

  • Artigo

Este artigo fornece exemplos que mostram diferentes maneiras de obter um intervalo dentro de uma planilha usando a API JavaScript do Excel. Para obter a lista completa de propriedades e métodos compatíveis com o Range objeto, consulte Classe Excel.Range.

Observação

A API JavaScript do Excel não tem um objeto ou classe "Célula". Em vez disso, a API JavaScript do Excel define todas as células do Excel como objetos Range. Uma célula individual na interface do usuário do Excel se traduz em um objeto Range com uma célula na API JavaScript do Excel. Um único objeto Range também pode conter várias células contíguas. Confira Trabalhar com células usando a API JavaScript do Excel para saber mais.

Obter intervalo por endereço

O exemplo de código a seguir obtém o intervalo com o endereço B2:C5 da planilha chamada Exemplo, carrega sua address propriedade e grava uma mensagem no console.

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}"`);
});

Obter intervalo por nome

O exemplo de código a seguir obtém o intervalo nomeado MyRange na planilha chamada Exemplo, carrega sua address propriedade e grava uma mensagem no console.

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}"`);
});

Obter intervalo usado

O exemplo de código a seguir obtém o intervalo usado da planilha chamada Exemplo, carrega sua address propriedade e grava uma mensagem no console. O intervalo usado é o menor intervalo que abrange todas as células na planilha que têm um valor ou uma formatação atribuída a elas. Se toda a planilha estiver em branco, o getUsedRange() método retornará um intervalo que consiste apenas na célula superior esquerda.

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}"`);
});

Obter intervalo inteiro

O exemplo de código a seguir obtém todo o intervalo de planilhas da planilha chamada Exemplo, carrega sua address propriedade e grava uma mensagem no console.

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}"`);
});

Confira também