이 클래스를 사용하여 기존 필터에 대한 정보를 얻거나 기존 필터의 기준을 복사합니다.
- 새 필터를 만들려면 다음을 참조하세요.
- 시트의 경우
Range.createFilter()
를 사용합니다. - 피벗 테이블의 경우
PivotTable.addFilter(sourceDataColumn, filterCriteria)
를 사용합니다. - 데이터베이스에 연결된 시트의 경우
DataSourceSheet.addFilter(columnName, filterCriteria)
를 사용합니다. - 데이터베이스에 연결된 피벗 테이블의 경우
DataSourcePivotTable.addFilter(columnName, filterCriteria)
를 사용합니다.
- 시트의 경우
- 모든 유형의 필터 기준을 만들려면
SpreadsheetApp.newFilterCriteria()
및FilterCriteriaBuilder
를 참고하세요.
일반적인 용도
기준 복사
다음 샘플에서는A1:C20
범위에 적용되는 필터를 가져와 C 열에 적용된 기준을 가져와 기준을 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);
필터로 숨겨진 값 가져오기
다음 샘플은 지정된 범위에 적용되는 필터를 가져오고 필터가 숨기는 B열의 값을 로깅합니다.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);
메서드
메서드 | 반환 유형 | 간략한 설명 |
---|---|---|
copy() | FilterCriteriaBuilder | 이 필터 기준을 복사하고 다른 필터에 적용할 수 있는 기준 작성 도구를 만듭니다. |
getCriteriaType() | BooleanCriteria | 기준의 불리언 유형(예: CELL_EMPTY )을 반환합니다. |
getCriteriaValues() | Object[] | 불리언 기준에 대한 인수 배열을 반환합니다. |
getHiddenValues() | String[] | 필터로 숨겨진 값을 반환합니다. |
getVisibleBackgroundColor() | Color | 필터 기준으로 사용되는 배경 색상을 반환합니다. |
getVisibleForegroundColor() | Color | 필터 기준으로 사용되는 포그라운드 색상을 반환합니다. |
getVisibleValues() | String[] | 피벗 테이블 필터에 표시되는 값을 반환합니다. |
자세한 문서
copy()
이 필터 기준을 복사하고 다른 필터에 적용할 수 있는 기준 작성 도구를 만듭니다.
이 방법은 모든 유형의 필터에서 사용할 수 있습니다. 시트 필터를 사용하는 경우 기준을 다른 열에 복사할 수 있습니다.
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);
Return
FilterCriteriaBuilder
: 이 필터 기준을 기반으로 하는 필터 기준 빌더입니다.
getCriteriaType()
기준의 불리언 유형(예: CELL_EMPTY
)을 반환합니다. 부울 기준의 유형에 관한 자세한 내용은 BooleanCriteria
enum을 참조하세요.
사용자는 종종 기존 메서드를 대체하지 않고 불리언 조건 기준을 필터에 추가합니다.
- 기준에 대한 인수를 가져오려면
getCriteriaValues()
를 사용합니다. - 기준 유형 및 기준 값을 사용하여 필터 기준을 만들거나 수정하려면
FilterCriteriaBuilder.withCriteria(criteria, args)
을 참고하세요.
이 메서드는 모든 유형의 필터에 사용할 수 있습니다. 필터 기준이 불리언 조건이 아니면 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);
Return
BooleanCriteria
: 불리언 기준의 유형입니다. 기준이 불리언 조건이 아닌 경우 null
입니다.
getCriteriaValues()
불리언 기준에 대한 인수 배열을 반환합니다. 일부 부울 기준 유형에는 인수가 없으며 CELL_NOT_EMPTY
와 같은 빈 배열을 반환합니다.
사용자는 종종 기존 메서드를 대체하지 않고 불리언 조건 기준을 필터에 추가합니다.
- 부울 기준 유형을 가져오려면
getCriteriaType()
를 사용하세요. - 기준 유형 및 기준 값을 사용하여 필터 기준을 만들거나 수정하려면
FilterCriteriaBuilder.withCriteria(criteria, args)
을 참고하세요.이 메서드는 모든 유형의 필터에 사용할 수 있습니다.
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);
Return
Object[]
: 부울 기준 유형에 적합한 인수 배열입니다. 인수의 수와 유형은FilterCriteriaBuilder
클래스의 상응하는when...()
메서드와 일치합니다.
getHiddenValues()
필터로 숨겨진 값을 반환합니다.
시트의 기본 유형인 시트 Grid
개에 필터를 적용할 때 이 기준을 사용하세요.
다른 유형의 필터에서 이 메서드를 호출하면 null
를 반환합니다.
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);
Return
String[]
: 필터가 숨기는 값의 배열입니다.
getVisibleBackgroundColor()
필터 기준으로 사용되는 배경 색상을 반환합니다. 이 배경 색상을 사용하는 셀은 계속 표시됩니다.
시트의 기본 유형인 시트 Grid
개에 필터를 적용할 때 이 기준을 사용하세요.
다른 유형의 필터에서 이 메서드를 호출하면 null
를 반환합니다.
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);
Return
Color
- 필터 기준으로 사용되는 배경색입니다.
getVisibleForegroundColor()
필터 기준으로 사용되는 포그라운드 색상을 반환합니다. 이 포그라운드 색상이 있는 셀은 계속 표시됩니다.
시트의 기본 유형인 시트 Grid
개에 필터를 적용할 때 이 기준을 사용하세요.
다른 유형의 필터에서 이 메서드를 호출하면 null
를 반환합니다.
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);
Return
Color
- 필터 기준으로 사용되는 포그라운드 색상입니다.
getVisibleValues()
피벗 테이블 필터에 표시되는 값을 반환합니다.
이 기준은 데이터베이스에 연결되지 않은 피벗 테이블의 필터에만 적용됩니다. 다른 유형의 필터에는 빈 배열을 반환합니다.
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);
Return
String[]
: 피벗 테이블 필터에 표시되는 값의 배열입니다.