API en versión preliminar de JavaScript de Excel

  • Artículo

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:

En la tabla siguiente se proporciona un resumen conciso de las API, mientras que la tabla de lista de API posterior proporciona una lista detallada.

Área de característica Descripción Objetos relevantes
Tareas de documento Convierta los comentarios en tareas asignadas a los usuarios. DocumentTask, DocumentTaskChange, DocumentTaskChangeCollection, DocumentTaskCollection
Tipos de datos vinculados Agrega compatibilidad con tipos de datos conectados a Excel desde orígenes externos. LinkedDataType, LinkedDataTypeAddedEventArgs, LinkedDataTypeCollection
Estilos de tabla Proporciona control para la fuente, el borde, el color de relleno y otros aspectos de los estilos de tabla. Tabla, tabla dinámica, segmentación de datos

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 Opciones de cálculo está habilitada o deshabilitada.
Base64EncodedImage data Codificación de cadena base64.
type Tipo de archivo de la imagen codificada.
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(assignee: Excel.EmailIdentity) Asigna la tarea adjunta al comentario al usuario especificado como usuario asignado.
getTask() Obtiene la tarea asociada a este comentario.
getTaskOrNullObject() Obtiene la tarea asociada a este comentario.
CommentReply assignTask(assignee: Excel.EmailIdentity) Asigna la tarea adjunta al comentario al usuario especificado como único asignador.
getTask() Obtiene la tarea asociada al subproceso de esta respuesta de comentario.
getTaskOrNullObject() Obtiene la tarea asociada al subproceso de esta respuesta de comentario.
DocumentTask assign(assignee: Excel.EmailIdentity) Agrega el usuario especificado a la lista de asignados adjuntos a la tarea.
Cesionarios Devuelve una colección de 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 Obtiene o establece la fecha y hora en que se debe iniciar la tarea y que se vence.
title Especifica el título de la tarea.
unassign(assignee: Excel.EmailIdentity) Quita el usuario especificado de la lista de asignados adjuntos a la tarea.
unassignAll() Quita todos los usuarios de la lista de asignados adjuntos a la tarea.
DocumentTaskChange Cesionario Representa el usuario asignado a la tarea para una assign acción de cambio o el usuario no asignado a 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 de comment o commentReply al que está delimitado 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 deshacía para la acción de undo cambio.
DocumentTaskChangeCollection getCount() Obtiene el número de registros de cambios de la colección de 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 con su identificador.
getItemAt(index: number) Obtiene una tarea por su índice en la colección.
getItemOrNullObject(key: string) Obtiene una tarea con 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 hora en que debe iniciarse la tarea.
EmailIdentity displayName Representa el nombre para mostrar del usuario.
email Representa el correo electrónico del usuario.
id Representa el identificador único del usuario.
EntityArrayCardLayout arrayProperty Representa el nombre de la propiedad que contiene la matriz que se muestra en la tarjeta.
columnsToReport Representa el recuento de columnas que las notificaciones de tarjeta 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 las notificaciones de tarjeta están en la matriz.
EntityCardLayout Diseño Representa el tipo de este diseño.
ExternalCodeServiceObjectCellValue Python_str Representa la salida de la función str() 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 que devolvería Range.valueTypes para una celda con este valor.
basicValue Representa el valor que devolvería 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.
type Representa el tipo de este valor de celda.
Identity displayName Representa el nombre para mostrar del usuario.
id Representa el identificador único del usuario.
LinkedDataType Dataprovider Nombre del proveedor de datos para el tipo de datos vinculado.
lastRefreshed Fecha y hora de la zona horaria local desde que se abrió el libro cuando se actualizó por última vez el tipo de datos vinculado.
name Nombre del tipo de datos vinculado.
periodicRefreshInterval Frecuencia, en segundos, en la que se actualiza el tipo de datos vinculado si refreshMode se establece en "Periódico".
refreshMode Mecanismo por el que se recuperan los datos del tipo de datos vinculado.
requestRefresh() Realiza una solicitud para actualizar el tipo de datos vinculado.
requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode) Realiza una solicitud para cambiar el modo de actualización de este tipo de datos vinculado.
serviceId Identificador único del tipo de datos vinculado.
supportedRefreshModes Devuelve una matriz con todos los modos de actualización admitidos por el tipo de datos vinculado.
LinkedDataTypeAddedEventArgs serviceId Identificador único del nuevo tipo de datos vinculado.
source Obtiene el origen del evento.
type Obtiene el tipo del evento.
LinkedDataTypeCollection getCount() Obtiene el número de tipos de datos vinculados de la colección.
getItem(key: number) Obtiene un tipo de datos vinculado por identificador de servicio.
getItemAt(index: number) Obtiene un tipo de datos vinculado por su índice en la colección.
getItemOrNullObject(key: number) Obtiene un tipo de datos vinculado por identificador.
items Obtiene los elementos secundarios cargados en esta colección.
requestRefreshAll() Realiza una solicitud para actualizar todos los tipos de datos vinculados de la colección.
LocalImageCellValue altText Representa el texto alternativo que se usa en escenarios de accesibilidad para describir lo que representa la imagen.
Atribución Representa información de atribución para describir los requisitos de origen y licencia de esta imagen.
basicType Representa el valor que devolvería Range.valueTypes para una celda con este valor.
basicValue Representa el valor que devolvería Range.values para una celda con este valor.
image Representa la propia imagen, almacenada en caché o codificada.
Proveedor Representa información que describe la entidad o la persona que proporcionó la imagen.
type Representa el tipo de este valor de celda.
LocalImageCellValueCacheId cacheUid Representa el UID de la imagen tal como aparece en la memoria caché.
NamedSheetViewCollection getItemOrNullObject(key: string) Obtiene una vista de hoja con su nombre.
PivotLayout getCell(dataHierarchy: DataPivotHierarchy | string, rowItems: Array<PivotItem | string>, columnItems: Array<PivotItem | 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.
pivotStyle Estilo aplicado a la tabla dinámica.
setStyle(style: string | PivotTableStyle | BuiltInPivotTableStyle) Establece el estilo aplicado a la tabla dinámica.
PythonErrorCellValue basicType Representa el valor que devolvería Range.valueTypes para una celda con este valor.
basicValue Representa el valor que devolvería Range.values para una celda con este valor.
Errortype Representa el tipo de ErrorCellValue.
type Representa el tipo de este valor de celda.
Query delete() Elimina la consulta y la conexión asociada.
refresh() Actualiza la consulta.
QueryCollection refreshAll() Actualice todas las consultas.
Rango
RangeAreas
RefreshModeChangedEventArgs refreshMode Modo de actualización del tipo de datos vinculado.
serviceId Identificador único del objeto cuyo modo de actualización se ha cambiado.
source Obtiene el origen del evento.
type Obtiene el tipo del evento.
RefreshRequestCompletedEventArgs Renovados Indica si la solicitud de actualización se realizó correctamente.
serviceId Identificador único del objeto cuya solicitud de actualización se completó.
source Obtiene el origen del evento.
type Obtiene el tipo del evento.
Advertencias Matriz que contiene las advertencias generadas a partir de la solicitud de actualización.
ShapeCollection addSvg(xml: string) Crea un gráfico vectorial escalable (SVG) de una cadena XML y lo agrega a la hoja de cálculo.
Slicer nameInFormula Indica el nombre de la segmentación usado en la fórmula.
setStyle(style: string | SlicerStyle | BuiltInSlicerStyle) Establece el estilo aplicado a la segmentación de datos.
slicerStyle Estilo aplicado a la segmentación de datos.
Table clearStyle() Cambia la tabla para usar el estilo de tabla predeterminado.
onFiltered Se produce cuando se aplica un filtro en una tabla específica.
setStyle(style: string | TableStyle | BuiltInTableStyle) Establece el estilo aplicado a la tabla.
tableStyle Estilo aplicado a la tabla.
TableCollection onFiltered Se produce cuando se aplica un filtro en cualquier tabla de un libro o 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 que devolvería Range.valueTypes para una celda con este valor.
basicValue Representa el valor que devolvería Range.values para una celda con este valor.
errorSubType Representa el tipo de TimeoutErrorCellValue.
Errortype Representa el tipo de ErrorCellValue.
type Representa el tipo de este valor de celda.
Workbook externalCodeServiceTimeout Especifica la longitud máxima de tiempo, en segundos, que se asigna a una fórmula que depende de que se complete un servicio de código externo.
linkedDataTypes Devuelve una colección de tipos de datos vinculados que forman parte 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 una colección de tareas que están presentes en el libro.
use1904DateSystem True si el libro usa el sistema de fechas 1904.
Worksheet 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.
WorksheetCollection addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Worksheet | string) Inserta las hojas de cálculo especificadas de un libro en el libro actual.
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