Class Filter

กรอง

ใช้คลาสนี้เพื่อแก้ไขตัวกรองที่มีอยู่ในชีต Grid ซึ่งเป็นประเภทเริ่มต้นของชีต ชีตตารางเป็นชีตทั่วไปที่มีข้อมูลซึ่งไม่ได้เชื่อมต่อกับฐานข้อมูล

หากยังไม่มีตัวกรองในชีต ให้สร้างตัวกรองโดยใช้ Range.createFilter()

หากต้องการใช้ชั้นเรียนนี้ คุณต้องเข้าถึงตัวกรองชีตตารางกริดก่อนโดยใช้ Range.getFilter() หรือ Sheet.getFilter()

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

นำตัวกรองออก

ตัวอย่างด้านล่างรับตัวกรองในชีตที่ใช้งานอยู่และนำออก
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Removes the filter from the active sheet.
filter.remove();

ดูช่วงที่จะใช้กับตัวกรอง

ตัวอย่างด้านล่างจะได้รับตัวกรองในชีตที่ใช้งานอยู่ จากนั้นใช้เมธอด getRange() จากคลาสนี้เพื่อบันทึกช่วงที่ใช้ตัวกรองนั้น
let ss = SpreadsheetApp.getActiveSheet();
// Gets the existing filter on the active sheet.
let filter = ss.getFilter();
// Logs the range that the filter applies to in A1 notation.
console.log(filter.getRange().getA1Notation());

วิธีการ

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
getColumnFilterCriteria(columnPosition)FilterCriteriaรับเกณฑ์ตัวกรองในคอลัมน์ที่ระบุ หรือใส่ null หากคอลัมน์นั้นไม่ได้ใช้เกณฑ์ตัวกรอง
getRange()Rangeรับช่วงที่ใช้กับตัวกรอง
remove()voidนำตัวกรองนี้ออก
removeColumnFilterCriteria(columnPosition)Filterนำเกณฑ์ตัวกรองออกจากคอลัมน์ที่ระบุ
setColumnFilterCriteria(columnPosition, filterCriteria)Filterตั้งค่าเกณฑ์ตัวกรองในคอลัมน์ที่ระบุ
sort(columnPosition, ascending)Filterจัดเรียงช่วงที่กรองตามคอลัมน์ที่ระบุ โดยไม่รวมแถวแรก (แถวส่วนหัว) ในช่วงที่ใช้ตัวกรองนี้

เอกสารประกอบโดยละเอียด

getColumnFilterCriteria(columnPosition)

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

หากต้องการดูรายละเอียดเพิ่มเติมเกี่ยวกับเกณฑ์ตัวกรอง โปรดเชื่อมโยงวิธีการนี้กับเมธอดจากคลาส FilterCriteria

let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
  // Gets the filter criteria applied to column B of the active sheet
  // and logs the hidden values.
let filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
console.log(filterCriteria);

พารามิเตอร์

ชื่อTypeคำอธิบาย
columnPositionIntegerตำแหน่งที่จัดทำดัชนี 1 ของคอลัมน์ เช่น ดัชนีของคอลัมน์ B คือ 2

รีเทิร์น

FilterCriteria — เกณฑ์การกรอง

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRange()

รับช่วงที่ใช้กับตัวกรอง

// Gets the existing filter on the active sheet.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Logs the range that the filter applies to in A1 notation.
console.log(filter.getRange().getA1Notation());

รีเทิร์น

Range — ช่วงของตัวกรอง หากต้องการรับช่วงในรูปแบบ A1 ให้เชื่อมโยงเมธอดนี้กับ Range.getA1Notation()

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove()

นำตัวกรองนี้ออก

// Removes the filter from the active sheet.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
filter.remove();

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeColumnFilterCriteria(columnPosition)

นำเกณฑ์ตัวกรองออกจากคอลัมน์ที่ระบุ

// Removes the filter criteria from column B.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
filter.removeColumnFilterCriteria(2);

พารามิเตอร์

ชื่อTypeคำอธิบาย
columnPositionIntegerตำแหน่งที่จัดทำดัชนี 1 ของคอลัมน์ เช่น ดัชนีของคอลัมน์ B คือ 2

รีเทิร์น

Filter — ตัวกรองสำหรับเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setColumnFilterCriteria(columnPosition, filterCriteria)

ตั้งค่าเกณฑ์ตัวกรองในคอลัมน์ที่ระบุ ก่อนอื่น ให้สร้างเครื่องมือสร้างเกณฑ์ตัวกรองโดยใช้ SpreadsheetApp.newFilterCriteria() จากนั้นเพิ่มเกณฑ์ให้กับเครื่องมือสร้าง โดยใช้คลาส FilterCriteriaBuilder หลังจากที่สร้างเกณฑ์แล้ว ให้กำหนดเป็นพารามิเตอร์ filterCriteria สำหรับวิธีการนี้

let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Builds the filter criteria to use as a parameter for setColumnFilterCriteria.
const criteria = SpreadsheetApp.newFilterCriteria()
                             .setHiddenValues(["Hello", "World"])
                             .build();
// Sets the filter criteria for column C.
filter.setColumnFilterCriteria(3, criteria);

พารามิเตอร์

ชื่อTypeคำอธิบาย
columnPositionIntegerตำแหน่งที่จัดทำดัชนี 1 ของคอลัมน์ เช่น ดัชนีของคอลัมน์ B คือ 2
filterCriteriaFilterCriteriaเกณฑ์ตัวกรองที่จะตั้งค่า หากคุณตั้งค่าเกณฑ์เป็น null ระบบจะนำเกณฑ์ตัวกรองออกจากคอลัมน์ที่ระบุ หรือจะใช้ removeColumnFilterCriteria(columnPosition) ก็ได้

รีเทิร์น

Filter — ตัวกรองสำหรับเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

sort(columnPosition, ascending)

จัดเรียงช่วงที่กรองตามคอลัมน์ที่ระบุ โดยไม่รวมแถวแรก (แถวส่วนหัว) ในช่วงที่ใช้ตัวกรองนี้

// Gets the existing filter and sorts it by column B in ascending order.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
filter.sort(2, true);

พารามิเตอร์

ชื่อTypeคำอธิบาย
columnPositionIntegerตำแหน่งที่จัดทำดัชนี 1 ของคอลัมน์ เช่น ดัชนีของคอลัมน์ B คือ 2
ascendingBooleanหากเป็น true ให้จัดเรียงช่วงที่กรองจากน้อยไปหามาก หากเป็น false ให้จัดเรียงช่วงที่กรองจากมากไปหาน้อย

รีเทิร์น

Filter — ตัวกรองสำหรับเชน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets