Excel.PivotItem class

Paquet:

excel

Représente l’élément de tableau croisé dynamique d’Excel.

Extends

OfficeExtension.ClientObject

Remarques

Jeu d’API : ExcelApi 1.8

Utilisateur

• Excel.PivotField : sortByValues
• Excel.PivotItemCollection : getItem, getItemOrNullObject, items
• Excel.PivotLayout : getCell
• Excel.PivotManualFilter : selectedItems
• Excel.ShowAsRule : baseItem

Propriétés

context	Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
id	ID de l’élément de tableau croisé dynamique.
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	Indique si l’élément de tableau croisé dynamique est visible.

Méthodes

load(options)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
set(properties, options)	Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.
set(properties)	Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
toJSON()	Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.PivotItem est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.PivotItemDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

id

ID de l’élément de tableau croisé dynamique.

readonly id: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.8

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.

isExpanded: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.8

name

Nom du champ PivotItem.

name: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.8

visible

Indique si l’élément de tableau croisé dynamique est visible.

visible: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.8

Détails de la méthode

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.PivotItemLoadOptions): Excel.PivotItem;

Paramètres

options

Excel.Interfaces.PivotItemLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.PivotItem

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.PivotItem;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.

Retours

Excel.PivotItem

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.PivotItem;

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Excel.PivotItem

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.PivotItemUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties

Excel.Interfaces.PivotItemUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux propriétés de l’objet sur lequel la méthode est appelée.

options

OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet de propriétés tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.PivotItem): void;

Paramètres

properties

Excel.PivotItem

Retours

void

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.PivotItem est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.PivotItemDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.PivotItemData;

Retours

Excel.Interfaces.PivotItemData