Class EmbeddedChartBuilder

הטמעהתרשיםכלי ליצירת תרשימים

כלי לבנייה שמשמש לעריכה של EmbeddedChart. השינויים שבוצעו בתרשים לא נשמרים עד שמפעילים את הפונקציה 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

שיטהסוג הערך שמוחזרתיאור קצר
addRange(range)EmbeddedChartBuilderהוספת טווח לתרשים שהכלי הזה משנה.
asAreaChart()EmbeddedAreaChartBuilderמגדיר את סוג התרשים ל-AreaChart ומחזיר EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderמגדיר את סוג התרשים ל-BarChart ומחזיר EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderמגדיר את סוג התרשים כ-ColumnChart ומחזיר EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderמגדיר את סוג התרשים ל-ComboChart ומחזיר EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderמגדיר את סוג התרשים ל-HistogramChart ומחזיר EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderמגדיר את סוג התרשים ל-LineChart ומחזיר EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderמגדיר את סוג התרשים כ-PieChart ומחזיר EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderמגדיר את סוג התרשים ל-ScatterChart ומחזיר EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderמגדיר את סוג התרשים כ-TableChart ומחזיר EmbeddedTableChartBuilder.
build()EmbeddedChartהתרשים ייווצר כך שישקף את כל השינויים שבוצעו בו.
clearRanges()EmbeddedChartBuilderמסיר את כל הטווחים מהתרשים שהכלי הזה משנה.
getChartType()ChartTypeהפונקציה מחזירה את סוג התרשים הנוכחי.
getContainer()ContainerInfoמחזירים את התרשים ContainerInfo, שמכיל את המיקום שבו התרשים מופיע בגיליון.
getRanges()Range[]הפונקציה מחזירה עותק של רשימת טווחי התאריכים שמוצגים כרגע בתרשים.
removeRange(range)EmbeddedChartBuilderהפונקציה מסירה את הטווח שצוין מהתרשים שהכלי הזה משנה.
setChartType(type)EmbeddedChartBuilderשינוי סוג התרשים.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderהגדרת האסטרטגיה לשימוש בשורות ובעמודות מוסתרות.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderהגדרה של אסטרטגיית המיזוג שתשמש כשקיימים יותר מטווח אחד.
setNumHeaders(headers)EmbeddedChartBuilderמגדיר את מספר השורות או העמודות בטווח שצריך להתייחס אליהן כאל כותרות.
setOption(option, value)EmbeddedChartBuilderהגדרת אפשרויות מתקדמות לתרשים הזה.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderהגדרת המיקום, שינוי המקום שבו התרשים מופיע בגיליון.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderקובעת אם השורות והעמודות בתרשים יוחלפו.

תיעוד מפורט

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

פרמטרים

שםסוגתיאור
rangeRangeהטווח שרוצים להוסיף.

חזרה

‫EmbeddedChartBuilder — הכלי הזה, לשרשור.

asAreaChart()

מגדיר את סוג התרשים ל-AreaChart ומחזיר EmbeddedAreaChartBuilder.

חזרה

‫EmbeddedAreaChartBuilder — כלי לבניית תרשים שטח.

asBarChart()

מגדיר את סוג התרשים ל-BarChart ומחזיר EmbeddedBarChartBuilder.

חזרה

‫EmbeddedBarChartBuilder — כלי ליצירת תרשים עמודות אופקי.

asColumnChart()

מגדיר את סוג התרשים כ-ColumnChart ומחזיר EmbeddedColumnChartBuilder.

חזרה

‫EmbeddedColumnChartBuilder — כלי ליצירת תרשים עמודות אנכי.

asComboChart()

מגדיר את סוג התרשים ל-ComboChart ומחזיר EmbeddedComboChartBuilder.

חזרה

‫EmbeddedComboChartBuilder — כלי לבניית תרשים משולב.

asHistogramChart()

מגדיר את סוג התרשים ל-HistogramChart ומחזיר EmbeddedHistogramChartBuilder.

חזרה

‫EmbeddedHistogramChartBuilder — כלי ליצירת תרשים היסטוגרמה.

asLineChart()

מגדיר את סוג התרשים ל-LineChart ומחזיר EmbeddedLineChartBuilder.

חזרה

‫EmbeddedLineChartBuilder – כלי לבניית תרשים קו.

asPieChart()

מגדיר את סוג התרשים כ-PieChart ומחזיר EmbeddedPieChartBuilder.

חזרה

‫EmbeddedPieChartBuilder — כלי לבניית תרשים עוגה.

asScatterChart()

מגדיר את סוג התרשים ל-ScatterChart ומחזיר EmbeddedScatterChartBuilder.

חזרה

‫EmbeddedScatterChartBuilder — כלי לבניית תרשים פיזור.

asTableChart()

מגדיר את סוג התרשים כ-TableChart ומחזיר EmbeddedTableChartBuilder.

חזרה

‫EmbeddedTableChartBuilder — כלי ליצירת תרשים טבלה.

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 — הכלי הזה, לשרשור.

getChartType()

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

חזרה

‫ChartType — סוג התרשים.

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

פרמטרים

שםסוגתיאור
rangeRangeהטווח להסרה.

חזרה

‫EmbeddedChartBuilder — הכלי הזה, לשרשור.

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

פרמטרים

שםסוגתיאור
typeChartTypeהסוג שאליו רוצים לשנות את התרשים.

חזרה

‫EmbeddedChartBuilder — הכלי הזה, לשרשור.

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

פרמטרים

שםסוגתיאור
strategyChartHiddenDimensionStrategyהאסטרטגיה שבה יש להשתמש בשורות ובעמודות מוסתרות.

חזרה

‫EmbeddedChartBuilder — הכלי הזה, לשרשור.

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

פרמטרים

שםסוגתיאור
mergeStrategyChartMergeStrategyאסטרטגיית המיזוג שבה רוצים להשתמש.

חזרה

‫EmbeddedChartBuilder — הכלי הזה, לשרשור.

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

פרמטרים

שםסוגתיאור
headersIntegerמספר השורות או העמודות שיוגדרו ככותרות. ערכים שליליים גורמים לכותרות להיות מזוהות אוטומטית.

חזרה

‫EmbeddedChartBuilder — הכלי הזה, לשרשור.

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

פרמטרים

שםסוגתיאור
optionStringשם האפשרות.
valueObjectהערך של האפשרות.

חזרה

‫EmbeddedChartBuilder — הכלי הזה, לשרשור.

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

פרמטרים

שםסוגתיאור
anchorRowPosIntegerהחלק העליון של התרשים מעוגן בשורה הזו.
anchorColPosIntegerהצד השמאלי של התרשים מעוגן בעמודה הזו.
offsetXIntegerהפינה השמאלית העליונה של התרשים מוסטת במספר הפיקסלים הזה.
offsetYIntegerההיסט של הפינה השמאלית התחתונה של התרשים, בפיקסלים.

חזרה

‫EmbeddedChartBuilder — הכלי הזה, לשרשור.

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

פרמטרים

שםסוגתיאור
transposeBooleanאם הערך הוא true, השורות והעמודות שמשמשות ליצירת התרשים מוחלפות.

חזרה

‫EmbeddedChartBuilder — הכלי הזה, לשרשור.