דף זה תורגם על ידי Cloud Translation API.

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`	הסרת כל הטווחים מהתרשים שה-builder הזה משנה.
`getChartType()`	`ChartType`	הפונקציה מחזירה את סוג התרשים הנוכחי.
`getContainer()`	`ContainerInfo`	החזרת התרשים `ContainerInfo`, שמכיל את המיקום שבו התרשים מופיע בגיליון.
`getRanges()`	`Range[]`	הפונקציה מחזירה עותק של רשימת הטווחים שמספקים נתונים לתרשים הזה כרגע.
`removeRange(range)`	`EmbeddedChartBuilder`	הסרת הטווח שצוין מהתרשים שה-builder הזה משנה.
`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);

פרמטרים

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

חזרה

EmbeddedChartBuilder – ה-builder הזה, לשרשור

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

הסרת כל הטווחים מהתרשים שה-builder הזה משנה.

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

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

חזרה

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

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

הטווח שהוסרו צריך להתאים לטווח שנוסף באמצעות 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 will render 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
// will not be removed, and will 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`	`ChartType`	הסוג שאליו רוצים לשנות את התרשים.

חזרה

EmbeddedChartBuilder – ה-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`	`ChartHiddenDimensionStrategy`	האסטרטגיה לשימוש בשורות ובעמודות מוסתרות.

חזרה

EmbeddedChartBuilder – ה-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);

פרמטרים

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

חזרה

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

פרמטרים

שם	סוג	תיאור
`anchorRowPos`	`Integer`	הצד העליון של התרשים מוצמדת לשורה הזו.
`anchorColPos`	`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` הוא 1, השורות והעמודות שמשמשות ליצירת התרשים מועברות למבנה 'אלכסוני'.

חזרה

EmbeddedChartBuilder – ה-builder הזה, לשרשור