Nouveautés de l’API JavaScript 1.7 pour Excel

  • Article

Les fonctionnalités Excel JavaScript API ensemble de conditions 1.7 incluent des API pour les graphiques, événements, feuilles de calcul, plages, propriétés de document, éléments nommés, options de protection et styles.

Personnaliser des graphiques

Avec le nouvel API graphique, vous pouvez créer des types de graphiques supplémentaires, ajouter une série de données à un graphique, définir le titre du graphique, ajouter un titre d’axe, ajouter une unité d’affichage, ajouter une courbe de tendance avec moyenne mobile, modifier une courbe de tendance en ligne, et bien plus encore. Voici quelques exemples.

  • Axe du graphique - obtenir, définir, mettre en forme et supprimer une unité d’axe, une étiquette et un titre dans un graphique.
  • Série de graphique - ajouter, configurer et supprimer une série dans un graphique. Modifier les marqueurs de série, les commandes traçage et le redimensionnement.
  • Courbes de tendance de graphique - ajouter, obtenir et mettre en forme des courbes de tendance dans un graphique.
  • Légende de graphique - mettre en forme la police de légende dans un graphique.
  • Point de graphique - définir la couleur du point de graphique.
  • Sous-chaîne de titre de graphique : obtenir et définir la sous-chaîne de titre d’un graphique.
  • Type de graphique - option pour créer plusieurs types de graphiques.

Événements

Les API Événements pour Excel fournissent un grand nombre de gestionnaires d’événements autorisant votre complément à exécuter automatiquement une fonction désignée lorsqu’un événement spécifique se produit. Vous pouvez créer cette fonction pour effectuer n’importe quelle action nécessaire à votre scénario. Pour une liste des événements qui sont actuellement disponibles, voir Manipuler des Événements à l’aide de l’API JavaScript Excel.

Personnaliser l’apparence de feuilles de calcul et des plages

À l’aide des nouveaux API, vous pouvez personnaliser l’apparence de feuilles de calcul de plusieurs façons :

  • Figer les volets pour conserver certaines lignes ou colonnes visibles lorsque vous faites défiler la feuille de calcul. Par exemple, si la première ligne dans votre feuille de calcul contient des en-têtes, vous pouvez figer cette ligne de sorte que les en-têtes de colonne restent visibles pendant le défilement vers le bas de la feuille de calcul.
  • Modifier la couleur d’onglet de la feuille de calcul.
  • Ajouter des en-têtes de feuille de calcul.

Vous pouvez personnaliser l’apparence des plages de plusieurs façons :

  • Définir le style de cellule pour une plage pour vous assurer que toutes les cellules dans la plage ont une mise en forme cohérente. Un style de cellule est un ensemble défini de caractéristiques de mise en forme, comme les polices et les tailles de police, formats des nombres, bordures de cellule et ombrage de cellule. Utilisez un des styles de cellule intégrés d’Excel ou créer votre propre style de cellule personnalisé.
  • Définit l’orientation du texte pour une plage.
  • Ajouter ou modifier un lien hypertexte sur une plage qui permet d’accéder à un autre emplacement dans le classeur ou à un emplacement externe.

Gérer les propriétés du document

À l’aide des API de propriétés du document, vous pouvez accéder aux propriétés de document intégrées et également créer et gérer les propriétés de document personnalisées pour stocker l’état du classeur et lire le flux de travail et la logique d’entreprise.

Obtenir des feuilles de calcul

À l’aide des API de copie de feuille de calcul , vous pouvez copier les données et le format à partir d’une feuille de calcul dans une nouvelle feuille de calcul au sein du même classeur et réduire la quantité de transfert de données nécessaire.

Gérer les plages en toute simplicité

À l’aide des API de plage différente, vous pouvez effectuer des actions telles qu’obtenir la région environnante, obtenir une plage redimensionnée et bien plus encore. Ces API doivent rendre des tâches telles que la manipulation de plage et l’adressage beaucoup plus efficaces.

