Class Slicer

Slicer

Représente un segment, qui permet de filtrer des plages, des graphiques et des tableaux croisés dynamiques de manière non collaborative. Cette classe contient des méthodes permettant d'accéder aux sélecteurs existants et de les modifier. Pour créer un sélecteur, utilisez Sheet.insertSlicer(range, anchorRowPos, anchorColPos).

Méthodes

Méthode	Type renvoyé	Brève description
getBackgroundColorObject()	Color|null	Renvoie l'arrière-plan Color du sélecteur.
getColumnPosition()	Integer|null	Renvoie la position de la colonne (par rapport à la plage de données du sélecteur) sur laquelle le filtre est appliqué dans le sélecteur, ou null si la position de la colonne n'est pas définie.
getContainerInfo()	ContainerInfo	Obtient des informations sur l'emplacement du sélecteur dans la feuille.
getFilterCriteria()	FilterCriteria|null	Renvoie les critères de filtrage du sélecteur ou null si les critères de filtrage ne sont pas définis.
getRange()	Range	Obtient la plage de données à laquelle le sélecteur est appliqué.
getTitle()	String	Renvoie le titre du sélecteur.
getTitleHorizontalAlignment()	String	Obtient l'alignement horizontal du titre.
getTitleTextStyle()	TextStyle	Renvoie le style de texte du titre du sélecteur.
isAppliedToPivotTables()	Boolean	Indique si le sélecteur donné est appliqué aux tableaux croisés dynamiques.
remove()	void	Supprime le segment.
setApplyToPivotTables(applyToPivotTables)	Slicer	Indique si le sélecteur donné doit être appliqué aux tableaux croisés dynamiques de la feuille de calcul.
setBackgroundColor(color)	Slicer	Définit la couleur d'arrière-plan du sélecteur.
setBackgroundColorObject(color)	Slicer	Définit l'arrière-plan Color du sélecteur.
setColumnFilterCriteria(columnPosition, filterCriteria)	Slicer	Définit l'index de colonne et les critères de filtrage du sélecteur.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	Slicer	Définit la position du sélecteur sur la feuille.
setRange(rangeApi)	Slicer	Définit la plage de données sur laquelle le sélecteur est appliqué.
setTitle(title)	Slicer	Définit le titre du sélecteur.
setTitleHorizontalAlignment(horizontalAlignment)	Slicer	Définit l'alignement horizontal du titre dans le sélecteur.
setTitleTextStyle(textStyle)	Slicer	Définit le style du texte du sélecteur.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
getBackgroundColor()	String|null	Renvoie la couleur d'arrière-plan du sélecteur au format CSS (par exemple, "#ffffff").

Documentation détaillée

getBackgroundColorObject()

Renvoie l'arrière-plan Color du sélecteur.

Renvois

Color|null : couleur d'arrière-plan de ce sélecteur. Renvoie null si aucune couleur n'est définie.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getColumnPosition()

Renvoie la position de la colonne (par rapport à la plage de données du sélecteur) sur laquelle le filtre est appliqué dans le sélecteur, ou null si la position de la colonne n'est pas définie. Il s'agit de la position de la colonne (indexée à 1), comme pour le filtre.

Renvois

Integer|null : position de la colonne de ce sélecteur.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getContainerInfo()

Obtient des informations sur l'emplacement du sélecteur dans la feuille.

Renvois

ContainerInfo : objet contenant la position du conteneur du sélecteur.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getFilterCriteria()

Renvoie les critères de filtrage du sélecteur ou null si les critères de filtrage ne sont pas définis.

Renvois

FilterCriteria|null : critères de filtre de ce sélecteur.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getRange()

Obtient la plage de données à laquelle le sélecteur est appliqué.

Renvois

Range : plage du sélecteur.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getTitle()

Renvoie le titre du sélecteur.

Renvois

String : ce sélecteur, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getTitleHorizontalAlignment()

Obtient l'alignement horizontal du titre.

Renvois

