Conjunto de requisitos solo en línea de la API de JavaScript de Excel
El ExcelApiOnline conjunto de requisitos es un conjunto de requisitos especial que incluye características que solo están disponibles para Excel en la Web. Las API de este conjunto de requisitos se consideran API de producción (no sujetas a cambios estructurales o de comportamiento no documentados) para la aplicación Excel en la Web.
ExcelApiOnline Las API se consideran api de "versión preliminar" para otras plataformas (Windows, Mac, iOS) y es posible que no sean compatibles con ninguna de esas plataformas.
Cuando las API del ExcelApiOnline conjunto de requisitos se admiten en todas las plataformas, se agregarán al siguiente conjunto de requisitos publicado (ExcelApi 1.[NEXT]). Una vez que el nuevo conjunto de requisitos sea público, esas API se quitarán de ExcelApiOnline. Piense en esto como un proceso de promoción similar a una API que pasa de la versión preliminar a la versión preliminar.
Importante
ExcelApiOnline es un superconjunto del conjunto de requisitos numerado más reciente.
Importante
ExcelApiOnline 1.1 es la única versión de las API solo en línea. Esto se debe a que Excel en la Web siempre tendrá una única versión disponible para los usuarios que sea la versión más reciente.
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 de las API actuales ExcelApiOnline .
| Área de característica | Descripción | Objetos relevantes |
|---|---|---|
| Libros vinculados | Administre vínculos entre libros, incluida la compatibilidad con la actualización y la interrupción de vínculos de libros. | LinkedWorkbook, LinkedWorkbookCollection |
| Vistas de hoja con nombre | Proporciona control mediante programación de vistas de hoja de cálculo por usuario. | NamedSheetView, NamedSheetViewCollection |
| Movimiento de eventos de hoja de cálculo | Detecte cuándo se mueven las hojas de cálculo dentro de una colección, la posición de la hoja de cálculo y el origen del cambio. | WorksheetCollection, WorksheetMovedEventArgs |
| Protección de la hoja de cálculo | Impedir que los usuarios no autorizados realicen cambios en los intervalos especificados dentro de una hoja de cálculo. | WorksheetProtection, AllowEditRange, AllowEditRangeCollection, AllowEditRangeOptions |
Uso recomendado
Dado que ExcelApiOnline las API solo son compatibles con Excel en la Web, el complemento debe comprobar si se admite el conjunto de requisitos antes de llamar a estas API. Esto evita llamar a una API solo en línea en otra plataforma.
if (Office.context.requirements.isSetSupported("ExcelApiOnline", "1.1")) {
// Any API exclusive to the ExcelApiOnline requirement set.
}
Una vez que la API se encuentra en un conjunto de requisitos multiplataforma, debe quitar o editar la isSetSupported comprobación. Esto habilitará la característica del complemento en otras plataformas. Asegúrese de probar la característica en esas plataformas al realizar este cambio.
Importante
El manifiesto no se puede especificar ExcelApiOnline 1.1 como requisito de activación. No es un valor válido para usar en el elemento Set.
Lista de API
En la tabla siguiente se enumeran las API de JavaScript de Excel incluidas actualmente en el conjunto de ExcelApiOnline requisitos. Para obtener una lista completa de todas las API de JavaScript de Excel (incluidas ExcelApiOnline las API y las API publicadas anteriormente), consulte todas las API de JavaScript de Excel.
| Clase | Campos | Descripción |
|---|---|---|
| AllowEditRange | address | Especifica el intervalo asociado al objeto . |
| delete() | Elimina el objeto de .AllowEditRangeCollection |
|
| isPasswordProtected | Especifica si el objeto está protegido con contraseña. | |
| pauseProtection(password?: string) | Pausa la protección de la hoja de cálculo para el objeto para el usuario en la sesión actual. | |
| setPassword(password?: string) | Cambia la contraseña asociada al objeto . | |
| title | Especifica el título del objeto. | |
| AllowEditRangeCollection | add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions) | Agrega un AllowEditRange objeto a la hoja de cálculo. |
| getCount() | Devuelve el número de objetos de AllowEditRange la colección. |
|
| getItem(key: string) | Obtiene el AllowEditRange objeto por su título. |
|
| getItemAt(index: number) | Devuelve un AllowEditRange objeto por su índice en la colección. |
|
| getItemOrNullObject(key: string) | Obtiene el AllowEditRange objeto por su título. |
|
| items | Obtiene los elementos secundarios cargados en esta colección. | |
| pauseProtection(password: string) | Pausa la protección de la hoja de cálculo para todos los AllowEditRange objetos que se encuentran en esta hoja de cálculo que tienen la contraseña especificada para el usuario en la sesión actual. |
|
| AllowEditRangeOptions | password | Contraseña asociada a AllowEditRange. |
| LinkedWorkbook | breakLinks() | Realiza una solicitud para interrumpir los vínculos que apuntan al libro vinculado. |
| id | Dirección URL original que apunta al libro vinculado. | |
| refresh() | Realiza una solicitud para actualizar los datos recuperados del libro vinculado. | |
| LinkedWorkbookCollection | breakAllLinks() | Interrumpe todos los vínculos a los libros vinculados. |
| getItem(key: string) | Obtiene información sobre un libro vinculado por su dirección URL. | |
| getItemOrNullObject(key: string) | Obtiene información sobre un libro vinculado por su dirección URL. | |
| items | Obtiene los elementos secundarios cargados en esta colección. | |
| refreshAll() | Realiza una solicitud para actualizar todos los vínculos del libro. | |
| workbookLinksRefreshMode | Representa el modo de actualización de los vínculos del libro. | |
| NamedSheetView | activate() | Activa esta vista de hoja. |
| delete() | Quita la vista de hoja de la hoja de cálculo. | |
| duplicate(name?: string) | Crea una copia de esta vista de hoja. | |
| name | Obtiene o establece el nombre de la vista de hoja. | |
| NamedSheetViewCollection | add(name: string) | Crea una nueva vista de hoja con el nombre especificado. |
| enterTemporary() | Crea y activa una nueva vista de hoja temporal. | |
| exit() | Sale de la vista de hoja actualmente activa. | |
| getActive() | Obtiene la vista de hoja actualmente activa de la hoja. | |
| getCount() | Obtiene el número de vistas de hoja de esta hoja de cálculo. | |
| getItem(key: string) | Obtiene una vista de hoja con su nombre. | |
| getItemAt(index: number) | Obtiene una vista de hoja por su índice en la colección. | |
| items | Obtiene los elementos secundarios cargados en esta colección. | |
| TableRowCollection | deleteRows(rows: number[] | TableRow[]) | Elimine varias filas de una tabla. |
| deleteRowsAt(index: number, count?: number) | Elimine un número especificado de filas de una tabla, empezando por un índice determinado. | |
| Workbook | linkedWorkbooks | Devuelve una colección de libros vinculados. |
| Worksheet | namedSheetViews | Devuelve una colección de vistas de hoja que están presentes en la hoja de cálculo. |
| WorksheetProtection | allowEditRanges | Especifica el AllowEditRangeCollection objeto encontrado en esta hoja de cálculo. |
| canPauseProtection | Especifica si la protección se puede pausar para esta hoja de cálculo. | |
| checkPassword(password?: string) | Especifica si la contraseña se puede usar para desbloquear la protección de la hoja de cálculo. | |
| isPasswordProtected | Especifica si la hoja está protegida con contraseña. | |
| isPaused | Especifica si la protección de la hoja de cálculo está en pausa. | |
| pauseProtection(password?: string) | Pausa la protección de la hoja de cálculo para el objeto de hoja de cálculo especificado para el usuario en la sesión actual. | |
| resumeProtection() | Reanuda la protección de la hoja de cálculo para el objeto de hoja de cálculo especificado para el usuario en una sesión determinada. | |
| savedOptions | Especifica las opciones de protección guardadas en la hoja de cálculo. | |
| setPassword(password?: string) | Cambia la contraseña asociada al WorksheetProtection objeto . |
|
| updateOptions(options: Excel.WorksheetProtectionOptions) | Cambie las opciones de protección de la hoja de cálculo asociadas al WorksheetProtection objeto . |
|
| WorksheetProtectionChangedEventArgs | allowEditRangesChanged | Especifica si alguno de los AllowEditRange objetos ha cambiado. |
| protectionOptionsChanged | Especifica si ha WorksheetProtectionOptions cambiado. |
|
| sheetPasswordChanged | Especifica si la contraseña de la hoja de cálculo ha cambiado. |