Excel.SlicerCollection class

Paquet:

excel

Représente une collection de tous les objets de segment dans le classeur ou une feuille de calcul.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

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.
items	Obtient l’élément enfant chargé dans cette collection de sites.

Méthodes

add(slicerSource, sourceField, slicerDestination)	Ajoute un nouveau segment au classeur.
getCount()	Renvoie le nombre de séries de la collection.
getItem(key)	Obtient un objet de segment à l’aide de son nom ou de son ID.
getItemAt(index)	Obtient une forme en fonction de sa position dans la collection.
getItemOrNullObject(key)	Obtient un segment à l’aide de son nom ou de son ID. Si le segment n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
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.
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.SlicerCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.SlicerCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

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

items

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: Excel.Slicer[];

Valeur de propriété

Excel.Slicer[]

Détails de la méthode

add(slicerSource, sourceField, slicerDestination)

Ajoute un nouveau segment au classeur.

add(slicerSource: string | PivotTable | Table, sourceField: string | PivotField | number | TableColumn, slicerDestination?: string | Worksheet): Excel.Slicer;

Paramètres

slicerSource

string | Excel.PivotTable | Excel.Table

Source de données sur laquelle le nouveau segment sera basé. Il peut s’agir d’un PivotTable objet, d’un Table objet ou d’une chaîne. Lorsqu’un objet PivotTable est passé, la source de données est la source de l’objet PivotTable . Lorsqu’un Table objet est passé, la source de données est l’objet Table . Lorsqu’une chaîne est passée, elle est interprétée comme le nom ou l’ID d’un tableau croisé dynamique ou d’une table.

sourceField

string | Excel.PivotField | number | Excel.TableColumn

Champ dans la source de données par lequel filtrer. Il peut s’agir d’un PivotField objet, d’un TableColumn objet, de l’ID d’un PivotField ou du nom ou de l’ID d’un TableColumn.

slicerDestination

string | Excel.Worksheet

Facultatif. Feuille de calcul dans laquelle le nouveau segment sera créé. Il peut s’agir d’un Worksheet objet ou du nom ou de l’ID d’une feuille de calcul. Ce paramètre peut être omis si la collection de segments est récupérée à partir d’une feuille de calcul.

Retours

Excel.Slicer

Nouveau segment.

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.getItem("Pivot");
    const slicer = sheet.slicers.add(
        "Farm Sales", /* The slicer data source. For PivotTables, this can be the PivotTable object reference or name. */
        "Type" /* The field in the data source to filter by. For PivotTables, this can be a PivotField object reference or ID. */
    );
    slicer.name = "Fruit Slicer";
    await context.sync();
});

getCount()

Renvoie le nombre de séries de la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

getItem(key)

Obtient un objet de segment à l’aide de son nom ou de son ID.

getItem(key: string): Excel.Slicer;

Paramètres

key

string

Nom ou ID du segment.

Retours

Excel.Slicer

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.caption = "Fruit Types";
    slicer.left = 395;
    slicer.top = 15;
    slicer.height = 135;
    slicer.width = 150;
    await context.sync();
});

getItemAt(index)

Obtient une forme en fonction de sa position dans la collection.

getItemAt(index: number): Excel.Slicer;

Paramètres

index

number

Valeur d’indice de l’objet à récupérer. Avec indice zéro.

Retours

Excel.Slicer

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

getItemOrNullObject(key)

Obtient un segment à l’aide de son nom ou de son ID. Si le segment n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getItemOrNullObject(key: string): Excel.Slicer;

Paramètres

key

string

Nom ou ID du segment à récupérer.

Retours

Excel.Slicer

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.SlicerCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerCollection;

Paramètres

options

Excel.Interfaces.SlicerCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Retours

Excel.SlicerCollection

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

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

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?: OfficeExtension.LoadOption): Excel.SlicerCollection;

Paramètres

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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.SlicerCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.SlicerCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): Excel.Interfaces.SlicerCollectionData;

Retours

Excel.Interfaces.SlicerCollectionData