Compartir a través de

Novedades de la API de JavaScript de Excel 1.7

  • Artículo

Las características del conjunto de requisitos 1.7 de la API de JavaScript para Excel incluyen las API para gráficos, eventos, hojas de cálculo, rangos, propiedades del documento, elementos con nombre, opciones de protección y estilos.

Personalizar gráficos

Con las nuevas API para gráficos, puede crear tipos de gráficos adicionales, añadir una serie de datos a un gráfico, establecer el título del gráfico, agregar un título de eje, añadir una unidad de presentación, agregar una línea de tendencia con una media móvil, cambiar una línea de tendencia a lineal y mucho más. A continuación, se muestran algunos ejemplos.

  • Eje de gráfico: obtener, establecer, dar formato y eliminar unidades, etiquetas y títulos de eje de un gráfico.
  • Serie de gráficos: agregar, establecer y eliminar una serie de un gráfico. Cambiar los marcadores de series, órdenes de trazado y ajustes de tamaño.
  • Líneas de tendencia de gráfico: agregar, obtener y dar formato a las líneas de tendencia de un gráfico.
  • Leyenda de gráfico: formato de la fuente de la leyenda de un gráfico.
  • Punto del gráfico: establecer el color de punto de gráfico.
  • Subcadena de título del gráfico: obtiene y establece la subcadena de título de un gráfico.
  • Tipo de gráfico: opción para crear más tipos de gráficos.

Eventos

Las API de eventos de Excel proporcionan una variedad de controladores de eventos que permiten al complemento ejecutar automáticamente una función designada cuando se produce un evento específico. Puede diseñar esa función para realizar la acción que necesite el escenario. Para obtener una lista de los eventos que están actualmente disponibles, consulte Trabajar con Eventos mediante la API de JavaScript de Excel.

Personalizar la apariencia de hojas de cálculo y rangos

Mediante las nuevas API, puede personalizar la apariencia de las hojas de cálculo de varias maneras:

  • Inmovilizar paneles para mantener filas o columnas específicas visibles mientras se desplaza en la hoja de cálculo. Por ejemplo, si la primera fila de la hoja de cálculo contiene encabezados, puede inmovilizarla para que los encabezados de columna permanezcan visibles mientras se desplaza hacia abajo en la hoja de cálculo.
  • Modificar el color de la pestaña de la hoja de cálculo.
  • Agregar encabezados de hoja de cálculo.

Puede personalizar la apariencia de los rangos de varias formas:

  • Establecer el estilo de celda de un rango para asegurar que todas las celdas del rango tengan un formato coherente. Un estilo de celda es un conjunto definido de características de formato, como las fuentes y los tamaños de fuente, formatos de número, bordes de celda y sombreados de celda. Use cualquiera de los estilos de celda integrados de Excel o cree su propio estilo de celda personalizado.
  • Establecer la orientación del texto para un rango.
  • Agregar o modificar un hipervínculo en un rango que enlaza a otra ubicación del libro o externa.

Administrar las propiedades del documento

Mediante las API de propiedades del documento, puede acceder a las propiedades de documento integradas y también crear y administrar propiedades personalizadas del documento para almacenar el estado del libro y dirigir el flujo de trabajo y la lógica empresarial.

Copiar las hojas de cálculo

Con las API de copia de hoja de cálculo, puede copiar los datos y el formato de una hoja de cálculo a una hoja de cálculo nueva dentro del mismo libro y reducir la cantidad de transferencia de datos necesaria.

Controlar los rangos con facilidad

Con las diversas API de intervalo, puede hacer cosas como obtener la región que lo rodea, obtener un intervalo cuyo tamaño haya cambiado y mucho más. Estas API deberían hacer que tareas como la manipulación y el direccionamiento de rangos sean mucho más eficientes.

