Excel.FilterPivotHierarchy class

Paquet:

excel

Représente le FilterPivotHierarchy Excel.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Propriétés

context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
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.

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 passer un objet brut avec les propriétés appropriées ou 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.
setToDefault()	Restaurer la FilterPivotHierarchy à ses valeurs par défaut.
toJSON()	Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.FilterPivotHierarchy est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.FilterPivotHierarchyDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

enableMultipleFilterItems

Détermine si vous voulez autoriser plusieurs éléments de filtre.

enableMultipleFilterItems: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

fields

Renvoie les PivotFields associés à la FilterPivotHierarchy.

readonly fields: Excel.PivotFieldCollection;

Valeur de propriété

Excel.PivotFieldCollection

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

id

ID de l’objet FilterPivotHierarchy.

readonly id: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

name

Nom du filterPivotHierarchy.

name: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

position

Position du filterPivotHierarchy.

position: number;

Valeur de propriété

number

Remarques

[ Ensemble 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.FilterPivotHierarchyLoadOptions): Excel.FilterPivotHierarchy;

Paramètres

options

Excel.Interfaces.FilterPivotHierarchyLoadOptions

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

Retours

Excel.FilterPivotHierarchy

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.FilterPivotHierarchy;

Paramètres

propertyNames

string | string[]

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

Retours

Excel.FilterPivotHierarchy

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.FilterPivotHierarchy;

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.FilterPivotHierarchy

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

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

Paramètres

properties

Excel.Interfaces.FilterPivotHierarchyUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des 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 properties 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.FilterPivotHierarchy): void;

Paramètres

properties

Excel.FilterPivotHierarchy

Retours

void

setToDefault()

Restaurer la FilterPivotHierarchy à ses valeurs par défaut.

setToDefault(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

toJSON()

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

toJSON(): Excel.Interfaces.FilterPivotHierarchyData;

Retours

Excel.Interfaces.FilterPivotHierarchyData