แสดงตัวควบคุมตัวกรองที่ใช้เพื่อกรองช่วง แผนภูมิ และตาราง Pivot แบบไม่ทำงานร่วมกัน คลาสนี้ประกอบด้วยวิธีเข้าถึงและแก้ไขตัวควบคุมตัวกรองที่มีอยู่ หากต้องการสร้างตัวควบคุมตัวกรองใหม่ ให้ใช้ Sheet.insertSlicer(range, anchorRowPos, anchorColPos)
วิธีการ
วิธีการ | ประเภทการแสดงผล | รายละเอียดแบบย่อ |
---|---|---|
getBackgroundColorObject() | Color | แสดงพื้นหลัง Color ของตัวควบคุมตัวกรอง |
getColumnPosition() | Integer | แสดงผลตำแหน่งคอลัมน์ (สัมพันธ์กับช่วงข้อมูลของตัวควบคุมตัวกรอง) ที่ใช้ตัวกรองในตัวควบคุมตัวกรอง หรือแสดง null หากไม่ได้ตั้งค่าตำแหน่งคอลัมน์ |
getContainerInfo() | ContainerInfo | รับข้อมูลว่าตัวควบคุมตัวกรองอยู่ในตำแหน่งใดในชีต |
getFilterCriteria() | FilterCriteria | แสดงผลเกณฑ์ตัวกรองของตัวควบคุมตัวกรอง หรือ null หากไม่ได้ตั้งค่าเกณฑ์ตัวกรอง |
getRange() | Range | รับช่วงข้อมูลที่ใช้กับตัวควบคุมตัวกรอง |
getTitle() | String | แสดงชื่อของตัวควบคุมตัวกรอง |
getTitleHorizontalAlignment() | String | รับการจัดชื่อในแนวนอน |
getTitleTextStyle() | TextStyle | แสดงรูปแบบข้อความของชื่อตัวควบคุมตัวกรอง |
isAppliedToPivotTables() | Boolean | แสดงผลว่ามีการใช้ตัวควบคุมตัวกรองที่ระบุกับตาราง Pivot หรือไม่ |
remove() | void | ลบตัวควบคุมตัวกรอง |
setApplyToPivotTables(applyToPivotTables) | Slicer | ตั้งค่าว่าควรใช้ตัวควบคุมตัวกรองที่ระบุกับตาราง Pivot ในเวิร์กชีตหรือไม่ |
setBackgroundColor(color) | Slicer | ตั้งค่าสีพื้นหลังของตัวควบคุมตัวกรอง |
setBackgroundColorObject(color) | Slicer | ตั้งค่าพื้นหลัง Color ของตัวควบคุมตัวกรอง |
setColumnFilterCriteria(columnPosition, filterCriteria) | Slicer | ตั้งค่าดัชนีคอลัมน์และเกณฑ์การกรองของตัวควบคุมตัวกรอง |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | Slicer | กำหนดตำแหน่งที่ตัวควบคุมตัวกรองจะปรากฏในชีต |
setRange(rangeApi) | Slicer | ตั้งค่าช่วงข้อมูลที่นำตัวควบคุมตัวกรองไปใช้ |
setTitle(title) | Slicer | ตั้งชื่อตัวควบคุมตัวกรอง |
setTitleHorizontalAlignment(horizontalAlignment) | Slicer | ตั้งค่าการจัดข้อความแนวนอนของชื่อในตัวควบคุมตัวกรอง |
setTitleTextStyle(textStyle) | Slicer | ตั้งค่ารูปแบบข้อความของตัวควบคุมตัวกรอง |
เอกสารประกอบโดยละเอียด
getBackgroundColorObject()
แสดงพื้นหลัง Color
ของตัวควบคุมตัวกรอง
รีเทิร์น
Color
— สีพื้นหลังของตัวควบคุมตัวกรองนี้ แสดงผล null
หากไม่ได้ตั้งค่าสี
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumnPosition()
แสดงผลตำแหน่งคอลัมน์ (สัมพันธ์กับช่วงข้อมูลของตัวควบคุมตัวกรอง) ที่ใช้ตัวกรองในตัวควบคุมตัวกรอง หรือแสดง null
หากไม่ได้ตั้งค่าตำแหน่งคอลัมน์ ซึ่งควรเป็นตำแหน่ง 1 รายการที่จัดทำดัชนีของคอลัมน์ที่คล้ายกับตัวกรอง
รีเทิร์น
Integer
— ตำแหน่งคอลัมน์ของตัวควบคุมตัวกรองนี้
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getContainerInfo()
รับข้อมูลว่าตัวควบคุมตัวกรองอยู่ในตำแหน่งใดในชีต
รีเทิร์น
ContainerInfo
— ออบเจ็กต์ที่มีตำแหน่งคอนเทนเนอร์ของตัวควบคุมตัวกรอง
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFilterCriteria()
แสดงผลเกณฑ์ตัวกรองของตัวควบคุมตัวกรอง หรือ null
หากไม่ได้ตั้งค่าเกณฑ์ตัวกรอง
รีเทิร์น
FilterCriteria
— เกณฑ์ตัวกรองของตัวควบคุมตัวกรองนี้
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRange()
getTitle()
แสดงชื่อของตัวควบคุมตัวกรอง
รีเทิร์น
String
— ตัวควบคุมตัวกรองนี้สำหรับการทำเชน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getTitleHorizontalAlignment()
รับการจัดชื่อในแนวนอน
รีเทิร์น
String
— การจัดข้อความแนวนอนของชื่อตัวควบคุมตัวกรองนี้
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getTitleTextStyle()
isAppliedToPivotTables()
แสดงผลว่ามีการใช้ตัวควบคุมตัวกรองที่ระบุกับตาราง Pivot หรือไม่
รีเทิร์น
Boolean
— true
หากใช้ตัวควบคุมตัวกรองนี้กับตาราง Pivot มิฉะนั้นจะเป็น false
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
remove()
ลบตัวควบคุมตัวกรอง
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setApplyToPivotTables(applyToPivotTables)
ตั้งค่าว่าควรใช้ตัวควบคุมตัวกรองที่ระบุกับตาราง Pivot ในเวิร์กชีตหรือไม่
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
applyToPivotTables | Boolean | ระบุว่าควรใช้ตัวควบคุมตัวกรองนี้กับตาราง Pivot หรือไม่ |
รีเทิร์น
Slicer
— ตัวควบคุมตัวกรองนี้สำหรับการทำเชน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setBackgroundColor(color)
ตั้งค่าสีพื้นหลังของตัวควบคุมตัวกรอง ค่า null
จะรีเซ็ตสีพื้นหลัง
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
color | String | สีพื้นหลังใหม่ของตัวควบคุมตัวกรองนี้ในรูปแบบ CSS (เช่น "#ffffff") |
รีเทิร์น
Slicer
— ตัวควบคุมตัวกรองนี้สำหรับการทำเชน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setBackgroundColorObject(color)
ตั้งค่าพื้นหลัง Color
ของตัวควบคุมตัวกรอง ค่า null
จะรีเซ็ตสีพื้นหลัง
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
color | Color | สีพื้นหลังใหม่ของตัวควบคุมตัวกรองนี้ |
รีเทิร์น
Slicer
— ตัวควบคุมตัวกรองนี้สำหรับการทำเชน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setColumnFilterCriteria(columnPosition, filterCriteria)
ตั้งค่าดัชนีคอลัมน์และเกณฑ์การกรองของตัวควบคุมตัวกรอง ค่า null
จะรีเซ็ตตัวกรองตัวควบคุมตัวกรอง
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
columnPosition | Integer | ตำแหน่งคอลัมน์ใหม่ของตัวควบคุมตัวกรองนี้ |
filterCriteria | FilterCriteria | เกณฑ์ตัวกรองใหม่ของตัวควบคุมตัวกรองนี้ |
รีเทิร์น
Slicer
— ตัวควบคุมตัวกรองนี้สำหรับการทำเชน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)
กำหนดตำแหน่งที่ตัวควบคุมตัวกรองจะปรากฏในชีต ดัชนีแถวตำแหน่งและคอลัมน์ จะมีการจัดทำดัชนีแบบ 1
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
anchorRowPos | Integer | ด้านบนของตัวควบคุมตัวกรองจะตรึงไว้ในแถวนี้ |
anchorColPos | Integer | ที่ด้านบนของตัวควบคุมตัวกรองจะตรึงอยู่ในคอลัมน์นี้ |
offsetX | Integer | ค่าออฟเซ็ตแนวนอนจากมุมของเซลล์ หน่วยเป็นพิกเซล |
offsetY | Integer | ค่าออฟเซ็ตแนวตั้งจากมุมเซลล์ หน่วยเป็นพิกเซล |
รีเทิร์น
Slicer
— ตัวควบคุมตัวกรองนี้สำหรับการทำเชน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setRange(rangeApi)
ตั้งค่าช่วงข้อมูลที่นำตัวควบคุมตัวกรองไปใช้
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
rangeApi | Range | ช่วงใหม่สำหรับตัวควบคุมตัวกรองนี้ |
รีเทิร์น
Slicer
— ตัวควบคุมตัวกรองนี้สำหรับการทำเชน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setTitle(title)
ตั้งชื่อตัวควบคุมตัวกรอง ชื่อที่ว่างเปล่าจะรีเซ็ตชื่อเป็นค่าเริ่มต้น
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
title | String | ชื่อใหม่ของตัวควบคุมตัวกรองนี้ |
รีเทิร์น
Slicer
— ตัวควบคุมตัวกรองนี้สำหรับการทำเชน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setTitleHorizontalAlignment(horizontalAlignment)
ตั้งค่าการจัดข้อความแนวนอนของชื่อในตัวควบคุมตัวกรอง ค่า null
จะรีเซ็ตการปรับแนว
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
horizontalAlignment | String | การจัดข้อความแนวนอนใหม่ของชื่อตัวควบคุมตัวกรองนี้ |
รีเทิร์น
Slicer
— ตัวควบคุมตัวกรองนี้สำหรับการทำเชน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setTitleTextStyle(textStyle)
ตั้งค่ารูปแบบข้อความของตัวควบคุมตัวกรอง
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
textStyle | TextStyle | รูปแบบข้อความใหม่ของชื่อตัวควบคุมตัวกรอง |
รีเทิร์น
Slicer
— ตัวควบคุมตัวกรองนี้สำหรับการทำเชน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets