Class PivotGroup

PivotGroup

אפשר לגשת לקבוצות של פירוט בטבלת צירים ולשנות אותן.

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addManualGroupingRule(groupName, groupMembers)PivotGroupמוסיף כלל ידני לקיבוץ קבוצת הצירים הזו.
areLabelsRepeated()Booleanהפונקציה מחזירה תשובה אם התוויות מוצגות כחוזרות.
clearGroupingRule()PivotGroupהסרת כל כללי הקיבוץ מקבוצת הצירים הזו.
clearSort()PivotGroupמסירה את המיון שהוחל על הקבוצה.
getDateTimeGroupingRule()DateTimeGroupingRule|nullהפונקציה מחזירה את כלל הקיבוץ לפי תאריך ושעה בקבוצת הצירים, או null אם לא הוגדר כלל קיבוץ לפי תאריך ושעה.
getDimension()Dimensionהפונקציה מחזירה תשובה אם מדובר בקבוצת שורות או בקבוצת עמודות.
getGroupLimit()PivotGroupLimit|nullהפונקציה מחזירה את המגבלה על קבוצת הצירים בקבוצת הצירים.
getIndex()Integerהפונקציה מחזירה את האינדקס של קבוצת הצירים הזו בסדר הקבוצות הנוכחי.
getPivotTable()PivotTableמחזירה את ה-PivotTable שהקיבוץ הזה שייך אליו.
getSourceDataColumn()Integerהפונקציה מחזירה את מספר העמודה בנתוני המקור שהקבוצה הזו מסכמת.
getSourceDataSourceColumn()DataSourceColumn|nullהפונקציה מחזירה את העמודה במקור הנתונים שהקבוצה של טבלת הצירים פועלת עליה.
hideRepeatedLabels()PivotGroupהסתרת תוויות חוזרות בקבוצה הזו.
isSortAscending()Booleanהפונקציה מחזירה את הערך true אם המיון הוא בסדר עולה, ואת הערך false אם המיון הוא בסדר יורד.
moveToIndex(index)PivotGroupמעבירה את הקבוצה הזו למיקום שצוין ברשימה הנוכחית של קבוצות שורות או עמודות.
remove()voidהסרת קבוצת הצירים הזו מהטבלה.
removeManualGroupingRule(groupName)PivotGroupמסיר את כלל הקיבוץ הידני עם המזהה groupName שצוין.
resetDisplayName()PivotGroupמאפס את השם המוצג של הקבוצה הזו בטבלת הצירים לערך ברירת המחדל שלה.
setDateTimeGroupingRule(dateTimeGroupingRuleType)PivotGroupמגדירה את כלל הקיבוץ לפי תאריך ושעה בקבוצת הצירים.
setDisplayName(name)PivotGroupהגדרת השם המוצג של הקבוצה הזו בטבלת הצירים.
setGroupLimit(countLimit)PivotGroupהגדרת המגבלה על קבוצת הצירים בקבוצת הצירים.
setHistogramGroupingRule(minValue, maxValue, intervalSize)PivotGroupמגדיר כלל לקיבוץ היסטוגרמה לקבוצת הצירים הזו.
showRepeatedLabels()PivotGroupאם יש יותר מקבוצת שורות או עמודות, השיטה הזו מציגה את התווית של הקבוצה הזו לכל רשומה בקבוצה הבאה.
showTotals(showTotals)PivotGroupהגדרה של הצגת הערכים הכוללים של קבוצת הצירים הזו בטבלה.
sortAscending()PivotGroupהגדרת סדר המיון כסדר עולה.
sortBy(value, oppositeGroupValues)PivotGroupממיינת את הקבוצה הזו לפי PivotValue שצוין עבור הערכים מ-oppositeGroupValues.
sortDescending()PivotGroupהגדרת סדר המיון בסדר יורד.
totalsAreShown()Booleanהפונקציה מחזירה תשובה אם הערכים הכוללים מוצגים כרגע עבור קבוצת הצירים הזו.

תיעוד מפורט

addManualGroupingRule(groupName, groupMembers)

מוסיף כלל ידני לקיבוץ קבוצת הצירים הזו.

פרמטרים

שםסוגתיאור
groupNameStringהשם של כלל הקיבוץ הזה.
groupMembersObject[]הערכים שנכללים בכלל הקיבוץ הזה.

חזרה

‫PivotGroup – קבוצת הצירים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

areLabelsRepeated()

