Class FilterCriteria

ตัวกรองเกณฑ์

ใช้คลาสนี้เพื่อรับข้อมูลเกี่ยวกับหรือคัดลอกเกณฑ์ในตัวกรองที่มีอยู่

การใช้งานทั่วไป

คัดลอกเกณฑ์

ตัวอย่างต่อไปนี้จะรับตัวกรองที่ใช้กับช่วง A1:C20 รับเกณฑ์ที่ใช้กับคอลัมน์ C และคัดลอกเกณฑ์ไปยังคอลัมน์ B 
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Copies the filter criteria applied to column C.
const filter = range.getFilter();
const 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 ที่ซ่อนตัวกรองไว้ 
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Gets the filter criteria applied to column B, then gets the hidden values.
const 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()

คัดลอกเกณฑ์ตัวกรองนี้และสร้างเครื่องมือสร้างเกณฑ์ที่คุณนำไปใช้กับตัวกรองอื่นได้

คุณใช้เมธอดนี้กับตัวกรองประเภทใดก็ได้ หากใช้ตัวกรองชีต คุณจะคัดลอกเกณฑ์ไปยังคอลัมน์อื่นได้ 

const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Makes a copy of the filter criteria applied to column C.
const 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 ดูข้อมูลเกี่ยวกับประเภทของเกณฑ์บูลีนได้ที่ BooleanCriteria enum

ผู้ใช้มักใช้วิธีนี้เพื่อเพิ่มเกณฑ์เงื่อนไขบูลีนลงในตัวกรองโดยไม่แทนที่เกณฑ์ที่มีอยู่

  • หากต้องการรับอาร์กิวเมนต์สําหรับเกณฑ์ ให้ใช้ getCriteriaValues()
  • หากต้องการใช้ประเภทเกณฑ์และค่าเกณฑ์เพื่อสร้างหรือแก้ไขเกณฑ์ตัวกรอง โปรดดู FilterCriteriaBuilder.withCriteria(criteria, args)

คุณใช้วิธีการนี้กับตัวกรองประเภทใดก็ได้ หากเกณฑ์ตัวกรองไม่ใช่เงื่อนไขบูลีน ระบบจะแสดงผล null 

const ss = SpreadsheetApp.getActiveSheet();
// Gets the filter on the active sheet.
const filter = ss.getFilter();
// Gets the criteria type and returns a string representing the criteria type
// object.
const criteriaType =
    filter.getColumnFilterCriteria(2).getCriteriaType().toString();
// Logs the criteria type.
console.log(criteriaType);

รีเทิร์น

BooleanCriteria — ประเภทของเกณฑ์บูลีน หรือ null หากเกณฑ์ไม่ใช่เงื่อนไขบูลีน

getCriteriaValues()

แสดงผลอาร์เรย์ของอาร์กิวเมนต์สําหรับเกณฑ์บูลีน เกณฑ์บูลีนบางประเภทไม่มีอาร์กิวเมนต์และแสดงผลอาร์เรย์ว่าง เช่น CELL_NOT_EMPTY

ผู้ใช้มักใช้วิธีนี้เพื่อเพิ่มเกณฑ์เงื่อนไขบูลีนลงในตัวกรองโดยไม่แทนที่เกณฑ์ที่มีอยู่

  • หากต้องการรับประเภทเกณฑ์บูลีน ให้ใช้ getCriteriaType()
  • หากต้องการใช้ประเภทเกณฑ์และค่าเกณฑ์เพื่อสร้างหรือแก้ไขเกณฑ์ตัวกรอง โปรดดู FilterCriteriaBuilder.withCriteria(criteria, args)

    คุณใช้วิธีการนี้กับตัวกรองประเภทใดก็ได้ 

    const ss = SpreadsheetApp.getActiveSheet();
const 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.
const criteriaValues = filter.getColumnFilterCriteria(2).getCriteriaValues();
console.log(criteriaValues);

    รีเทิร์น

    Object[] — อาร์เรย์ของอาร์กิวเมนต์ที่เหมาะสมกับประเภทเกณฑ์บูลีน จํานวนอาร์กิวเมนต์และประเภทของอาร์กิวเมนต์ตรงกับเมธอด when...() ที่เกี่ยวข้องของคลาส FilterCriteriaBuilder

getHiddenValues()

แสดงผลค่าที่ตัวกรองซ่อนอยู่

ใช้เกณฑ์นี้กับตัวกรองในชีต Grid ซึ่งเป็นชีตประเภทเริ่มต้น แสดงผล null หากคุณเรียกใช้เมธอดนี้กับตัวกรองประเภทอื่นๆ 

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Gets the filter criteria applied to column B, then gets the hidden values.
const filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
// Logs the hidden values.
console.log(filterCriteria);

รีเทิร์น

String[] — อาร์เรย์ของค่าที่ตัวกรองซ่อนไว้

getVisibleBackgroundColor()

ส่งกลับสีพื้นหลังที่ใช้เป็นเกณฑ์ตัวกรอง เซลล์ที่มีสีพื้นหลังนี้จะยังคงมองเห็นได้

ใช้เกณฑ์นี้กับตัวกรองในชีต Grid ซึ่งเป็นชีตประเภทเริ่มต้น แสดงผล null หากคุณเรียกใช้เมธอดนี้กับตัวกรองประเภทอื่นๆ 

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Logs the background color that column B is filtered by as a hexadecimal
// string.
const filter = range.getFilter();
const color = filter.getColumnFilterCriteria(2)
                  .getVisibleBackgroundColor()
                  .asRgbColor()
                  .asHexString();
console.log(color);

รีเทิร์น

Color — สีพื้นหลังที่ใช้เป็นเกณฑ์ตัวกรอง

getVisibleForegroundColor()

แสดงผลสีพื้นหน้าที่ใช้เป็นเกณฑ์ตัวกรอง เซลล์ที่มีสีพื้นหน้านี้จะยังคงมองเห็นได้

ใช้เกณฑ์นี้กับตัวกรองในชีต Grid ซึ่งเป็นชีตประเภทเริ่มต้น แสดงผล null หากคุณเรียกใช้เมธอดนี้กับตัวกรองประเภทอื่นๆ 

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Logs the foreground color that column B is filtered by as a hexadecimal
// string.
const filter = range.getFilter();
const color = filter.getColumnFilterCriteria(2)
                  .getVisibleForegroundColor()
                  .asRgbColor()
                  .asHexString();
console.log(color);

รีเทิร์น

Color — สีพื้นหน้าที่ใช้เป็นเกณฑ์ตัวกรอง

getVisibleValues()

แสดงผลค่าที่ตัวกรองตาราง Pivot แสดง

เกณฑ์นี้มีไว้สำหรับตัวกรองในตาราง Pivot ที่ไม่ได้เชื่อมต่อกับฐานข้อมูลเท่านั้น แสดงผลอาร์เรย์ว่างสำหรับตัวกรองประเภทอื่นๆ 

const ss = SpreadsheetApp.getActiveSheet();
// Gets the first pivot table on the sheet, then gets the visible values of its
// first filter.
const pivotTable = ss.getPivotTables()[0];
const pivotFilterValues =
    pivotTable.getFilters()[0].getFilterCriteria().getVisibleValues();
// Logs the visible values.
console.log(pivotFilterValues);

รีเทิร์น

String[] — อาร์เรย์ของค่าที่ตัวกรองตาราง Pivot แสดง