Nouveautés de l’API JavaScript Excel 1.8

  • Article

L’ensemble de conditions requises Excel JavaScript API 1.8 incluent des API pour les tableaux croisés dynamiques, validation des données, graphiques, les événements pour les diagrammes, les options de performances et création de classeur.

Tableau croisé dynamique

Vague 2 des APIs de tableau croisé dynamique permet aux compléments de définir les hiérarchies d’un tableau croisé dynamique. Vous pouvez désormais contrôler les données et comment elles sont regroupées. Notre Article tableau croisé dynamique a plus d’informations sur les nouvelles fonctionnalités de tableau croisé dynamique.

Validation des données

La validation des données vous donne le contrôle sur ce qu’un utilisateur insère dans une feuille de calcul. Vous pouvez limiter les cellules à des ensembles de réponse prédéfinie ou donner des avertissements contextuels concernant des entrées indésirables. En savoir plus maintenant sur Ajout de validation des données à des plages.

Graphiques

Une autre série de graphiques API apporte un meilleur contrôle par programme des éléments de graphique. Vous avez à présent un meilleur accès à la légende, axes, courbe de tendance et zone de traçage.

Événements

Plus d’événements ont été ajoutés pour les graphiques. Votre complément réagit aux interactions des utilisateurs avec le graphique. Vous pouvez également Activer ou désactiver les événements sur l’ensemble du classeur.

Liste des API

Le tableau suivant répertorie les API dans l’ensemble de conditions requises de l’API JavaScript Excel 1.8. 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.8 ou version antérieure, consultez API Excel dans l’ensemble de conditions requises 1.8 ou antérieur.

Classe Champs Description
BasicDataValidation formula1 Spécifie l’opérande de droite lorsque la propriété de l’opérateur est définie sur un opérateur binaire tel que GreaterThan (l’opérande de gauche est la valeur que l’utilisateur tente d’entrer dans la cellule).
formula2 Avec les opérateurs ternaires Between et NotBetween, spécifie l’opérande de limite supérieure.
opérateur L’opérateur à utiliser pour la validation des données.
Graphique categoryLabelLevel Spécifie une constante d’énumération de niveau d’étiquette de catégorie de graphique, faisant référence au niveau des étiquettes de catégorie source.
displayBlanksAs Spécifie la façon dont les cellules vides sont tracées sur un graphique.
onActivated Se produit lorsque le graphique est activé.
onDeactivated Se produit lorsque le graphique est désactivé.
Plotarea Représente la zone de traçage du graphique.
plotBy Spécifie la façon dont les colonnes ou les lignes sont utilisées comme séries de données sur le graphique.
plotVisibleOnly Vrai si seules les cellules visibles sont tracées.
seriesNameLevel Spécifie une constante d’énumération de niveau de nom de série de graphique, faisant référence au niveau des noms des séries sources.
showDataLabelsOverMaximum Spécifie s’il faut afficher les étiquettes de données lorsque la valeur est supérieure à la valeur maximale sur l’axe des valeurs.
style Spécifie le style de graphique pour le graphique.
ChartActivatedEventArgs chartId Obtient l’ID du graphique activé.
type Obtient le type de l’événement.
worksheetId Obtient l’ID de la feuille de calcul dans laquelle le graphique est activé.
ChartAddedEventArgs chartId Obtient l’ID du graphique ajouté à la feuille de calcul.
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 le graphique est ajouté.
ChartAxis Alignement Spécifie l’alignement de l’étiquette de graduation d’axe spécifiée.
isBetweenCategories Spécifie si l’axe des valeurs traverse l’axe des catégories entre les catégories.
Multiniveaux Spécifie si un axe est multiniveau.
numberFormat Spécifie le code de format de l’étiquette de graduation de l’axe.
Compenser Spécifie la distance entre les niveaux des étiquettes et la distance entre le premier niveau et la ligne d’axe.
position Spécifie la position d’axe spécifiée où l’autre axe se croise.
positionAt Spécifie la position de l’axe où l’autre axe se croise.
setPositionAt(value: number) Définit la position d’axe spécifiée où l’autre axe se croise.
textOrientation Spécifie l’angle auquel le texte est orienté pour l’étiquette de graduation de l’axe du graphique.
ChartAxisFormat fill Spécifie la mise en forme du remplissage du graphique.
ChartAxisTitle setFormula(formula: string) Valeur de chaîne qui représente la formule de titre de l’axe graphique à l’aide de la notation de style A1.
ChartAxisTitleFormat bordure Spécifie le format de bordure du titre de l’axe du graphique, qui inclut la couleur, le style de trait et le poids.
fill Spécifie la mise en forme de remplissage du titre de l’axe du graphique.
ChartBorder clear() Désactiver le format de bordure d’un élément de graphique.
ChartCollection onActivated Se produit lorsqu’un graphique est activé.
onAdded Se produit lorsqu’un nouveau graphique est ajouté à la feuille de calcul.
onDeactivated Se produit lorsqu’un graphique est désactivé.
onDeleted Se produit lorsqu’un graphique est supprimé.
ChartDataLabel Insertion automatique Spécifie si l’étiquette de données génère automatiquement le texte approprié en fonction du contexte.
format Représente le format d’étiquette de données graphique.
formula Valeur de chaîne qui représente la formule de l’étiquette de données du graphique à l’aide de la notation de style A1.
height Représente la hauteur, exprimée en points, de l’étiquette de données du graphique.
horizontalAlignment Représente l’alignement horizontal de l’étiquette de données du graphique.
left Représente la distance en points, du bord gauche de l’étiquette de données graphique au bord gauche de la zone de graphique.
numberFormat Valeur de chaîne qui représente le code de format pour l’étiquette de données.
text Chaîne représentant le texte d’étiquette de données dans un graphique.
textOrientation Représente l’angle vers lequel le texte est orienté pour l’étiquette de données du graphique.
top Représente la distance en points, du bord supérieur de l’étiquette de données graphique au bord supérieur de la zone de graphique.
verticalAlignment Représente l’alignement vertical de l’étiquette de données du graphique.
width Représente la largeur, exprimée en points, de l’étiquette de données du graphique.
ChartDataLabelFormat bordure Représente le format bordure, qui inclut couleur, style de ligne et épaisseur.
ChartDataLabels Insertion automatique Spécifie si les étiquettes de données génèrent automatiquement le texte approprié en fonction du contexte.
horizontalAlignment Spécifie l’alignement horizontal de l’étiquette de données du graphique.
numberFormat Spécifie le code de format des étiquettes de données.
textOrientation Représente l’angle auquel le texte est orienté pour les étiquettes de données.
verticalAlignment Représente l’alignement vertical de l’étiquette de données du graphique.
ChartDeactivatedEventArgs chartId Obtient l’ID du graphique qui est désactivé.
type Obtient le type de l’événement.
worksheetId Obtient l’ID de la feuille de calcul dans laquelle le graphique est désactivé.
ChartDeletedEventArgs chartId Obtient l’ID du graphique supprimé de la feuille de calcul.
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 le graphique est supprimé.
ChartLegendEntry height Spécifie la hauteur de l’entrée de légende sur la légende du graphique.
index Spécifie l’index de l’entrée de légende dans la légende du graphique.
left Spécifie la valeur de gauche d’une entrée de légende de graphique.
top Spécifie le haut d’une entrée de légende de graphique.
width Représente la largeur de l’entrée de légende sur le graphique Légende.
ChartLegendFormat bordure Représente le format bordure, qui inclut couleur, style de ligne et épaisseur.
ChartPlotArea format Spécifie la mise en forme d’une zone de traçage de graphique.
height Spécifie la valeur de hauteur d’une zone de traçage.
insideHeight Spécifie la valeur de hauteur intérieure d’une zone de traçage.
insideLeft Spécifie la valeur à l’intérieur gauche d’une zone de traçage.
insideTop Spécifie la valeur intérieure supérieure d’une zone de traçage.
insideWidth Spécifie la valeur de largeur intérieure d’une zone de traçage.
left Spécifie la valeur de gauche d’une zone de traçage.
position Spécifie la position d’une zone de traçage.
top Spécifie la valeur supérieure d’une zone de traçage.
width Spécifie la valeur de largeur d’une zone de traçage.
ChartPlotAreaFormat bordure Spécifie les attributs de bordure d’une zone de traçage de graphique.
fill Spécifie le format de remplissage d’un objet, qui inclut des informations de mise en forme d’arrière-plan.
ChartSeries axisGroup Spécifie le groupe pour la série spécifiée.
dataLabels Représente une collection de toutes les étiquettes de données de la série.
Explosion Spécifie la valeur d’explosion d’un graphique en secteurs ou d’un graphique en anneau.
firstSliceAngle Spécifie l’angle de la première tranche de graphique en secteurs ou en anneau, en degrés (dans le sens des aiguilles d’une montre à partir de la verticale).
invertIfNegative True si Excel inverse le modèle dans l’élément lorsqu’il correspond à un nombre négatif.
Chevauchement Spécifie comment barres et colonnes sont positionnées.
secondPlotSize Spécifie la taille de la section secondaire d’un graphique en secteurs de secteur ou d’un graphique en barres de secteur, sous la forme d’un pourcentage de la taille du secteur principal.
splitType Spécifie la façon dont les deux sections d’un graphique en secteurs de secteur ou d’un graphique en barres de secteur sont fractionnées.
varyByCategories True si Excel affecte une couleur ou un modèle différent à chaque marqueur de données.
ChartTrendline backwardPeriod Représente le nombre de points que la courbe de tendance étend en arrière.
forwardPeriod Représente le nombre de points que la courbe de tendance étend en avant.
Étiquette Représente l’étiquette d’une courbe de tendance de graphique.
showEquation Vrai si l’équation de la courbe de tendance est affichée sur le graphique.
showRSquared True si la valeur r-carrée de la courbe de tendance est affichée sur le graphique.
ChartTrendlineLabel Insertion automatique Spécifie si l’étiquette de courbe de tendance génère automatiquement le texte approprié en fonction du contexte.
format Format de l’étiquette de courbe de tendance du graphique.
formula Valeur de chaîne qui représente la formule de l’étiquette de courbe de tendance du graphique à l’aide de la notation de style A1.
height Représente la hauteur, exprimée en points, de l’étiquette de tendances du graphique.
horizontalAlignment Représente l’alignement horizontal de l’étiquette de courbe de tendance du graphique.
left Représente la distance, en points, entre le bord gauche de l’étiquette de courbe de tendance du graphique et le bord gauche de la zone de graphique.
numberFormat Valeur de chaîne qui représente le code de format de l’étiquette de courbe de tendance.
text Chaîne représentant le texte d’étiquette de tendances dans un graphique.
textOrientation Représente l’angle vers lequel le texte est orienté pour l’étiquette de courbe de tendance du graphique.
top Représente la distance, en points, entre le bord supérieur de l’étiquette de courbe de tendance du graphique et le haut de la zone de graphique.
verticalAlignment Représente l’alignement vertical de l’étiquette de courbe de tendance du graphique.
width Représente la largeur, exprimée en points, de l’étiquette de tendances du graphique.
ChartTrendlineLabelFormat bordure Spécifie le format de bordure, qui inclut la couleur, le style de trait et le poids.
fill Spécifie le format de remplissage de l’étiquette de courbe de tendance du graphique actuel.
police Spécifie les attributs de police (tels que le nom de la police, la taille de police et la couleur) pour une étiquette de courbe de tendance de graphique.
CustomDataValidation formula Une formule de validation des données personnalisée.
DataPivotHierarchy champ Renvoie les PivotFields associés à la DataPivotHierarchy.
id ID de dataPivotHierarchy.
name Nom de la DataPivotHierarchy.
numberFormat Format de nombre de la DataPivotHierarchy.
position Position de la DataPivotHierarchy.
setToDefault() Restaurer la DataPivotHierarchy à ses valeurs par défaut.
showAs Spécifie si les données doivent être affichées sous la forme d’un calcul récapitulatif spécifique.
summarizeBy Spécifie si tous les éléments de DataPivotHierarchy sont affichés.
DataPivotHierarchyCollection add(pivotHierarchy: Excel.PivotHierarchy) Ajoute le PivotHierarchy à l’axe en cours.
getCount() Obtient le nombre de hiérarchies croisées de la collection.
getItem(name: string) Obtient un DataPivotHierarchy par son nom ou son ID.
getItemOrNullObject(name: string) Obtient une DataPivotHierarchy par nom.
items Obtient l’élément enfant chargé dans cette collection de sites.
remove(DataPivotHierarchy: Excel.DataPivotHierarchy) Supprime le PivotHierarchy de l’axe en cours.
DataValidation clear() Efface la validation des données de la plage active.
errorAlert Alerte d’erreur lorsque l’utilisateur entre des données non valides.
ignoreBlanks Spécifie si la validation des données sera effectuée sur des cellules vides.
prompt Invite lorsque les utilisateurs sélectionnent une cellule.
Règle Règle de validation des données qui contient différents types de critères de validation des données.
type Type de validation des données, consultez Excel.DataValidationType pour plus d’informations.
Valide Représente si toutes les valeurs de cellule sont valides selon les règles de validation des données.
DataValidationErrorAlert message Représente le message d’alerte d’erreur.
showAlert Spécifie s’il faut afficher une boîte de dialogue d’alerte d’erreur lorsqu’un utilisateur entre des données non valides.
style Le type d’alerte de validation des données, consultez Excel.DataValidationAlertStyle pour plus d’informations.
title Représente le titre de la boîte de dialogue d’alerte d’erreur.
DataValidationPrompt message Spécifie le message de l’invite.
showPrompt Spécifie si une invite s’affiche lorsqu’un utilisateur sélectionne une cellule avec validation des données.
title Spécifie le titre de l’invite.
DataValidationRule Personnalisé Critères de validation des données personnalisés.
date Critères de validation des données de date.
Decimales Critères de validation des données décimales.
list Critères de validation des données de liste.
textLength Critères de validation des données de longueur de texte.
time Critères de validation des données de temps.
wholeNumber Critères de validation des données de nombre entier.
DateTimeDataValidation formula1 Spécifie l’opérande de droite lorsque la propriété de l’opérateur est définie sur un opérateur binaire tel que GreaterThan (l’opérande de gauche est la valeur que l’utilisateur tente d’entrer dans la cellule).
formula2 Avec les opérateurs ternaires Between et NotBetween, spécifie l’opérande de limite supérieure.
opérateur L’opérateur à utiliser pour la validation des données.
FilterPivotHierarchy enableMultipleFilterItems Détermine si vous voulez autoriser plusieurs éléments de filtre.
fields Renvoie les PivotFields associés à la FilterPivotHierarchy.
id ID de l’objet FilterPivotHierarchy.
name Nom du filterPivotHierarchy.
position Position du filterPivotHierarchy.
setToDefault() Restaurer la FilterPivotHierarchy à ses valeurs par défaut.
FilterPivotHierarchyCollection add(pivotHierarchy: Excel.PivotHierarchy) Ajoute le PivotHierarchy à l’axe en cours.
getCount() Obtient le nombre de hiérarchies croisées de la collection.
getItem(name: string) Obtient un FilterPivotHierarchy par son nom ou son ID.
getItemOrNullObject(name: string) Obtient un FilterPivotHierarchy par nom.
items Obtient l’élément enfant chargé dans cette collection de sites.
remove(filterPivotHierarchy: Excel.FilterPivotHierarchy) Supprime le PivotHierarchy de l’axe en cours.
ListDataValidation inCellDropDown Spécifie s’il faut afficher la liste dans une liste déroulante de cellules.
source Source de la liste de validation des données
PivotField id ID du champ de tableau croisé dynamique.
items Renvoie les pivotItems associés au champ de tableau croisé dynamique.
name Nom du champ PivotField.
showAllItems Détermine si vous voulez afficher tous les éléments de PivotField.
sortByLabels(sortBy: SortBy) Trie le PivotField.
subtotals Sous-totaux du champ PivotField.
PivotFieldCollection getCount() Obtient le nombre de champs de tableau croisé dynamique dans la collection.
getItem(name: string) Obtient un champ de tableau croisé dynamique par son nom ou son ID.
getItemOrNullObject(name: string) Obtient un champ de tableau croisé dynamique par nom.
items Obtient l’élément enfant chargé dans cette collection de sites.
PivotHierarchy fields Renvoie les PivotFields associés à la PivotHierarchy.
id ID de pivotHierarchy.
name Nom de la PivotHierarchy.
PivotHierarchyCollection getCount() Obtient le nombre de hiérarchies croisées de la collection.
getItem(name: string) Obtient un PivotHierarchy par son nom ou son ID.
getItemOrNullObject(name: string) Obtient une PivotHierarchy par nom.
items Obtient l’élément enfant chargé dans cette collection de sites.
PivotItem id ID de l’objet PivotItem.
isExpanded Détermine si l’élément est développé pour afficher les éléments enfants ou si ce dernier est réduit et les éléments enfants sont masqués.
name Nom du champ PivotItem.
visible Spécifie si l’objet PivotItem est visible.
PivotItemCollection getCount() Obtient le nombre de PivotItems dans la collection.
getItem(name: string) Obtient un objet PivotItem par son nom ou son ID.
getItemOrNullObject(name: string) Obtient un pivotItem par nom.
items Obtient l’élément enfant chargé dans cette collection de sites.
PivotLayout getColumnLabelRange() Renvoie la plage où les étiquettes de colonnes de tableau croisé dynamique se trouvent.
getDataBodyRange() Renvoie la plage où les valeurs de données de tableau croisé dynamique se trouvent.
getFilterAxisRange() Renvoie la plage de la zone de filtre de tableau croisé dynamique.
getRange() Renvoie la plage sur laquelle le tableau croisé dynamique existe, à l’exception de la zone de filtre.
getRowLabelRange() Renvoie la plage où les étiquettes de lignes de tableau croisé dynamique se trouvent.
layoutType Cette propriété indique le PivotLayoutType de tous les champs sur le tableau croisé dynamique.
showColumnGrandTotals Spécifie si le rapport de tableau croisé dynamique affiche des totaux généraux pour les colonnes.
showRowGrandTotals Spécifie si le rapport de tableau croisé dynamique affiche des totaux généraux pour les lignes.
subtotalLocation Cette propriété indique le SubtotalLocationType de tous les champs du tableau croisé dynamique.
PivotTable columnHierarchies Les hiérarchies de colonne de tableau croisé dynamique.
dataHierarchies Les hiérarchies de données de tableau croisé dynamique.
delete() Supprime le tableau croisé dynamique.
filterHierarchies Les hiérarchies de filtre de tableau croisé dynamique.
Hiérarchies Les hiérarchies Pivot de tableau croisé dynamique.
Disposition Le PivotLayout décrivant la disposition et la structure visuelle de tableau croisé dynamique.
rowHierarchies Les hiérarchies de lignes de tableau croisé dynamique.
PivotTableCollection add(name: string, source: Range | string | Table, destination : plage | string) Ajoutez un tableau croisé dynamique basé sur les données sources spécifiées et insérez-le dans la cellule supérieure gauche de la plage de destination.
Range dataValidation Renvoie un objet de validation des données.
RowColumnPivotHierarchy fields Renvoie les PivotFields associés à la RowColumnPivotHierarchy.
id ID de rowColumnPivotHierarchy.
name Nom de la RowColumnPivotHierarchy.
position Position de la RowColumnPivotHierarchy.
setToDefault() Restaurer la RowColumnPivotHierarchy à ses valeurs par défaut.
RowColumnPivotHierarchyCollection add(pivotHierarchy: Excel.PivotHierarchy) Ajoute le PivotHierarchy à l’axe en cours.
getCount() Obtient le nombre de hiérarchies croisées de la collection.
getItem(name: string) Obtient un RowColumnPivotHierarchy par son nom ou son ID.
getItemOrNullObject(name: string) Obtient une RowColumnPivotHierarchy par nom.
items Obtient l’élément enfant chargé dans cette collection de sites.
remove(rowColumnPivotHierarchy: Excel.RowColumnPivotHierarchy) Supprime le PivotHierarchy de l’axe en cours.
Runtime enableEvents Activer/désactiver les événements JavaScript dans le volet Office ou le complément de contenu actuel.
ShowAsRule baseField PivotField sur lequel baser le ShowAs calcul, le cas échéant en fonction du ShowAsCalculation type , sinon null.
baseItem Élément sur lequel baser le ShowAs calcul, le cas échéant en fonction du ShowAsCalculation type , sinon null.
Calcul Calcul ShowAs à utiliser pour le champ croisé dynamique.
Style autoIndent Spécifie si le texte est automatiquement mis en retrait lorsque l’alignement du texte dans une cellule est défini sur une distribution égale.
textOrientation L’orientation du texte pour le style.
Subtotals automatic Si Automatic a la valeur true, toutes les autres valeurs sont ignorées lors de la définition de .Subtotals
Moyenne
count
countNumbers
Max
Min
Produit
standardDeviation
standardDeviationP
Somme
Variance
varianceP
Tableau legacyId Retourne un ID numérique.
TableChangedEventArgs getRange(ctx: Excel.RequestContext) Obtient la plage qui représente la zone modifiée d’un tableau sur une feuille de calcul spécifique.
getRangeOrNullObject(ctx: Excel.RequestContext) Obtient la plage qui représente la zone modifiée d’un tableau sur une feuille de calcul spécifique.
Classeur readOnly Retourne true si le classeur est ouvert en mode lecture seule.
WorkbookCreated
Feuille de calcul onCalculated Se produit lorsque la feuille de calcul est calculée.
showGridlines Spécifie si le quadrillage est visible par l’utilisateur.
showHeadings Spécifie si les titres sont visibles par l’utilisateur.
WorksheetCalculatedEventArgs type Obtient le type de l’événement.
worksheetId Obtient l’ID de la feuille de calcul dans laquelle le calcul s’est produit.
worksheetChangedEventArgs getRange(ctx: Excel.RequestContext) Obtient l’adresse de plage qui représente la zone modifiée dans une feuille de calcul spécifique.
getRangeOrNullObject(ctx: Excel.RequestContext) Obtient l’adresse de plage qui représente la zone modifiée dans une feuille de calcul spécifique.
WorksheetCollection onCalculated Se produit lorsqu’une feuille de calcul du classeur est calculée.

Voir aussi