הפונקציה מחזירה תשובה אם התוויות מוצגות כחוזרות.

חזרה

‫Boolean – true אם התוויות חוזרות על עצמן, אחרת הפונקציה מחזירה false.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

clearGroupingRule()

הסרת כל כללי הקיבוץ מקבוצת הצירים הזו.

חזרה

‫PivotGroup – קבוצת הצירים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

clearSort()

מסירה את המיון שהוחל על הקבוצה.

חזרה

‫PivotGroup – קבוצת הצירים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

getDateTimeGroupingRule()

הפונקציה מחזירה את כלל הקיבוץ לפי תאריך ושעה בקבוצת הצירים, או null אם לא הוגדר כלל קיבוץ לפי תאריך ושעה.

חזרה

‫DateTimeGroupingRule|null — כלל הקיבוץ לפי תאריך ושעה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

getDimension()

הפונקציה מחזירה תשובה אם מדובר בקבוצת שורות או בקבוצת עמודות.

חזרה

‫Dimension – המאפיין שמייצג את סוג הקבוצה הזו

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

getGroupLimit()

הפונקציה מחזירה את המגבלה על קבוצת הצירים בקבוצת הצירים. הפונקציה מחזירה null אם לא הוגדרה מגבלה על קבוצת הצירים.

חזרה

‫PivotGroupLimit|null — המגבלה על קבוצת הצירים.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

getIndex()

הפונקציה מחזירה את האינדקס של קבוצת הצירים הזו בסדר הקבוצות הנוכחי.

חזרה

‫Integer – האינדקס של קבוצת הצירים

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

getPivotTable()

מחזירה את ה-PivotTable שהקיבוץ הזה שייך אליו.

חזרה

‫PivotTable – טבלת הצירים שאליה הקבוצה שייכת.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

getSourceDataColumn()

הפונקציה מחזירה את מספר העמודה בנתוני המקור שהקבוצה הזו מסכמת. האינדקס הזה מבוסס על 1. אם הקבוצה הזו מסכמת נתוני מקור בעמודה A של הגיליון האלקטרוני, השיטה הזו מחזירה 1.

חזרה

‫Integer — מספר עמודת נתוני המקור

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

getSourceDataSourceColumn()

הפונקציה מחזירה את העמודה במקור הנתונים שהקבוצה של טבלת הצירים פועלת עליה. הפונקציה מחזירה null אם טבלת הצירים היא לא {DataSourcePivotTableApi}.

חזרה

‫DataSourceColumn|null — העמודה במקור הנתונים שעליה מבוצע הקיבוץ בטבלת הצירים.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

hideRepeatedLabels()

הסתרת תוויות חוזרות בקבוצה הזו. אם התוויות כבר מוסתרות, לא יקרה כלום. אם קוראים לשיטה הזו לפני שיש כמה קיבוצים של שורות או עמודות, כשמוסיפים קיבוץ נוסף, התוויות שחוזרות על עצמן מוסתרות.

חזרה

‫PivotGroup – קבוצת הצירים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

isSortAscending()

הפונקציה מחזירה את הערך true אם המיון הוא בסדר עולה, ואת הערך false אם המיון הוא בסדר יורד.

חזרה

‫Boolean — true אם סדר המיון הוא עולה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

moveToIndex(index)

מעבירה את הקבוצה הזו למיקום שצוין ברשימה הנוכחית של קבוצות שורות או עמודות. האינדקסים האלה מבוססים על 0. לדוגמה, אם רוצים להעביר את הקבוצה הזו למיקום הראשון, צריך להפעיל את השיטה הזו עם 0.

פרמטרים

שםסוגתיאור
indexIntegerהאינדקס שאליו רוצים להעביר את הקיבוץ הזה.

חזרה

‫PivotGroup – קבוצת הצירים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

remove()

הסרת קבוצת הצירים הזו מהטבלה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

removeManualGroupingRule(groupName)

מסיר את כלל הקיבוץ הידני עם המזהה groupName שצוין.

פרמטרים

שםסוגתיאור
groupNameStringהשם של כלל הקיבוץ שרוצים להסיר.

חזרה

‫PivotGroup – קבוצת הצירים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

resetDisplayName()

מאפס את השם המוצג של הקבוצה הזו בטבלת הצירים לערך ברירת המחדל שלה.

חזרה

‫PivotGroup – קבוצת הצירים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

setDateTimeGroupingRule(dateTimeGroupingRuleType)

מגדירה את כלל הקיבוץ לפי תאריך ושעה בקבוצת הצירים.

