Class DataSourcePivotTable

DataSourcePivotTable

เข้าถึงและแก้ไขตาราง Pivot ของแหล่งข้อมูลที่มีอยู่ หากต้องการสร้างตาราง Pivot ของแหล่งข้อมูลใหม่ ให้ใช้ Range.createDataSourcePivotTable(dataSource)

ใช้คลาสนี้กับข้อมูลที่เชื่อมต่อกับฐานข้อมูลเท่านั้น

วิธีการ

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
addColumnGroup(columnName)PivotGroupเพิ่มกลุ่มคอลัมน์ Pivot ใหม่ตามคอลัมน์แหล่งข้อมูลที่ระบุ
addFilter(columnName, filterCriteria)PivotFilterเพิ่มตัวกรองใหม่โดยอิงตามคอลัมน์แหล่งข้อมูลที่ระบุพร้อมด้วยเกณฑ์ตัวกรองที่ระบุ
addPivotValue(columnName, summarizeFunction)PivotValueเพิ่มค่า Pivot ใหม่โดยอิงตามคอลัมน์แหล่งข้อมูลที่ระบุด้วยฟังก์ชันสรุปที่ระบุ
addRowGroup(columnName)PivotGroupเพิ่มกลุ่มแถว Pivot ใหม่ตามคอลัมน์แหล่งข้อมูลที่ระบุ
asPivotTable()PivotTableแสดงผลตาราง Pivot ของแหล่งข้อมูลเป็นออบเจ็กต์ตาราง Pivot ปกติ
cancelDataRefresh()DataSourcePivotTableยกเลิกการรีเฟรชข้อมูลที่เชื่อมโยงกับออบเจ็กต์นี้หากยังทำงานอยู่
forceRefreshData()DataSourcePivotTableรีเฟรชข้อมูลของออบเจ็กต์นี้โดยไม่คำนึงถึงสถานะปัจจุบันของ
getDataSource()DataSourceรับแหล่งข้อมูลที่ออบเจ็กต์ลิงก์อยู่
getStatus()DataExecutionStatusรับสถานะการเรียกใช้ข้อมูลของออบเจ็กต์
refreshData()DataSourcePivotTableรีเฟรชข้อมูลของออบเจ็กต์
waitForCompletion(timeoutInSeconds)DataExecutionStatusรอจนกว่าการดำเนินการปัจจุบันจะเสร็จสมบูรณ์ แล้วหมดเวลาหลังจากใช้งานไปตามจำนวนวินาทีที่ระบุ

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

addColumnGroup(columnName)

เพิ่มกลุ่มคอลัมน์ Pivot ใหม่ตามคอลัมน์แหล่งข้อมูลที่ระบุ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNameStringชื่อคอลัมน์แหล่งที่มาของข้อมูลที่กลุ่ม Pivot อ้างอิง

รีเทิร์น

PivotGroup — กลุ่ม Pivot ใหม่

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

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

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

addFilter(columnName, filterCriteria)

เพิ่มตัวกรองใหม่โดยอิงตามคอลัมน์แหล่งข้อมูลที่ระบุพร้อมด้วยเกณฑ์ตัวกรองที่ระบุ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNameStringชื่อคอลัมน์แหล่งที่มาของข้อมูลที่ตัวกรองอิงตาม
filterCriteriaFilterCriteriaเกณฑ์ที่ตัวกรองใช้

รีเทิร์น

PivotFilter — ตัวกรองใหม่

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

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

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

addPivotValue(columnName, summarizeFunction)

เพิ่มค่า Pivot ใหม่โดยอิงตามคอลัมน์แหล่งข้อมูลที่ระบุด้วยฟังก์ชันสรุปที่ระบุ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNameStringชื่อคอลัมน์แหล่งที่มาของข้อมูลที่ค่า Pivot อิงตาม
summarizeFunctionPivotTableSummarizeFunctionฟังก์ชันสรุปที่ค่า Pivot ใช้

