ใช้ชั้นเรียนนี้เพื่อรับข้อมูลเกี่ยวกับหรือคัดลอกเกณฑ์ในตัวกรองที่มีอยู่
- หากต้องการสร้างตัวกรองใหม่ ให้ดูข้อมูลต่อไปนี้
- สําหรับชีต ให้ใช้
Range.createFilter()
- สําหรับตาราง Pivot ให้ใช้
PivotTable.addFilter(sourceDataColumn, filterCriteria)
- สําหรับชีตที่เชื่อมต่อกับฐานข้อมูล ให้ใช้
DataSourceSheet.addFilter(columnName, filterCriteria)
- สําหรับตาราง Pivot ที่เชื่อมต่อกับฐานข้อมูล ให้ใช้
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[] | แสดงผลค่าที่ตัวกรองตาราง Pivot แสดง |
เอกสารประกอบโดยละเอียด
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);
ไปกลับ
FilterCriteriaBuilder
— เครื่องมือสร้างเกณฑ์ตัวกรองตามเกณฑ์ตัวกรองนี้
getCriteriaType()
แสดงผลประเภทบูลีนของเกณฑ์ เช่น CELL_EMPTY
หากต้องการเรียนรู้เกี่ยวกับประเภทของเกณฑ์บูลีน โปรดดู Enum ของ BooleanCriteria
ผู้ใช้มักใช้วิธีการนี้เพื่อเพิ่มเกณฑ์เงื่อนไขบูลีนในตัวกรอง โดยไม่ได้แทนที่เกณฑ์ที่มีอยู่
- หากต้องการดูอาร์กิวเมนต์สําหรับเกณฑ์ ให้ใช้
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);
ไปกลับ
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);
ไปกลับ
Object[]
— อาร์เรย์ของอาร์กิวเมนต์ที่เหมาะสมสําหรับประเภทเกณฑ์บูลีน จํานวนอาร์กิวเมนต์และประเภทอาร์กิวเมนต์ตรงกับเมธอดwhen...()
ที่เกี่ยวข้องของคลาสFilterCriteriaBuilder
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);
ไปกลับ
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);
ไปกลับ
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);
ไปกลับ
Color
— สีพื้นหน้าที่ใช้เป็นเกณฑ์ตัวกรอง
getVisibleValues()
แสดงผลค่าที่ตัวกรองตาราง Pivot แสดง
เกณฑ์นี้มีไว้สําหรับตัวกรองในตาราง Pivot ที่ไม่ได้เชื่อมต่อกับฐานข้อมูลเท่านั้น แสดงผลอาร์เรย์ที่ว่างเปล่าของตัวกรองประเภทอื่นๆ
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);
ไปกลับ
String[]
— อาร์เรย์ของค่าที่ตัวกรองตาราง Pivot แสดง