Class PivotGroup

PivotGroup

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

Methods

שיטהסוג הערך המוחזרתיאור קצר
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()

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

חזרה

Booleantrue אם יש תוויות חוזרות, אחרת הפונקציה מחזירה 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()

הפונקציה מחזירה את המספר של עמודת נתוני המקור שהקבוצה הזו מסכם. האינדקס הזה מבוסס על 1. אם הקבוצה הזו מסכם את נתוני המקור בעמודה '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 אם סדר המיון הוא יורד.

חזרה

Booleantrue אם סדר המיון הוא עולה.

אישור

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

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

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

חזרה

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

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

חזרה

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

אישור

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

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