Partager via

Version d’évaluation API JavaScript Excel

  • Article

Les nouvelles Excel JavaScript APIs introduits dans « Aperçu » et versions ultérieures deviennent partie intégrante d’une exigence spécifique, numérotée définie après que test suffisantes se produit et les commentaires des utilisateurs sont acquis.

Remarque

L’aperçu API peut être modifiés et n’est pas destinés à utiliser dans un environnement de production. Nous vous recommandons de les tester uniquement dans les environnements de test et de développement. N’utilisez pas un aperçu d’API dans un environnement de production ou dans les documents commerciaux importants.

Pour utiliser les API disponibles en préversion :

Le tableau suivant fournit un résumé concis des API, tandis que le tableau de liste d’API suivant fournit une liste détaillée.

Fonctionnalité Description Objets pertinents
Tâches de document Transformez les commentaires en tâches attribuées aux utilisateurs. DocumentTask, DocumentTaskChange, DocumentTaskChangeCollection, DocumentTaskCollection
Types de données liés Ajoute la prise en charge des types de données connectés à Excel à partir de sources externes. LinkedDataType, LinkedDataTypeAddedEventArgs, LinkedDataTypeCollection
Styles de tableau Fournit un contrôle pour la police, la bordure, la couleur de remplissage et d’autres aspects des styles de tableau. Tableau, tableau croisé dynamique, segment

Liste des API

Le tableau suivant répertorie les API JavaScript Excel actuellement en préversion. Pour obtenir la liste complète de toutes les API JavaScript Excel (y compris les API en préversion et les API précédemment publiées), consultez toutes les API JavaScript Excel.

