API en versión preliminar de JavaScript de Excel

Las nuevas API de JavaScript de Excel se presentan en "versión preliminar" y pasan a formar parte de un conjunto de requisitos numerado específico después de que se realicen suficientes pruebas y se adquieran suficientes comentarios de los usuarios.

Nota:

Las API en versión preliminar están sujetas a cambios y no están pensadas para su uso en un entorno de producción. Le recomendamos que solo las pruebe en entornos de desarrollo y pruebas. No use las API en versión preliminar en un entorno de producción o en documentos críticos para la empresa.

Usar las API en versión preliminar:

Lista de API

En la tabla siguiente se enumeran las API de JavaScript de Excel actualmente en versión preliminar. Para obtener una lista completa de todas las API de JavaScript de Excel (incluidas las API de versión preliminar y las API publicadas anteriormente), consulte todas las API de JavaScript de Excel.

Clase Campos Descripción
Application formatStaleValues Especifica si la opción Formato de valores obsoletos en las Opciones de cálculo está habilitada o deshabilitada.
AutorunEventCompletedOptions allowEvent Especifica si se permite que el evento continúe.
autorunEventType Especifica el tipo de evento de ejecución automática que se completará, si se permite.
message Si se proporciona, especifica un mensaje de error opcional si no se permite que el evento continúe.
Base64EncodedImage data La cadena codificada en base64.
type El tipo de archivo de la imagen codificada en base64.
Chart getDataRange() Obtiene el origen de datos de todo el gráfico.
getDataRangeOrNullObject() Obtiene el origen de datos de todo el gráfico.
Comment assignTask(asignado: Excel.EmailIdentity) Asigna la tarea adjunta al comentario al usuario especificado como un usuario asignado.
getTask() Obtiene la tarea asociada a este comentario.
getTaskOrNullObject() Obtiene la tarea asociada a este comentario.
CommentReply assignTask(asignado: Excel.EmailIdentity) Asigna la tarea adjunta al comentario al usuario dado como único asignado.
getTask() Obtiene la tarea asociada con este hilo de respuesta de comentario.
getTaskOrNullObject() Obtiene la tarea asociada con este hilo de respuesta de comentario.
DatetimeFormatInfo shortDateTimePattern Obtiene la cadena de formato para un valor de fecha y hora breves.
DocumentTask assign(assignee: Excel.EmailIdentity) Agrega el usuario especificado a la lista de asignados asociados a la tarea.
Usuarios asignados Devuelve una colección de usuarios asignados de la tarea.
Cambios Obtiene los registros de cambios de la tarea.
comment Obtiene el comentario asociado a la tarea.
completedBy Obtiene el usuario más reciente que ha completado la tarea.
completedDateTime Obtiene la fecha y hora en que se completó la tarea.
createdBy Obtiene el usuario que creó la tarea.
createdDateTime Obtiene la fecha y hora en que se creó la tarea.
id Obtiene el identificador de la tarea.
percentComplete Especifica el porcentaje de finalización de la tarea.
prioridad Especifica la prioridad de la tarea.
startAndDueDateTime Especifica la fecha y la hora en que debe iniciarse y vencer la tarea.
title Especifica el título de la tarea.
unassign(assignee: Excel.EmailIdentity) Quita el usuario especificado de la lista de asignados a la tarea.
unassignAll() Quita todos los usuarios de la lista de usuarios asignados a la tarea.
DocumentTaskChange Entidad asignada Representa el usuario asignado a la tarea para una assign acción de cambio o el usuario no asignado de la tarea para una unassign acción de cambio.
changedBy Representa la identidad del usuario que realizó el cambio de tarea.
commentId Representa el identificador del comentario o la respuesta al comentario en el que está anclado el cambio de tarea.
createdDateTime Representa la fecha y hora de creación del registro de cambio de tarea.
dueDateTime Representa la fecha y hora de vencimiento de la tarea.
id El GUID único del cambio de tarea.
percentComplete Representa el porcentaje de finalización de la tarea.
prioridad Representa la prioridad de la tarea.
startDateTime Representa la fecha y hora de inicio de la tarea.
title Representa el título de la tarea.
type Representa el tipo de acción del registro de cambio de tarea.
undoChangeId Representa la DocumentTaskChange.id propiedad que se deshizo para la acción de undo cambio.
DocumentTaskChangeCollection getCount() Obtiene el número de registros de cambios de la colección para la tarea.
getItemAt(index: number) Obtiene un registro de cambio de tarea mediante su índice en la colección.
items Obtiene los elementos secundarios cargados en esta colección.
DocumentTaskCollection getCount() Obtiene el número de tareas de la colección.
getItem(key: string) Obtiene una tarea usando su identificador.
getItemAt(index: number) Obtiene una tarea por su índice en la colección.
getItemOrNullObject(key: string) Obtiene una tarea usando su identificador.
items Obtiene los elementos secundarios cargados en esta colección.
DocumentTaskSchedule dueDateTime Obtiene la fecha y hora de vencimiento de la tarea.
startDateTime Obtiene la fecha y la hora en que debe iniciarse la tarea.
Identidad de correo electrónico displayName Representa el nombre para mostrar del usuario.
email Representa el correo electrónico del usuario.
id Representa el ID. único del usuario.
EntityArrayCardLayout propiedad de matriz Representa el nombre de la propiedad que contiene la matriz que se muestra en la tarjeta.
columnsToReport Representa el recuento de columnas que la tarjeta afirma que están en la matriz.
displayName Representa el nombre de la propiedad que contiene la matriz que se muestra en la tarjeta.
firstRowIsHeader Representa si la primera fila de la matriz se trata como un encabezado.
diseño Representa el tipo de este diseño.
rowsToReport Representa el recuento de filas que la tarjeta afirma que están en la matriz.
ExternalCodeServiceObjectCellValue Python_str Representa la salida de la str() función cuando se usa en este objeto.
Python_type Representa el nombre de tipo completo de este objeto.
Python_typeName Representa el nombre de tipo corto de este objeto.
basicType Representa el valor devuelto por Range.valueTypes para una celda con este valor.
Valor básico Representa el valor devuelto por Range.values para una celda con este valor.
language Representa el lenguaje en tiempo de ejecución de este servicio de código externo.
vista previa Representa el valor de vista previa que se muestra en la celda.
proveedor Representa información sobre el servicio que proporcionó los datos en este ExternalCodeServiceObjectCellValuearchivo .
type Representa el tipo de este valor de celda.
Identity displayName Representa el nombre para mostrar del usuario.
id Representa el ID. único del usuario.
Imagen local getBase64EncodedImageData(cacheUid: string) Obtiene los datos de imagen codificados en base64 almacenados en la memoria caché de imágenes compartida con el identificador único de caché (UID).
LocalImageCellValue texto alternativo Representa el texto alternativo usado en escenarios de accesibilidad para describir lo que representa la imagen.
Atribución Representa la información de atribución para describir el origen y los requisitos de licencia de esta imagen.
basicType Representa el valor devuelto por Range.valueTypes para una celda con este valor.
Valor básico Representa el valor devuelto por Range.values para una celda con este valor.
image Representa la propia imagen, ya sea almacenada en caché o codificada.
proveedor Representa información que describe a la entidad o persona que proporcionó la imagen.
type Representa el tipo de este valor de celda.
LocalImageCellValueCacheId cachedUid Representa el UID de la imagen tal como aparece en la memoria caché.
NameErrorCellValue errorSubType Representa el tipo de NameErrorCellValue.
NamedSheetViewCollection getItemOrNullObject(key: string) Obtiene una vista de hoja con su nombre.
NotAvailableErrorCellValue errorSubType Representa el tipo de NotAvailableErrorCellValue.
PivotLayout getCell(dataHierarchy: DataPivotHierarchy | string, rowItems: Elemento dinámico de matriz<| string>, columnItems: Elemento dinámico de matriz<| string>) Obtiene una única celda de la tabla dinámica en función de una jerarquía de datos y de los elementos de fila y columna de sus respectivas jerarquías.
Estilo dinámico El estilo aplicado a la tabla dinámica.
setStyle(style: string | Estilo de tabla dinámica | BuiltInPivotTableStyle) Establece el estilo aplicado a la tabla dinámica.
PivotTable actualización automática Especifica si la tabla dinámica se actualiza automáticamente cuando cambia el origen de datos.
PythonErrorCellValue basicType Representa el valor devuelto por Range.valueTypes para una celda con este valor.
Valor básico Representa el valor devuelto por Range.values para una celda con este valor.
tipo de error Representa el tipo de ErrorCellValue.
type Representa el tipo de este valor de celda.
Query delete() Elimina la consulta y la conexión asociada.
QueryCollection refreshAll() Actualizar todas las consultas.
Rango togglePythonMarshalMode(marshalMode?: Excel.PythonMarshalMode) Establece el modo de cálculo de comandos de Python en Excel fórmula =PY.
RequestContext sensitivityLabelsCatalog [Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR)]
setInvocation(invocation: { invocationId: number isInSyncExecution: boolean })
SensitivityLabel getCurrentOrNullObject() Obtiene la información de etiqueta actual que existe en el libro para el usuario.
tryToUpdate(labelId: string) Intenta actualizar a la etiqueta de confidencialidad proporcionada en el libro para el usuario.
SensitivityLabelDetails Niños Obtiene las subetiquetas de la etiqueta de confidencialidad.
color Obtiene el color de la etiqueta de confidencialidad.
id Obtiene el identificador único (GUID) de la etiqueta de confidencialidad.
isEnabled Obtiene un valor que indica si la etiqueta está habilitada.
name Obtiene el nombre de la etiqueta de confidencialidad.
order Obtiene la prioridad de la etiqueta de confidencialidad, con 0 como prioridad más baja.
protectionType Obtiene un valor que indica el tipo de protección proporcionada por esta etiqueta.
siteId Obtiene el identificador único (GUID) del espacio empresarial al que pertenece la etiqueta de confidencialidad.
información sobre herramientas Obtiene la descripción de la etiqueta de confidencialidad.
SensitivityLabelDetailsCollection getFirst() Obtiene el primer SensitivityLabelDetails objeto de esta colección.
getFirstOrNullObject() Obtiene el primer SensitivityLabelDetails objeto de esta colección.
items Obtiene los elementos secundarios cargados en esta colección.
SensitivityLabelsCatalog getLabelingCapability Obtiene si el catálogo de etiquetas de confidencialidad está habilitado en Excel.
getLabels() Obtiene etiquetas de confidencialidad que están disponibles para el usuario actual.
ShapeCollection addLocalImageReference(address: string) Crea una referencia para la imagen local almacenada en la dirección de celda y la muestra como una forma flotante sobre las celdas.
addSvg(xml: string) Crea un gráfico vectorial escalable (SVG) de una cadena XML y lo agrega a la hoja de cálculo.
ShapeFont strikethrough Especifica el estado de tachado de la fuente.
subscript Especifica el estado de subíndice de la fuente.
superscript Especifica el estado de superíndice de la fuente.
tintAndShade Especifica un doble que aclara u oscurece un color para la fuente del rango.
Slicer nameInFormula Especifica el nombre de segmentación de datos utilizado en la fórmula.
setStyle(style: string | Estilo de segmentación | BuiltInSlicerStyle) Establece el estilo aplicado a la segmentación de datos.
slicerStyle Estilo aplicado a la segmentación de datos.
Tabla altTextDescription Especifica el texto alternativo de accesibilidad.
altTextTitle Especifica un resumen de la tabla, como el que usan los lectores de pantalla.
clearStyle() Cambia la tabla para usar el estilo de tabla predeterminado.
comment Especifica un comentario asociado a la tabla.
isActive Recupera si la tabla está actualmente activa.
onFiltered Se produce cuando se aplica un filtro a una tabla específica.
setStyle(style: string | TableStyle | BuiltInTableStyle) Establece el estilo aplicado a la tabla.
source Recupera el tipo de origen de datos del que procede la tabla.
tableStyle El estilo aplicado a la tabla.
TableCollection onFiltered Se produce cuando se aplica un filtro a cualquier tabla de un libro o a una hoja de cálculo.
TableFilteredEventArgs tableId Obtiene el identificador de la tabla en la que se aplica el filtro.
type Obtiene el tipo del evento.
worksheetId Obtiene el identificador de la hoja de cálculo que contiene la tabla.
TimeoutErrorCellValue basicType Representa el valor devuelto por Range.valueTypes para una celda con este valor.
Valor básico Representa el valor devuelto por Range.values para una celda con este valor.
errorSubType Representa el tipo de TimeoutErrorCellValue.
tipo de error Representa el tipo de ErrorCellValue.
type Representa el tipo de este valor de celda.
Window rangeSelection Obtiene la selección de rango en la ventana.
Workbook autorunEventCompleted(AutorunEventCompletedOptions: Excel.AutorunEventCompletedOptions) Notifica a la aplicación host que el código del complemento ha terminado de ejecutarse en un evento de ejecución automática.
externalCodeServiceTimeout Especifica el período máximo de tiempo, en segundos, asignado para que se complete una fórmula que depende de un servicio de código externo.
inPreviewMode() Devuelve si el libro está actualmente en modo de vista previa.
imagen local Devuelve el LocalImage objeto asociado al libro.
etiqueta de confidencialidad Devuelve la etiqueta de confidencialidad del libro.
showPivotFieldList Especifica si el panel de lista de campos de la tabla dinámica se muestra en el nivel de libro.
Tasks Devuelve un conjunto de tareas que están presentes en el libro.
use1904DateSystem True si el libro usa el sistema de fechas 1904.
Worksheet onCalculationBusy Se produce cuando las celdas de la hoja de cálculo se calculan de forma asincrónica.
onFiltered Se produce cuando se aplica un filtro en una hoja de cálculo específica.
Tasks Devuelve una colección de tareas que están presentes en la hoja de cálculo.
WorksheetCalculationBusyEventArgs address La dirección de los rangos que comenzaron el cálculo.
source Origen del evento.
type Obtiene el tipo del evento.
worksheetId El identificador de la hoja de cálculo en la que se produjo el cálculo.
WorksheetCollection addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Hoja de cálculo | string) Inserta las hojas de cálculo especificadas de un libro en el libro actual.
onCalculationBusy Se produce cuando las celdas de la hoja de cálculo se calculan de forma asincrónica.
onFiltered Se produce cuando se aplica cualquier filtro de hoja de cálculo al libro.
WorksheetFilteredEventArgs type Obtiene el tipo del evento.
worksheetId Obtiene el identificador de la hoja de cálculo en la que se aplica el filtro.

Vea también

  • Last updated on