כדי להסיר את הכלל, משתמשים ב-clearGroupingRule().

פרמטרים

שםסוגתיאור
dateTimeGroupingRuleTypeDateTimeGroupingRuleTypeסוג הכלל להגדרה.

חזרה

‫PivotGroup – קבוצת הצירים, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

setDisplayName(name)

הגדרת השם המוצג של הקבוצה הזו בטבלת הצירים.

פרמטרים

שםסוגתיאור
nameStringהשם המוצג שרוצים להגדיר.

חזרה

‫PivotGroup – קבוצת הצירים לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

setGroupLimit(countLimit)

הגדרת המגבלה על קבוצת הצירים בקבוצת הצירים. הפעולה נתמכת רק עבור DataSourcePivotTable.

פרמטרים

שםסוגתיאור
countLimitIntegerמגבלת הספירה של השורות או העמודות להגדרה. חייב להיות חיובי.

חזרה

‫PivotGroup — קבוצת הצירים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

setHistogramGroupingRule(minValue, maxValue, intervalSize)

מגדיר כלל לקיבוץ היסטוגרמה לקבוצת הצירים הזו. כלל היסטוגרמה מארגן ערכים בעמודת נתוני מקור בקטגוריות בגודל קבוע. כל הערכים מ-minValue עד maxValue מוצבים בקבוצות בגודל interval. כל הערכים שקטנים מ-minValue מוצבים בקטגוריה אחת, וכך גם כל הערכים שגדולים מ-maxValue.

פרמטרים

שםסוגתיאור
minValueIntegerהערך המינימלי של פריטים שיוצבו בדליים. ערכים שקטנים מהערך הזה משולבים בדלי אחד.
maxValueIntegerהערך המקסימלי של פריטים שאפשר להכניס לקטגוריות. ערכים שגדולים מהערך הזה משולבים בדלי אחד.
intervalSizeInteger

חזרה

‫PivotGroup – קבוצת הצירים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

showRepeatedLabels()

אם יש יותר מקבוצת שורות או עמודות, השיטה הזו מציגה את התווית של הקבוצה הזו לכל רשומה בקבוצה הבאה. אם התוויות כבר חוזרות על עצמן, לא מתבצעת פעולה. אם קוראים לשיטה הזו לפני שיש כמה קיבוצים של שורות או עמודות, כשמוסיפים קיבוץ נוסף מוצגות תוויות חוזרות.

חזרה

‫PivotGroup – קבוצת הצירים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

showTotals(showTotals)

הגדרה של הצגת הערכים הכוללים של קבוצת הצירים הזו בטבלה.

פרמטרים

שםסוגתיאור
showTotalsBooleanהאם להציג סיכומים או לא.

חזרה

‫PivotGroup – קבוצת הצירים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

sortAscending()

הגדרת סדר המיון כסדר עולה.

חזרה

‫PivotGroup – קבוצת הצירים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

sortBy(value, oppositeGroupValues)

ממיינת את הקבוצה הזו לפי PivotValue שצוין עבור הערכים מ-oppositeGroupValues. 

// Sorts the item group by the "SUM of Quantity" pivot value for the specified
// salespersons.
const sheet = SpreadsheetApp.getActiveSheet();
const pivotTable = sheet.getPivotTables()[0];
const itemGroup = pivotTable.getRowGroups()[0];
const sumQuantityValue = pivotTable.getPivotValues()[0];
itemGroup.sortBy(sumQuantityValue, ['Beth', 'Amir', 'Devyn']);

פרמטרים

שםסוגתיאור
valuePivotValueערך הציר שלפיו רוצים למיין.
oppositeGroupValuesObject[]הערכים של קבוצת ציר הפוכה (קבוצת עמודות אם ממיינים קבוצת שורות, או קבוצת שורות אם ממיינים קבוצת עמודות) שמשמשים למיון. הסדר של הערכים האלה קובע את העדיפות במקרה של שוויון.

חזרה

‫PivotGroup – קבוצת הצירים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

sortDescending()

הגדרת סדר המיון בסדר יורד.

חזרה

‫PivotGroup – קבוצת הצירים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

totalsAreShown()

הפונקציה מחזירה תשובה אם הערכים הכוללים מוצגים כרגע עבור קבוצת הצירים הזו.

חזרה

‫Boolean — true אם מוצגים ערכים כוללים לקבוצת הצירים הזו, אחרת הפונקציה מחזירה false.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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