Obtención de un intervalo mediante la API de JavaScript de Excel

  • Artículo

En este artículo se proporcionan ejemplos que muestran diferentes maneras de obtener un rango dentro de una hoja de cálculo mediante la API de JavaScript de Excel. Para obtener la lista completa de propiedades y métodos que admite el Range objeto, vea Clase Excel.Range.

Nota:

La API de JavaScript para Excel no tiene un objeto o clase de "Celda". En su lugar, se definen todas las celdas de Excel como objetos Range. Una celda individual en la interfaz de usuario de Excel se traduce en un objeto Range con una celda en la API de JavaScript para Excel. Un solo objeto Range también puede contener varias celdas contiguas. Consulte Trabajar con celdas mediante la API de JavaScript para Excel para obtener más información.

Obtener el rango por dirección

El ejemplo de código siguiente obtiene el intervalo con la dirección B2:C5 de la hoja de cálculo denominada Sample, carga su address propiedad y escribe un mensaje en la consola.

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

Obtener el rango por nombre

El ejemplo de código siguiente obtiene el intervalo denominado MyRange de la hoja de cálculo denominada Sample, carga su address propiedad y escribe un mensaje en la consola.

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

Obtener el rango usado

El ejemplo de código siguiente obtiene el intervalo usado de la hoja de cálculo denominada Sample, carga su address propiedad y escribe un mensaje en la consola. El rango usado es el rango más pequeño que abarque todas las celdas de la hoja de cálculo que tengan asignado un valor o un formato. Si toda la hoja de cálculo está en blanco, el getUsedRange() método devuelve un rango que consta solo de la celda superior izquierda.

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

Obtener el rango completo

El ejemplo de código siguiente obtiene todo el intervalo de hojas de cálculo de la hoja de cálculo denominada Sample, carga su address propiedad y escribe un mensaje en la consola.

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

Vea también