Classe Champs Description
Application formatStaleValues Spécifie si l’option Mettre en forme les valeurs obsolètes dans Options de calcul est activée ou désactivée.
Base64EncodedImage data Encodage de chaîne base64.
type Type de fichier de l’image encodée.
Graphique getDataRange() Obtient la source de données de l’ensemble du graphique.
getDataRangeOrNullObject() Obtient la source de données de l’ensemble du graphique.
Case à cocherCellControl type Représente un contrôle interagissant à l’intérieur d’une cellule.
Commentaire assignTask(assignee : Excel.EmailIdentity) Affecte la tâche jointe au commentaire à l’utilisateur donné en tant que destinataire.
getTask() Obtient la tâche associée à ce commentaire.
getTaskOrNullObject() Obtient la tâche associée à ce commentaire.
CommentReply assignTask(assignee : Excel.EmailIdentity) Affecte la tâche jointe au commentaire à l’utilisateur donné en tant que seul destinataire.
getTask() Obtient la tâche associée au thread de cette réponse de commentaire.
getTaskOrNullObject() Obtient la tâche associée au thread de cette réponse de commentaire.
DatetimeFormatInfo shortDateTimePattern Obtient la chaîne de format pour une valeur de date et d’heure courte.
DocumentTask assign(assignee : Excel.EmailIdentity) Ajoute l’utilisateur donné à la liste des personnes associées à la tâche.
Cessionnaires Retourne une collection de personnes assignées de la tâche.
changements Obtient les enregistrements de modification de la tâche.
comment Obtient le commentaire associé à la tâche.
completedBy Obtient l’utilisateur le plus récent à avoir terminé la tâche.
completedDateTime Obtient la date et l’heure auxquelles la tâche a été terminée.
createdBy Obtient l’utilisateur qui a créé la tâche.
createdDateTime Obtient la date et l’heure de création de la tâche.
id Obtient l’ID de la tâche.
percentComplete Spécifie le pourcentage d’achèvement de la tâche.
priorité Spécifie la priorité de la tâche.
startAndDueDateTime Obtient ou définit la date et l’heure à laquelle la tâche doit démarrer et est arrivée à échéance.
title Spécifie le titre de la tâche.
unassign(assignee : Excel.EmailIdentity) Supprime l’utilisateur donné de la liste des ayants droit attachés à la tâche.
unassignAll() Supprime tous les utilisateurs de la liste des ayants droit attachés à la tâche.
DocumentTaskChange cessionnaire Représente l’utilisateur affecté à la tâche pour une assign action de modification, ou l’utilisateur non affecté à la tâche pour une unassign action de modification.
changedBy Représente l’identité de l’utilisateur qui a modifié la tâche.
commentId Représente l’ID de la réponse au commentaire ou au commentaire auquel la modification de tâche est ancrée.
createdDateTime Représente la date et l’heure de création de l’enregistrement de modification de tâche.
dueDateTime Représente la date et l’heure d’échéance de la tâche.
id GUID unique de la modification de la tâche.
percentComplete Représente le pourcentage d’achèvement de la tâche.
priorité Représente la priorité de la tâche.
startDateTime Représente la date et l’heure de début de la tâche.
title Représente le titre de la tâche.
type Représente le type d’action de l’enregistrement de modification de tâche.
undoChangeId Représente la DocumentTaskChange.id propriété qui a été annulée pour l’action de undo modification.
DocumentTaskChangeCollection getCount() Obtient le nombre d’enregistrements de modification dans la collection pour la tâche.
getItemAt(index: number) Obtient un enregistrement de modification de tâche à l’aide de son index dans la collection.
items Obtient l’élément enfant chargé dans cette collection de sites.
DocumentTaskCollection getCount() Obtient le nombre de tâches dans la collection.
getItem(key: string) Obtient une tâche à l’aide de son ID.
getItemAt(index: number) Obtient une tâche en fonction de son index dans la collection.
getItemOrNullObject(key: string) Obtient une tâche à l’aide de son ID.
items Obtient l’élément enfant chargé dans cette collection de sites.
DocumentTaskSchedule dueDateTime Obtient la date et l’heure d’échéance de la tâche.
startDateTime Obtient la date et l’heure de début de la tâche.
EmailIdentity displayName Représente le nom d’affichage de l’utilisateur.
email Représente l’e-mail de l’utilisateur.
id Représente l’ID unique de l’utilisateur.
EmptyCellControl type
EntityArrayCardLayout arrayProperty Représente le nom de la propriété qui contient le tableau affiché dans le carte.
columnsToReport Représente le nombre de colonnes dans lesquelles les revendications carte se trouvent dans le tableau.
displayName Représente le nom de la propriété qui contient le tableau affiché dans le carte.
firstRowIsHeader Représente si la première ligne du tableau est traitée comme un en-tête.
disposition Représente le type de cette disposition.
rowsToReport Représente le nombre de lignes dans lesquelles les revendications carte se trouvent dans le tableau.
EntityCardLayout disposition Représente le type de cette disposition.
ExternalCodeServiceObjectCellValue Python_str Représente la sortie de la fonction str() lorsqu’elle est utilisée sur cet objet.
Python_type Représente le nom de type complet de cet objet.
Python_typeName Représente le nom de type court de cet objet.
basicType Représente la valeur qui serait retournée par Range.valueTypes pour une cellule avec cette valeur.
basicValue Représente la valeur qui serait retournée par Range.values pour une cellule avec cette valeur.
language Représente le langage d’exécution de ce service de code externe.
aperçu Représente la valeur d’aperçu affichée dans la cellule.
type Représente le type de cette valeur de cellule.
Identity displayName Représente le nom d’affichage de l’utilisateur.
id Représente l’ID unique de l’utilisateur.
LinkedDataType dataProvider Nom du fournisseur de données pour le type de données lié.
lastRefreshed Date et heure du fuseau horaire local depuis l’ouverture du classeur lors de la dernière actualisation du type de données lié.
name Nom du type de données lié.
periodicRefreshInterval Fréquence, en secondes, à laquelle le type de données lié est actualisé si refreshMode est défini sur « Périodique ».
refreshMode Mécanisme par lequel les données du type de données lié sont récupérées.
requestRefresh() Effectue une demande d’actualisation du type de données lié.
requestSetRefreshMode(refreshMode : Excel.LinkedDataTypeRefreshMode) Effectue une demande de modification du mode d’actualisation pour ce type de données lié.
serviceId ID unique du type de données lié.
supportedRefreshModes Retourne un tableau avec tous les modes d’actualisation pris en charge par le type de données lié.
LinkedDataTypeAddedEventArgs serviceId ID unique du nouveau type de données lié.
source Obtient la source de l’événement.
type Obtient le type de l’événement.
LinkedDataTypeCollection getCount() Obtient le nombre de types de données liés dans la collection.
getItem(key : number) Obtient un type de données lié par ID de service.
getItemAt(index: number) Obtient un type de données lié par son index dans la collection.
getItemOrNullObject(key : number) Obtient un type de données lié par ID.
items Obtient l’élément enfant chargé dans cette collection de sites.
requestRefreshAll() Effectue une demande d’actualisation de tous les types de données liés dans la collection.
LocalImage getBase64EncodedImageData(cacheUid : string) Obtient les données d’image encodées en Base64 stockées dans le cache d’images partagées avec l’identificateur unique de cache (UID).
LocalImageCellValue altText Représente le texte de remplacement utilisé dans les scénarios d’accessibilité pour décrire ce que l’image représente.
attribution Représente les informations d’attribution pour décrire la source et les exigences de licence pour cette image.
basicType Représente la valeur qui serait retournée par Range.valueTypes pour une cellule avec cette valeur.
basicValue Représente la valeur qui serait retournée par Range.values pour une cellule avec cette valeur.
image Représente l’image elle-même, mise en cache ou encodée.
fournisseur Représente des informations qui décrivent l’entité ou la personne qui a fourni l’image.
type Représente le type de cette valeur de cellule.
LocalImageCellValueCacheId cacheUid Représente l’UID de l’image telle qu’elle apparaît dans le cache.
MixedCellControl type
NamedSheetViewCollection getItemOrNullObject(key: string) Obtient une vue de feuille à l’aide de son nom.
PivotLayout getCell(dataHierarchy : DataPivotHierarchy | string, rowItems : Array<PivotItem | string>, columnItems : Array<PivotItem | string>) Obtient une cellule unique dans le tableau croisé dynamique basé sur une hiérarchie de données ainsi que les éléments de ligne et de colonne de leurs hiérarchies respectives.
pivotStyle Style appliqué au tableau croisé dynamique.
setStyle(style : string | PivotTableStyle | BuiltInPivotTableStyle) Définit le style appliqué au tableau croisé dynamique.
PythonErrorCellValue basicType Représente la valeur qui serait retournée par Range.valueTypes pour une cellule avec cette valeur.
basicValue Représente la valeur qui serait retournée par Range.values pour une cellule avec cette valeur.
errorType Représente le type de ErrorCellValue.
type Représente le type de cette valeur de cellule.
Query delete() Supprime la requête et la connexion associée.
refresh() Actualise la requête.
QueryCollection refreshAll() Actualisez toutes les requêtes.
Range clearOrResetContents() Efface les valeurs des cellules de la plage, avec une attention particulière accordée aux cellules contenant des contrôles.
contrôle Accède au contrôle de cellule appliqué à cette plage.
RangeAreas clearOrResetContents() Efface les valeurs des cellules dans les plages, avec une attention particulière accordée aux cellules contenant des contrôles.
RangeTextRun police
text
RefreshModeChangedEventArgs refreshMode Mode d’actualisation du type de données lié.
serviceId ID unique de l’objet dont le mode d’actualisation a été modifié.
source Obtient la source de l’événement.
type Obtient le type de l’événement.
RefreshRequestCompletedEventArgs dispos Indique si la demande d’actualisation a réussi.
serviceId ID unique de l’objet dont la demande d’actualisation a été effectuée.
source Obtient la source de l’événement.
type Obtient le type de l’événement.
Avertissements Tableau qui contient les avertissements générés à partir de la demande d’actualisation.
SettableCellProperties textRuns Représente la textRuns propriété.
ShapeCollection addLocalImageReference(address : string) Crée une référence pour l’image locale stockée dans l’adresse de cellule et l’affiche sous la forme d’une forme flottante sur les cellules.
addSvg(xml: string) Crée un graphique de fichiers SVG (SVG) à partir d’une chaîne XML et il est ajouté à la feuille de calcul.
Segment nameInFormula Représente le nom du segment utilisé dans la formule.
setStyle(style : string | SlicerStyle | BuiltInSlicerStyle) Définit le style appliqué au segment.
slicerStyle Style appliqué au segment.
Tableau clearStyle() Modifie le tableau pour utiliser le style de tableau par défaut.
onFiltered Se produit lorsqu’un filtre est appliqué à une table spécifique.
setStyle(style : string | TableStyle | BuiltInTableStyle) Définit le style appliqué au tableau.
tableStyle Style appliqué au tableau.
TableCollection onFiltered Se produit lorsqu’un filtre est appliqué à une table d’un classeur ou d’une feuille de calcul.
TableFilteredEventArgs tableId Obtient l’ID de la table dans laquelle le filtre est appliqué.
type Obtient le type de l’événement.
worksheetId Obtient l’ID de la feuille de calcul qui contient le tableau.
TimeoutErrorCellValue basicType Représente la valeur qui serait retournée par Range.valueTypes pour une cellule avec cette valeur.
basicValue Représente la valeur qui serait retournée par Range.values pour une cellule avec cette valeur.
errorSubType Représente le type de TimeoutErrorCellValue.
errorType Représente le type de ErrorCellValue.
type Représente le type de cette valeur de cellule.
UnknownCellControl type
Classeur externalCodeServiceTimeout Spécifie la durée maximale, en secondes, allouée à une formule qui dépend d’un service de code externe.
linkedDataTypes Retourne une collection de types de données liés qui font partie du classeur.
localImage Retourne l’objet LocalImage associé au classeur.
showPivotFieldList Spécifie si le volet liste de champs du tableau croisé dynamique s’affiche au niveau du classeur.
tâches Retourne une collection de tâches présentes dans le classeur.
use1904DateSystem True si le classeur utilise le calendrier depuis 1904.
Worksheet onFiltered Se produit lorsqu’un filtre est appliqué à une feuille de calcul spécifique.
tâches Retourne une collection de tâches présentes dans la feuille de calcul.
WorksheetCollection addFromBase64(base64File : string, sheetNamesToInsert ?: string[], positionType ?: Excel.WorksheetPositionType, relativeTo ?: Worksheet | string) Insère les feuilles de calcul spécifiées d’un classeur dans le classeur actif.
onFiltered Se produit lorsqu’un filtre de la feuille de calcul est appliqué dans le classeur.
WorksheetFilteredEventArgs type Obtient le type de l’événement.
worksheetId Obtient l’ID de la feuille de calcul dans laquelle le filtre est appliqué.

Voir aussi