ExcelScript.Slicer interface

Paquet:

ExcelScript

Représente un Slicer objet dans le classeur.

Remarques

Exemples

/**
 * This script adds a slicer for an existing PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Pivot".
  const farmPivot = workbook.getPivotTable("Farm Pivot");

  // Create the slicer. 
  // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
  const fruitSlicer: ExcelScript.Slicer = workbook.addSlicer(
    farmPivot, /* The table or PivotTale to be sliced. */
    farmPivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
  );

  // Select the items to display.
  fruitSlicer.selectItems(["Lemon", "Lime"]);

  // Set the left margin of the slicer.
  fruitSlicer.setLeft(400);
}

Méthodes

clearFilters()	Supprime tous les filtres appliqués actuellement sur le tableau.
delete()	Supprime le segment.
getCaption()	Représente le légende du segment.
getHeight()	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.
getId()	Représente l’ID unique du segment.
getIsFilterCleared()	La valeur est true si tous les filtres actuellement appliqués sur le segment sont effacés.
getLeft()	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.
getName()	Représente le nom du segment.
getSelectedItems()	Renvoie une matrice de noms d’éléments sélectionnés.
getSlicerItem(key)	Obtient un segment de l’élément à l’aide de son nom ou clé. Si l’élément de segment n’existe pas, cette méthode retourne undefined.
getSlicerItems()	Représente la collection d’éléments de segment qui font partie du segment.
getSortBy()	Représente l’ordre de tri des éléments dans le segment. Les valeurs possibles sont : « DataSourceOrder », « Ascending », « Descending ».
getStyle()	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.
getTop()	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.
getWidth()	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.
getWorksheet()	Obtenir la feuille de calcul contenant la plage.
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.
setCaption(caption)	Représente le légende du segment.
setHeight(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.
setLeft(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.
setName(name)	Représente le nom du segment.
setSortBy(sortBy)	Représente l’ordre de tri des éléments dans le segment. Les valeurs possibles sont : « DataSourceOrder », « Ascending », « Descending ».
setStyle(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.
setTop(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.
setWidth(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.

Détails de la méthode

clearFilters()

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

clearFilters(): void;

Retours

void

delete()

Supprime le segment.

delete(): void;

Retours

void

getCaption()

Représente le légende du segment.

getCaption(): string;

Retours

string

getHeight()

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.

getHeight(): number;

Retours

number

getId()

Représente l’ID unique du segment.

getId(): string;

Retours

string

getIsFilterCleared()

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

getIsFilterCleared(): boolean;

Retours

boolean

getLeft()

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.

getLeft(): number;

Retours

number

getName()

Représente le nom du segment.

getName(): string;

Retours

string

getSelectedItems()

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

getSelectedItems(): string[];

Retours

string[]

getSlicerItem(key)

Obtient un segment de l’élément à l’aide de son nom ou clé. Si l’élément de segment n’existe pas, cette méthode retourne undefined.

getSlicerItem(key: string): SlicerItem | undefined;

Paramètres

key

string

Clé ou nom du segment à récupérer.

Retours

ExcelScript.SlicerItem | undefined

getSlicerItems()

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

getSlicerItems(): SlicerItem[];

Retours

ExcelScript.SlicerItem[]

getSortBy()

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

getSortBy(): SlicerSortType;

Retours

ExcelScript.SlicerSortType

getStyle()

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.

getStyle(): string;

Retours

string

getTop()

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.

getTop(): number;

Retours

number

getWidth()

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.

getWidth(): number;

Retours

number

getWorksheet()

Obtenir la feuille de calcul contenant la plage.

getWorksheet(): Worksheet;

Retours

ExcelScript.Worksheet

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

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

Retours

void

setCaption(caption)

Représente le légende du segment.

setCaption(caption: string): void;

Paramètres

caption

string

Retours

void

setHeight(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.

setHeight(height: number): void;

Paramètres

height

number

Retours

void

setLeft(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.

setLeft(left: number): void;

Paramètres

left

number

Retours

void

setName(name)

Représente le nom du segment.

setName(name: string): void;

Paramètres

name

string

Retours

void

setSortBy(sortBy)

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

setSortBy(sortBy: SlicerSortType): void;

Paramètres

sortBy

ExcelScript.SlicerSortType

Retours

void

setStyle(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.

setStyle(style: string): void;

Paramètres

style

string

Retours

void

setTop(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.

setTop(top: number): void;

Paramètres

top

number

Retours

void

setWidth(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.

setWidth(width: number): void;

Paramètres

width

number

Retours

void