Además:

  • Opciones de protección de libro y hoja de cálculo: use estas API para proteger los datos de una hoja de cálculo y la estructura del libro.
  • Actualizar un elemento con nombre: utilice esta API para actualizar un elemento con nombre.
  • Obtener celda activa: use esta API para obtener la celda activa de un libro.

Lista de API

En la tabla siguiente se enumeran las API del conjunto de requisitos de la API de JavaScript de Excel 1.7. Para ver la documentación de referencia de API para todas las API admitidas por el conjunto de requisitos de la API de JavaScript de Excel 1.7 o versiones anteriores, consulte API de Excel en el conjunto de requisitos 1.7 o anterior.

Clase Campos Descripción
Chart chartType Especifica el tipo del gráfico.
id Identificador único del gráfico.
showAllFieldButtons Especifica si se van a mostrar todos los botones de campo en un gráfico dinámico.
ChartAreaFormat frontera Representa el formato de borde del área del gráfico, que incluye color, estilo de línea y peso.
ChartAxes getItem(type: Excel.ChartAxisType, group?: Excel.ChartAxisGroup) Devuelve el eje específico identificado por tipo y grupo.
ChartAxis axisGroup Especifica el grupo para el eje especificado.
baseTimeUnit Especifica la unidad base para el eje de categorías especificado.
categoryType Especifica el tipo de eje de categoría.
customDisplayUnit Especifica el valor de unidad de visualización del eje personalizado.
displayUnit Representa la unidad de visualización del eje.
height Especifica el alto, en puntos, del eje del gráfico.
left Especifica la distancia, en puntos, desde el borde izquierdo del eje a la izquierda del área del gráfico.
logBase Especifica la base del logaritmo cuando se usan escalas logarítmicas.
majorTickMark Especifica el tipo de marca de graduación principal para el eje especificado.
majorTimeUnitScale Especifica el valor de escala de unidad principal para el eje de categorías cuando la categoryType propiedad se establece en dateAxis.
minorTickMark Especifica el tipo de marca de graduación secundaria para el eje especificado.
minorTimeUnitScale Especifica el valor de escala de unidad secundaria para el eje de categorías cuando la categoryType propiedad se establece en dateAxis.
reversePlotOrder Especifica si Excel traza puntos de datos del último al primero.
scaleType Especifica el tipo de escala del eje de valores.
setCategoryNames(sourceData: Range) Establece todos los nombres de categoría del eje especificado.
setCustomDisplayUnit(value: number) Establece la unidad de visualización de ejes en un valor personalizado.
showDisplayUnitLabel Especifica si la etiqueta de la unidad de visualización del eje está visible.
tickLabelPosition Especifica la posición de los rótulos de marcas de graduación en el eje especificado.
tickLabelSpacing Especifica el número de categorías o series entre etiquetas de marca de graduación.
tickMarkSpacing Especifica el número de categorías o series entre marcas de graduación.
top Especifica la distancia, en puntos, desde el borde superior del eje hasta la parte superior del área del gráfico.
type Especifica el tipo de eje.
visible Especifica si el eje está visible.
width Especifica el ancho, en puntos, del eje del gráfico.
ChartBorder color Código de color HTML que representa el color de los bordes del gráfico.
lineStyle Representa el estilo de línea del borde.
weight Representa el grosor del borde, en puntos.
ChartDataLabel position Valor que representa la posición de la etiqueta de datos.
separador Cadena que representa el separador empleado para la etiqueta de datos de un gráfico.
showBubbleSize Especifica si el tamaño de la burbuja de etiqueta de datos es visible.
showCategoryName Especifica si el nombre de la categoría de etiqueta de datos está visible.
showLegendKey Especifica si la clave de leyenda de etiqueta de datos está visible.
showPercentage Especifica si el porcentaje de etiqueta de datos está visible.
showSeriesName Especifica si el nombre de la serie de etiquetas de datos está visible.
showValue Especifica si el valor de la etiqueta de datos está visible.
ChartFormatString font Representa los atributos de fuente, como el nombre de fuente, el tamaño de fuente y el color de un objeto de caracteres de gráfico.
ChartLegend height Especifica el alto, en puntos, de la leyenda del gráfico.
left Especifica el valor izquierdo, en puntos, de la leyenda del gráfico.
legendEntries Representa una colección de legendEntries en la leyenda.
showShadow Especifica si la leyenda tiene una sombra en el gráfico.
top Especifica la parte superior de una leyenda de gráfico.
width Especifica el ancho, en puntos, de la leyenda del gráfico.
ChartLegendEntry visible Representa la visibilidad de una entrada de leyenda de gráfico.
ChartLegendEntryCollection getCount() Devuelve el número de entradas de leyenda de la colección.
getItemAt(index: number) Devuelve una entrada de leyenda en el índice especificado.
items Obtiene los elementos secundarios cargados en esta colección.
ChartLineFormat lineStyle Representa el estilo de línea.
weight Indica el grosor de la línea, en puntos.
ChartPoint dataLabel Devuelve la etiqueta de datos de un punto del gráfico.
hasDataLabel Representa si un punto de datos tiene una etiqueta de datos.
markerBackgroundColor Representación del código de color HTML del color de fondo del marcador de un punto de datos (por ejemplo, #FF0000 representa Rojo).
markerForegroundColor Representación del código de color HTML del color de primer plano del marcador de un punto de datos (por ejemplo, #FF0000 representa Rojo).
markerSize Representa el tamaño del marcador de un punto de datos.
markerStyle Representa el estilo de marcador de un punto de datos del gráfico.
ChartPointFormat frontera Representa el formato de borde de un punto de datos de gráfico, que incluye información de color, estilo y peso.
ChartSeries chartType Representa el tipo de gráfico de una serie.
delete() Elimina la serie del gráfico.
doughnutHoleSize Representa el tamaño del agujero de los anillos de una serie de gráfico.
Filtrada Especifica si la serie está filtrada.
gapWidth Representa el ancho del rango de una serie de gráfico.
hasDataLabels Especifica si la serie tiene etiquetas de datos.
markerBackgroundColor Especifica el color de fondo del marcador de una serie de gráficos.
markerForegroundColor Especifica el color de primer plano del marcador de una serie de gráficos.
markerSize Especifica el tamaño del marcador de una serie de gráficos.
markerStyle Especifica el estilo de marcador de una serie de gráficos.
plotOrder Especifica el orden de trazado de una serie de gráficos dentro del grupo de gráficos.
setBubbleSizes(sourceData: Range) Establece los tamaños de burbuja de una serie de gráficos.
setValues(sourceData: Range) Establece los valores de una serie de gráficos.
setXAxisValues(sourceData: Range) Establece los valores del eje X para una serie de gráficos.
showShadow Especifica si la serie tiene una sombra.
Suave Especifica si la serie es suave.
líneas de tendencia Colección de líneas de tendencia de la serie.
ChartSeriesCollection add(name?: string, index?: number) Agrega una nueva serie a la colección.
ChartTitle getSubstring(start: number, length: number) Obtenga la subcadena de un título de gráfico.
height Devuelve el alto, en puntos, del título del gráfico.
horizontalAlignment Especifica la alineación horizontal del título del gráfico.
left Especifica la distancia, en puntos, desde el borde izquierdo del título del gráfico hasta el borde izquierdo del área del gráfico.
position Representa la posición del título del gráfico.
setFormula(formula: string) Establece un valor de cadena que representa la fórmula del título del gráfico con la notación de estilo A1.
showShadow Representa un valor booleano que determina si el título del gráfico tiene una propiedad reemplazada.
textOrientation Especifica el ángulo al que está orientado el texto para el título del gráfico.
top Especifica la distancia, en puntos, desde el borde superior del título del gráfico hasta la parte superior del área del gráfico.
verticalAlignment Especifica la alineación vertical del título del gráfico.
width Especifica el ancho, en puntos, del título del gráfico.
ChartTitleFormat frontera Representa el formato de borde del título del gráfico, que incluye color, estilo de línea y peso.
ChartTrendline delete() Elimina el objeto de la línea de tendencia.
format Representa el formato de línea de tendencia de un gráfico.
interceptar Representa el valor de la intersección de la línea de tendencia.
movingAveragePeriod Representa el período de una línea de tendencia del gráfico.
name Representa el nombre de la línea de tendencia.
polynomialOrder Representa el orden de una línea de tendencia del gráfico.
type Representa el tipo de línea de tendencia de un gráfico.
ChartTrendlineCollection add(type?: Excel.ChartTrendlineType) Agrega una nueva línea de tendencia a la colección de líneas de tendencia.
getCount() Devuelve el número de líneas de tendencia de la colección.
getItem(index: number) Obtiene un objeto de línea de tendencia por índice, que es el orden de inserción en la matriz de elementos.
items Obtiene los elementos secundarios cargados en esta colección.
ChartTrendlineFormat line Indica el formato de línea de gráfico.
CustomProperty delete() Elimina la propiedad personalizada.
key Clave de la propiedad personalizada.
type Tipo del valor usado para la propiedad personalizada.
value Valor de la propiedad personalizada.
CustomPropertyCollection add(key: string, value: any) Crea una nueva propiedad personalizada o establece una existente.
deleteAll() Elimina todas las propiedades personalizadas de la colección.
getCount() Obtiene el recuento de las propiedades personalizadas.
getItem(key: string) Obtiene un objeto de propiedad personalizada mediante su clave, que no distingue mayúsculas de minúsculas.
getItemOrNullObject(key: string) Obtiene un objeto de propiedad personalizada mediante su clave, que no distingue mayúsculas de minúsculas.
items Obtiene los elementos secundarios cargados en esta colección.
DataConnectionCollection refreshAll() Actualiza las conexiones de datos de la colección, como desde una tabla dinámica a un conjunto de datos de Power BI, o un modelo de datos a una tabla o intervalo en el mismo libro.
DocumentProperties autor Autor del libro.
categoría Categoría del libro.
comments Campo Comentarios en los metadatos del libro.
company La empresa del libro.
creationDate Obtiene la fecha de creación del libro.
costumbre Obtiene la colección de propiedades personalizadas del libro.
Palabras clave Palabras clave del libro.
lastAuthor Obtiene el último autor del libro.
director Administrador del libro.
revisionNumber Obtiene el número de revisión del libro.
subject Asunto del libro.
title Título del libro.
NamedItem arrayValues Devuelve un objeto que contiene los valores y tipos del elemento con nombre.
formula Fórmula del elemento con nombre.
NamedItemArrayValues types Representa los tipos de cada elemento de la matriz de elementos con nombre.
values Representa los valores de cada elemento de la matriz de elementos con nombre.
Rango getAbsoluteResizedRange(numRows: number, numColumns: number) Obtiene un Range objeto con la misma celda superior izquierda que el objeto actual Range , pero con los números especificados de filas y columnas.
getImage() Representa el intervalo como una imagen PNG codificada en Base64.
getSurroundingRegion() Devuelve un Range objeto que representa la región circundante de la celda superior izquierda de este rango.
hyperlink Representa el hipervínculo del intervalo actual.
isEntireColumn Representa si el intervalo actual es una columna completa.
isEntireRow Representa si el intervalo actual es una fila completa.
numberFormatLocal Representa el código de formato de número de Excel para el intervalo especificado, en función de la configuración de idioma del usuario.
showCard() Muestra la tarjeta de una celda activa si tiene contenido de valor enriquecido.
estilo Representa el estilo del rango actual.
RangeFormat textOrientation Orientación del texto de todas las celdas dentro del rango.
useStandardHeight Determina si el alto de fila del Range objeto es igual al alto estándar de la hoja.
useStandardWidth Especifica si el ancho de columna del Range objeto es igual al ancho estándar de la hoja.
RangeHyperlink address Representa el destino de dirección URL del hipervínculo.
documentReference Representa el destino de referencia del documento para el hipervínculo.
screenTip Representa la cadena que se muestra al mantener el puntero sobre el hipervínculo.
textToDisplay Representa la cadena que se muestra en la celda superior izquierda del rango.
Estilo borders Colección de cuatro objetos de borde que representan el estilo de los cuatro bordes.
Builtin Especifica si el estilo es un estilo integrado.
delete() Elimina este estilo.
fill Relleno del estilo.
font Objeto Font que representa la fuente del estilo.
formulaHidden Especifica si la fórmula se ocultará cuando la hoja de cálculo esté protegida.
horizontalAlignment Representa la alineación horizontal del estilo.
includeAlignment Especifica si el estilo incluye las propiedades de sangría automática, alineación horizontal, alineación vertical, texto de ajuste, nivel de sangría y orientación del texto.
includeBorder Especifica si el estilo incluye las propiedades de color, índice de color, estilo de línea y borde de peso.
includeFont Especifica si el estilo incluye las propiedades de fondo, negrita, color, índice de color, estilo de fuente, cursiva, nombre, tamaño, tachado, subíndice, superíndice y subrayado.
includeNumber Especifica si el estilo incluye la propiedad de formato de número.
includePatterns Especifica si el estilo incluye el color, el índice de color, la inversión si es negativo, el patrón, el color del patrón y las propiedades interiores del índice de color del patrón.
includeProtection Especifica si el estilo incluye las propiedades de protección ocultas y bloqueadas de la fórmula.
indentLevel Un número entero entre 0 y 250 que indica el nivel de sangría para el estilo.
locked Especifica si el objeto está bloqueado cuando la hoja de cálculo está protegida.
name El nombre del estilo.
numberFormat El código de formato del formato de número para el estilo.
numberFormatLocal El código de formato localizado del formato de número para el estilo.
readingOrder El orden de lectura para el estilo.
shrinkToFit Especifica si el texto se reduce automáticamente para ajustarse al ancho de columna disponible.
verticalAlignment Especifica la alineación vertical del estilo.
wrapText Especifica si Excel ajusta el texto del objeto.
StyleCollection add(name: string) Agrega un nuevo estilo a la colección.
getItem(name: string) Obtiene un valor Style por nombre.
items Obtiene los elementos secundarios cargados en esta colección.
Tabla onChanged Se produce cuando los datos de las celdas cambian en una tabla específica.
onSelectionChanged Se produce cuando la selección cambia en una tabla específica.
TableChangedEventArgs address Obtiene la dirección que representa el área de cambio de una tabla en una hoja de cálculo concreta.
changeType Obtiene el tipo de cambio que representa cómo se desencadena el evento modificado.
source Obtiene el origen del evento.
tableId Obtiene el identificador de la tabla en la que cambiaron los datos.
type Obtiene el tipo del evento.
worksheetId Obtiene el identificador de la hoja de cálculo en la que cambiaron los datos.
TableCollection onChanged Se produce cuando los datos cambian en cualquier tabla de un libro o una hoja de cálculo.
TableSelectionChangedEventArgs address Obtiene la dirección del intervalo que representa el área seleccionada de la tabla en una hoja de cálculo específica.
isInsideTable Especifica si la selección está dentro de una tabla.
tableId Obtiene el identificador de la tabla en la que cambió la selección.
type Obtiene el tipo del evento.
worksheetId Obtiene el identificador de la hoja de cálculo en la que cambió la selección.
Workbook dataConnections Representa todas las conexiones de datos del libro.
getActiveCell() Obtiene la celda activa del libro.
name Obtiene el nombre del libro.
properties Obtiene las propiedades del libro.
protection Devuelve el objeto de protección de un libro.
Estilos Representa una colección de estilos asociada con el libro.
WorkbookProtection protect(password?: string) Protege el libro.
protegido Especifica si el libro está protegido.
unprotect(password?: string) Desprotege el libro.
Worksheet copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet) Copia una hoja de cálculo y la coloca en la posición especificada.
freezePanes Obtiene un objeto que se puede usar para manipular paneles inmovilizados en la hoja de cálculo.
getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number) Obtiene el Range objeto que comienza en un índice de fila y un índice de columna determinados, y abarca un determinado número de filas y columnas.
onActivated Se produce cuando se activa la hoja de cálculo.
onChanged Se produce cuando los datos cambian en una hoja de cálculo específica.
onDeactivated Se produce cuando se desactiva la hoja de cálculo.
onSelectionChanged Se produce cuando la selección cambia en una hoja de cálculo específica.
standardHeight Devuelve el ancho estándar (predeterminado) de todas las filas de la hoja de cálculo, en puntos.
standardWidth Especifica el ancho estándar (predeterminado) de todas las columnas de la hoja de cálculo.
tabColor Color de pestaña de la hoja de cálculo.
WorksheetActivatedEventArgs type Obtiene el tipo del evento.
worksheetId Obtiene el identificador de la hoja de cálculo que se activa.
WorksheetAddedEventArgs source Obtiene el origen del evento.
type Obtiene el tipo del evento.
worksheetId Obtiene el identificador de la hoja de cálculo que se agrega al libro.
WorksheetChangedEventArgs address Obtiene la dirección del intervalo que representa el área que ha cambiado en una hoja de cálculo específica.
changeType Obtiene el tipo de cambio que representa cómo se desencadena el evento modificado.
source Obtiene el origen del evento.
type Obtiene el tipo del evento.
worksheetId Obtiene el identificador de la hoja de cálculo en la que cambiaron los datos.
WorksheetCollection onActivated Se produce cuando se activa cualquier hoja de cálculo del libro.
onAdded Se produce cuando se agrega una nueva hoja de cálculo al libro.
onDeactivated Se produce cuando se desactiva cualquier hoja de cálculo del libro.
onDeleted Se produce cuando se elimina una hoja de cálculo del libro.
WorksheetDeactivatedEventArgs type Obtiene el tipo del evento.
worksheetId Obtiene el identificador de la hoja de cálculo que está desactivada.
WorksheetDeletedEventArgs source Obtiene el origen del evento.
type Obtiene el tipo del evento.
worksheetId Obtiene el identificador de la hoja de cálculo que se elimina del libro.
WorksheetFreezePanes freezeAt(frozenRange: Range | string) Establece las celdas inmovilizadas en la vista de la hoja de cálculo activa.
freezeColumns(count?: number) Inmovilizar la primera columna o columnas de la hoja de cálculo en su lugar.
freezeRows(count?: number) Inmovilizar la fila superior o las filas de la hoja de cálculo en su lugar.
getLocation() Obtiene un rango que describe las celdas bloqueadas en la vista de hoja de cálculo activa.
getLocationOrNullObject() Obtiene un rango que describe las celdas bloqueadas en la vista de hoja de cálculo activa.
unfreeze() Elimina todos los paneles inmovilizados de la hoja de cálculo.
WorksheetProtection unprotect(password?: string) Desprotege una hoja de cálculo.
WorksheetProtectionOptions allowEditObjects Representa la opción de protección de la hoja de cálculo que permite la edición de objetos.
allowEditScenarios Representa la opción de protección de la hoja de cálculo que permite la edición de escenarios.
selectionMode Representa la opción de protección de la hoja de cálculo del modo de selección.
WorksheetSelectionChangedEventArgs address Obtiene la dirección del intervalo que representa el área seleccionada de una hoja de cálculo específica.
type Obtiene el tipo del evento.
worksheetId Obtiene el identificador de la hoja de cálculo en la que cambió la selección.

Vea también