Ensemble de conditions requises de l’API JavaScript Excel 1.1

  • Article

L’API JavaScript 1.1 pour Excel est la première version de l’API. Il s’agit du seul ensemble de conditions requises spécifiques à Excel pris en charge par Excel 2016.

Liste des API

Le tableau suivant répertorie les API dans l’ensemble de conditions requises de l’API JavaScript Excel 1.1. Pour afficher la documentation de référence sur les API pour toutes les API prises en charge par l’ensemble de conditions requises de l’API JavaScript Excel 1.1, consultez API Excel dans l’ensemble de conditions requises 1.1.

Classe Champs Description
Application calculate(calculationType : Excel.CalculationType) Recalcule tous les classeurs actuellement ouverts dans Excel.
calculationMode Retourne le mode de calcul utilisé dans le classeur, tel que défini par les constantes dans Excel.CalculationMode.
Binding getRange() Renvoie la plage représentée par la liaison.
getTable() Renvoie le tableau représenté par la liaison.
getText() Renvoie le texte représenté par la liaison.
id Représente l’identificateur de liaison.
type Renvoie le type de la liaison.
BindingCollection count Renvoie le nombre de liaisons de la collection.
getItem(id: string) Obtient un objet de liaison par ID.
getItemAt(index: number) Obtient un objet de liaison en fonction de sa position dans le tableau d’éléments.
items Obtient l’élément enfant chargé dans cette collection de sites.
Graphique axes Représente les axes du graphique.
dataLabels Représente les étiquettes des données sur le graphique.
delete() Supprime l’objet de graphique.
format Regroupe les propriétés de format de la zone de graphique.
height Spécifie la hauteur, en points, de l’objet de graphique.
left La distance, en points, entre le côté gauche du graphique et l’origine de la feuille de calcul.
Légende Représente la légende du graphique.
name Spécifie le nom d’un objet graphique.
series Représente une série ou une collection de séries dans le graphique.
setData(sourceData : Range, seriesBy ?: Excel.ChartSeriesBy) Redéfinit les données sources du graphique.
setPosition(startCell : Range | string, endCell ?: Range | string) Positionne le graphique par rapport aux cellules dans la feuille de calcul.
title Représente le titre du graphique indiqué et comprend le texte, la visibilité, la position et la mise en forme du titre.
top Spécifie la distance, en points, entre le bord supérieur de l’objet et le haut de la ligne 1 (dans une feuille de calcul) ou le haut de la zone de graphique (sur un graphique).
width Spécifie la largeur, en points, de l’objet graphique.
ChartAreaFormat fill Représente le format de remplissage d’un objet, qui comprend des informations de mise en forme d’arrière-plan.
police Représente les attributs de police (nom de la police, taille de police, couleur, etc.) de l’objet.
ChartAxes Categoryaxis Représente l’axe des abscisses d’un graphique.
seriesAxis Représente l’axe des séries d’un graphique 3D.
Valueaxis Représente l’axe des ordonnées.
ChartAxis format Représente la mise en forme d’un objet de graphique, à savoir le format des lignes et de la police.
Majorgridlines Renvoie un objet qui représente le quadrillage principal de l’axe spécifié.
majorUnit Représente l’intervalle entre deux graduations principales.
maximum Représente la valeur maximale sur l’axe des ordonnées.
minimum Représente la valeur minimale sur l’axe des ordonnées.
Minorgridlines Renvoie un objet qui représente le quadrillage secondaire de l’axe spécifié.
minorUnit Représente l’intervalle entre deux graduations secondaires.
title Représente le titre de l’axe.
ChartAxisFormat police Spécifie les attributs de police (nom de la police, taille de police, couleur, etc.) d’un élément d’axe de graphique.
line Spécifie la mise en forme des lignes de graphique.
ChartAxisTitle format Spécifie la mise en forme du titre de l’axe du graphique.
text Spécifie le titre de l’axe.
visible Spécifie si le titre de l’axe est visible.
ChartAxisTitleFormat police Spécifie les attributs de police du titre de l’axe du graphique, tels que le nom de la police, la taille de police ou la couleur, de l’objet titre de l’axe du graphique.
ChartCollection add(type : Excel.ChartType, sourceData : Range, seriesBy ?: Excel.ChartSeriesBy) Crée un graphique.
count Renvoie le nombre de graphiques dans la feuille de calcul.
getItem(name: string) Extrait un graphique à l’aide de son nom.
getItemAt(index: number) Extrait un graphique en fonction de sa position dans la collection.
items Obtient l’élément enfant chargé dans cette collection de sites.
ChartDataLabelFormat fill Représente le format de remplissage de l’étiquette de données.
police Représente les attributs de police (tels que le nom de la police, la taille de police et la couleur) d’une étiquette de données de graphique.
ChartDataLabels format Spécifie le format des étiquettes de données de graphique, qui inclut la mise en forme de remplissage et de police.
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.
ChartFill clear() Efface la couleur de remplissage d’un élément de graphique.
setSolidColor(color: string) Définit le format de remplissage d’un élément de graphique sur une couleur unie.
ChartFont bold Représente le format de police Gras.
color Représentation par code de couleur HTML de la couleur du texte (par exemple, #FF0000 représente le rouge).
italic Représente le format de police Italique.
name Nom de police (par exemple, « Calibri »)
size Taille de la police (par exemple, 11)
underline Type de soulignement appliqué à la police.
ChartGridlines format Représente le format du quadrillage de graphique.
visible Spécifie si le quadrillage de l’axe est visible.
ChartGridlinesFormat line Représente le format des lignes du graphique.
ChartLegend format Représente le format d’une légende de graphique, à savoir le format du remplissage et de la police.
overlay Spécifie si la légende du graphique doit chevaucher le corps main du graphique.
position Spécifie la position de la légende sur le graphique.
visible Spécifie si la légende du graphique est visible.
ChartLegendFormat fill Représente le format de remplissage d’un objet, qui comprend des informations de mise en forme d’arrière-plan.
police Représente les attributs de police tels que le nom de police, la taille de police et la couleur d’une légende de graphique.
ChartLineFormat clear() Efface le format de ligne d’un élément de graphique.
color Code couleur HTML qui représente la couleur des lignes dans le graphique.
ChartPoint format Regroupe les propriétés de format d’un point d’un graphique.
value Renvoie la valeur d’un point du graphique.
ChartPointFormat fill Représente le format de remplissage d’un graphique, qui inclut des informations de mise en forme d’arrière-plan.
ChartPointsCollection count Renvoie le nombre de points de graphique dans la série.
getItemAt(index: number) Extrait un point en fonction de sa position dans la série.
items Obtient l’élément enfant chargé dans cette collection de sites.
ChartSeries format Représente le format d’une série de graphique, à savoir le format de remplissage et des lignes.
name Spécifie le nom d’une série dans un graphique.
Points Retourne une collection de tous les points de la série.
ChartSeriesCollection count Renvoie le nombre de séries de la collection.
getItemAt(index: number) Extrait une série en fonction de sa position dans la collection.
items Obtient l’élément enfant chargé dans cette collection de sites.
ChartSeriesFormat fill Représente le format de remplissage d’une série du graphique, qui comprend les informations de mise en forme d’arrière-plan.
line Représente le format des lignes.
ChartTitle format Représente le format du titre d’un graphique, à savoir le format de remplissage et de la police.
overlay Spécifie si le titre du graphique va superposer le graphique.
text Spécifie le texte du titre du graphique.
visible Spécifie si le titre du graphique est visible.
ChartTitleFormat fill Représente le format de remplissage d’un objet, qui comprend des informations de mise en forme d’arrière-plan.
police Représente les attributs de police (tels que le nom de la police, la taille de police et la couleur) d’un objet.
NamedItem getRange() Renvoie l’objet de plage qui est associé au nom.
name Nom de l’objet.
type Spécifie le type de la valeur retournée par la formule du nom.
value Représente la valeur calculée par la formule du nom.
visible Spécifie si l’objet est visible.
NamedItemCollection getItem(name: string) Obtient un NamedItem objet à l’aide de son nom.
items Obtient l’élément enfant chargé dans cette collection de sites.
Range adresse Spécifie la référence de plage dans le style A1.
addressLocal Représente la référence de plage pour la plage spécifiée dans la langue de l’utilisateur.
cellCount Spécifie le nombre de cellules dans la plage.
Effacer (applyTo ? : Excel.ClearApplyTo) Supprime les valeurs et les propriétés de format, de remplissage, de bordure, etc. de la plage.
columnCount Spécifie le nombre total de colonnes dans la plage.
columnIndex Spécifie le numéro de colonne de la première cellule de la plage.
delete(shift : Excel.DeleteShiftDirection) Supprime les cellules associées à la plage.
format Renvoie un objet de format, encapsulant la police, le remplissage, les bordures, l’alignement et d’autres propriétés de la plage.
formulas Représente la formule dans le style de notation A1.
formulasLocal Représente la formule en notation A1, en utilisant le langage et les paramètres de format de nombre régionaux de l’utilisateur.
getBoundingRect(anotherRange : Range | string) Renvoie le plus petit objet de plage qui englobe les plages données.
getCell(row: number, column: number) Renvoie l’objet de plage qui contient une cellule donnée sur la base des numéros de ligne et de colonne.
getColumn(column: number) Obtient une colonne contenue dans la plage.
getEntireColumn() Obtient un objet qui représente la colonne entière de la plage (par exemple, si la plage actuelle représente les cellules « B4 :E11 », il s’agit getEntireColumn d’une plage qui représente les colonnes « B :E »).
getEntireRow() Obtient un objet qui représente la ligne entière de la plage (par exemple, si la plage actuelle représente les cellules « B4 :E11 », il s’agit GetEntireRow d’une plage qui représente les lignes « 4 :11 »).
getIntersection(anotherRange : Range | string) Obtient l’objet de plage qui représente l’intersection rectangulaire des plages données.
getLastCell() Obtient la dernière cellule de la plage.
getLastColumn() Obtient la dernière colonne de la plage.
getLastRow() Obtient la dernière ligne de la plage.
getOffsetRange(rowOffset: number, columnOffset: number) Obtient un objet qui représente une plage décalée par rapport à la plage spécifiée.
getRow(row: number) Obtient une ligne contenue dans la plage.
insert(shift : Excel.InsertShiftDirection) Insère une cellule ou une plage de cellules dans la feuille de calcul à la place d’une plage donnée et décale les autres cellules pour libérer de l’espace.
numberFormat Représente le code de format numérique d’Excel pour la plage donnée.
Rowcount Renvoie le nombre total de lignes de la plage.
rowIndex Renvoie le numéro de ligne de la première cellule de la plage.
select() Sélectionne la plage spécifiée dans l’interface utilisateur d’Excel.
text Valeurs de texte de la plage spécifiée.
valueTypes Spécifie le type de données dans chaque cellule.
values Représente les valeurs brutes de la plage spécifiée.
worksheet Feuille de calcul contenant la plage.
RangeBorder color Code de couleur HTML représentant la couleur de la ligne de bordure, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).
sideIndex Valeur constante qui indique un côté spécifique de la bordure.
style L’une des constantes de style de ligne déterminant le style de ligne de la bordure.
weight Spécifie l'épaisseur de la bordure autour d'une plage.
RangeBorderCollection count Nombre d’objets de bordure de la collection.
getItem(index : Excel.BorderIndex) Obtient un objet de bordure à l’aide de son nom.
getItemAt(index: number) Obtient un objet de bordure à l’aide de son indice.
items Obtient l’élément enfant chargé dans cette collection de sites.
RangeFill clear() Réinitialise l’arrière-plan de la plage.
color Code de couleur HTML représentant la couleur de l’arrière-plan, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »)
RangeFont bold Représente la status en gras de la police.
color Représentation par code de couleur HTML de la couleur du texte (par exemple, #FF0000 représente le rouge).
italic Spécifie la status italique de la police.
name Nom de la police (par exemple, « Calibri »).
size Taille de police
underline Type de soulignement appliqué à la police.
RangeFormat Borders Collection d’objets de bordure qui s’appliquent à l’ensemble de la plage.
fill Renvoie l’objet de remplissage défini sur la plage globale.
police Renvoie l’objet de police défini sur l’ensemble de la plage.
horizontalAlignment Représente l’alignement horizontal de l’objet spécifié.
verticalAlignment Représente l’alignement vertical de l’objet spécifié.
wrapText Spécifie si Excel encapsule le texte dans l’objet.
Tableau colonnes Représente une collection de toutes les colonnes du tableau.
delete() Supprime le tableau.
getDataBodyRange() Obtient l’objet de plage associé au corps de données du tableau.
getHeaderRowRange() Obtient l’objet de plage associé à la ligne d’en-tête du tableau.
getRange() Renvoie l’objet de plage associé à l’intégralité du tableau.
getTotalRowRange() Obtient l’objet de plage associé à la ligne de total du tableau.
id Renvoie une valeur qui permet d’identifier le tableau dans un classeur donné.
name Nom du tableau.
rows Représente une collection de toutes les lignes du tableau.
showHeaders Spécifie si la ligne d’en-tête est visible.
showTotals Spécifie si la ligne totale est visible.
style Valeur constante qui représente le style de tableau.
TableCollection add(address : Range | string, hasHeaders : boolean) Crée une table.
count Renvoie le nombre de tableaux dans le classeur.
getItem(key: string) Obtient un tableau à l’aide de son nom ou de son ID.
getItemAt(index: number) Obtient un tableau en fonction de sa position dans la collection.
items Obtient l’élément enfant chargé dans cette collection de sites.
TableColumn delete() Supprime la colonne du tableau.
getDataBodyRange() Obtient l’objet de plage associé au corps de données de la colonne.
getHeaderRowRange() Obtient l’objet de plage associé à la ligne d’en-tête de la colonne.
getRange() Renvoie l’objet de plage associé à l’intégralité de la colonne.
getTotalRowRange() Obtient l’objet de plage associé à la ligne de total de la colonne.
id Renvoie une clé unique qui identifie la colonne du tableau.
index Renvoie le numéro d’indice de la colonne dans la collection de colonnes du tableau.
name Spécifie le nom de la colonne de table.
values Représente les valeurs brutes de la plage spécifiée.
TableColumnCollection add(index ?: number, values ?: Array<Array<boolean | string | number>> | boolean | string | number, name ?: string) Ajoute une nouvelle colonne au tableau.
count Renvoie le nombre de colonnes du tableau.
getItem(key : number | string) Obtient un objet de colonne par son nom ou son ID.
getItemAt(index: number) Obtient une colonne en fonction de sa position dans la collection.
items Obtient l’élément enfant chargé dans cette collection de sites.
TableRow delete() Supprime la ligne du tableau.
getRange() Renvoie l’objet de plage associé à la ligne entière.
index Renvoie le numéro d’indice de la ligne dans la collection de lignes du tableau.
values Représente les valeurs brutes de la plage spécifiée.
TableRowCollection add(index ?: number, values ?: Array<Array<boolean | string | number>> | boolean | string | number, alwaysInsert ?: boolean) Ajoute une ou plusieurs lignes dans le tableau.
count Renvoie le nombre de lignes du tableau.
getItemAt(index: number) Obtient une ligne en fonction de sa position dans la collection.
items Obtient l’élément enfant chargé dans cette collection de sites.
Classeur application Représente l’application Excel instance qui contient ce classeur.
bindings Représente une collection de liaisons appartenant au classeur.
getSelectedRange() Obtient la plage unique actuellement sélectionnée à partir du classeur.
Noms Représente une collection d’éléments nommés de portée classeur (plages et constantes nommées).
Tables Représente une collection de tableaux associés au classeur.
Feuilles Représente une collection de feuilles de calcul associées au classeur.
Feuille de calcul activate() Active la feuille de calcul dans l’interface utilisateur Excel.
Graphiques Retourne une collection de graphiques qui font partie de la feuille de calcul.
delete() Supprime la feuille de calcul du classeur.
getCell(row: number, column: number) Obtient l’objet Range contenant la cellule unique en fonction des numéros de ligne et de colonne.
getRange(address ?: string) Obtient l’objet Range , qui représente un seul bloc rectangulaire de cellules, spécifié par l’adresse ou le nom.
id Renvoie une valeur qui permet d’identifier la feuille de calcul de façon unique dans un classeur donné.
name Nom complet de la feuille de calcul.
position Position de la feuille de calcul au sein du classeur (sur une base zéro).
Tables Collection de tableaux qui font partie de la feuille de calcul.
Visibilité Visibilité de la feuille de calcul.
WorksheetCollection add(name ?: string) Ajoute une nouvelle feuille de calcul au classeur.
getActiveWorksheet() Obtient la feuille de calcul active du classeur.
getItem(key: string) Obtient un objet de feuille de calcul à l’aide de son nom ou de son ID.
items Obtient l’élément enfant chargé dans cette collection de sites.

Voir aussi