Excel.PivotLayout class

Description du texte de remplacement du tableau croisé dynamique.

Le texte de remplacement fournit une autre représentation textuelle des informations contenues dans le tableau croisé dynamique. Ces informations sont utiles pour les personnes présentant des troubles visuels ou cognitifs qui ne peuvent pas voir ou comprendre le tableau. Un titre peut être lu à une personne handicapée et est utilisé pour déterminer si elle souhaite entendre la description du contenu.

altTextDescription: string;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.13]

Titre de texte de remplacement du tableau croisé dynamique.

Le texte de remplacement fournit une autre représentation textuelle des informations contenues dans le tableau croisé dynamique. Ces informations sont utiles pour les personnes présentant des troubles visuels ou cognitifs qui ne peuvent pas voir ou comprendre le tableau. Un titre peut être lu à une personne handicapée et est utilisé pour déterminer si elle souhaite entendre la description du contenu.

altTextTitle: string;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.13]

Spécifie si la mise en forme est automatiquement mise en forme lorsqu’elle est actualisée ou lorsque des champs sont déplacés.

autoFormat: boolean;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.9]

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é

Le texte qui est automatiquement rempli dans une cellule vide du tableau croisé dynamique si fillEmptyCells == true. Notez que cette valeur persiste si fillEmptyCells est définie sur false, et que la définition de cette valeur ne définit pas cette propriété sur true. Par défaut, il s’agit d’une chaîne vide.

emptyCellText: string;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.13]

Indique si la liste de champs peut être affichée dans l’interface utilisateur.

enableFieldList: boolean;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.10]

Spécifie si les cellules vides du tableau croisé dynamique doivent être remplies avec le emptyCellText. La valeur par défaut est false. Notez que la valeur de emptyCellText persiste lorsque cette propriété est définie sur false.

fillEmptyCells: boolean;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.13]

Cette propriété indique le PivotLayoutType de tous les champs sur le tableau croisé dynamique. Si les champs ont des états différents, la valeur sera null.

layoutType: Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline";

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.8]

Indique si la mise en forme est conservée lorsque le rapport est actualisé ou recalculé par des opérations telles que le pivotement, le tri ou la modification d’éléments de champ de page.

preserveFormatting: boolean;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.9]

Indique si le rapport de tableau croisé dynamique affiche des totaux généraux pour les colonnes.

showColumnGrandTotals: boolean;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.8]

Indique si le tableau croisé dynamique affiche les en-têtes de champ (légendes de champ et listes déroulantes de filtre).

showFieldHeaders: boolean;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.13]

Indique si le rapport de tableau croisé dynamique affiche des totaux généraux pour les lignes.

showRowGrandTotals: boolean;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.8]

Cette propriété indique le SubtotalLocationType nombre de tous les champs du tableau croisé dynamique. Si les champs ont des états différents, il s’agit de null.

subtotalLocation: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off";

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.8]

Définit si une ligne vide doit être affichée après chaque élément. Elle est définie au niveau global pour le tableau croisé dynamique et appliquée à des champs croisés dynamiques individuels. Cette fonction remplace le paramètre de tous les champs du tableau croisé dynamique par la valeur du display paramètre.

displayBlankLineAfterEachItem(display: boolean): void;

Paramètres

Retours

Remarques

[Jeu d’API : ExcelApi 1.13]

Renvoie la plage où les étiquettes de colonnes de tableau croisé dynamique se trouvent.

getColumnLabelRange(): Excel.Range;

Retours

Remarques

[Jeu d’API : ExcelApi 1.8]

Renvoie la plage où les valeurs de données de tableau croisé dynamique se trouvent.

getDataBodyRange(): Excel.Range;

Retours

Remarques

[Jeu d’API : ExcelApi 1.8]

Obtient DataHierarchy servant à calculer la valeur dans une plage spécifiée dans le tableau croisé dynamique.

getDataHierarchy(cell: Range | string): Excel.DataPivotHierarchy;

Paramètres

Retours

Objet DataPivotHierarchy utilisé pour calculer la valeur dans la cellule spécifiée.

Remarques

[Jeu d’API : ExcelApi 1.9]

Renvoie la plage de la zone de filtre de tableau croisé dynamique.

getFilterAxisRange(): Excel.Range;

Retours

Remarques

[Jeu d’API : ExcelApi 1.8]

Obtient le PivotItems à partir d’un axe qui composent la valeur dans une plage spécifiée dans le tableau croisé dynamique.

getPivotItems(axis: Excel.PivotAxis, cell: Range | string): Excel.PivotItemCollection;

Paramètres

Retours

Collection PivotItem des éléments croisés dynamiques utilisés pour calculer les valeurs dans la ligne spécifiée.

Remarques

[Jeu d’API : ExcelApi 1.9]

Obtient le PivotItems à partir d’un axe qui composent la valeur dans une plage spécifiée dans le tableau croisé dynamique.

getPivotItems(axis: "Unknown" | "Row" | "Column" | "Data" | "Filter", cell: Range | string): Excel.PivotItemCollection;

Paramètres

Retours

Collection PivotItem des éléments croisés dynamiques utilisés pour calculer les valeurs dans la ligne spécifiée.

Remarques

[Jeu d’API : ExcelApi 1.9]

Renvoie la plage sur laquelle le tableau croisé dynamique existe, à l’exception de la zone de filtre.

getRange(): Excel.Range;

Retours

Remarques

[Jeu d’API : ExcelApi 1.8]

Renvoie la plage où les étiquettes de lignes de tableau croisé dynamique se trouvent.

getRowLabelRange(): Excel.Range;

Retours

Remarques

[Jeu d’API : ExcelApi 1.8]

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.PivotLayoutLoadOptions): Excel.PivotLayout;

Paramètres

Retours

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

Paramètres

Retours

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

Paramètres

Retours

Définit le paramètre « Répéter toutes les étiquettes d’élément » dans tous les champs du tableau croisé dynamique.

repeatAllItemLabels(repeatLabels: boolean): void;

Paramètres

Retours

Remarques

[Jeu d’API : ExcelApi 1.13]

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.PivotLayoutUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

Retours

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

set(properties: Excel.PivotLayout): void;

Paramètres

Retours

Définit le tableau croisé dynamique pour trier automatiquement à l’aide de la cellule spécifiée pour sélectionner automatiquement tous les critères et contexte nécessaires. Cela se comporte de la même manière que d’appliquer un tri automatique de l’interface utilisateur.

setAutoSortOnCell(cell: Range | string, sortBy: Excel.SortBy): void;

Paramètres

Retours

Remarques

[Jeu d’API : ExcelApi 1.9]

Définit le tableau croisé dynamique pour trier automatiquement à l’aide de la cellule spécifiée pour sélectionner automatiquement tous les critères et contexte nécessaires. Cela se comporte de la même manière que d’appliquer un tri automatique de l’interface utilisateur.

setAutoSortOnCell(cell: Range | string, sortBy: "Ascending" | "Descending"): void;

Paramètres

Retours

Remarques

[Jeu d’API : ExcelApi 1.9]

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.PivotLayout est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.PivotLayoutDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.PivotLayoutData;

Retours