Novedades de la API de JavaScript de Excel 1.8

  • Artículo

El conjunto de requisitos de API para JavaScript de Excel 1.8 incluye las API para tablas dinámicas, validación de datos, gráficos, eventos para gráficos, opciones de rendimiento y creación de libros.

Tabla dinámica

La segunda oleada de las API para la tabla dinámica permite que los complementos configuren las jerarquías de una tabla dinámica. Ahora puede controlar los datos y la forma en se agregan. Nuestro artículo sobre tabla dinámica tiene más información sobre las nuevas funciones de tabla dinámica.

Validación de datos

La validación de datos permite controlar lo que un usuario escribe en una hoja de cálculo. Puede limitar las celdas a conjuntos de respuestas predefinidas o añadir advertencias emergentes acerca de una entrada no deseada. Obtenga más información sobre cómo agregar validación de datos a intervalos actualmente.

Gráficos

Otra ronda de las API de gráfico aporta incluso un mayor control de programación a través de los elementos del mismo. Ahora tiene un mayor acceso a la leyenda, los ejes, la línea de tendencia y el área de trazado.

Eventos

Se han añadido más eventos para gráficos. Haga que el complemento reaccione a los usuarios que interactúan con el gráfico. También puede alternar los eventos que se desencadenan a través de todo el libro.

Lista de API

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

Clase Campos Descripción
BasicDataValidation fórmula1 Especifica el operando derecho cuando la propiedad operator se establece en un operador binario como GreaterThan (el operando izquierdo es el valor que el usuario intenta escribir en la celda).
fórmula2 Con los operadores ternarios Between y NotBetween, especifica el operando de límite superior.
operator El operador para validar los datos.
Chart categoryLabelLevel Especifica una constante de enumeración de nivel de etiqueta de categoría de gráfico, que hace referencia al nivel de las etiquetas de categoría de origen.
displayBlanksAs Especifica la forma en que las celdas en blanco se trazan en un gráfico.
onActivated Se produce cuando se activa el gráfico.
onDeactivated Se produce cuando se desactiva el gráfico.
plotArea Representa el área de trazado del gráfico.
plotBy Especifica la manera en que las columnas o las filas se usan como series de datos en el gráfico.
plotVisibleOnly True si solo se trazan las celdas visibles.
seriesNameLevel Especifica una constante de enumeración de nivel de nombre de serie de gráfico, que hace referencia al nivel de los nombres de las series de origen.
showDataLabelsOverMaximum Especifica si se muestran las etiquetas de datos cuando el valor es mayor que el valor máximo en el eje de valores.
estilo Especifica el estilo del gráfico.
ChartActivatedEventArgs chartId Obtiene el identificador del gráfico que se activa.
type Obtiene el tipo del evento.
worksheetId Obtiene el identificador de la hoja de cálculo en la que se activa el gráfico.
ChartAddedEventArgs chartId Obtiene el identificador del gráfico que se agrega a la hoja de cálculo.
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 se agrega el gráfico.
ChartAxis Alineación Especifica la alineación de la etiqueta de tic del eje especificado.
isBetweenCategories Especifica si el eje de valores cruza el eje de categorías entre categorías.
Multinivel Especifica si un eje es de varios niveles.
numberFormat Especifica el código de formato para la etiqueta de tic del eje.
Compensar Especifica la distancia entre los niveles de etiquetas y la distancia entre el primer nivel y la línea del eje.
position Especifica la posición del eje especificada donde se cruza el otro eje.
positionAt Especifica la posición del eje donde cruza el otro eje.
setPositionAt(value: number) Establece la posición del eje especificada donde se cruza el otro eje.
textOrientation Especifica el ángulo al que está orientado el texto para la etiqueta de tic del eje del gráfico.
ChartAxisFormat fill Especifica el formato de relleno del gráfico.
ChartAxisTitle setFormula(formula: string) Un valor de cadena que representa la fórmula del título del eje del gráfico mediante la notación de estilo A1.
ChartAxisTitleFormat border Especifica el formato de borde del título del eje del gráfico, que incluye el color, el estilo de línea y el peso.
fill Especifica el formato de relleno del título del eje del gráfico.
ChartBorder clear() Borra el formato del borde de un elemento del gráfico.
ChartCollection onActivated Se produce cuando se activa un gráfico.
onAdded Se produce cuando se agrega un nuevo gráfico a la hoja de cálculo.
onDeactivated Se produce cuando se desactiva un gráfico.
onDeleted Se produce cuando se elimina un gráfico.
ChartDataLabel Autotexto Especifica si la etiqueta de datos genera automáticamente el texto adecuado en función del contexto.
format Representa el formato de la etiqueta de datos del gráfico.
formula Valor de cadena que representa la fórmula de la etiqueta de datos del gráfico mediante la notación de estilo A1.
height Devuelve la altura, en puntos, de la etiqueta de datos del gráfico.
horizontalAlignment Representa la alineación horizontal de la etiqueta de datos del gráfico.
left Representa la distancia, en puntos, desde el borde izquierdo de la etiqueta de datos del gráfico hasta el borde izquierdo del área del gráfico.
numberFormat Valor de cadena que representa el código de formato de la etiqueta de datos.
text Cadena que representa el texto de la etiqueta de datos en un gráfico.
textOrientation Representa el ángulo al que está orientado el texto para la etiqueta de datos del gráfico.
top Representa la distancia, en puntos, desde el borde superior de la etiqueta de datos del gráfico hasta el borde superior del área del gráfico.
verticalAlignment Representa la alineación vertical de la etiqueta de datos del gráfico.
width Devuelve la anchura, en puntos, de la etiqueta de datos del gráfico.
ChartDataLabelFormat border Representa el formato de borde, que incluye el color, grosor y estilo de línea.
ChartDataLabels Autotexto Especifica si las etiquetas de datos generan automáticamente el texto adecuado en función del contexto.
horizontalAlignment Especifica la alineación horizontal de la etiqueta de datos del gráfico.
numberFormat Especifica el código de formato para las etiquetas de datos.
textOrientation Representa el ángulo al que está orientado el texto para las etiquetas de datos.
verticalAlignment Representa la alineación vertical de la etiqueta de datos del gráfico.
ChartDeactivatedEventArgs chartId Obtiene el identificador del gráfico que está desactivado.
type Obtiene el tipo del evento.
worksheetId Obtiene el identificador de la hoja de cálculo en la que se desactiva el gráfico.
ChartDeletedEventArgs chartId Obtiene el identificador del gráfico que se elimina de la hoja de cálculo.
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 se elimina el gráfico.
ChartLegendEntry height Especifica el alto de la entrada de leyenda en la leyenda del gráfico.
index Especifica el índice de la entrada de leyenda en la leyenda del gráfico.
left Especifica el valor izquierdo de una entrada de leyenda de gráfico.
top Especifica la parte superior de una entrada de leyenda de gráfico.
width Representa el ancho de la entrada de leyenda en el gráfico Leyenda.
ChartLegendFormat border Representa el formato de borde, que incluye el color, grosor y estilo de línea.
ChartPlotArea format Especifica el formato de un área de trazado de gráfico.
height Especifica el valor de alto de un área de trazado.
insideHeight Especifica el valor de alto interior de un área de trazado.
insideLeft Especifica el valor interior izquierdo de un área de trazado.
insideTop Especifica el valor superior interior de un área de trazado.
insideWidth Especifica el valor de ancho interior de un área de trazado.
left Especifica el valor izquierdo de un área de trazado.
position Especifica la posición de un área de trazado.
top Especifica el valor superior de un área de trazado.
width Especifica el valor de ancho de un área de trazado.
ChartPlotAreaFormat border Especifica los atributos de borde de un área de trazado del gráfico.
fill Especifica el formato de relleno de un objeto, que incluye información de formato de fondo.
ChartSeries axisGroup Especifica el grupo de la serie especificada.
dataLabels Representa una colección de todas las etiquetas de datos de la serie.
Explosión Especifica el valor de explosión de un gráfico circular o un segmento de gráfico de anillos.
firstSliceAngle Especifica el ángulo del primer gráfico circular o segmento de gráfico de anillos, en grados (en el sentido de las agujas del reloj desde vertical).
invertIfNegative True si Excel invierte el patrón en el elemento cuando corresponde a un número negativo.
Traslapo Especifica cómo se colocan las barras y columnas.
secondPlotSize Especifica el tamaño de la sección secundaria de un gráfico circular o un gráfico de barras circulares, como un porcentaje del tamaño del gráfico circular principal.
splitType Especifica la forma en que se dividen las dos secciones de un gráfico circular de pie o de una barra de gráfico circular.
varyByCategories True si Excel asigna un color o patrón diferente a cada marcador de datos.
ChartTrendline backwardPeriod Representa el número de periodos que la línea de tendencia se extiende hacia atrás.
forwardPeriod Representa el número de periodos que la línea de tendencia se extiende hacia delante.
Etiqueta Representa la etiqueta de una línea de tendencia del gráfico.
showEquation True si la ecuación de la línea de tendencia se muestra en el gráfico.
showRSquared True si el valor de r cuadrado de la línea de tendencia se muestra en el gráfico.
ChartTrendlineLabel Autotexto Especifica si la etiqueta de línea de tendencia genera automáticamente el texto adecuado en función del contexto.
format Formato de la etiqueta de línea de tendencia del gráfico.
formula Valor de cadena que representa la fórmula de la etiqueta de línea de tendencia del gráfico mediante la notación de estilo A1.
height Devuelve la altura, en puntos, de la etiqueta de línea de tendencia del gráfico.
horizontalAlignment Representa la alineación horizontal de la etiqueta de línea de tendencia del gráfico.
left Representa la distancia, en puntos, desde el borde izquierdo de la etiqueta de línea de tendencia del gráfico hasta el borde izquierdo del área del gráfico.
numberFormat Valor de cadena que representa el código de formato de la etiqueta de línea de tendencia.
text Cadena que representa el texto de la etiqueta de línea de tendencia en un gráfico.
textOrientation Representa el ángulo al que está orientado el texto para la etiqueta de línea de tendencia del gráfico.
top Representa la distancia, en puntos, desde el borde superior de la etiqueta de línea de tendencia del gráfico hasta la parte superior del área del gráfico.
verticalAlignment Representa la alineación vertical de la etiqueta de línea de tendencia del gráfico.
width Devuelve la anchura, en puntos, de la etiqueta de línea de tendencia del gráfico.
ChartTrendlineLabelFormat border Especifica el formato del borde, que incluye el color, el estilo de línea y el peso.
fill Especifica el formato de relleno de la etiqueta de línea de tendencia del gráfico actual.
font Especifica los atributos de fuente (como el nombre de fuente, el tamaño de fuente y el color) de una etiqueta de línea de tendencia del gráfico.
CustomDataValidation formula Una fórmula de validación de datos personalizados.
DataPivotHierarchy campo Devuelve los PivotFields asociados con DataPivotHierarchy.
id Identificador de DataPivotHierarchy.
name Nombre de DataPivotHierarchy.
numberFormat Formato de número de DataPivotHierarchy.
position Posición de la DataPivotHierarchy.
setToDefault() Restablece DataPivotHierarchy a sus valores predeterminados.
showAs Especifica si los datos deben mostrarse como un cálculo de resumen específico.
summarizeBy Especifica si se muestran todos los elementos de DataPivotHierarchy.
DataPivotHierarchyCollection add(pivotHierarchy: Excel.PivotHierarchy) Agrega PivotHierarchy al eje actual.
getCount() Obtiene el número de jerarquías dinámicas en la colección.
getItem(name: string) Obtiene un objeto DataPivotHierarchy por su nombre o identificador.
getItemOrNullObject(name: string) Obtiene una DataPivotHierarchy por su nombre.
items Obtiene los elementos secundarios cargados en esta colección.
remove(DataPivotHierarchy: Excel.DataPivotHierarchy) Elimina PivotHierarchy del eje actual.
DataValidation clear() Borra la validación de datos del rango actual.
errorAlert Mensaje de error cuando el usuario escribe datos no válidos.
ignoreBlanks Especifica si la validación de datos se realizará en celdas en blanco.
prompt Preguntar cuándo los usuarios seleccionan una celda.
Regla Regla de validación de datos que contiene diferentes tipos de criterios de validación de datos.
type Tipo de validación de datos, consulte Excel.DataValidationType para obtener más información.
Válido Representa si todos los valores de celda son válidos de acuerdo con las reglas de validación de datos.
DataValidationErrorAlert message Representa el mensaje de alerta de error.
showAlert Especifica si se debe mostrar un cuadro de diálogo de alerta de error cuando un usuario escribe datos no válidos.
estilo El tipo de alerta de validación de datos, consulte Excel.DataValidationAlertStyle para obtener más información.
title Representa el título del cuadro de diálogo de alerta de error.
DataValidationPrompt message Especifica el mensaje del símbolo del sistema.
showPrompt Especifica si se muestra un mensaje cuando un usuario selecciona una celda con validación de datos.
title Especifica el título del símbolo del sistema.
DataValidationRule Personalizado Criterios de validación de datos personalizados.
date Criterios de validación de datos de fecha.
Decimal Criterios de validación de datos decimales.
list Criterios de validación de datos de lista.
textLength Criterios de validación de datos de longitud de texto.
time Criterios de validación de datos de tiempo.
wholeNumber Criterios de validación de datos de número entero.
DateTimeDataValidation fórmula1 Especifica el operando derecho cuando la propiedad operator se establece en un operador binario como GreaterThan (el operando izquierdo es el valor que el usuario intenta escribir en la celda).
fórmula2 Con los operadores ternarios Between y NotBetween, especifica el operando de límite superior.
operator El operador para validar los datos.
FilterPivotHierarchy enableMultipleFilterItems Determina si se permiten varios elementos de filtro.
fields Devuelve los PivotFields asociados con FilterPivotHierarchy.
id Identificador de FilterPivotHierarchy.
name Nombre de FilterPivotHierarchy.
position Posición de la FilterPivotHierarchy.
setToDefault() Restablece FilterPivotHierarchy a sus valores predeterminados.
FilterPivotHierarchyCollection add(pivotHierarchy: Excel.PivotHierarchy) Agrega PivotHierarchy al eje actual.
getCount() Obtiene el número de jerarquías dinámicas en la colección.
getItem(name: string) Obtiene un filterPivotHierarchy por su nombre o identificador.
getItemOrNullObject(name: string) Obtiene una FilterPivotHierarchy por su nombre.
items Obtiene los elementos secundarios cargados en esta colección.
remove(filterPivotHierarchy: Excel.FilterPivotHierarchy) Elimina PivotHierarchy del eje actual.
ListDataValidation inCellDropDown Especifica si se va a mostrar la lista en una lista desplegable de celdas.
source Origen de la lista de validación de datos
PivotField id Identificador del campo dinámico.
items Devuelve los pivotItems asociados al pivotfield.
name Nombre de PivotField.
showAllItems Determina si se muestran todos los elementos de PivotField.
sortByLabels(sortBy: SortBy) Ordena el PivotField.
subtotals Subtotales del PivotField.
PivotFieldCollection getCount() Obtiene el número de campos dinámicos de la colección.
getItem(name: string) Obtiene un pivotfield por su nombre o identificador.
getItemOrNullObject(name: string) Obtiene un pivotfield por nombre.
items Obtiene los elementos secundarios cargados en esta colección.
PivotHierarchy fields Devuelve los PivotFields asociados con PivotHierarchy.
id Identificador de pivotHierarchy.
name Nombre de la PivotHierarchy.
PivotHierarchyCollection getCount() Obtiene el número de jerarquías dinámicas en la colección.
getItem(name: string) Obtiene un elemento PivotHierarchy por su nombre o identificador.
getItemOrNullObject(name: string) Obtiene un PivotHierarchy por su nombre.
items Obtiene los elementos secundarios cargados en esta colección.
PivotItem id Identificador del objeto PivotItem.
isExpanded Determina si el elemento se expande para mostrar los elementos secundarios o si está contraído y se ocultan los elementos secundarios.
name Nombre del PivotItem.
visible Especifica si el objeto PivotItem está visible.
PivotItemCollection getCount() Obtiene el número de elementos PivotItem de la colección.
getItem(name: string) Obtiene un objeto PivotItem por su nombre o identificador.
getItemOrNullObject(name: string) Obtiene un objeto PivotItem por su nombre.
items Obtiene los elementos secundarios cargados en esta colección.
PivotLayout getColumnLabelRange() Devuelve el intervalo donde residen las etiquetas de columna de la tabla dinámica.
getDataBodyRange() Devuelve el intervalo donde residen los valores de datos de tabla dinámica.
getFilterAxisRange() Devuelve el intervalo del área de filtro de la tabla dinámica.
getRange() Devuelve el intervalo en el que existe la tabla dinámica, excluyendo el área de filtro.
getRowLabelRange() Devuelve el intervalo donde residen las etiquetas de fila de la tabla dinámica.
layoutType Esta propiedad indica el PivotLayoutType de todos los campos de la tabla dinámica.
showColumnGrandTotals Especifica si el informe de tabla dinámica muestra los totales generales de las columnas.
showRowGrandTotals Especifica si el informe de tabla dinámica muestra los totales generales de las filas.
subtotalLocation Esta propiedad indica el SubtotalLocationType de todos los campos de la tabla dinámica.
PivotTable columnHierarchies Las jerarquías dinámicas de columna de la tabla dinámica.
dataHierarchies Las jerarquías dinámicas de datos de la tabla dinámica.
delete() Elimina la tabla dinámica.
filterHierarchies Las jerarquías dinámicas de filtro de la tabla dinámica.
Jerarquías Las jerarquías dinámicas de la tabla dinámica.
Diseño El PivotLayout que describe el diseño y la estructura visual de la tabla dinámica.
rowHierarchies Las jerarquías dinámicas de fila de la tabla dinámica.
PivotTableCollection add(name: string, source: Range | string | Tabla, destino: intervalo | string) Agregue una tabla dinámica basada en los datos de origen especificados e insérela en la celda superior izquierda del intervalo de destino.
Range dataValidation Devuelve un objeto de validación de datos.
RowColumnPivotHierarchy fields Devuelve los PivotFields asociados con la RowColumnPivotHierarchy.
id Identificador de RowColumnPivotHierarchy.
name Nombre de la RowColumnPivotHierarchy.
position Posición de la RowColumnPivotHierarchy.
setToDefault() Restablece la RowColumnPivotHierarchy a sus valores predeterminados.
RowColumnPivotHierarchyCollection add(pivotHierarchy: Excel.PivotHierarchy) Agrega PivotHierarchy al eje actual.
getCount() Obtiene el número de jerarquías dinámicas en la colección.
getItem(name: string) Obtiene un objeto RowColumnPivotHierarchy por su nombre o identificador.
getItemOrNullObject(name: string) Obtiene una RowColumnPivotHierarchy por su nombre.
items Obtiene los elementos secundarios cargados en esta colección.
remove(rowColumnPivotHierarchy: Excel.RowColumnPivotHierarchy) Elimina PivotHierarchy del eje actual.
Tiempo de ejecución enableEvents Alterne los eventos de JavaScript en el panel de tareas actual o en el complemento de contenido.
ShowAsRule baseField Campo dinámico en el que se basará el ShowAs cálculo, si procede según el ShowAsCalculation tipo, de lo contrario null.
baseItem Elemento en el que se basará el ShowAs cálculo, si procede según el ShowAsCalculation tipo, de lo contrario null.
Cálculo Cálculo ShowAs que se va a usar para el campo dinámico.
Estilo autoIndent Especifica si el texto se aplica sangría automáticamente cuando la alineación de texto de una celda se establece en la misma distribución.
textOrientation Orientación del texto para el estilo.
Subtotals automatic Si Automatic se establece en true, se omitirán todos los demás valores al establecer .Subtotals
Promedio
count
countNumbers
máximo
Min
Producto
standardDeviation
standardDeviationP
Suma
Varianza
varianceP
Table legacyId Devuelve un identificador numérico.
TableChangedEventArgs getRange(ctx: Excel.RequestContext) Obtiene el rango que representa el área modificada de una tabla en una hoja de cálculo específica.
getRangeOrNullObject(ctx: Excel.RequestContext) Obtiene el rango que representa el área modificada de una tabla en una hoja de cálculo específica.
Workbook readOnly Devuelve true si el libro está abierto en modo de solo lectura.
WorkbookCreated
Worksheet onCalculated Se produce cuando se calcula la hoja de cálculo.
showGridlines Especifica si las líneas de cuadrícula son visibles para el usuario.
showHeadings Especifica si los encabezados son visibles para el usuario.
WorksheetCalculatedEventArgs type Obtiene el tipo del evento.
worksheetId Obtiene el identificador de la hoja de cálculo en la que se produjo el cálculo.
WorksheetChangedEventArgs getRange(ctx: Excel.RequestContext) Obtiene el intervalo que representa el área que ha cambiado en una hoja de cálculo específica.
getRangeOrNullObject(ctx: Excel.RequestContext) Obtiene el intervalo que representa el área que ha cambiado en una hoja de cálculo específica.
WorksheetCollection onCalculated Se produce cuando se calcula cualquier hoja de cálculo del libro.

Vea también