De plus :

  • Options de protection de classeur et feuille de calcul : utilisez ces API pour protéger les données dans une feuille de calcul et la structure du classeur.
  • Mettre à jour un élément nommé : utilisez cet API pour mettre à jour un élément nommé.
  • Obtenir une cellule active : utilisez cette API pour obtenir la cellule active d’un classeur.

Liste des API

Le tableau suivant répertorie les API dans l’ensemble de conditions requises de l’API JavaScript Excel 1.7. Pour afficher la documentation de référence des API pour toutes les API prises en charge par l’ensemble de conditions requises de l’API JavaScript Excel 1.7 ou version antérieure, consultez API Excel dans l’ensemble de conditions requises 1.7 ou antérieur.

Classe Champs Description
Graphique chartType Spécifie le type du graphique.
id L’ID unique du graphique.
showAllFieldButtons Spécifie s’il faut afficher tous les boutons de champ sur un graphique croisé dynamique.
ChartAreaFormat bordure Représente le format de bordure de la zone de graphique, qui inclut la couleur, le style de trait et le poids.
ChartAxes getItem(type: Excel.ChartAxisType, group?: Excel.ChartAxisGroup) Renvoie l’axe spécifique identifié par type et par groupe.
ChartAxis axisGroup Spécifie le groupe pour l’axe spécifié.
baseTimeUnit Spécifie l’unité de base pour l’axe des catégories spécifié.
categoryType Spécifie le type d’axe des catégories.
customDisplayUnit Spécifie la valeur d’unité d’affichage de l’axe personnalisé.
displayUnit Représente l’unité d’affichage de l’axe.
height Spécifie la hauteur, en points, de l’axe du graphique.
left Spécifie la distance, en points, entre le bord gauche de l’axe et la gauche de la zone de graphique.
logBase Spécifie la base du logarithme lors de l’utilisation d’échelles logarithmiques.
majorTickMark Spécifie le type de graduation principale pour l’axe spécifié.
majorTimeUnitScale Spécifie la valeur d’échelle d’unité principale pour l’axe des catégories lorsque la propriété a la categoryType valeur dateAxis.
minorTickMark Spécifie le type de graduation mineure pour l’axe spécifié.
minorTimeUnitScale Spécifie la valeur d’échelle d’unité mineure pour l’axe des catégories lorsque la propriété a la categoryType valeur dateAxis.
reversePlotOrder Spécifie si Excel trace les points de données du dernier au premier.
scaleType Spécifie le type d’échelle de l’axe des valeurs.
setCategoryNames(sourceData: Range) Définit tous les noms de catégorie pour l’axe spécifié.
setCustomDisplayUnit(value: number) Définit l’unité d’affichage axe sur une valeur personnalisée.
showDisplayUnitLabel Spécifie si l’étiquette d’unité d’affichage de l’axe est visible.
tickLabelPosition Spécifie la position des étiquettes de graduation sur l'axe spécifié.
tickLabelSpacing Spécifie le nombre de catégories ou de séries entre les étiquettes de graduation.
tickMarkSpacing Spécifie le nombre de catégories ou de séries entre les graduations.
top Spécifie la distance, en points, entre le bord supérieur de l’axe et le haut de la zone de graphique.
type Spécifie le type d’axe.
visible Spécifie si l’axe est visible.
width Spécifie la largeur, en points, de l’axe du graphique.
ChartBorder color Code couleur HTML qui représente la couleur des bordures dans le graphique.
lineStyle Représente le style de trait de la bordure.
weight Représente l’épaisseur de bordure, en points.
ChartDataLabel position Valeur qui représente la position de l’étiquette de données.
Séparateur Chaîne représentant le séparateur utilisé pour les étiquettes de données d’un graphique.
showBubbleSize Spécifie si la taille de la bulle d’étiquette de données est visible.
showCategoryName Spécifie si le nom de la catégorie d’étiquette de données est visible.
showLegendKey Spécifie si la clé de légende d’étiquette de données est visible.
showPercentage Spécifie si le pourcentage d’étiquette de données est visible.
showSeriesName Spécifie si le nom de la série d’étiquettes de données est visible.
showValue Spécifie si la valeur de l’étiquette de données est visible.
ChartFormatString police Représente les attributs de police, tels que le nom de police, la taille de police et la couleur d’un objet de caractères de graphique.
ChartLegend height Spécifie la hauteur, en points, de la légende sur le graphique.
left Spécifie la valeur de gauche, en points, de la légende sur le graphique.
legendEntries Représente une collection de legendEntries dans la légende.
showShadow Spécifie si la légende comporte une ombre sur le graphique.
top Spécifie le haut d’une légende de graphique.
width Spécifie la largeur, en points, de la légende sur le graphique.
ChartLegendEntry visible Représente la visibilité d’une entrée de légende de graphique.
ChartLegendEntryCollection getCount() Retourne le nombre d’entrées de légende dans la collection.
getItemAt(index: number) Retourne une entrée de légende à l’index donné.
items Obtient l’élément enfant chargé dans cette collection de sites.
ChartLineFormat lineStyle Représente le style de trait.
weight Représente l’épaisseur de bordure, en points.
ChartPoint Datalabel Renvoie l’étiquette de données d’un point du graphique.
hasDataLabel Représente si un point de données a une étiquette de données.
markerBackgroundColor Représentation par code de couleur HTML de la couleur d’arrière-plan du marqueur d’un point de données (par exemple, #FF0000 représente le rouge).
markerForegroundColor Représentation par code de couleur HTML de la couleur de premier plan du marqueur d’un point de données (par exemple, #FF0000 représente le rouge).
markerSize Représente la taille du marqueur d’un point de données.
markerStyle Représente le style du marqueur du point de données de graphique.
ChartPointFormat bordure Représente le format de bordure d’un point de données de graphique, qui inclut des informations de couleur, de style et de poids.
ChartSeries chartType Représente le type de graphique d’une série.
delete() Supprime la série graphique.
doughnutHoleSize Représente la taille du centre d’une série de graphiques en anneaux.
Filtrée Spécifie si la série est filtrée.
gapWidth Représente la largeur de l’intervalle d’une série de graphique.
hasDataLabels Spécifie si la série a des étiquettes de données.
markerBackgroundColor Spécifie la couleur d’arrière-plan du marqueur d’une série de graphiques.
markerForegroundColor Spécifie la couleur de premier plan du marqueur d’une série de graphiques.
markerSize Spécifie la taille de marqueur d’une série de graphiques.
markerStyle Spécifie le style de marqueur d’une série de graphiques.
plotOrder Spécifie l’ordre de traçage d’une série de graphiques dans le groupe de graphiques.
setBubbleSizes(sourceData: Range) Définit les tailles de bulles d’une série de graphiques.
setValues(sourceData: Range) Définit les valeurs d’une série de graphiques.
setXAxisValues(sourceData: Range) Définit les valeurs de l’axe x d’une série de graphiques.
showShadow Spécifie si la série a une ombre.
Lisse Spécifie si la série est lisse.
courbes de tendance Collection de courbes de tendance dans la série.
ChartSeriesCollection add(name?: string, index?: number) Ajouter une nouvelle série à la collection.
ChartTitle getSubstring(start: number, length: number) Obtient la sous-chaîne d’un titre de graphique.
height Représente la hauteur, exprimée en points, du titre du graphique.
horizontalAlignment Spécifie l’alignement horizontal du titre du graphique.
left Spécifie la distance, en points, entre le bord gauche du titre du graphique et le bord gauche de la zone de graphique.
position Représente la position du titre du graphique.
setFormula(formula: string) Définit une valeur de chaîne qui représente la formule de titre de graphique à l’aide de la notation de style A1.
showShadow Représente une valeur booléenne qui détermine si le titre du graphique possède une ombre.
textOrientation Spécifie l’angle vers lequel le texte est orienté pour le titre du graphique.
top Spécifie la distance, en points, entre le bord supérieur du titre du graphique et le haut de la zone de graphique.
verticalAlignment Spécifie l’alignement vertical du titre du graphique.
width Spécifie la largeur, en points, du titre du graphique.
ChartTitleFormat bordure Représente le format de bordure du titre du graphique, qui inclut la couleur, le style de trait et le poids.
ChartTrendline delete() Supprime l’objet courbe de tendance.
format Représente la mise en forme de courbe de tendance de graphique.
Intercepter Représente la valeur intercept de la courbe de tendance.
movingAveragePeriod Représente la période d’une courbe de tendance de graphique.
name Représente le nom de la courbe de tendance.
polynomialOrder Représente l’ordre d’une courbe de tendance de graphique.
type Représente le type de courbe de tendance de graphique.
ChartTrendlineCollection add(type?: Excel.ChartTrendlineType) Ajoute une nouvelle courbe de tendance à la collection de courbes de tendance.
getCount() Renvoie le nombre de courbes de tendance de la collection.
getItem(index : numérique) Obtient un objet de courbe de tendance par index, qui est l’ordre d’insertion dans le tableau d’éléments.
items Obtient l’élément enfant chargé dans cette collection de sites.
ChartTrendlineFormat line Représente le format des lignes du graphique.
CustomProperty delete() Supprime la propriété personnalisée.
key Clé de la propriété personnalisée.
type Type de la valeur utilisée pour la propriété personnalisée.
value Valeur de la propriété personnalisée.
CustomPropertyCollection add(key: string, value: any) Crée une nouvelle propriété personnalisée ou en définit une existante.
deleteAll() Supprime toutes les propriétés personnalisées de cette collection.
getCount() Obtient le nombre des propriétés personnalisées.
getItem(key: string) Obtient un objet de propriété personnalisé par sa clé, qui ne tient pas compte de la casse.
getItemOrNullObject(key: string) Obtient un objet de propriété personnalisé par sa clé, qui ne tient pas compte de la casse.
items Obtient l’élément enfant chargé dans cette collection de sites.
DataConnectionCollection refreshAll() Actualise les connexions de données dans la collection, par exemple à partir d’un tableau croisé dynamique vers un jeu de données Power BI, ou d’un modèle de données vers une table ou une plage dans le même classeur.
DocumentProperties Auteur Auteur du classeur.
Catégorie Catégorie du classeur.
comments Commentaires du classeur.
company Société du classeur.
creationDate Obtient la date de création du classeur.
Personnalisé Obtient la collection de propriétés personnalisées du classeur.
Mots-clés Mots clés du classeur.
lastAuthor Obtient ou définit le dernier auteur du classeur.
manager Gestionnaire du classeur.
revisionNumber Obtient le numéro de révision du classeur.
subject Objet du classeur.
title Titre du classeur.
NamedItem arrayValues Renvoie un objet contenant les valeurs et les types de l’élément nommé.
formula Formule de l’élément nommé.
NamedItemArrayValues types Représente les types de chaque élément dans le tableau d’éléments nommés
values Représente les valeurs de chaque élément dans le tableau élément nommé.
Range getAbsoluteResizedRange(numRows: number, numColumns: number) Obtient un Range objet avec la même cellule supérieure gauche que l’objet actuel Range , mais avec le nombre spécifié de lignes et de colonnes.
getImage() Restitue la plage sous la forme d’une image png codée en base64.
getSurroundingRegion() Renvoie un Range objet qui représente la région environnante pour la cellule en haut à gauche de cette plage.
lien hypertexte Représente le lien hypertexte pour la plage actuelle.
isEntireColumn Représente si la plage active est une colonne entière.
isEntireRow Représente si la plage active est une ligne entière.
numberFormatLocal Représente le code de format numérique d’Excel pour la plage donnée, en fonction des paramètres de langue de l’utilisateur.
showCard() Affiche la carte pour une cellule active si son contenu est riche en valeur.
style Représente le style de la plage actuelle.
RangeFormat textOrientation Orientation du texte de toutes les cellules de la plage.
useStandardHeight Détermine si la hauteur de ligne de l’objet Range est égale à la hauteur standard de la feuille.
useStandardWidth Spécifie si la largeur de colonne de l’objet Range est égale à la largeur standard de la feuille.
RangeHyperlink adresse Représente la cible d’URL pour le lien hypertexte.
documentReference Représente la cible de référence de document pour le lien hypertexte.
info-bulle Représente la chaîne affichée lorsque vous pointez sur le lien hypertexte.
textToDisplay Représente la chaîne qui s’affiche dans la cellule en haut à gauche de la plage.
Style Borders Collection de quatre objets de bordure qui représentent le style des quatre bordures.
Builtin Spécifie si le style est un style intégré.
delete() Supprime ce style.
fill Remplissage du style.
police Objet Font qui représente la police du style.
formulaHidden Spécifie si la formule sera masquée lorsque la feuille de calcul est protégée.
horizontalAlignment Représente l’alignement horizontal pour le style.
includeAlignment Spécifie si le style inclut les propriétés de retrait automatique, d’alignement horizontal, d’alignement vertical, d’habillage du texte, de niveau de retrait et d’orientation du texte.
includeBorder Spécifie si le style inclut les propriétés de couleur, d’index de couleur, de style de trait et de bordure de poids.
includeFont Spécifie si le style inclut l’arrière-plan, le gras, la couleur, l’index de couleur, le style de police, l’italique, le nom, la taille, le barré, l’indice, l’exposant et le soulignement.
includeNumber Spécifie si le style inclut la propriété de format de nombre.
includePatterns Spécifie si le style inclut la couleur, l’index de couleur, l’inverse si négatif, le modèle, la couleur de modèle et les propriétés intérieures de l’index de couleur de modèle.
includeProtection Spécifie si le style inclut les propriétés de protection masquées et verrouillées de formule.
indentLevel Entier compris entre 0 à 250 qui indique le niveau de retrait du style.
locked Spécifie si l’objet est verrouillé lorsque la feuille de calcul est protégée.
name Nom du style.
numberFormat Le code de format du nombre format pour le style.
numberFormatLocal Le code de format localisé du nombre format pour le style.
readingOrder L’ordre de lecture du style.
shrinkToFit Spécifie si le texte se réduit automatiquement pour s’adapter à la largeur de colonne disponible.
verticalAlignment Spécifie l’alignement vertical du style.
wrapText Spécifie si Excel encapsule le texte dans l’objet.
StyleCollection add(name: string) Ajoute un nouveau style à la collection.
getItem(name: string) Obtient un Style par nom.
items Obtient l’élément enfant chargé dans cette collection de sites.
Tableau onChanged Se produit lorsque les données des cellules changent sur une table spécifique.
onSelectionChanged Se produit lorsque la sélection change sur une table spécifique.
TableChangedEventArgs adresse Obtient l’adresse qui représente la zone modifiée d’un tableau figurant dans une feuille de calcul spécifique.
changeType Obtient le type de modification qui représente la façon dont l’événement modifié est déclenché.
source Obtient la source de l’événement.
tableId Obtient l’ID de la table dans laquelle les données ont été modifiées.
type Obtient le type de l’événement.
worksheetId Obtient l’ID de la feuille de calcul dans laquelle les données ont été modifiées.
TableCollection onChanged Se produit lorsque les données changent sur une table d’un classeur ou d’une feuille de calcul.
TableSelectionChangedEventArgs adresse Obtient l’adresse de plage qui représente la zone sélectionnée d’un tableau dans une feuille de calcul spécifique.
isInsideTable Spécifie si la sélection se trouve à l’intérieur d’une table.
tableId Obtient l’ID de la table dans laquelle la sélection a été modifiée.
type Obtient le type de l’événement.
worksheetId Obtient l’ID de la feuille de calcul dans laquelle la sélection a été modifiée.
Classeur dataConnections Représente toutes les connexions de données dans le classeur.
getActiveCell() Obtient la cellule active du classeur.
name Obtient le nom du classeur.
properties Obtient les propriétés du classeur.
protection Retourne l’objet de protection d’un classeur.
Styles Représente une collection de styles associés au classeur.
WorkbookProtection protect(password?: string) Protège un classeur.
Protégé Spécifie si le classeur est protégé.
unprotect(password?: string) Annule la protection un classeur.
Feuille de calcul copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet) Copie une feuille de calcul et la place à la position spécifiée.
freezePanes Obtient un objet qui peut être utilisé pour manipuler des volets figés dans la feuille de calcul.
getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number) Obtient l’objet Range commençant à un index de ligne et d’un index de colonne particuliers, et couvrant un certain nombre de lignes et de colonnes.
onActivated Se produit lorsque la feuille de calcul est activée.
onChanged Se produit lorsque les données changent dans une feuille de calcul spécifique.
onDeactivated Se produit lorsque la feuille de calcul est désactivée.
onSelectionChanged Se produit lorsque la sélection change dans une feuille de calcul spécifique.
standardHeight Renvoie la hauteur standard (par défaut) de toutes les lignes dans la feuille de calcul, en points.
standardWidth Spécifie la largeur standard (par défaut) de toutes les colonnes de la feuille de calcul.
tabColor Couleur d’onglet de la feuille de calcul.
WorksheetActivatedEventArgs type Obtient le type de l’événement.
worksheetId Obtient l’ID de la feuille de calcul qui est activée.
WorksheetAddedEventArgs source Obtient la source de l’événement.
type Obtient le type de l’événement.
worksheetId Obtient l’ID de la feuille de calcul qui est ajoutée au classeur.
worksheetChangedEventArgs adresse Obtient l’adresse de plage qui représente la zone modifiée dans une feuille de calcul spécifique.
changeType Obtient le type de modification qui représente la façon dont l’événement modifié est déclenché.
source Obtient la source de l’événement.
type Obtient le type de l’événement.
worksheetId Obtient l’ID de la feuille de calcul dans laquelle les données ont été modifiées.
WorksheetCollection onActivated Se produit lorsqu’une feuille de calcul du classeur est activée.
onAdded Se produit lorsqu’une nouvelle feuille de calcul est ajoutée au classeur.
onDeactivated Se produit lorsqu’une feuille de calcul du classeur est désactivée.
onDeleted Se produit lorsqu’une feuille de calcul est supprimée du classeur.
WorksheetDeactivatedEventArgs type Obtient le type de l’événement.
worksheetId Obtient l’ID de la feuille de calcul qui est désactivée.
WorksheetDeletedEventArgs source Obtient la source de l’événement.
type Obtient le type de l’événement.
worksheetId Obtient l’ID de la feuille de calcul qui est supprimée du classeur.
WorksheetFreezePanes freezeAt(frozenRange: Range | string) Définit les cellules figées dans l’affichage de la feuille de calcul active.
freezeColumns(count?: number) Figer la ou les premières colonnes de la feuille de calcul en place.
freezeRows(count?: number) Figer la ou les lignes supérieures de la feuille de calcul en place.
getLocation() Obtient une plage qui définit les cellules figées dans l’affichage de la feuille de calcul active.
getLocationOrNullObject() Obtient une plage qui définit les cellules figées dans l’affichage de la feuille de calcul active.
unfreeze() Supprime tous les volets figés dans la feuille de calcul.
WorksheetProtection unprotect(password?: string) Annule la protection d’une feuille de calcul.
WorksheetProtectionOptions allowEditObjects Représente l’option de protection de feuille de calcul autorisant la modification d’objets.
allowEditScenarios Représente l’option de protection de feuille de calcul autorisant la modification des scénarios.
Selectionmode Représente l’option de protection de feuille de calcul qui autorise le mode sélection.
WorksheetSelectionChangedEventArgs adresse Obtient l’adresse de plage qui représente la zone sélectionnée dans une feuille de calcul spécifique.
type Obtient le type de l’événement.
worksheetId Obtient l’ID de la feuille de calcul dans laquelle la sélection a été modifiée.

Voir aussi