Représente une segmentation, qui permet de filtrer les plages, les graphiques et les tableaux croisés dynamiques de manière non collaborative. Cette classe contient des méthodes permettant d'accéder aux segments existants et de les modifier. Pour créer un segment, utilisez Sheet.insertSlicer(range, anchorRowPos, anchorColPos).
Méthodes
| Méthode | Type renvoyé | Brève description |
|---|---|---|
getBackgroundColorObject() | Color | Renvoyez l'arrière-plan Color du segment. |
getColumnPosition() | Integer | Renvoie la position de la colonne (par rapport à la plage de données du segment) sur laquelle le filtre est appliqué dans le segment, ou null si la position de la colonne n'est pas définie. |
getContainerInfo() | ContainerInfo | Récupère des informations sur l'emplacement du segment dans la feuille. |
getFilterCriteria() | FilterCriteria | Renvoie les critères de filtrage du segment ou null s'ils ne sont pas définis. |
getRange() | Range | Récupère la plage de données à laquelle le segment est appliqué. |
getTitle() | String | Renvoie le titre du segment. |
getTitleHorizontalAlignment() | String | Récupère l'alignement horizontal du titre. |
getTitleTextStyle() | TextStyle | Renvoie le style de texte du titre du segment. |
isAppliedToPivotTables() | Boolean | Indique si le segment donné est appliqué aux tableaux croisés dynamiques. |
remove() | void | Supprime le segment. |
setApplyToPivotTables(applyToPivotTables) | Slicer | Détermine si le segment 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 segment. |
setBackgroundColorObject(color) | Slicer | Définit l'arrière-plan Color du segment. |
setColumnFilterCriteria(columnPosition, filterCriteria) | Slicer | Définit l'index de colonne et les critères de filtrage du segment. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | Slicer | Définit la position du segment sur la feuille. |
setRange(rangeApi) | Slicer | Définit la plage de données à laquelle le segment est appliqué. |
setTitle(title) | Slicer | Définit le titre du segment. |
setTitleHorizontalAlignment(horizontalAlignment) | Slicer | Définit l'alignement horizontal du titre dans le segment. |
setTitleTextStyle(textStyle) | Slicer | Définit le style de texte du segment. |
Documentation détaillée
getBackgroundColorObject()
Renvoyez l'arrière-plan Color du segment.
Aller-retour
Color : couleur d'arrière-plan de ce segment. 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 champs d'application 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 segment) sur laquelle le filtre est appliqué dans le segment, ou null si la position de la colonne n'est pas définie. Il doit s'agir d'une position indexée de 1 colonne, semblable au filtre.
Aller-retour
Integer : position de la colonne de ce segment.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getContainerInfo()
Récupère des informations sur l'emplacement du segment dans la feuille.
Aller-retour
ContainerInfo : objet contenant la position du conteneur du segment.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFilterCriteria()
Renvoie les critères de filtrage du segment ou null s'ils ne sont pas définis.
Aller-retour
FilterCriteria : critères de filtre de ce segment.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getRange()
Récupère la plage de données à laquelle le segment est appliqué.
Aller-retour
Range : plage de segments.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getTitle()
Renvoie le titre du segment.
Aller-retour
String : ce segment est utilisé pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getTitleHorizontalAlignment()
Récupère l'alignement horizontal du titre.
Aller-retour
String : alignement horizontal du titre de ce segment.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getTitleTextStyle()
Renvoie le style de texte du titre du segment.
Aller-retour
TextStyle : style de texte du titre de ce segment.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
isAppliedToPivotTables()
Indique si le segment donné est appliqué aux tableaux croisés dynamiques.
Aller-retour
Boolean : true si ce segment est appliqué aux tableaux croisés dynamiques, sinon false.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 champs d'application suivants :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setApplyToPivotTables(applyToPivotTables)
Détermine si le segment donné doit être appliqué aux tableaux croisés dynamiques de la feuille de calcul.
Paramètres
| Nom | Type | Description |
|---|---|---|
applyToPivotTables | Boolean | Indique si ce segment doit s'appliquer aux tableaux croisés dynamiques. |
Aller-retour
Slicer : ce segment est utilisé pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 segment. Une valeur null réinitialise la couleur de l'arrière-plan.
Paramètres
| Nom | Type | Description |
|---|---|---|
color | String | Nouvelle couleur d'arrière-plan de ce segment au format CSS (par exemple, '#ffffff'). |
Aller-retour
Slicer : ce segment est utilisé pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setBackgroundColorObject(color)
Définit l'arrière-plan Color du segment. Une valeur null réinitialise la couleur de l'arrière-plan.
Paramètres
| Nom | Type | Description |
|---|---|---|
color | Color | Nouvelle couleur d'arrière-plan de ce segment. |
Aller-retour
Slicer : ce segment est utilisé pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 segment. Une valeur null réinitialise le filtre de segment.
Paramètres
| Nom | Type | Description |
|---|---|---|
columnPosition | Integer | Nouvelle position de colonne de ce segment. |
filterCriteria | FilterCriteria | Nouveaux critères de filtre de ce segment. |
Aller-retour
Slicer : ce segment est utilisé pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)
Définit la position du segment sur la feuille. Les indices de position des lignes et des colonnes d'ancrage sont indexés sur 1.
Paramètres
| Nom | Type | Description |
|---|---|---|
anchorRowPos | Integer | Le dessus du segment est ancré dans cette ligne. |
anchorColPos | Integer | Le dessus du segment est ancré dans ce col. |
offsetX | Integer | Décalage horizontal par rapport à l'angle de la cellule, en pixels. |
offsetY | Integer | Décalage vertical en pixels de l'angle de la cellule. |
Aller-retour
Slicer : ce segment est utilisé pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setRange(rangeApi)
Définit la plage de données à laquelle le segment est appliqué.
Paramètres
| Nom | Type | Description |
|---|---|---|
rangeApi | Range | Nouvelle plage de ce segment. |
Aller-retour
Slicer : ce segment est utilisé pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setTitle(title)
Définit le titre du segment. Un titre vide réinitialise le titre à sa valeur par défaut.
Paramètres
| Nom | Type | Description |
|---|---|---|
title | String | Nouveau titre de ce segment. |
Aller-retour
Slicer : ce segment est utilisé pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 segment. Une valeur null réinitialise l'alignement.
Paramètres
| Nom | Type | Description |
|---|---|---|
horizontalAlignment | String | Nouvel alignement horizontal du titre de ce segment. |
Aller-retour
Slicer : ce segment est utilisé pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setTitleTextStyle(textStyle)
Définit le style de texte du segment.
Paramètres
| Nom | Type | Description |
|---|---|---|
textStyle | TextStyle | Nouveau style de texte du titre du segment. |
Aller-retour
Slicer : ce segment est utilisé pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets