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

Class EmbeddedChartBuilder

הבנאי ששימש לעריכת EmbeddedChart. שינויים שמתבצעים בתרשים לא נשמרים עד שמפעילים את Sheet.updateChart(chart) בתרשים המחודש.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B8");
var 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);

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`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)`

מוסיף טווח לתרשים שהכלי הזה משנה אותו. אי אפשר להוסיף את הטווח אם הוא כבר נוסף לתרשים.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(sheet.getRange("A1:B8"))
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

פרמטרים

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

החזרות

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(range)
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

החזרות

EmbeddedChart - התרשים שנוצר, שעדיין יש להוסיף לגיליון האלקטרוני

`clearRanges()`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This code updates the chart to use only the new ranges while preserving the existing
// formatting of the chart.
var chart = sheet.getCharts()[0];
var newChart = chart
    .modify()
    .clearRanges()
    .addRange(sheet.getRange("A1:A5"))
    .addRange(sheet.getRange("B1:B5"))
    .build();
sheet.updateChart(newChart);

החזרות

EmbeddedChartBuilder – הכלי הזה ליצירת שרשורים

`getChartType()`

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

החזרות

ChartType – סוג התרשים

`getContainer()`

מחזירים את התרשים ContainerInfo, שכולל את המיקום שבו מופיע התרשים בגיליון.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var 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()
var containerInfo = chartBuilder.getContainer();

// Logs the values we 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) כדי לשנות את הרשימה הזו.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var chartBuilder = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(sheet.getRange("A1:B8"))
    .setPosition(5, 5, 0, 0);

var ranges = chartBuilder.getRanges();

// There's only one range as a data source for this chart,
// so this logs "A1:B8"
for (var i in ranges) {
  var range = ranges[i];
  Logger.log(range.getA1Notation());
}

החזרות

Range[] – מערך של טווחים שמשמשים כמקור הנתונים של התרשים לבנייה

`removeRange(range)`

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

הטווח שהוסר חייב להתאים לטווח שנוסף דרך addRange(range), אחרת לא יבוצע שינוי בתרשים. לא ניתן להשתמש בשיטה הזו כדי להסיר ערכים באופן חלקי מטווח.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var firstRange = sheet.getRange("A1:B5");
var secondRange = sheet.getRange("A6:B8");

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

var chart = chartBuilder.build();

sheet.insertChart(chart);

פרמטרים

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

החזרות

EmbeddedChartBuilder – הכלי הזה ליצירת שרשורים

`setChartType(type)`

שינוי סוג התרשים. לא כל סוגי התרשימים המוטמעים נתמכים בשלב זה. ChartType.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(range)
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

פרמטרים

שם	תיאור	התיאור
`type`	`ChartType`	הסוג שאליו רוצים לשנות את התרשים.

החזרות

EmbeddedChartBuilder – הכלי הזה ליצירת שרשורים

`setHiddenDimensionStrategy(strategy)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var 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 – הכלי הזה ליצירת שרשורים

`setMergeStrategy(mergeStrategy)`

מגדיר את אסטרטגיית המיזוג לשימוש כאשר קיים יותר מטווח אחד. במקרה של MERGE_ROWS השורות ממוזגות, ואם הערך הוא MERGE_COLUMNS, העמודות ממוזגות. ברירת המחדל היא MERGE_COLUMNS.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B10");
var range2 = sheet.getRange("C:C10");
var 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 – הכלי הזה ליצירת שרשורים

`setNumHeaders(headers)`

המדיניות מגדירה את מספר השורות או העמודות בטווח שיש להתייחס אליהן ככותרות.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(range)
    .setNumHeaders(1)
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

פרמטרים

שם	תיאור	התיאור
`headers`	`Integer`	מספר השורות או העמודות שיש להתייחס אליהן ככותרות. ערכים שליליים גורמים לזיהוי אוטומטי של כותרות.

החזרות

EmbeddedChartBuilder – הכלי הזה ליצירת שרשורים

`setOption(option, value)`

מגדיר אפשרויות מתקדמות לתרשים הזה. במאמר אפשרויות הגדרה שלChart תוכלו לראות רשימה של האפשרויות הזמינות.

השיטה הזו לא מאמתת שהאפשרות שציינתם חוקית לסוג התרשים הזה, וגם לא כאשר הערך הוא בפורמט או במבנה הנכונים.

בדוגמה הזו מוסבר איך לשנות את הכותרת ולהגדיר מקרא.

builder.setOption('title', 'Earnings projections');
builder.setOption('legend', {position: 'top', textStyle: {color: 'blue', fontSize: 16}});

פרמטרים

שם	תיאור	התיאור
`option`	`String`	שם האפשרות.
`value`	`Object`	הערך של האפשרות.

החזרות

EmbeddedChartBuilder – הכלי הזה – לשרשורים.

`setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)`

הגדרת המיקום תוך שינוי המיקום של התרשים בגיליון. anchorRowPos ו-anchorColPos נוספו לאינדקס אחד.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var 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 – הכלי הזה ליצירת שרשורים

`setTransposeRowsAndColumns(transpose)`

המדיניות הזו קובעת אם השורות והעמודות בתרשים יוצגו בשקפים. אם הערך הוא true, השורות והעמודות מתחלפות. ברירת המחדל היא false.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(range)
    .setTransposeRowsAndColumns(true)
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

פרמטרים

שם	תיאור	התיאור
`transpose`	`Boolean`	אם הערך הוא `true`, השורות והעמודות שמשמשות לבניית התרשים משתנות.

החזרות

EmbeddedChartBuilder – הכלי הזה ליצירת שרשורים