Utilizza questa classe per ottenere informazioni sui filtri esistenti o copiarli.
- Per creare un nuovo filtro, consulta quanto segue:
- Per i fogli, utilizza
Range.createFilter()
. - Per le tabelle pivot, utilizza
PivotTable.addFilter(sourceDataColumn, filterCriteria)
. - Per i fogli collegati a un database, utilizza
DataSourceSheet.addFilter(columnName, filterCriteria)
. - Per le tabelle pivot collegate a un database, utilizza
DataSourcePivotTable.addFilter(columnName, filterCriteria)
.
- Per i fogli, utilizza
- Per creare i criteri per qualsiasi tipo di filtro, consulta
SpreadsheetApp.newFilterCriteria()
eFilterCriteriaBuilder
.
Utilizzi comuni
Copia criteri
Il seguente esempio ottiene il filtro che si applica all'intervalloA1:C20
, ottiene i criteri
applicati alla colonna C e copia i criteri nella colonna B.
let ss = SpreadsheetApp.getActiveSheet(); let range = ss.getRange("A1:C20"); // Copies the filter criteria applied to column C. let filter = range.getFilter(); let criteria = filter.getColumnFilterCriteria(3).copy().build(); // Applies the copied criteria to column B. The copied criteria overwrites any existing // criteria on column B. filter.setColumnFilterCriteria(2, criteria);
Visualizza i valori nascosti dal filtro
L'esempio seguente recupera il filtro applicato all'intervallo specificato e registra i valori da colonna B nascosta dal filtro.let ss = SpreadsheetApp.getActiveSheet(); let range = ss.getRange("A1:C20"); let filter = range.getFilter(); // Gets the filter criteria applied to column B, then gets the hidden values. let filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues(); // Logs the hidden values. console.log(filterCriteria);
Metodi
Metodo | Tipo restituito | Breve descrizione |
---|---|---|
copy() | FilterCriteriaBuilder | Copia questi criteri di filtro e crea un generatore di criteri che è possibile applicare a un altro filtro. |
getCriteriaType() | BooleanCriteria | Restituisce il tipo booleano del criterio, ad esempio CELL_EMPTY . |
getCriteriaValues() | Object[] | Restituisce un array di argomenti per i criteri booleani. |
getHiddenValues() | String[] | Restituisce i valori che il filtro nasconde. |
getVisibleBackgroundColor() | Color | Restituisce il colore di sfondo utilizzato come criterio di filtro. |
getVisibleForegroundColor() | Color | Restituisce il colore in primo piano utilizzato come criterio di filtro. |
getVisibleValues() | String[] | Restituisce i valori visualizzati dal filtro della tabella pivot. |
Documentazione dettagliata
copy()
Copia questi criteri di filtro e crea un generatore di criteri che è possibile applicare a un altro filtro.
Puoi utilizzare questo metodo con qualsiasi tipo di filtro. Se utilizzi un filtro del foglio, puoi: copia i criteri in un'altra colonna.
let ss = SpreadsheetApp.getActiveSheet(); let filter = ss.getFilter(); // Makes a copy of the filter criteria applied to column C. let criteria = filter.getColumnFilterCriteria(3).copy().build(); // Applies the copied criteria to column B. The copied criteria overwrites any existing // criteria on column B. filter.setColumnFilterCriteria(2, criteria);
Invio
FilterCriteriaBuilder
: uno strumento per la creazione dei criteri di filtro basato su questi criteri.
getCriteriaType()
Restituisce il tipo booleano del criterio, ad esempio CELL_EMPTY
. Per scoprire di più sui tipi
dei criteri booleani, consulta l'enumerazione BooleanCriteria
.
Spesso questo metodo viene utilizzato per aggiungere criteri di condizione booleana a un filtro senza sostituire criteri esistenti.
- Per ottenere gli argomenti per i criteri, utilizza
getCriteriaValues()
. - Per utilizzare il tipo di criteri e i valori dei criteri per creare o modificare i criteri di filtro, consulta
FilterCriteriaBuilder.withCriteria(criteria, args)
.
Puoi utilizzare questo metodo per qualsiasi tipo di filtro. Se il criterio del filtro non è booleano
, restituisce null
.
let ss = SpreadsheetApp.getActiveSheet(); // Gets the filter on the active sheet. let filter = ss.getFilter(); // Gets the criteria type and returns a string representing the criteria type object. let criteriaType = filter.getColumnFilterCriteria(2) .getCriteriaType() .toString(); // Logs the criteria type. console.log(criteriaType);
Invio
BooleanCriteria
: il tipo di criteri booleani o null
se il criterio non è booleano
.
getCriteriaValues()
Restituisce un array di argomenti per i criteri booleani. Alcuni tipi di criteri booleani non hanno
argomenti e restituiscono un array vuoto, ad esempio CELL_NOT_EMPTY
.
Spesso questo metodo viene utilizzato per aggiungere criteri di condizione booleana a un filtro senza sostituire criteri esistenti.
- Per ottenere il tipo di criteri booleani, utilizza
getCriteriaType()
. - Per utilizzare il tipo di criteri e i valori dei criteri per creare o modificare un criterio di filtro, consulta
FilterCriteriaBuilder.withCriteria(criteria, args)
.Puoi utilizzare questo metodo per qualsiasi tipo di filtro.
let ss = SpreadsheetApp.getActiveSheet(); let filter = ss.getFilter(); // Gets the values of the boolean criteria and logs them. For example, if the boolean // condition is whenNumberGreaterThan(10), then the logged value is 10. let criteriaValues = filter.getColumnFilterCriteria(2).getCriteriaValues(); console.log(criteriaValues);
Invio
Object[]
: un array di argomenti appropriato per il tipo di criteri booleani. Il numero di argomenti e il loro tipo corrispondono al metodowhen...()
corrispondente della classeFilterCriteriaBuilder
.
getHiddenValues()
Restituisce i valori che il filtro nasconde.
Usa questo criterio con i filtri sui fogli Grid
, il tipo predefinito di foglio.
Restituisce null
se chiami questo metodo per altri tipi di filtri.
let ss = SpreadsheetApp.getActiveSheet(); let range = ss.getRange("A1:C20"); let filter = range.getFilter(); // Gets the filter criteria applied to column B, then gets the hidden values. let filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues(); // Logs the hidden values. console.log(filterCriteria);
Invio
String[]
: un array di valori che il filtro nasconde.
getVisibleBackgroundColor()
Restituisce il colore di sfondo utilizzato come criterio di filtro. Le celle con questo colore di sfondo rimangono visibile.
Usa questo criterio con i filtri sui fogli Grid
, il tipo predefinito di foglio.
Restituisce null
se chiami questo metodo per altri tipi di filtri.
let ss = SpreadsheetApp.getActiveSheet(); let range = ss.getRange("A1:C20"); // Logs the background color that column B is filtered by as a hexadecimal string. let filter = range.getFilter(); let color = filter.getColumnFilterCriteria(2) .getVisibleBackgroundColor() .asRgbColor() .asHexString(); console.log(color);
Invio
Color
: il colore di sfondo utilizzato come criterio di filtro.
getVisibleForegroundColor()
Restituisce il colore in primo piano utilizzato come criterio di filtro. Le celle con questo colore in primo piano rimangono visibile.
Usa questo criterio con i filtri sui fogli Grid
, il tipo predefinito di foglio.
Restituisce null
se chiami questo metodo per altri tipi di filtri.
let ss = SpreadsheetApp.getActiveSheet(); let range = ss.getRange("A1:C20"); // Logs the foreground color that column B is filtered by as a hexadecimal string. let filter = range.getFilter(); let color = filter.getColumnFilterCriteria(2) .getVisibleForegroundColor() .asRgbColor() .asHexString(); console.log(color);
Invio
Color
: il colore in primo piano utilizzato come criterio di filtro.
getVisibleValues()
Restituisce i valori visualizzati dal filtro della tabella pivot.
Questo criterio riguarda solo i filtri nelle tabelle pivot che non sono collegate a un database. Restituisce un array vuoto per altri tipi di filtri.
let ss = SpreadsheetApp.getActiveSheet(); // Gets the first pivot table on the sheet, then gets the visible values of its first filter. pivotTable = ss.getPivotTables()[0]; pivotFilterValues = pivotTable.getFilters()[0].getFilterCriteria().getVisibleValues(); // Logs the visible values. console.log(pivotFilterValues);
Invio
String[]
: un array di valori visualizzati dal filtro della tabella pivot.