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|nullแสดงประเภทบูลีนของเกณฑ์ เช่น CELL_EMPTY
getCriteriaValues()Object[]แสดงผลอาร์เรย์ของอาร์กิวเมนต์สำหรับเกณฑ์บูลีน
getHiddenValues()String[]แสดงค่าที่ตัวกรองซ่อนไว้
getVisibleBackgroundColor()Color|nullแสดงสีพื้นหลังที่ใช้เป็นเกณฑ์ตัวกรอง
getVisibleForegroundColor()Color|nullแสดงผลสีพื้นหน้าที่ใช้เป็นเกณฑ์ตัวกรอง
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 — ประเภทของเกณฑ์บูลีน หรือ 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|null — สีพื้นหลังที่ใช้เป็นเกณฑ์การกรอง


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|null — สีพื้นหน้าที่ใช้เป็นเกณฑ์ตัวกรอง


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 แสดง