כלי לבנייה שמשמש לעריכה של Embedded
. השינויים שבוצעו בתרשים לא נשמרים עד שמפעילים את הפונקציה Sheet.updateChart(chart)
בתרשים שנבנה מחדש.
const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('A1:B8'); let chart = sheet.getCharts()[0]; chart = chart.modify() .addRange(range) .setOption('title', 'Updated!') .setOption('animation.duration', 500) .setPosition(2, 2, 0, 0) .build(); sheet.updateChart(chart);
Methods
תיעוד מפורט
add Range(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 | הטווח שרוצים להוסיף. |
חזרה
Embedded
— הכלי הזה, לשרשור.
as Area Chart()
מגדיר את סוג התרשים ל-AreaChart ומחזיר Embedded
.
חזרה
Embedded
— כלי לבניית תרשים שטח.
as Bar Chart()
מגדיר את סוג התרשים ל-BarChart ומחזיר Embedded
.
חזרה
Embedded
— כלי ליצירת תרשים עמודות אופקי.
as Column Chart()
מגדיר את סוג התרשים כ-ColumnChart ומחזיר Embedded
.
חזרה
Embedded
— כלי ליצירת תרשים עמודות אנכי.
as Combo Chart()
מגדיר את סוג התרשים ל-ComboChart ומחזיר Embedded
.
חזרה
Embedded
— כלי לבניית תרשים משולב.
as Histogram Chart()
מגדיר את סוג התרשים ל-HistogramChart ומחזיר Embedded
.
חזרה
Embedded
— כלי ליצירת תרשים היסטוגרמה.
as Line Chart()
מגדיר את סוג התרשים ל-LineChart ומחזיר Embedded
.
חזרה
Embedded
– כלי לבניית תרשים קו.
as Pie Chart()
מגדיר את סוג התרשים כ-PieChart ומחזיר Embedded
.
חזרה
Embedded
— כלי לבניית תרשים עוגה.
as Scatter Chart()
מגדיר את סוג התרשים ל-ScatterChart ומחזיר Embedded
.
חזרה
Embedded
— כלי לבניית תרשים פיזור.
as Table Chart()
מגדיר את סוג התרשים כ-TableChart ומחזיר Embedded
.
חזרה
Embedded
— כלי ליצירת תרשים טבלה.
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);
חזרה
Embedded
— התרשים שנוצר, שעדיין צריך להוסיף אותו לגיליון האלקטרוני.
clear Ranges()
מסיר את כל הטווחים מהתרשים שהכלי הזה משנה.
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);
חזרה
Embedded
— הכלי הזה, לשרשור.
get Chart Type()
get Container()
מחזירים את התרשים Container
, שמכיל את המיקום שבו התרשים מופיע בגיליון.
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(), );
חזרה
Container
– אובייקט שמכיל את המיקום של מאגר התרשים.
get Ranges()
הפונקציה מחזירה עותק של רשימת טווחי התאריכים שמוצגים כרגע בתרשים. אפשר להשתמש ב-add
וב-remove
כדי לשנות את הרשימה הזו.
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[]
— מערך של טווחים שמשמשים כמקור הנתונים של התרשים שיוצג.
remove Range(range)
הפונקציה מסירה את הטווח שצוין מהתרשים שהכלי הזה משנה. לא תקפיץ הודעת שגיאה אם הטווח לא מופיע בתרשים הזה.
הטווח שהוסר צריך להיות זהה לטווח שנוסף באמצעות add
; אחרת לא יבוצע שינוי בתרשים. אי אפשר להשתמש בשיטה הזו כדי להסיר חלקית ערכים מטווח.
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 | הטווח להסרה. |
חזרה
Embedded
— הכלי הזה, לשרשור.
set Chart Type(type)
שינוי סוג התרשים. כרגע אין תמיכה בכל סוגי התרשימים המוטמעים. 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);
פרמטרים
שם | סוג | תיאור |
---|---|---|
type | Chart | הסוג שאליו רוצים לשנות את התרשים. |
חזרה
Embedded
— הכלי הזה, לשרשור.
set Hidden Dimension Strategy(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 | האסטרטגיה שבה יש להשתמש בשורות ובעמודות מוסתרות. |
חזרה
Embedded
— הכלי הזה, לשרשור.
set Merge Strategy(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 | אסטרטגיית המיזוג שבה רוצים להשתמש. |
חזרה
Embedded
— הכלי הזה, לשרשור.
set Num Headers(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 | מספר השורות או העמודות שיוגדרו ככותרות. ערכים שליליים גורמים לכותרות להיות מזוהות אוטומטית. |
חזרה
Embedded
— הכלי הזה, לשרשור.
set Option(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 | הערך של האפשרות. |
חזרה
Embedded
— הכלי הזה, לשרשור.
set Position(anchorRowPos, anchorColPos, offsetX, offsetY)
הגדרת המיקום, שינוי המקום שבו התרשים מופיע בגיליון. הערכים anchor
ו-anchor
הם אינדקסים מבוססי-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 | ההיסט של הפינה השמאלית התחתונה של התרשים, בפיקסלים. |
חזרה
Embedded
— הכלי הזה, לשרשור.
set Transpose Rows And Columns(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 , השורות והעמודות שמשמשות ליצירת התרשים מוחלפות. |
חזרה
Embedded
— הכלי הזה, לשרשור.