Class Slicer

Segmentador

Representa um controle de filtros, que é usado para filtrar intervalos, gráficos e tabelas dinâmicas de maneira não colaborativa. Essa classe contém métodos para acessar e modificar segmentadores atuais. Para criar um novo segmentador, use Sheet.insertSlicer(range, anchorRowPos, anchorColPos).

Métodos

MétodoTipo de retornoBreve descrição
getBackgroundColorObject()Color|nullRetorna o plano de fundo Color do segmentador.
getColumnPosition()Integer|nullRetorna a posição da coluna (em relação ao intervalo de dados do segmentador) em que o filtro é aplicado no segmentador ou null se a posição da coluna não estiver definida.
getContainerInfo()ContainerInfoRecebe informações sobre onde o segmentador está posicionado na planilha.
getFilterCriteria()FilterCriteria|nullRetorna os critérios de filtro da segmentação ou null se eles não estiverem definidos.
getRange()RangeRecebe o intervalo de dados em que o segmentador é aplicado.
getTitle()StringRetorna o título do segmentador.
getTitleHorizontalAlignment()StringRecebe o alinhamento horizontal do título.
getTitleTextStyle()TextStyleRetorna o estilo de texto do título do segmentador.
isAppliedToPivotTables()BooleanRetorna se o segmentador de dados especificado está aplicado a tabelas dinâmicas.
remove()voidExclui o controle de filtros.
setApplyToPivotTables(applyToPivotTables)SlicerDefine se o segmentador especificado deve ser aplicado às tabelas dinâmicas na planilha.
setBackgroundColor(color)SlicerDefine a cor do plano de fundo da segmentação.
setBackgroundColorObject(color)SlicerDefine o plano de fundo Color do segmentador.
setColumnFilterCriteria(columnPosition, filterCriteria)SlicerDefine o índice da coluna e os critérios de filtragem da segmentação.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)SlicerDefine a posição em que o segmentador aparece na planilha.
setRange(rangeApi)SlicerDefine o período em que o segmentador é aplicado.
setTitle(title)SlicerDefine o título do segmentador.
setTitleHorizontalAlignment(horizontalAlignment)SlicerDefine o alinhamento horizontal do título no segmentador.
setTitleTextStyle(textStyle)SlicerDefine o estilo do texto do segmentador.

Documentação detalhada

getBackgroundColorObject()

Retorna o plano de fundo Color do segmentador.

Retornar

Color|null: a cor de fundo deste segmentador. Retorna null se nenhuma cor for definida.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getColumnPosition()

Retorna a posição da coluna (em relação ao intervalo de dados do segmentador) em que o filtro é aplicado no segmentador ou null se a posição da coluna não estiver definida. Essa deve ser a posição indexada em 1 da coluna, semelhante ao filtro.

Retornar

Integer|null: a posição da coluna deste segmentador.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getContainerInfo()

Recebe informações sobre onde o segmentador está posicionado na planilha.

Retornar

ContainerInfo: um objeto que contém a posição do contêiner do segmentador.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getFilterCriteria()

Retorna os critérios de filtro da segmentação ou null se eles não estiverem definidos.

Retornar

FilterCriteria|null: os critérios de filtro da segmentação.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getRange()

Recebe o intervalo de dados em que o segmentador é aplicado.

Retornar

Range: o intervalo do segmentador.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getTitle()

Retorna o título do segmentador.

Retornar

String: este segmentador, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getTitleHorizontalAlignment()

Recebe o alinhamento horizontal do título.

Retornar

String: o alinhamento horizontal do título do segmentador.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getTitleTextStyle()

Retorna o estilo de texto do título do segmentador.

Retornar

TextStyle: o estilo de texto do título do segmentador.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

isAppliedToPivotTables()

Retorna se o segmentador de dados especificado está aplicado a tabelas dinâmicas.

Retornar

Boolean: true se o filtro for aplicado a tabelas dinâmicas, caso contrário, false.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

remove()

Exclui o controle de filtros.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setApplyToPivotTables(applyToPivotTables)

Define se o segmentador especificado deve ser aplicado às tabelas dinâmicas na planilha.

Parâmetros

NomeTipoDescrição
applyToPivotTablesBooleanEspecifica se o segmentador deve ser aplicado às tabelas dinâmicas.

Retornar

Slicer: este segmentador, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setBackgroundColor(color)

Define a cor do plano de fundo da segmentação. Um valor null redefine a cor de plano de fundo.

Parâmetros

NomeTipoDescrição
colorStringA nova cor de plano de fundo deste segmentador na notação CSS (como "#ffffff").

Retornar

Slicer: este segmentador, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setBackgroundColorObject(color)

Define o plano de fundo Color do segmentador. Um valor null redefine a cor de fundo.

Parâmetros

NomeTipoDescrição
colorColorA nova cor de plano de fundo dessa segmentação.

Retornar

Slicer: este segmentador, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setColumnFilterCriteria(columnPosition, filterCriteria)

Define o índice da coluna e os critérios de filtragem da segmentação. Um valor null redefine o filtro de segmentação.

Parâmetros

NomeTipoDescrição
columnPositionIntegerA nova posição da coluna deste segmentador.
filterCriteriaFilterCriteriaOs novos critérios de filtro da segmentação.

Retornar

Slicer: este segmentador, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Define a posição em que o segmentador aparece na planilha. Os índices de posição da linha e da coluna de ancoragem são indexados em 1.

Parâmetros

NomeTipoDescrição
anchorRowPosIntegerA parte superior do segmentador fica ancorada nessa linha.
anchorColPosIntegerA parte de cima do segmentador fica ancorada nessa coluna.
offsetXIntegerO deslocamento horizontal do canto da célula em pixels.
offsetYIntegerO deslocamento vertical do canto da célula em pixels.

Retornar

Slicer: este segmentador, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setRange(rangeApi)

Define o período em que o segmentador é aplicado.

Parâmetros

NomeTipoDescrição
rangeApiRangeO novo intervalo para esse segmentador.

Retornar

Slicer: este segmentador, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setTitle(title)

Define o título do segmentador. Um título vazio redefine o título para o valor padrão.

Parâmetros

NomeTipoDescrição
titleStringO novo título do segmentador.

Retornar

Slicer: este segmentador, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setTitleHorizontalAlignment(horizontalAlignment)

Define o alinhamento horizontal do título no segmentador. Um valor null redefine o alinhamento.

Parâmetros

NomeTipoDescrição
horizontalAlignmentStringO novo alinhamento horizontal do título da segmentação.

Retornar

Slicer: este segmentador, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setTitleTextStyle(textStyle)

Define o estilo do texto do segmentador.

Parâmetros

NomeTipoDescrição
textStyleTextStyleO novo estilo de texto do título do segmentador.

Retornar

Slicer: este segmentador, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Métodos obsoletos