Excel.Slicer class

Représente la légende du segment.

caption: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

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é

Représente la hauteur, exprimée en points, de l’axe de graphique. Lève une exception lorsqu’elle InvalidArgument est définie avec une valeur négative ou zéro comme entrée.

height: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Représente l’ID unique du segment.

readonly id: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

La valeur est true si tous les filtres actuellement appliqués sur le segment sont effacés.

readonly isFilterCleared: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Représente la distance, en points, entre le côté gauche du graphique et l’origine de la feuille de calcul. Génère une InvalidArgument erreur quand elle est définie avec une valeur négative en tant qu’entrée.

left: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Représente le nom du segment.

name: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Représente la collection d’éléments de segment qui font partie du segment.

readonly slicerItems: Excel.SlicerItemCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Représente l’ordre de tri des éléments dans le segment. Les valeurs possibles sont : « DataSourceOrder », « Ascending », « Descending ».

sortBy: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Valeur constante qui représente le style de segment. Les valeurs possibles sont : « SlicerStyleLight1 » à « SlicerStyleLight6 », « TableStyleOther1 » à « TableStyleOther2 », « SlicerStyleDark1 » à « SlicerStyleDark6 ». Vous pouvez également indiquer un style personnalisé présent dans le classeur.

style: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const slicer = context.workbook.slicers.getItem("Fruit Slicer");
    slicer.style = "SlicerStyleLight6";
    await context.sync();
});

Représente la distance, en points, du bord supérieur de la section à la partie droite de la feuille de calcul. Génère une InvalidArgument erreur quand elle est définie avec une valeur négative en tant qu’entrée.

top: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Représente la largeur, en points, de la forme. Génère une InvalidArgument erreur quand elle est définie avec une valeur négative ou zéro comme entrée.

width: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Obtenir la feuille de calcul contenant la plage.

readonly worksheet: Excel.Worksheet;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Supprime tous les filtres appliqués actuellement sur le tableau.

clearFilters(): void;

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const slicer = context.workbook.slicers.getItem("Fruit Slicer");
    slicer.clearFilters();
    await context.sync();
});

Supprime le segment.

delete(): void;

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.slicers.getItemAt(0).delete();
    await context.sync();
});

Renvoie une matrice de noms d’éléments sélectionnés.

getSelectedItems(): OfficeExtension.ClientResult<string[]>;

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

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.SlicerLoadOptions): Excel.Slicer;

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

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

Paramètres

Retours

Sélectionne les éléments de segment en fonction de leurs clés. Les sélections précédentes sont effacées. Tous les éléments sont sélectionnés par défaut si le tableau est vide.

selectItems(items?: string[]): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const slicer = context.workbook.slicers.getItem("Fruit Slicer");
    slicer.selectItems(["Lemon", "Lime", "Orange"]);
    await context.sync();
});

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.SlicerUpdateData, 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.Slicer): void;

Paramètres

Retours

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

toJSON(): Excel.Interfaces.SlicerData;

Retours