Modèle d’objet JavaScript Excel dans les compléments Office

• 09/03/2020
• 4 minutes à lire
• • o
  • R
  • A
  • l
  • m
  • +4

Cet article décrit comment utiliser l’API JavaScript Excel pour créer des compléments pour Excel 2016 ou une version ultérieure. Il introduit des concepts de base fondamentaux pour l’utilisation de l’API et fournit des conseils pour effectuer des tâches spécifiques telles que la lecture ou l’écriture sur une large plage, la mise à jour de toutes les cellules de la plage, etc.

Bureau.api js pour Excel

Un complément Excel interagit avec des objets dans Excel à l’aide de l’API JavaScript Office, qui comprend deux modèles d’objets JavaScript:

• API JavaScript Excel : Introduite avec Office 2016, l’API JavaScript Excel fournit des objets fortement typés que vous pouvez utiliser pour accéder à des feuilles de calcul, des plages, des tableaux, des graphiques, etc.

• API communes : Introduite avec Office 2013, l’API commune peut être utilisée pour accéder à des fonctionnalités telles que l’interface utilisateur, les boîtes de dialogue et les paramètres clients communs à plusieurs types d’applications Office.

Bien que vous utilisiez probablement l’API JavaScript Excel pour développer la majorité des fonctionnalités des compléments ciblant Excel 2016 ou une version ultérieure, vous utiliserez également des objets dans l’API commune. Par exemple:

• Contexte : L’objet Context représente l’environnement d’exécution du complément et donne accès aux objets clés de l’API. Il se compose de détails de configuration de classeur tels que contentLanguage et officeTheme et fournit également des informations sur l’environnement d’exécution du complément tel que host et platform. En outre, il fournit la méthode requirements.isSetSupported(), que vous pouvez utiliser pour vérifier si l’ensemble d’exigences spécifié est pris en charge par l’application Excel sur laquelle le complément est en cours d’exécution.Document
• : L’objet Document fournit la méthode getFileAsync(), que vous pouvez utiliser pour télécharger le fichier Excel dans lequel le complément est en cours d’exécution.

L’image suivante montre quand vous pouvez utiliser l’API JavaScript Excel ou les API communes.

Modèle d’objet spécifique à Excel

Pour comprendre les API Excel, vous devez comprendre comment les composants d’un classeur sont liés les uns aux autres.

• Un classeur contient une ou plusieurs feuilles de calcul.
• Une feuille de calcul contient des collections des objets de données présents dans la feuille individuelle et donne accès aux cellules via des objets de plage.
• Une plage représente un groupe de cellules contiguës.Les plages
• sont utilisées pour créer et placer des tables, des Graphiques, des formes et d’autres objets de visualisation de données ou d’organisation.Les classeurs
• contiennent des collections de certains de ces objets de données (tels que des tables) pour l’ensemble du classeur.

Plages

Une plage est un groupe de cellules contiguës dans le classeur. Les compléments utilisent généralement une notation de style A1 (par exemple, B3 pour la cellule unique de la colonne B et de la ligne 3 ou C2: F4 pour les cellules des colonnes C à F et des lignes 2 à 4) pour définir des plages.Les plages

ont trois propriétés principales : values, formulas et format. Ces propriétés obtiennent ou définissent les valeurs de cellules, les formules à évaluer et le formatage visuel des cellules.

Échantillon de plage

L’exemple suivant montre comment créer des enregistrements de ventes. Cette fonction utilise des objets Range pour définir les valeurs, les formules et les formats.

Cet exemple crée les données suivantes dans la feuille de calcul en cours:

Pour plus d’informations, consultez Travailler avec des plages à l’aide de l’API JavaScript Excel.

Graphiques, tableaux et autres objets de données

Les API JavaScript Excel peuvent créer et manipuler les structures de données et les visualisations dans Excel. Les tableaux et les graphiques sont deux des objets les plus couramment utilisés, mais les API prennent en charge les tableaux croisés dynamiques, les formes, les images, etc.

Création d’une table

Créez des tables à l’aide de plages remplies de données. Les contrôles de mise en forme et de table (tels que les filtres) sont automatiquement appliqués à la plage.

L’échantillon suivant crée un tableau en utilisant les plages de l’échantillon précédent.

L’utilisation de cet exemple de code sur la feuille de calcul avec les données précédentes crée le tableau suivant:

Pour plus d’informations, consultez Travailler avec des tableaux à l’aide de l’API JavaScript Excel.

Création d’un graphique

Créez des graphiques pour visualiser les données dans une plage. Les API prennent en charge des dizaines de variétés de graphiques, chacune pouvant être personnalisée en fonction de vos besoins.

L’exemple suivant crée un graphique à colonnes simple pour trois éléments et le place 100 pixels sous le haut de la feuille de calcul.

L’exécution de cet exemple sur la feuille de calcul avec le tableau précédent crée le graphique suivant:

Pour plus d’informations, consultez Travailler avec des graphiques à l’aide de l’API JavaScript Excel.

Voir aussi