Modelo de objetos JavaScript de Excel en Complementos de Office

  • 09/03/2020
  • 4 minutos de lectura
    • o
    • R
    • A
    • l
    • m
    • +4

En este artículo se describe cómo usar la API JavaScript de Excel para crear complementos para Excel 2016 o posterior. Presenta conceptos básicos que son fundamentales para usar la API y proporciona orientación para realizar tareas específicas, como leer o escribir en un amplio rango, actualizar todas las celdas en el rango y más.

Importante

Consulte Uso del modelo de API específico de la aplicación para obtener más información sobre la naturaleza asincrónica de las API de Excel y cómo funcionan con el libro de trabajo.

Oficina.api de js para Excel

Un complemento de Excel interactúa con objetos en Excel mediante la API de JavaScript de Office, que incluye dos modelos de objetos JavaScript:

  • API de JavaScript de Excel: Introducida con Office 2016, la API de JavaScript de Excel proporciona objetos fuertemente escritos que puede usar para acceder a hojas de trabajo, rangos, tablas, gráficos y más.

  • API comunes: Introducida con Office 2013, la API común se puede usar para acceder a funciones como la interfaz de usuario, los diálogos y la configuración del cliente que son comunes en varios tipos de aplicaciones de Office.

Si bien es probable que utilices la API JavaScript de Excel para desarrollar la mayoría de las funcionalidades en complementos dirigidos a Excel 2016 o posterior, también usarás objetos en la API Común. Por ejemplo:

  • Contexto: El objeto Context representa el entorno de tiempo de ejecución del complemento y proporciona acceso a objetos clave de la API. Consta de detalles de configuración del libro de trabajo, como contentLanguage y officeTheme, y también proporciona información sobre el entorno de ejecución del complemento, como host y platform. Además, proporciona el método requirements.isSetSupported(), que puede usar para verificar si el conjunto de requisitos especificado es compatible con la aplicación de Excel donde se ejecuta el complemento.Documento
  • : El objeto Document proporciona el método getFileAsync(), que puede usar para descargar el archivo de Excel donde se ejecuta el complemento.

La siguiente imagen muestra cuándo puede usar la API JavaScript de Excel o las API comunes.

Modelo de objetos específico de Excel

Para comprender las API de Excel, debe comprender cómo se relacionan los componentes de un libro de trabajo entre sí.

  • Un libro de trabajo contiene una o más hojas de trabajo.
  • Una hoja de trabajo contiene colecciones de los objetos de datos que están presentes en la hoja individual y da acceso a las celdas a través de objetos de rango.
  • Un Rango representa un grupo de celdas contiguas.Los rangos
  • se utilizan para crear y colocar Tablas, Gráficos, Formas y otros objetos de visualización u organización de datos.
  • Los libros de trabajo contienen colecciones de algunos de esos objetos de datos (como tablas) para todo el libro de trabajo.

Rangos

Un rango es un grupo de celdas contiguas en el libro de trabajo. Los complementos suelen usar notación de estilo A1 (por ejemplo, B3 para la celda individual de la columna B y la fila 3 o C2:F4 para las celdas de las columnas C a F y las filas 2 a 4) para definir rangos.Los rangos

tienen tres propiedades principales: values, formulas y format. Estas propiedades obtienen o establecen los valores de celda, las fórmulas que se evaluarán y el formato visual de las celdas.

Muestra de rango

El siguiente ejemplo muestra cómo crear registros de ventas. Esta función utiliza objetos Range para establecer los valores, fórmulas y formatos.

Este ejemplo crea los siguientes datos en la hoja de trabajo actual:

Para obtener más información, consulte Trabajar con rangos mediante la API JavaScript de Excel.

Gráficos, tablas y otros objetos de datos

Las API de JavaScript de Excel pueden crear y manipular las estructuras y visualizaciones de datos dentro de Excel. Las tablas y los gráficos son dos de los objetos más utilizados, pero las API admiten tablas dinámicas, formas, imágenes y mucho más.

Crear una tabla

Crear tablas mediante rangos llenos de datos. Los controles de formato y de tabla (como los filtros) se aplican automáticamente al rango.

El siguiente ejemplo crea una tabla utilizando los rangos de la muestra anterior.

El uso de este código de ejemplo en la hoja de trabajo con los datos anteriores crea la siguiente tabla:

Para obtener más información, consulte Trabajar con tablas mediante la API de JavaScript de Excel.

Crear un gráfico

Crear gráficos para visualizar los datos en un rango. Las API admiten docenas de variedades de gráficos, cada una de las cuales se puede personalizar para satisfacer sus necesidades.

El siguiente ejemplo crea un gráfico de columnas simple para tres elementos y lo coloca 100 píxeles debajo de la parte superior de la hoja de trabajo.

Al ejecutar este ejemplo en la hoja de trabajo con la tabla anterior, se crea el siguiente gráfico:

Para obtener más información, consulte Trabajar con gráficos mediante la API de JavaScript de Excel.

Véase también



+