כלי ליצירת תרשימים של טבלאות. פרטים נוספים זמינים במסמכי התיעוד של Gviz.
Methods
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
add | Embedded | הוספת טווח לתרשים שהכלי הזה משנה. |
as | Embedded | מגדירה את סוג התרשים ל-AreaChart ומחזירה Embedded. |
as | Embedded | מגדיר את סוג התרשים ל-BarChart ומחזיר Embedded. |
as | Embedded | מגדירה את סוג התרשים כ-ColumnChart ומחזירה Embedded. |
as | Embedded | מגדיר את סוג התרשים ל-ComboChart ומחזיר Embedded. |
as | Embedded | מגדירה את סוג התרשים ל-HistogramChart ומחזירה Embedded. |
as | Embedded | מגדירה את סוג התרשים ל-LineChart ומחזירה Embedded. |
as | Embedded | מגדיר את סוג התרשים ל-PieChart ומחזיר Embedded. |
as | Embedded | מגדירה את סוג התרשים ל-ScatterChart ומחזירה Embedded. |
as | Embedded | מגדירה את סוג התרשים כ-TableChart ומחזירה Embedded. |
build() | Embedded | התרשים ייווצר כך שישקף את כל השינויים שבוצעו בו. |
clear | Embedded | הפעולה הזו מסירה את כל הטווחים מהתרשים שהכלי הזה משנה. |
enable | Embedded | ההגדרה קובעת אם להפעיל את האפשרות של מעבר בין דפים בנתונים. |
enable | Embedded | ההגדרה הזו מפעילה את האפשרות להצגת תוצאות בדפים ומגדירה את מספר השורות בכל דף. |
enable | Embedded | הגדרה של מספר השורות בכל דף ושל הדף הראשון בטבלה שיוצג (מספרי הדפים מבוססים על אפס). |
enable | Embedded | הוספנו תמיכה בסיסית בשפות שנכתבות מימין לשמאל (כמו ערבית או עברית) על ידי היפוך סדר העמודות בטבלה, כך שעמודה אפס היא העמודה הכי ימנית, והעמודה האחרונה היא העמודה הכי שמאלית. |
enable | Embedded | ההגדרה קובעת אם העמודות ימוינו כשהמשתמש ילחץ על כותרת של עמודה. |
get | Chart | הפונקציה מחזירה את סוג התרשים הנוכחי. |
get | Container | מחזירים את התרשים Container, שמכיל את המיקום שבו התרשים מופיע בגיליון. |
get | Range[] | הפונקציה מחזירה עותק של רשימת הטווחים שמספקים כרגע נתונים לתרשים הזה. |
remove | Embedded | הפונקציה מסירה את הטווח שצוין מהתרשים שהכלי הזה משנה. |
set | Embedded | שינוי סוג התרשים. |
set | Embedded | הגדרה של מספר השורה הראשונה בטבלת הנתונים. |
set | Embedded | מגדיר את האסטרטגיה לשימוש בשורות ובעמודות מוסתרות. |
set | Embedded | הגדרת האינדקס של העמודה שלפיה הטבלה תמוין בהתחלה (בסדר עולה). |
set | Embedded | הגדרה של אינדקס העמודה שלפיו הטבלה תמוין בהתחלה (בסדר יורד). |
set | Embedded | הגדרה של אסטרטגיית המיזוג שתשמש כשקיימים יותר מטווח אחד. |
set | Embedded | מגדיר את מספר השורות או העמודות בטווח שצריך להתייחס אליהן כאל כותרות. |
set | Embedded | הגדרת אפשרויות מתקדמות לתרשים הזה. |
set | Embedded | הגדרת המיקום, שינוי המקום שבו התרשים מופיע בגיליון. |
set | Embedded | קובעת אם השורות והעמודות בתרשים יוחלפו. |
show | Embedded | הגדרה של הצגת מספר השורה כעמודה הראשונה בטבלה. |
use | Embedded | הגדרה שקובעת אם סגנון של צבעים מתחלפים יוקצה לשורות אי-זוגיות וזוגיות בתרשים טבלה. |
תיעוד מפורט
addRange(range)
הוספת טווח לתרשים שהכלי הזה משנה. הפונקציה לא מוסיפה את הטווח אם הוא כבר נוסף לתרשים.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange('A1:B8')) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
range | Range | הטווח שרוצים להוסיף. |
חזרה
EmbeddedChartBuilder – ה-builder הזה, לשרשור.
asAreaChart()
מגדירה את סוג התרשים ל-AreaChart ומחזירה EmbeddedAreaChartBuilder.
חזרה
EmbeddedAreaChartBuilder — builder של תרשים שטח.
asBarChart()
מגדיר את סוג התרשים ל-BarChart ומחזיר EmbeddedBarChartBuilder.
חזרה
EmbeddedBarChartBuilder – builder לתרשים עמודות אופקי.
asColumnChart()
מגדירה את סוג התרשים כ-ColumnChart ומחזירה EmbeddedColumnChartBuilder.
חזרה
EmbeddedColumnChartBuilder – builder לתרשים עמודות אנכי.
asComboChart()
מגדיר את סוג התרשים ל-ComboChart ומחזיר EmbeddedComboChartBuilder.
חזרה
EmbeddedComboChartBuilder — builder של תרשים משולב.
asHistogramChart()
מגדירה את סוג התרשים ל-HistogramChart ומחזירה EmbeddedHistogramChartBuilder.
חזרה
EmbeddedHistogramChartBuilder — builder של תרשים היסטוגרמה.
asLineChart()
מגדירה את סוג התרשים ל-LineChart ומחזירה EmbeddedLineChartBuilder.
חזרה
EmbeddedLineChartBuilder — builder של תרשים קו.
asPieChart()
מגדיר את סוג התרשים ל-PieChart ומחזיר EmbeddedPieChartBuilder.
חזרה
EmbeddedPieChartBuilder – builder לתרשים עוגה.
asScatterChart()
מגדירה את סוג התרשים ל-ScatterChart ומחזירה EmbeddedScatterChartBuilder.
חזרה
EmbeddedScatterChartBuilder – builder לתרשים פיזור.
asTableChart()
מגדירה את סוג התרשים כ-TableChart ומחזירה EmbeddedTableChartBuilder.
חזרה
EmbeddedTableChartBuilder – builder של תרשים טבלה.
build()
התרשים ייווצר כך שישקף את כל השינויים שבוצעו בו.
השיטה הזו לא יוצרת אוטומטית את התרשים מעל הגיליון האלקטרוני. צריך להוסיף תרשים חדש באמצעות sheet.insertChart(chart), ולעדכן תרשים קיים באמצעות sheet.updateChart(chart).
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
חזרה
EmbeddedChart — התרשים שנוצר, שעדיין צריך להוסיף אותו לגיליון האלקטרוני.
clearRanges()
הפעולה הזו מסירה את כל הטווחים מהתרשים שהכלי הזה משנה.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This code updates the chart to use only the new ranges while preserving the // existing formatting of the chart. const chart = sheet.getCharts()[0]; const newChart = chart.modify() .clearRanges() .addRange(sheet.getRange('A1:A5')) .addRange(sheet.getRange('B1:B5')) .build(); sheet.updateChart(newChart);
חזרה
EmbeddedChartBuilder – ה-builder הזה, לשרשור.
enablePaging(enablePaging)
ההגדרה קובעת אם להפעיל את האפשרות של מעבר בין דפים בנתונים.
התנהגות ברירת המחדל היא השבתת החלוקה לדפים. אם ההחלפה לדפים מופעלת, גודל הדף שמוגדר כברירת מחדל הוא 10.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
enable | Boolean | true אם צריך להפעיל את העמודים, false אחרת. |
חזרה
EmbeddedTableChartBuilder – ה-builder הזה שימושי לשרשור.
enablePaging(pageSize)
ההגדרה הזו מפעילה את האפשרות להצגת תוצאות בדפים ומגדירה את מספר השורות בכל דף.
גודל הדף שמוגדר כברירת מחדל הוא 10.
// Creates a table chart builder and enables paging with page size of 5. const builder = Charts.newTableChart(); builder.enablePaging(5);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
page | Integer | מספר השורות בכל דף בטבלה. |
חזרה
EmbeddedTableChartBuilder – ה-builder הזה שימושי לשרשור.
enablePaging(pageSize, startPage)
הגדרה של מספר השורות בכל דף ושל הדף הראשון בטבלה שיוצג (מספרי הדפים מבוססים על אפס).
גודל הדף שמוגדר כברירת מחדל הוא 10, ודף ההתחלה שמוגדר כברירת מחדל הוא 0.
// Creates a table chart builder and enables paging with page size of 5 and // displays page 2 first. const builder = Charts.newTableChart(); builder.enablePaging(5, 2);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
page | Integer | מספר השורות בכל דף בטבלה. |
start | Integer | הדף הראשון בטבלה שיוצג (מספרי הדפים מתחילים מאפס). |
חזרה
EmbeddedTableChartBuilder – ה-builder הזה שימושי לשרשור.
enableRtlTable(rtlEnabled)
הוספנו תמיכה בסיסית בשפות שכותבים מימין לשמאל (כמו ערבית או עברית) על ידי היפוך סדר העמודות בטבלה, כך שעמודה אפס היא העמודה הימנית ביותר, והעמודה האחרונה היא העמודה השמאלית ביותר.
השינוי הזה לא משפיע על אינדקס העמודות בנתונים הבסיסיים, אלא רק על סדר התצוגה. גם אם בוחרים באפשרות הזו, הצגה מלאה של שפה דו-כיוונית (BiDi) אינה נתמכת בוויזואליזציית הטבלה. המערכת מתעלמת מהאפשרות הזו אם מפעילים את האפשרות page (חלוקה לדפים), או אם בטבלה יש סרגלי גלילה כי הגדרתם אפשרויות של גובה ורוחב שקטנות יותר מהגודל הנדרש של הטבלה. התנהגות ברירת המחדל היא השבתה של התמיכה ב-RTL.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
rtl | Boolean | true אם צריך להפעיל תמיכה בכתיבה מימין לשמאל, false
אחרת. |
חזרה
EmbeddedTableChartBuilder – ה-builder הזה שימושי לשרשור.
enableSorting(enableSorting)
ההגדרה קובעת אם למיין את העמודות כשהמשתמש לוחץ על כותרת של עמודה.
אם המיון מופעל, כשמשתמשים לוחצים על כותרת העמודה השורות ממוינות אוטומטית. התנהגות ברירת המחדל היא שהמיון מופעל.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
enable | Boolean | true כדי להפעיל מיון בלחיצה על כותרות עמודות, false אחרת. |
חזרה
EmbeddedTableChartBuilder – ה-builder הזה שימושי לשרשור.
getChartType()
getContainer()
מחזירים את התרשים ContainerInfo, שמכיל את המיקום שבו התרשים מופיע בגיליון.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const chartBuilder = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange('A1:B8')) .setPosition(5, 5, 0, 0); // This method returns the exact same data as Chart#getContainerInfo() const containerInfo = chartBuilder.getContainer(); // Logs the values used in setPosition() Logger.log( 'Anchor Column: %s\r\nAnchor Row %s\r\nOffset X %s\r\nOffset Y %s', containerInfo.getAnchorColumn(), containerInfo.getAnchorRow(), containerInfo.getOffsetX(), containerInfo.getOffsetY(), );
חזרה
ContainerInfo – אובייקט שמכיל את המיקום של מאגר התרשים.
getRanges()
הפונקציה מחזירה עותק של רשימת הטווחים שמספקים כרגע נתונים לתרשים הזה. אפשר להשתמש ב-addRange(range) וב-removeRange(range) כדי לשנות את הרשימה הזו.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const chartBuilder = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange('A1:B8')) .setPosition(5, 5, 0, 0); const ranges = chartBuilder.getRanges(); // There's only one range as a data source for this chart, // so this logs "A1:B8" for (const i in ranges) { const range = ranges[i]; Logger.log(range.getA1Notation()); }
חזרה
Range[] — מערך של טווחים שמשמשים כמקור הנתונים של התרשים שייבנה.
removeRange(range)
הפונקציה מסירה את הטווח שצוין מהתרשים שהכלי הזה משנה. לא תקפיץ הודעת שגיאה אם הטווח לא מופיע בתרשים הזה.
הטווח שהוסר צריך להיות זהה לטווח שנוסף באמצעות addRange(range);
אחרת לא יבוצע שינוי בתרשים. אי אפשר להשתמש בשיטה הזו כדי להסיר ערכים באופן חלקי מטווח.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const firstRange = sheet.getRange('A1:B5'); const secondRange = sheet.getRange('A6:B8'); const chartBuilder = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(firstRange) // This range renders in a different color .addRange(secondRange) .setPosition(5, 5, 0, 0); // Note that you can use either of these two formats, but the range // MUST match up with a range that was added via addRange(), or it // is not removed, and does not throw an exception chartBuilder.removeRange(firstRange); chartBuilder.removeRange(sheet.getRange('A6:B8')); const chart = chartBuilder.build(); sheet.insertChart(chart);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
range | Range | הטווח להסרה. |
חזרה
EmbeddedChartBuilder – ה-builder הזה, לשרשור.
setChartType(type)
שינוי סוג התרשים. כרגע לא נתמכים כל סוגי התרשימים המוטמעים. ChartType.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
type | Chart | הסוג שאליו רוצים לשנות את התרשים. |
חזרה
EmbeddedChartBuilder – ה-builder הזה, לשרשור.
setFirstRowNumber(number)
הגדרה של מספר השורה הראשונה בטבלת הנתונים.
מספר השורה של השורה הראשונה הוא 1 כברירת מחדל.
// Creates a table chart builder and sets the first row to be 2. const builder = Charts.newTableChart(); builder.setFirstRowNumber(2);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
number | Integer | מספר השורה של השורה הראשונה בטבלת הנתונים. |
חזרה
EmbeddedTableChartBuilder – ה-builder הזה שימושי לשרשור.
setHiddenDimensionStrategy(strategy)
מגדיר את האסטרטגיה לשימוש בשורות ובעמודות מוסתרות. ברירת המחדל היא IGNORE_ROWS.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setHiddenDimensionStrategy( Charts.ChartHiddenDimensionStrategy.IGNORE_COLUMNS, ) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
strategy | Chart | האסטרטגיה שבה יש להשתמש בשורות ובעמודות מוסתרות. |
חזרה
EmbeddedChartBuilder – ה-builder הזה, לשרשור.
setInitialSortingAscending(column)
הגדרה של אינדקס העמודה שלפיה הטבלה תמוין בהתחלה (בסדר עולה).
העמודה ממוינת בסדר עולה ומסומנת בחץ קטן שמציין זאת.
// Creates a table chart builder and sorts it by the second column (ascending). const builder = Charts.newTableChart(); builder.setInitialSortingAscending(2);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
column | Integer | מספר העמודה שלפיה הטבלה צריכה להיות ממוינת בהתחלה. |
חזרה
EmbeddedTableChartBuilder – ה-builder הזה שימושי לשרשור.
setInitialSortingDescending(column)
הגדרה של אינדקס העמודה שלפיו הטבלה תמוין בהתחלה (בסדר יורד).
העמודה ממוינת בסדר יורד ומסומנת בחץ קטן שמציין זאת.
// Creates a table chart builder and sorts it by the second column (descending). const builder = Charts.newTableChart(); builder.setInitialSortingDescending(2);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
column | Integer | מספר העמודה שלפיה הטבלה צריכה להיות ממוינת בהתחלה. |
חזרה
EmbeddedTableChartBuilder – ה-builder הזה שימושי לשרשור.
setMergeStrategy(mergeStrategy)
הגדרה של אסטרטגיית המיזוג שתשמש כשקיימים יותר מטווח אחד. אם הערך הוא MERGE_ROWS, השורות מוזגו. אם הערך הוא MERGE_COLUMNS, העמודות מוזגו. ברירת המחדל היא MERGE_COLUMNS.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B10'); const range2 = sheet.getRange('C:C10'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .addRange(range2) .setMergeStrategy(Charts.ChartMergeStrategy.MERGE_ROWS) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
merge | Chart | אסטרטגיית המיזוג שבה רוצים להשתמש. |
חזרה
EmbeddedChartBuilder – ה-builder הזה, לשרשור.
setNumHeaders(headers)
מגדיר את מספר השורות או העמודות בטווח שצריך להתייחס אליהן כאל כותרות.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setNumHeaders(1) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
headers | Integer | מספר השורות או העמודות שיוגדרו ככותרות. ערכים שליליים גורמים לזיהוי אוטומטי של כותרות. |
חזרה
EmbeddedChartBuilder – ה-builder הזה, לשרשור.
setOption(option, value)
הגדרת אפשרויות מתקדמות לתרשים הזה. רשימת האפשרויות הזמינות מופיעה במאמר אפשרויות להגדרת תרשים.
בשיטה הזו לא מתבצע אימות של האפשרות שציינתם, כדי לוודא שהיא מתאימה לסוג התרשים הזה, וגם לא מתבצע אימות של הערך כדי לוודא שהוא בפורמט או במבנה הנכונים.
בדוגמה הזו מוסבר איך לשנות את הכותרת ולהגדיר מקרא.
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); const sheet = spreadsheet.getSheets()[0]; const chart = sheet.newChart() .setOption('title', 'Earnings projections') .setOption('legend', { position: 'top', textStyle: { color: 'blue', fontSize: 16 }, }).build();
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
option | String | שם האפשרות. |
value | Object | הערך של האפשרות. |
חזרה
EmbeddedChartBuilder – ה-builder הזה, לשרשור.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)
הגדרת המיקום, שינוי המקום שבו התרשים מופיע בגיליון. הערכים anchorRowPos ו-anchorColPos מבוססים על אינדקס שמתחיל ב-1.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
anchor | Integer | החלק העליון של התרשים מעוגן בשורה הזו. |
anchor | Integer | הצד השמאלי של התרשים מעוגן בעמודה הזו. |
offsetX | Integer | הפינה השמאלית העליונה של התרשים מוסטת במספר הפיקסלים הזה. |
offsetY | Integer | ההיסט של הפינה השמאלית התחתונה של התרשים, בפיקסלים. |
חזרה
EmbeddedChartBuilder – ה-builder הזה, לשרשור.
setTransposeRowsAndColumns(transpose)
קובעת אם השורות והעמודות בתרשים יוחלפו. אם הערך הוא true, השורות והעמודות מתחלפות. ברירת המחדל היא false.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setTransposeRowsAndColumns(true) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
transpose | Boolean | אם הערך הוא true, השורות והעמודות שמשמשות ליצירת התרשים מוחלפות. |
חזרה
EmbeddedChartBuilder – ה-builder הזה, לשרשור.
showRowNumberColumn(showRowNumber)
הגדרה של הצגת מספר השורה כעמודה הראשונה בטבלה.
ההתנהגות שמוגדרת כברירת מחדל היא לא להציג את מספרי השורות.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
show | Boolean | true אם העמודה הראשונה בטבלה צריכה להציג את מספר השורה,
false אחרת. |
חזרה
EmbeddedTableChartBuilder – ה-builder הזה שימושי לשרשור.
useAlternatingRowStyle(alternate)
ההגדרה קובעת אם סגנון צבעים מתחלף יוקצה לשורות אי-זוגיות וזוגיות בתרשים טבלה.
התנהגות ברירת המחדל היא שהשורות יהיו בסגנון של צבעים מתחלפים.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
alternate | Boolean | true אם סגנונות הצבע צריכים להיות מתחלפים, false אחרת. |
חזרה
EmbeddedTableChartBuilder – ה-builder הזה שימושי לשרשור.