Excel.Slicer class

Référence

Paquet:: excel

Représente un Slicer objet dans le classeur.

Extends: OfficeExtension.ClientObject

Remarques

Propriétés

caption	Représente la légende du segment.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
height	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.
id	Représente l’ID unique du segment.
isFilterCleared	La valeur est `true` si tous les filtres actuellement appliqués sur le segment sont effacés.
left	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.
name	Représente le nom du segment.
nameInFormula	Représente le nom du segment utilisé dans la formule.
slicerItems	Représente la collection d’éléments de segment qui font partie du segment.
slicerStyle	Style appliqué au segment.
sortBy	Représente l’ordre de tri des éléments dans le segment. Les valeurs possibles sont : « DataSourceOrder », « Ascending », « Descending ».
style	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.
top	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.
width	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.
worksheet	Obtenir la feuille de calcul contenant la plage.

Méthodes

clearFilters()	Supprime tous les filtres appliqués actuellement sur le tableau.
delete()	Supprime le segment.
getSelectedItems()	Renvoie une matrice de noms d’éléments sélectionnés.
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.
selectItems(items)	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.
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.
setStyle(style)	Définit le style appliqué au segment.
toJSON()	Remplace la méthode JavaScript `toJSON()` afin de fournir une sortie plus utile lorsqu’un objet API est passé à `JSON.stringify()`. (`JSON.stringify`appelle à 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.SlicerData`que ) qui 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é

caption

Représente la légende du segment.

caption: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

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

height

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é

number

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

id

Représente l’ID unique du segment.

readonly id: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

isFilterCleared

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

readonly isFilterCleared: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

left

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é

number

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

name

Représente le nom du segment.

name: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

nameInFormula

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Représente le nom du segment utilisé dans la formule.

nameInFormula: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

slicerItems

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

readonly slicerItems: Excel.SlicerItemCollection;

Valeur de propriété

Excel.SlicerItemCollection

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

slicerStyle

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Style appliqué au segment.

readonly slicerStyle: Excel.SlicerStyle;

Valeur de propriété

Excel.SlicerStyle

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

sortBy

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é

Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

style

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é

string

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();
});

top

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é

number

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

width

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é

number

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

worksheet

Obtenir la feuille de calcul contenant la plage.

readonly worksheet: Excel.Worksheet;

Valeur de propriété

Excel.Worksheet

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Détails de la méthode

clearFilters()

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

clearFilters(): void;

Retours

void

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();
});

delete()

Supprime le segment.

delete(): void;

Retours

void

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();
});

getSelectedItems()

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

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

Retours

OfficeExtension.ClientResult<string[]>

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

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

Paramètres

options: Excel.Interfaces.SlicerLoadOptions

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

Retours

Excel.Slicer

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

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

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

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

selectItems(items)

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

items: string[]

Facultatif. Noms d’éléments de segment spécifiés à sélectionner.

Retours

void

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();
});

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

Paramètres

properties: Excel.Interfaces.SlicerUpdateData

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

Paramètres

properties: Excel.Slicer

Retours

void

setStyle(style)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Définit le style appliqué au segment.

setStyle(style: string | SlicerStyle | BuiltInSlicerStyle): void;

Paramètres

style: string | Excel.SlicerStyle | Excel.BuiltInSlicerStyle

Style à appliquer au segment. Une InvalidArgument erreur est générée si une chaîne qui ne correspond pas au nom d’un style est fournie.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

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

Excel.Interfaces.SlicerData