Class PivotGroup

PivotGroup

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

שיטות

שיטהסוג הערך שמוחזרתיאור קצר
addManualGroupingRule(groupName, groupMembers)PivotGroupהוספה של כלל קיבוץ ידני לקבוצת הצירים הזו.
areLabelsRepeated()Booleanמחזירה אם תוויות מוצגות כחוזרות.
clearGroupingRule()PivotGroupפעולה זו מסירה כללי קיבוץ מקבוצת הצירים הזו.
clearSort()PivotGroupכל המיון שהוחל על הקבוצה יוסר.
getDateTimeGroupingRule()DateTimeGroupingRuleהפונקציה מחזירה את כלל הקיבוץ של תאריך ושעה בקבוצת הצירים, או null אם לא הוגדר כלל קיבוץ לפי תאריך ושעה.
getDimension()Dimensionמחזירה אם זו קבוצה של שורות או של עמודות.
getGroupLimit()PivotGroupLimitמחזירה את המגבלה של קבוצת הצירים.
getIndex()Integerמחזירה את האינדקס של קבוצת הצירים הזו בסדר הנוכחי של הקבוצה.
getPivotTable()PivotTableמחזירה את PivotTable שאליו שייכת הקיבוץ הזה.
getSourceDataColumn()Integerמחזירה את מספר העמודה של נתוני המקור שהקבוצה מסכמת.
getSourceDataSourceColumn()DataSourceColumnמחזירה את העמודה של מקור הנתונים שעליה פועלת קבוצת הצירים.
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 - כלל הקיבוץ לפי תאריך ושעה.

הרשאות

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

  • 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 - המגבלה של קבוצת הצירים.

הרשאות

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

  • 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()

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

החזרות

Integer – מספר העמודה של נתוני המקור

הרשאות

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

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

getSourceDataSourceColumn()

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

החזרות

DataSourceColumn – עמודת מקור הנתונים שבה פועלת קבוצת הצירים.

הרשאות

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

  • 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.
var sheet = SpreadsheetApp.getActiveSheet();
var pivotTable = sheet.getPivotTables()[0];
var itemGroup = pivotTable.getRowGroups()[0];
var 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()

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

החזרות

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

הרשאות

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

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