כלי ליצירת תרשימי עמודות. פרטים נוספים זמינים ב מסמכי התיעוד של Gviz.
Methods
תיעוד מפורט
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 הזה, לשרשור.
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 הזה, לשרשור.
reverseCategories()
הופכת את סדר הציור של הסדרות בציר הדומיין. בתרשימים עם טווח אנכי (כמו תרשימי קו, שטח או עמודות), המשמעות היא שהציר האופקי מצויר מימין לשמאל. בתרשימים עם טווח אופקי (כמו תרשימי עמודות), המשמעות היא שהציר האנכי מצויר מלמעלה למטה. בתרשימי עוגה, המשמעות היא שהפלחים מצוירים נגד כיוון השעון.
// Creates a pie chart builder and sets drawing of the slices in a // counter-clockwise manner. const builder = Charts.newPieChart(); builder.reverseCategories();
חזרה
EmbeddedColumnChartBuilder – ה-builder הזה שימושי לשרשור.
setBackgroundColor(cssValue)
הגדרת צבע הרקע של התרשים.
// Creates a line chart builder and sets the background color to gray const builder = Charts.newLineChart(); builder.setBackgroundColor('gray');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
css | String | ערך ה-CSS של הצבע (למשל "blue" או "#00f"). |
חזרה
EmbeddedColumnChartBuilder – ה-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 הזה, לשרשור.
setColors(cssValues)
הגדרת הצבעים של הקווים בתרשים.
// Creates a line chart builder and sets the first two lines to be drawn in // green and red, respectively. const builder = Charts.newLineChart(); builder.setColors(['green', 'red']);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
css | String[] | מערך של ערכי CSS של צבעים, כמו ["red", "#acf"]. האלמנט ה-n במערך מייצג את הצבע של הקו ה-n בתרשים. |
חזרה
EmbeddedColumnChartBuilder – ה-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 הזה, לשרשור.
setLegendPosition(position)
ההגדרה הזו קובעת את המיקום של המקרא ביחס לתרשים. כברירת מחדל, לא מוצג מקרא.
// Creates a line chart builder and sets the legend position to right. const builder = Charts.newLineChart(); builder.setLegendPosition(Charts.Position.RIGHT);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
position | Position | המיקום של המקרא. |
חזרה
EmbeddedColumnChartBuilder – ה-builder הזה שימושי לשרשור.
setLegendTextStyle(textStyle)
הגדרת סגנון הטקסט של מקרא התרשים.
// Creates a line chart builder and sets it up for a blue, 26-point legend. const textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26); const style = textStyleBuilder.build(); const builder = Charts.newLineChart(); builder.setLegendTextStyle(style);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
text | Text | סגנון הטקסט שבו רוצים להשתמש עבור מקרא התרשים. |
חזרה
EmbeddedColumnChartBuilder – ה-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 הזה, לשרשור.
setRange(start, end)
ההגדרה הזו קובעת את הטווח של התרשים.
אם יש נקודות נתונים מחוץ לטווח, הטווח יורחב כדי לכלול את נקודות הנתונים האלה.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
start | Number | הערך של קו הרשת הנמוך ביותר בציר הטווח. |
end | Number | הערך של קו הרשת העליון בציר הטווח. |
חזרה
EmbeddedColumnChartBuilder – ה-builder הזה שימושי לשרשור.
setStacked()
התרשים מציג קווים מוערמים, כלומר ערכי הקווים והעמודות מוערמים (מצטברים). כברירת מחדל, אין חפיפה.
חזרה
EmbeddedColumnChartBuilder – ה-builder הזה שימושי לשרשור.
setTitle(chartTitle)
הגדרת הכותרת של התרשים. הכותרת מוצגת במרכז מעל התרשים.
// Creates a line chart builder and title to 'My Line Chart'. const builder = Charts.newLineChart(); builder.setTitle('My Line Chart');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
chart | String | כותרת התרשים. |
חזרה
EmbeddedColumnChartBuilder – ה-builder הזה שימושי לשרשור.
setTitleTextStyle(textStyle)
מגדיר את סגנון הטקסט של שם התרשים.
// Creates a line chart builder and sets it up for a blue, 26-point title. const textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26); const style = textStyleBuilder.build(); const builder = Charts.newLineChart(); builder.setTitleTextStyle(style);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
text | Text | סגנון הטקסט שבו יש להשתמש לכותרת התרשים. אפשר ליצור אובייקט Text על ידי קריאה ל-Charts.newTextStyle(). |
חזרה
EmbeddedColumnChartBuilder – ה-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 הזה, לשרשור.
setXAxisTextStyle(textStyle)
הגדרת סגנון הטקסט של הציר האופקי.
// Creates a line chart builder and sets the X-axis text style to blue, 18-point // font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setXAxisTextStyle(textStyle);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
text | Text | סגנון הטקסט שבו רוצים להשתמש לכותרת של הציר האופקי. אפשר ליצור אובייקט Text על ידי קריאה ל-Charts.newTextStyle(). |
חזרה
EmbeddedColumnChartBuilder – ה-builder הזה שימושי לשרשור.
setXAxisTitle(title)
מוסיפה כותרת לציר האופקי. הכותרת מיושרת למרכז ומופיעה מתחת לתוויות של ערכי הציר.
// Creates a line chart builder and sets the X-axis title. const builder = Charts.newLineChart(); builder.setTitle('X-axis Title');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
title | String | הכותרת של ציר ה-X. |
חזרה
EmbeddedColumnChartBuilder – ה-builder הזה שימושי לשרשור.
setXAxisTitleTextStyle(textStyle)
הגדרת סגנון הטקסט של הכותרת של הציר האופקי.
// Creates a line chart builder and sets the X-axis title text style to blue, // 18-point font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setXAxisTitleTextStyle(textStyle);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
text | Text | סגנון הטקסט שבו רוצים להשתמש לכותרת של הציר האופקי. אפשר ליצור אובייקט Text על ידי קריאה ל-Charts.newTextStyle(). |
חזרה
EmbeddedColumnChartBuilder – ה-builder הזה שימושי לשרשור.
setYAxisTextStyle(textStyle)
הגדרת סגנון הטקסט של הציר האנכי.
// Creates a line chart builder and sets the Y-axis text style to blue, 18-point // font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setYAxisTextStyle(textStyle);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
text | Text | סגנון הטקסט שבו רוצים להשתמש לכותרת של הציר האופקי. אפשר ליצור אובייקט Text על ידי קריאה ל-Charts.newTextStyle(). |
חזרה
EmbeddedColumnChartBuilder – ה-builder הזה שימושי לשרשור.
setYAxisTitle(title)
מוסיפים כותרת לציר האנכי. הכותרת ממורכזת ומופיעה מימין לתוויות של הערכים.
// Creates a line chart builder and sets the Y-axis title. const builder = Charts.newLineChart(); builder.setYAxisTitle('Y-axis Title');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
title | String | הכותרת של ציר ה-Y. |
חזרה
EmbeddedColumnChartBuilder – ה-builder הזה שימושי לשרשור.
setYAxisTitleTextStyle(textStyle)
הגדרת סגנון הטקסט של הכותרת של הציר האנכי.
// Creates a line chart builder and sets the Y-axis title text style to blue, // 18-point font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setYAxisTitleTextStyle(textStyle);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
text | Text | סגנון הטקסט שבו רוצים להשתמש לכותרת של הציר האופקי. אפשר ליצור אובייקט Text על ידי קריאה ל-Charts.newTextStyle(). |
חזרה
EmbeddedColumnChartBuilder – ה-builder הזה שימושי לשרשור.
useLogScale()
הופך את ציר הטווח לסולם לוגריתמי (נדרש שכל הערכים יהיו חיוביים). ציר הטווח הוא הציר האנכי בתרשימים אנכיים (כמו תרשים קו, תרשים שטח או תרשים עמודות) והציר האופקי בתרשימים אופקיים (כמו תרשים עמודות אופקי).
חזרה
EmbeddedColumnChartBuilder – ה-builder הזה שימושי לשרשור.