String : alignement horizontal du titre du sélecteur.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getTitleTextStyle()

Renvoie le style de texte du titre du sélecteur.

Renvois

TextStyle : style de texte du titre de ce sélecteur.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

isAppliedToPivotTables()

Indique si le sélecteur donné est appliqué aux tableaux croisés dynamiques.

Renvois

Boolean : true si ce sélecteur est appliqué à des tableaux croisés dynamiques, sinon false.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

remove()

Supprime le segment.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setApplyToPivotTables(applyToPivotTables)

Indique si le sélecteur donné doit être appliqué aux tableaux croisés dynamiques de la feuille de calcul.

Paramètres

Nom	Type	Description
applyToPivotTables	Boolean	Indique si ce sélecteur doit s'appliquer aux tableaux croisés dynamiques.

Renvois

Slicer : ce sélecteur, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setBackgroundColor(color)

Définit la couleur d'arrière-plan du sélecteur. Une valeur null réinitialise la couleur d'arrière-plan.

Paramètres

Nom	Type	Description
color	String	Nouvelle couleur d'arrière-plan de ce sélecteur en notation CSS (par exemple, "#ffffff").

Renvois

Slicer : ce sélecteur, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setBackgroundColorObject(color)

Définit l'arrière-plan Color du sélecteur. Une valeur null réinitialise la couleur d'arrière-plan.

Paramètres

Nom	Type	Description
color	Color	Nouvelle couleur d'arrière-plan de ce sélecteur.

Renvois

Slicer : ce sélecteur, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setColumnFilterCriteria(columnPosition, filterCriteria)

Définit l'index de colonne et les critères de filtrage du sélecteur. Une valeur null réinitialise le filtre du sélecteur.

Paramètres

Nom	Type	Description
columnPosition	Integer	Nouvelle position de colonne de ce sélecteur.
filterCriteria	FilterCriteria	Nouveaux critères de filtre de ce sélecteur.

Renvois

Slicer : ce sélecteur, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Définit la position du sélecteur sur la feuille. Les indices de position de la ligne et de la colonne d'ancrage sont indexés à partir de 1.

Paramètres

Nom	Type	Description
anchorRowPos	Integer	Le haut du sélecteur est ancré dans cette ligne.
anchorColPos	Integer	Le haut du sélecteur est ancré dans cette colonne.
offsetX	Integer	Décalage horizontal par rapport au coin de la cellule, en pixels.
offsetY	Integer	Décalage vertical par rapport au coin de la cellule, en pixels.

Renvois

Slicer : ce sélecteur, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setRange(rangeApi)

Définit la plage de données sur laquelle le sélecteur est appliqué.

Paramètres

Nom	Type	Description
rangeApi	Range	Nouvelle plage pour ce sélecteur.

Renvois

Slicer : ce sélecteur, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setTitle(title)

Définit le titre du sélecteur. Si vous ne saisissez aucun titre, la valeur par défaut est rétablie.

Paramètres

Nom	Type	Description
title	String	Nouveau titre de ce sélecteur.

Renvois

Slicer : ce sélecteur, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setTitleHorizontalAlignment(horizontalAlignment)

Définit l'alignement horizontal du titre dans le sélecteur. Une valeur null réinitialise l'alignement.

Paramètres

Nom	Type	Description
horizontalAlignment	String	Nouvelle alignement horizontal du titre de ce sélecteur.

Renvois

Slicer : ce sélecteur, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setTitleTextStyle(textStyle)

Définit le style du texte du sélecteur.

Paramètres

Nom	Type	Description
textStyle	TextStyle	Nouveau style de texte du titre du sélecteur.

Renvois

Slicer : ce sélecteur, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Méthodes obsolètes

getBackgroundColor()

Obsolète. Remplacé par getBackgroundColorObject()

Renvoie la couleur d'arrière-plan du sélecteur au format CSS (par exemple, "#ffffff").

Renvois

String|null : couleur d'arrière-plan de ce sélecteur. Renvoie null si aucune couleur n'est définie.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets