Nouveautés de l’API JavaScript Excel 1.12
ExcelApi 1.12 a augmenté la prise en charge des formules dans les plages en ajoutant des API pour le suivi des tableaux dynamiques et la recherche des précédents directs d’une formule. Il a également ajouté le contrôle API des filtres de tableau croisé dynamique. Des améliorations ont également été apportées aux zones de fonctionnalités des commentaires, des paramètres de culture et des propriétés personnalisées.
Fonctionnalité | Description | Objets pertinents |
---|---|---|
Événements de commentaire | Ajoute des événements pour ajouter, modifier et supprimer à la collection de commentaires. | CommentCollection |
Paramètres de culture de date et d’heure | Donne accès à des paramètres culturels supplémentaires autour de la mise en forme de date et d’heure. | CultureInfo, Application NumberFormatInfo |
Précédents directs | Retourne des plages utilisées pour évaluer la formule d’une cellule. | Range |
Filtres de tableau croisé dynamique | Applique des filtres pilotés par les valeurs aux champs d’un tableau croisé dynamique. | PivotField, PivotFilters |
Dépassement de plage | Permet aux compléments de rechercher les plages associées aux résultats de tableau dynamique . | Range |
Propriétés personnalisées au niveau de la feuille de calcul | Permet aux propriétés personnalisées d’être étendues au niveau de la feuille de calcul, en plus d’être étendues au niveau du classeur. | WorksheetCustomProperty, WorksheetCustomPropertyCollection |
Liste des API
Le tableau suivant répertorie les API dans l’ensemble de conditions requises de l’API JavaScript Excel 1.12. 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.12 ou version antérieure, consultez API Excel dans l’ensemble de conditions requises 1.12 ou antérieur.
Classe | Champs | Description |
---|---|---|
ChartAxisTitle | textOrientation | Spécifie l’angle auquel le texte est orienté pour le titre de l’axe du graphique. |
ChartSeries | getDimensionValues(dimension : Excel.ChartSeriesDimension) | Obtient les valeurs d’une dimension unique de la série de graphiques. |
Commentaire | contentType | Obtient le type de contenu du commentaire. |
CommentAddedEventArgs | commentDetails | Obtient le CommentDetail tableau qui contient l’ID de commentaire et les ID de ses réponses associées. |
source | Spécifie 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 l’événement s’est produit. | |
CommentChangedEventArgs | changeType | Obtient le type de modification qui représente la façon dont l’événement modifié est déclenché. |
commentDetails | Obtenez le CommentDetail tableau qui contient l’ID de commentaire et les ID de ses réponses associées. |
|
source | Spécifie 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 l’événement s’est produit. | |
CommentCollection | onAdded | Se produit lorsque les commentaires sont ajoutés. |
onChanged | Se produit lorsque des commentaires ou des réponses d’une collection de commentaires sont modifiés, y compris lorsque les réponses sont supprimées. | |
onDeleted | Se produit lorsque des commentaires sont supprimés dans la collection de commentaires. | |
CommentDeletedEventArgs | commentDetails | Obtient le CommentDetail tableau qui contient l’ID de commentaire et les ID de ses réponses associées. |
source | Spécifie 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 l’événement s’est produit. | |
CommentDetail | commentId | Représente l’ID du commentaire. |
replyIds | Représente les ID des réponses associées qui appartiennent au commentaire. | |
CommentReply | contentType | Type de contenu de la réponse. |
CultureInfo | datetimeFormat | Définit le format culturellement approprié de l’affichage de la date et de l’heure. |
DatetimeFormatInfo | dateSeparator | Obtient la chaîne utilisée comme séparateur de date. |
longDatePattern | Obtient la chaîne de format pour une valeur de date longue. | |
longTimePattern | Obtient la chaîne de format pour une valeur de longue durée. | |
shortDatePattern | Obtient la chaîne de format pour une valeur de date courte. | |
timeSeparator | Obtient la chaîne utilisée comme séparateur de temps. | |
PivotDateFilter | comparateur | Le comparateur est la valeur statique à laquelle d’autres valeurs sont comparées. |
condition | Spécifie la condition du filtre, qui définit les critères de filtrage nécessaires. | |
exclusif | Si true la valeur est , le filtre exclut les éléments qui répondent aux critères. |
|
lowerBound | Limite inférieure de la plage pour la condition de between filtre. |
|
upperBound | Limite supérieure de la plage pour la condition de between filtre. |
|
wholeDays | Pour equals les conditions de filtre , before after , et between , indique si des comparaisons doivent être effectuées en tant que jours entiers. |
|
PivotField | applyFilter(filter : Excel.PivotFilters) | Définit un ou plusieurs filtres croisés dynamiques actuels du champ et les applique au champ. |
clearAllFilters() | Efface tous les critères de tous les filtres du champ. | |
clearFilter(filterType : Excel.PivotFilterType) | Efface tous les critères existants du filtre du champ du type donné (le cas échéant). | |
getFilters() | Obtient tous les filtres actuellement appliqués sur le champ. | |
isFiltered(filterType ?: Excel.PivotFilterType) | Vérifie s’il existe des filtres appliqués sur le champ. | |
PivotFilters | dateFilter | Filtre de date actuellement appliqué du champ de tableau croisé dynamique. |
labelFilter | Filtre d’étiquettes actuellement appliqué à PivotField. | |
manualFilter | Filtre manuel actuellement appliqué au champ croisé dynamique. | |
valueFilter | Filtre de valeurs actuellement appliqué au champ croisé dynamique. | |
PivotLabelFilter | comparateur | Le comparateur est la valeur statique à laquelle d’autres valeurs sont comparées. |
condition | Spécifie la condition du filtre, qui définit les critères de filtrage nécessaires. | |
exclusif | Si true la valeur est , le filtre exclut les éléments qui répondent aux critères. |
|
lowerBound | Limite inférieure de la plage pour la condition de between filtre. |
|
substring | Sous-chaîne utilisée pour les conditions de beginsWith filtre , endsWith et contains . |
|
upperBound | Limite supérieure de la plage pour la condition de between filtre. |
|
PivotManualFilter | selectedItems | Liste des éléments sélectionnés à filtrer manuellement. |
PivotTable | allowMultipleFiltersPerField | Spécifie si le tableau croisé dynamique autorise l’application de plusieurs filtres croisés dynamiques sur un champ de tableau croisé dynamique donné dans la table. |
PivotTableScopedCollection | getCount() | Obtient le nombre de tableaux croisés dynamiques dans la collection. |
getFirst() | Obtient le premier tableau croisé dynamique de la collection. | |
getItem(key: string) | Obtient un tableau croisé dynamique par nom. | |
getItemOrNullObject(name: string) | Obtient un tableau croisé dynamique par nom. | |
items | Obtient l’élément enfant chargé dans cette collection de sites. | |
PivotValueFilter | comparateur | Le comparateur est la valeur statique à laquelle d’autres valeurs sont comparées. |
condition | Spécifie la condition du filtre, qui définit les critères de filtrage nécessaires. | |
exclusif | Si true la valeur est , le filtre exclut les éléments qui répondent aux critères. |
|
lowerBound | Limite inférieure de la plage pour la condition de between filtre. |
|
selectionType | Spécifie si le filtre concerne les N éléments haut/bas, les N pourcentages supérieurs/bas ou les N premiers/bas. | |
seuil | Nombre seuil « N » d’éléments, pourcentage ou somme à filtrer pour une condition de filtre supérieure/inférieure. | |
upperBound | Limite supérieure de la plage pour la condition de between filtre. |
|
value | Nom de la « valeur » choisie dans le champ par lequel filtrer. | |
Range | getDirectPrecedents() | Renvoie un WorkbookRangeAreas objet qui représente la plage contenant toutes les cellules de précédent direct d’une plage spécifiée dans la même feuille de calcul ou dans plusieurs feuilles de calcul. |
getPivotTables(fullyContained ?: boolean) | Obtient une collection délimitée de tableaux croisés dynamiques qui chevauchent la plage. | |
getSpillParent() | Obtient l’objet de la plage contenant la cellule d’ancrage d’une cellule prise renversée dans. | |
getSpillParentOrNullObject() | Obtient l’objet de plage contenant la cellule d’ancrage pour la cellule qui est renversée. | |
getSpillingToRange() | Obtient l’objet de la plage contenant la plage renversé lorsque appelée sur une cellule d’ancrage. | |
getSpillingToRangeOrNullObject() | Obtient l’objet de la plage contenant la plage renversé lorsque appelée sur une cellule d’ancrage. | |
hasSpill | Représente si toutes les cellules ont une bordure renversée. | |
numberFormatCategories | Représente la catégorie de format numérique de chaque cellule. | |
savedAsArray | Représente si toutes les cellules doivent être enregistrées sous forme de formule matricielle. | |
RangeAreasCollection | getCount() | Obtient le nombre d’objets de RangeAreas cette collection. |
getItemAt(index: number) | Retourne l’objet RangeAreas en fonction de la position dans la collection. |
|
items | Obtient l’élément enfant chargé dans cette collection de sites. | |
WorkbookRangeAreas | addresses | Retourne un tableau d’adresses de style A1. |
Zones | Retourne l’objet RangeAreasCollection . |
|
getRangeAreasBySheet(key : string) | Retourne l’objet en fonction de l’ID RangeAreas ou du nom de la feuille de calcul dans la collection. |
|
getRangeAreasOrNullObjectBySheet(key : string) | Retourne l’objet RangeAreas en fonction du nom ou de l’ID de feuille de calcul dans la collection. |
|
Gammes | Retourne des plages qui composent cet objet dans un RangeCollection objet . |
|
Feuille de calcul | customProperties | Obtient une collection de propriétés personnalisées au niveau de la feuille de calcul. |
WorksheetCustomProperty | delete() | Supprime la propriété personnalisée. |
key | Obtient la clé de la propriété personnalisée. | |
value | Obtient ou définit la valeur de la propriété personnalisée. | |
WorksheetCustomPropertyCollection | add(key : string, value : string) | Ajoute une nouvelle propriété personnalisée qui correspond à la clé fournie. |
getCount() | Obtient le nombre de propriétés personnalisées dans cette feuille de calcul. | |
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. |