Class Slicer

Slicer

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 os cortadores atuais. Para criar um novo seletor, use Sheet.insertSlicer(range, anchorRowPos, anchorColPos).

Métodos

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

Documentação detalhada

getBackgroundColorObject()

Retorna o Color de plano de fundo do seletor.

Retornar

Color: a cor de plano de fundo desse seletor. 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 seletor) em que o filtro é aplicado no seletor ou null se a posição da coluna não estiver definida. Essa deve ser a posição indexada 1 da coluna, semelhante ao filtro.

Retornar

Integer: a posição da coluna desse seletor.

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 seletor está posicionado na planilha.

Retornar

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

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 do seletor ou null se eles não estiverem definidos.

Retornar

FilterCriteria: os critérios de filtro desse seletor.

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 seletor é aplicado.

Retornar

Range: o intervalo do 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

getTitle()

Retorna o título do seletor.

Retornar

String: este slicer, 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 seletor.

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

Retornar

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

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 seletor especificado é aplicado a tabelas dinâmicas.

Retornar

Boolean: true se a segmentação for aplicada 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 seletor especificado precisa ser aplicado às tabelas dinâmicas na planilha.

Parâmetros

NomeTipoDescrição
applyToPivotTablesBooleanEspecifica se esse seletor deve ser aplicado a tabelas dinâmicas.

Retornar

Slicer: este slicer, 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 de plano de fundo do divisor. Um valor null redefine a cor de plano de fundo.

Parâmetros

NomeTipoDescrição
colorStringA nova cor de plano de fundo desse seletor na notação CSS (por exemplo, '#ffffff').

Retornar

Slicer: este slicer, 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 Color de plano de fundo do seletor. Um valor null redefine a cor de plano de fundo.

Parâmetros

NomeTipoDescrição
colorColorA nova cor de plano de fundo desse seletor.

Retornar

Slicer: este slicer, 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 do seletor. Um valor null redefine o filtro do seletor.

Parâmetros

NomeTipoDescrição
columnPositionIntegerA nova posição da coluna desse seletor.
filterCriteriaFilterCriteriaOs novos critérios de filtro desse seletor.

Retornar

Slicer: este slicer, 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 seletor aparece na planilha. Os índices de posição de linha e coluna de âncora são indexados por 1.

Parâmetros

NomeTipoDescrição
anchorRowPosIntegerA parte de cima do seletor está ancorada nesta linha.
anchorColPosIntegerA parte de cima do seletor está ancorada nesta coluna.
offsetXIntegerO deslocamento horizontal do canto da célula em pixels.
offsetYIntegerO deslocamento vertical do canto da célula em pixels.

Retornar

Slicer: este slicer, 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 intervalo de dados em que o seletor é aplicado.

Parâmetros

NomeTipoDescrição
rangeApiRangeO novo intervalo para este seletor.

Retornar

Slicer: este slicer, 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 seletor. Um título vazio redefine o título para o valor padrão.

Parâmetros

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

Retornar

Slicer: este slicer, 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 seletor. Um valor null redefine o alinhamento.

Parâmetros

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

Retornar

Slicer: este slicer, 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 de texto do seletor.

Parâmetros

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

Retornar

Slicer: este slicer, 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