Acessar e modificar um filtro de página da fonte de dados atual. Para criar um novo filtro de página de fonte de dados, use DataSourceSheet.addFilter(columnName, filterCriteria).
Use essa classe apenas com dados conectados a um banco de dados.
Métodos
| Método | Tipo de retorno | Breve descrição |
|---|---|---|
getDataSourceColumn() | DataSourceColumn | Retorna a coluna de fonte de dados à qual esse filtro se aplica. |
getDataSourceSheet() | DataSourceSheet | Retorna o DataSourceSheet ao qual esse filtro pertence. |
getFilterCriteria() | FilterCriteria | Retorna os critérios para este filtro. |
remove() | void | Remove esse filtro do objeto da fonte de dados. |
setFilterCriteria(filterCriteria) | DataSourceSheetFilter | Define os critérios para este filtro. |
Documentação detalhada
getDataSourceColumn()
Retorna a coluna de fonte de dados à qual esse filtro se aplica.
Retorno
DataSourceColumn: a coluna da fonte de dados.
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
getDataSourceSheet()
Retorna o DataSourceSheet ao qual esse filtro pertence.
Retorno
DataSourceSheet: a página da fonte de dados a que esse filtro pertence.
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 para este filtro.
Retorno
FilterCriteria: os critérios para este filtro.
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()
Remove esse filtro do objeto da fonte de dados.
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
setFilterCriteria(filterCriteria)
Define os critérios para este filtro.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
filterCriteria | FilterCriteria | Os critérios de filtro a serem definidos. |
Retorno
DataSourceSheetFilter: o filtro 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