รีเทิร์น

PivotValue — ค่า Pivot ใหม่

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

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

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

addRowGroup(columnName)

เพิ่มกลุ่มแถว Pivot ใหม่ตามคอลัมน์แหล่งข้อมูลที่ระบุ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNameStringชื่อคอลัมน์แหล่งที่มาของข้อมูลที่กลุ่ม Pivot อ้างอิง

รีเทิร์น

PivotGroup — กลุ่ม Pivot ใหม่

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

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

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

asPivotTable()

แสดงผลตาราง Pivot ของแหล่งข้อมูลเป็นออบเจ็กต์ตาราง Pivot ปกติ

รีเทิร์น

PivotTable — ตาราง Pivot

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

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

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

cancelDataRefresh()

ยกเลิกการรีเฟรชข้อมูลที่เชื่อมโยงกับออบเจ็กต์นี้หากยังทำงานอยู่

ตัวอย่างนี้แสดงวิธียกเลิกการรีเฟรชสูตร

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

มีข้อยกเว้นหากไม่ได้เปิดใช้ประเภทแหล่งข้อมูล ใช้เมธอด SpreadsheetApp#enable...Execution() เพื่อเปิดใช้การดำเนินการกับข้อมูลสําหรับประเภทแหล่งข้อมูลที่เฉพาะเจาะจง

รีเทิร์น

DataSourcePivotTable — ออบเจ็กต์ข้อมูล

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

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

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

forceRefreshData()

รีเฟรชข้อมูลของออบเจ็กต์นี้โดยไม่คำนึงถึงสถานะปัจจุบันของ ดูรายละเอียดเพิ่มเติมได้ที่ refreshData() หากต้องการยกเลิกการรีเฟรชออบเจ็กต์นี้ที่ดำเนินการอยู่ในปัจจุบัน โปรดดู cancelDataRefresh()

มีข้อยกเว้นหากไม่ได้เปิดใช้ประเภทแหล่งข้อมูล ใช้เมธอด SpreadsheetApp#enable...Execution() เพื่อเปิดใช้การดำเนินการกับข้อมูลสําหรับประเภทแหล่งข้อมูลที่เฉพาะเจาะจง

รีเทิร์น

DataSourcePivotTable — ออบเจ็กต์ข้อมูล

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

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

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

getDataSource()

รับแหล่งข้อมูลที่ออบเจ็กต์ลิงก์อยู่

รีเทิร์น

DataSource — แหล่งข้อมูล

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

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

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

getStatus()

รับสถานะการเรียกใช้ข้อมูลของออบเจ็กต์

รีเทิร์น

DataExecutionStatus — สถานะการดำเนินการกับข้อมูล

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

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

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

refreshData()

รีเฟรชข้อมูลของออบเจ็กต์

มีข้อยกเว้นหากอยู่ในสถานะ error ในขณะนี้ ใช้ DataSource#updateSpec() เพื่ออัปเดตข้อกำหนด เราขอแนะนำให้ใช้วิธีนี้แทน forceRefreshData() เพื่อป้องกันการแก้ไขที่ไม่คาดคิดในแหล่งข้อมูล

มีข้อยกเว้นหากไม่ได้เปิดใช้ประเภทแหล่งข้อมูล ใช้เมธอด SpreadsheetApp#enable...Execution() เพื่อเปิดใช้การดำเนินการกับข้อมูลสําหรับประเภทแหล่งข้อมูลที่เฉพาะเจาะจง

รีเทิร์น

DataSourcePivotTable — ออบเจ็กต์ข้อมูล

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

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

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

waitForCompletion(timeoutInSeconds)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
timeoutInSecondsIntegerเวลาที่รอการเรียกใช้ข้อมูล หน่วยเป็นวินาที มีความยาวไม่เกิน 300 วินาที

รีเทิร์น

DataExecutionStatus — สถานะการดำเนินการกับข้อมูล

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

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

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