Conjunto de requisitos de la API de JavaScript de Excel 1.1

  • Artículo

API de JavaScript de Excel 1.1 es la primera versión de la API. Es el único conjunto de requisitos específicos de Excel admitido por Excel 2016.

Lista de API

En la tabla siguiente se enumeran las API del conjunto de requisitos de la API de JavaScript de Excel 1.1. 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.1, consulte Api de Excel en el conjunto de requisitos 1.1.

Clase Campos Descripción
Application calculate(calculationType: Excel.CalculationType) Recalcula todos los libros abiertos actualmente en Excel.
calculationMode Devuelve el modo de cálculo usado en el libro, tal como se define en las constantes de Excel.CalculationMode.
Enlace getRange() Devuelve el intervalo representado por el enlace.
getTable() Devuelve la tabla representada por el enlace.
getText() Devuelve el texto representado por el enlace.
id Representa el identificador de enlace.
type Devuelve el tipo de enlace.
BindingCollection count Devuelve el número de enlaces incluidos en la colección.
getItem(id: string) Obtiene un objeto de enlace por identificador.
getItemAt(index: number) Obtiene un objeto de enlace según su posición en la matriz de elementos.
items Obtiene los elementos secundarios cargados en esta colección.
Chart Ejes Representa los ejes del gráfico.
dataLabels Representa la clase DataLabels del gráfico.
delete() Elimina el objeto de gráfico.
format Encapsula las propiedades de formato del área del gráfico.
height Especifica el alto, en puntos, del objeto de gráfico.
left Distancia, en puntos, desde el lado izquierdo del gráfico hasta el origen de la hoja de cálculo.
Leyenda Representa la leyenda del gráfico.
name Especifica el nombre de un objeto de gráfico.
series Representa una sola serie o una colección de series del gráfico.
setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy) Configura los datos de origen para el gráfico.
setPosition(startCell: Range | string, endCell?: Range | string) Coloca el gráfico con respecto a las celdas de la hoja de cálculo.
title Representa el título del gráfico especificado, incluido el texto, la visibilidad, la posición y el formato del título.
top Especifica la distancia, en puntos, desde el borde superior del objeto hasta la parte superior de la fila 1 (en una hoja de cálculo) o la parte superior del área del gráfico (en un gráfico).
width Especifica el ancho, en puntos, del objeto de gráfico.
ChartAreaFormat fill Representa el formato de relleno de un objeto, que incluye información del formato de fondo.
font Representa los atributos de fuente (nombre de fuente, tamaño de fuente, color, etc.) del objeto actual.
ChartAxes categoryAxis Representa el eje de categorías de un gráfico.
seriesAxis Representa el eje de serie de un gráfico 3D.
valueAxis Representa el eje de valores de un eje.
ChartAxis format Representa el formato de un objeto de gráfico, que incluye el formato de línea y de fuente.
majorGridlines Devuelve un objeto que representa las líneas de cuadrícula principales del eje especificado.
majorUnit Representa el intervalo entre dos marcas de graduación principales.
maximum Representa el valor máximo del eje de valores.
minimum Representa el valor mínimo del eje de valores.
minorGridlines Devuelve un objeto que representa las líneas de cuadrícula secundarias del eje especificado.
minorUnit Representa el rango entre dos marcas de graduación secundarias.
title Representa el título del eje.
ChartAxisFormat font Especifica los atributos de fuente (nombre de fuente, tamaño de fuente, color, etc.) para un elemento de eje de gráfico.
line Especifica el formato de línea del gráfico.
ChartAxisTitle format Especifica el formato del título del eje del gráfico.
text Especifica el título del eje.
visible Especifica si el título del eje está visible.
ChartAxisTitleFormat font Especifica los atributos de fuente del título del eje del gráfico, como el nombre de fuente, el tamaño de fuente o el color, del objeto de título del eje del gráfico.
ChartCollection add(type: Excel.ChartType, sourceData: Range, seriesBy?: Excel.ChartSeriesBy) Crea un nuevo gráfico.
count Devuelve el número de gráficos de la hoja de cálculo.
getItem(name: string) Obtiene un gráfico mediante su nombre.
getItemAt(index: number) Obtiene un gráfico en función de su posición en la colección.
items Obtiene los elementos secundarios cargados en esta colección.
ChartDataLabelFormat fill Representa el formato de relleno de la etiqueta de datos del gráfico actual.
font Representa los atributos de fuente (como el nombre de fuente, el tamaño de fuente y el color) de una etiqueta de datos de gráfico.
ChartDataLabels format Especifica el formato de las etiquetas de datos del gráfico, que incluye el formato de relleno y fuente.
position Valor que representa la posición de la etiqueta de datos.
Separador Cadena que representa el separador empleado para las etiquetas 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.
ChartFill clear() Borra el color de relleno de un elemento de gráfico.
setSolidColor(color: string) Establece el formato de relleno de un elemento de gráfico en un color uniforme.
ChartFont bold Indica el estado de negrita de la fuente.
color Representación del código de color HTML del color de texto (por ejemplo, #FF0000 representa Rojo).
italic Representa el estado de cursiva de la fuente.
name Nombre de fuente (por ejemplo, "Calibri")
size Tamaño de la fuente (por ejemplo, 11)
underline Tipo de subrayado aplicado a la fuente.
ChartGridlines format Representa el formato de las líneas de cuadrícula del gráfico.
visible Especifica si las líneas de cuadrícula del eje están visibles.
ChartGridlinesFormat line Indica el formato de línea de gráfico.
ChartLegend format Representa el formato de una leyenda del gráfico, que incluye el formato de relleno y de fuente.
overlay Especifica si la leyenda del gráfico debe superponerse con el cuerpo principal del gráfico.
position Especifica la posición de la leyenda en el gráfico.
visible Especifica si la leyenda del gráfico está visible.
ChartLegendFormat fill Representa el formato de relleno de un objeto, que incluye información del formato de fondo.
font Representa los atributos de fuente, como el nombre de fuente, el tamaño de fuente y el color de una leyenda de gráfico.
ChartLineFormat clear() Borra el formato de línea de un elemento de gráfico.
color Código de color HTML que representa el color de las líneas del gráfico.
ChartPoint format Encapsula las propiedades de formato del punto del gráfico.
value Devuelve el valor de un punto del gráfico.
ChartPointFormat fill Representa el formato de relleno de un gráfico, que incluye información de formato de fondo.
ChartPointsCollection count Devuelve el número de puntos del gráfico de la serie.
getItemAt(index: number) Recupera un punto basándose en su posición dentro de la serie.
items Obtiene los elementos secundarios cargados en esta colección.
ChartSeries format Representa el formato de una serie del gráfico, que incluye el formato de relleno y de línea.
name Especifica el nombre de una serie en un gráfico.
Puntos Devuelve una colección de todos los puntos de la serie.
ChartSeriesCollection count Devuelve el número de series incluidas en la colección.
getItemAt(index: number) Recupera una serie basada en su posición en la colección.
items Obtiene los elementos secundarios cargados en esta colección.
ChartSeriesFormat fill Representa el formato de relleno de una serie del gráfico, que incluye información del formato de fondo.
line Representa el formato de línea.
ChartTitle format Representa el formato de un título del gráfico, que incluye el formato de relleno y de fuente.
overlay Especifica si el título del gráfico se superpondrá al gráfico.
text Especifica el texto del título del gráfico.
visible Especifica si el título del gráfico está visible.
ChartTitleFormat fill Representa el formato de relleno de un objeto, que incluye información del formato de fondo.
font Representa los atributos de fuente (como el nombre de fuente, el tamaño de fuente y el color) de un objeto.
NamedItem getRange() Devuelve el objeto de rango asociado al nombre.
name Nombre del objeto.
type Especifica el tipo del valor devuelto por la fórmula del nombre.
value Representa el valor calculado por la fórmula del nombre.
visible Especifica si el objeto está visible.
NamedItemCollection getItem(name: string) Obtiene un NamedItem objeto con su nombre.
items Obtiene los elementos secundarios cargados en esta colección.
Range address Especifica la referencia de rango en estilo A1.
addressLocal Representa la referencia de intervalo para el intervalo especificado en el idioma del usuario.
cellCount Especifica el número de celdas del rango.
clear(applyTo?: Excel.ClearApplyTo) Borra valores de rango, formato, relleno, borde, etc.
columnCount Especifica el número total de columnas del intervalo.
columnIndex Especifica el número de columna de la primera celda del intervalo.
delete(shift: Excel.DeleteShiftDirection) Elimina las celdas asociadas al rango.
format Devuelve un objeto de formato que encapsula la fuente, el relleno, los bordes, la alineación y otras propiedades del rango.
formulas Representa la fórmula en notación de estilo A1.
formulasLocal Representa la fórmula en notación de estilo A1, en el idioma del usuario y en la configuración regional del formato numérico.
getBoundingRect(anotherRange: Range | string) Obtiene el objeto de intervalo más pequeño que abarca los intervalos especificados.
getCell(row: number, column: number) Obtiene el objeto de intervalo que contiene la celda en función de los números de fila y columna.
getColumn(column: number) Obtiene una columna contenida en el intervalo.
getEntireColumn() Obtiene un objeto que representa toda la columna del rango (por ejemplo, si el rango actual representa las celdas "B4:E11", es getEntireColumn un rango que representa las columnas "B:E").
getEntireRow() Obtiene un objeto que representa toda la fila del rango (por ejemplo, si el rango actual representa las celdas "B4:E11", es GetEntireRow un rango que representa las filas "4:11").
getIntersection(anotherRange: Range | string) Obtiene el objeto de rango que representa la intersección rectangular de los rangos especificados.
getLastCell() Obtiene la última celda del intervalo.
getLastColumn() Obtiene la última columna del intervalo.
getLastRow() Obtiene la última fila del intervalo.
getOffsetRange(rowOffset: number, columnOffset: number) Obtiene un objeto que representa un intervalo desplazado con respecto al intervalo especificado.
getRow(row: number) Obtiene una fila contenida en el intervalo.
insert(shift: Excel.InsertShiftDirection) Inserta una celda o un intervalo de celdas en la hoja de cálculo en lugar de este intervalo y desplaza las demás celdas para crear espacio.
numberFormat Representa el código de formato de número de Excel para el intervalo especificado.
Rowcount Devuelve el número total de filas del intervalo.
rowIndex Devuelve el número de fila de la primera celda del intervalo.
select() Selecciona el intervalo especificado en la interfaz de usuario de Excel.
text Valores de texto del rango especificado.
valueTypes Especifica el tipo de datos de cada celda.
values Representa los valores sin formato del rango especificado.
worksheet Hoja de cálculo que contiene el rango actual.
RangeBorder color Código de color HTML que representa el color de la línea de borde, con el formato #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja").
sideIndex Valor constante que indica el lado específico del borde.
estilo Una de las constantes de estilo de línea que especifica el estilo de línea del borde.
weight Especifica el grosor del borde que rodea un rango.
RangeBorderCollection count Número de objetos de borde de la colección.
getItem(index: Excel.BorderIndex) Obtiene un objeto de borde mediante su nombre.
getItemAt(index: number) Obtiene un objeto de borde mediante su índice.
items Obtiene los elementos secundarios cargados en esta colección.
RangeFill clear() Restablece el fondo del intervalo.
color Código de color HTML que representa el color del fondo, con el formato #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja")
RangeFont bold Representa el estado en negrita de la fuente.
color Representación del código de color HTML del color de texto (por ejemplo, #FF0000 representa Rojo).
italic Especifica el estado en cursiva de la fuente.
name Nombre de fuente (por ejemplo, "Calibri").
size Tamaño de fuente.
underline Tipo de subrayado aplicado a la fuente.
RangeFormat borders Colección de objetos de borde que se aplica al rango global seleccionado.
fill Devuelve el objeto de relleno definido en el intervalo global.
font Devuelve el objeto de fuente definido en el rango global.
horizontalAlignment Representa la alineación horizontal del objeto especificado.
verticalAlignment Representa la alineación vertical del objeto especificado.
wrapText Especifica si Excel ajusta el texto del objeto.
Table columnas Representa una colección de todas las columnas de la tabla.
delete() Elimina la tabla.
getDataBodyRange() Obtiene el objeto de rango asociado al cuerpo de datos de la tabla.
getHeaderRowRange() Obtiene el objeto de intervalo asociado a la fila de encabezado de la tabla.
getRange() Obtiene el objeto de rango asociado a toda la tabla.
getTotalRowRange() Obtiene el objeto de intervalo asociado a la fila de totales de la tabla.
id Devuelve un valor que identifica de forma única la tabla de un libro determinado.
name Nombre de la tabla.
rows Representa una colección de todas las filas de la tabla.
showHeaders Especifica si la fila de encabezado está visible.
showTotals Especifica si la fila total está visible.
estilo Valor constante que representa el estilo de tabla.
TableCollection add(address: Range | string, hasHeaders: boolean) Crear una tabla.
count Devuelve el número de tablas del libro.
getItem(key: string) Obtener una tabla por nombre o identificador.
getItemAt(index: number) Obtiene una tabla basada en su posición en la colección.
items Obtiene los elementos secundarios cargados en esta colección.
TableColumn delete() Elimina la columna de la tabla.
getDataBodyRange() Obtiene el objeto de intervalo asociado al cuerpo de datos de la columna.
getHeaderRowRange() Obtiene el objeto de intervalo asociado a la fila de encabezado de la columna.
getRange() Obtiene el objeto de intervalo asociado a toda la columna.
getTotalRowRange() Obtiene el objeto de rango asociado a la fila de totales de la columna.
id Devuelve una clave única que identifica la columna de la tabla.
index Devuelve el número de índice de la columna dentro de la colección de columnas de la tabla.
name Especifica el nombre de la columna de tabla.
values Representa los valores sin formato del rango especificado.
TableColumnCollection add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, name?: string) Agrega una nueva columna a la tabla.
count Devuelve el número de columnas de la tabla.
getItem(key: number | string) Obtiene un objeto de columna por nombre o identificador.
getItemAt(index: number) Obtiene una columna en función de su posición en la colección.
items Obtiene los elementos secundarios cargados en esta colección.
TableRow delete() Elimina la fila de la tabla.
getRange() Devuelve el objeto de rango asociado a toda la fila.
index Devuelve el número de índice de la fila dentro de la colección de filas de la tabla.
values Representa los valores sin formato del rango especificado.
TableRowCollection add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, alwaysInsert?: boolean) Agrega una o más filas a la tabla.
count Devuelve el número de filas de la tabla.
getItemAt(index: number) Obtiene una fila en función de su posición en la colección.
items Obtiene los elementos secundarios cargados en esta colección.
Workbook application Representa la instancia de la aplicación de Excel que contiene este libro.
bindings Representa una colección de enlaces que forman parte del libro.
getSelectedRange() Obtiene el intervalo único seleccionado actualmente del libro.
Nombres Representa una colección de elementos con nombre con ámbito de libro (intervalos y constantes con nombre).
Mesas Representa una colección de tablas asociadas con el libro.
Hojas de trabajo Representa una colección de hojas de cálculo asociadas con el libro.
Worksheet activate() Activa la hoja de cálculo en la interfaz de usuario de Excel.
tablas Devuelve una colección de gráficos que forman parte de la hoja de cálculo.
delete() Elimina la hoja de cálculo del libro.
getCell(row: number, column: number) Obtiene el Range objeto que contiene la celda única en función de los números de fila y columna.
getRange(address?: string) Obtiene el Range objeto , que representa un único bloque rectangular de celdas, especificado por la dirección o el nombre.
id Devuelve un valor que identifica de forma única la hoja de cálculo de un libro determinado.
name Nombre para mostrar de la hoja de cálculo.
position Posición de base cero de la hoja de cálculo dentro del libro.
Mesas Colección de tablas que forman parte de la hoja de cálculo.
Visibilidad Visibilidad de la hoja de cálculo.
WorksheetCollection add(name?: string) Agrega una nueva hoja al libro.
getActiveWorksheet() Obtiene la hoja de cálculo activa del libro.
getItem(key: string) Obtiene un objeto de hoja de cálculo mediante su nombre o identificador.
items Obtiene los elementos secundarios cargados en esta colección.

Vea también