Class EmbeddedPieChartBuilder

EmbeddedPieChartBuilder

Builder לתרשימי עוגה. לפרטים נוספים, ראו Gviz תיעוד.

שיטות

שיטהסוג הערך המוחזרתיאור קצר
addRange(range)EmbeddedChartBuilderהפונקציה מוסיפה טווח לתרשים שה-builder משנה.
asAreaChart()EmbeddedAreaChartBuilderהפונקציה מגדירה את סוג התרשים ל-RegionChart ומחזירה את הערך 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 משנה.
reverseCategories()EmbeddedPieChartBuilderהופך את השרטוט של הסדרות בציר הדומיין.
set3D()EmbeddedPieChartBuilderהגדרת התרשים לתלת-ממדי.
setBackgroundColor(cssValue)EmbeddedPieChartBuilderהגדרת צבע הרקע של התרשים.
setChartType(type)EmbeddedChartBuilderשינוי סוג התרשים.
setColors(cssValues)EmbeddedPieChartBuilderהגדרת הצבעים של הקווים בתרשים.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderמגדיר את האסטרטגיה שתשמש לשורות ולעמודות מוסתרות.
setLegendPosition(position)EmbeddedPieChartBuilderמגדיר את המיקום של המקרא ביחס לתרשים.
setLegendTextStyle(textStyle)EmbeddedPieChartBuilderמגדיר את סגנון הטקסט של מקרא התרשים.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderהגדרה של אסטרטגיית המיזוג לשימוש במקרים שבהם קיים יותר מטווח אחד.
setNumHeaders(headers)EmbeddedChartBuilderמגדירה את מספר השורות או העמודות בטווח שיש להתייחס אליהן ככותרות.
setOption(option, value)EmbeddedChartBuilderמגדיר אפשרויות מתקדמות לתרשים הזה.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderמגדיר את המיקום בגיליון ומשנה את המיקום שבו מופיע התרשים.
setTitle(chartTitle)EmbeddedPieChartBuilderמגדיר את שם התרשים.
setTitleTextStyle(textStyle)EmbeddedPieChartBuilderמגדיר את סגנון הטקסט של כותרת התרשים.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderהמדיניות קובעת אם השורות והעמודות בתרשים יעברו טרנספורמציה.

מסמכי תיעוד מפורטים

addRange(range)

הפונקציה מוסיפה טווח לתרשים שה-builder משנה. לא מוסיפה את הטווח אם הוא כבר נוספו לתרשים.

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

פרמטרים

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

חזרה

EmbeddedChartBuilder – ה-builder הזה, ליצירת שרשורים


asAreaChart()

הפונקציה מגדירה את סוג התרשים ל-RegionChart ומחזירה את הערך 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()

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

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 – ה-builder הזה, ליצירת שרשורים


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)

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

הטווח שהוסר חייב להתאים לטווח שנוסף דרך 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);

פרמטרים

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

חזרה

EmbeddedChartBuilder – ה-builder הזה, ליצירת שרשורים


reverseCategories()

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

// Creates a pie chart builder and sets drawing of the slices in a counter-clockwise manner.
var builder = Charts.newPieChart();
builder.reverseCategories();

חזרה

EmbeddedPieChartBuilder – ה-builder הזה, שימושי ליצירת שרשורים.


set3D()

הגדרת התרשים לתלת-ממדי.

חזרה

EmbeddedPieChartBuilder – ה-builder הזה, שימושי ליצירת שרשורים.


setBackgroundColor(cssValue)

הגדרת צבע הרקע של התרשים.

// Creates a line chart builder and sets the background color to gray
var builder = Charts.newLineChart();
builder.setBackgroundColor("gray");

פרמטרים

שםסוגתיאור
cssValueStringערך ה-CSS של הצבע (למשל "blue" או "#00f").

חזרה

EmbeddedPieChartBuilder – ה-builder הזה, שימושי ליצירת שרשורים.


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

פרמטרים

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

חזרה

EmbeddedChartBuilder – ה-builder הזה, ליצירת שרשורים


setColors(cssValues)

הגדרת הצבעים של הקווים בתרשים.

// Creates a line chart builder and sets the first two lines to be drawn in green and red,
// respectively.
var builder = Charts.newLineChart();
builder.setColors(["green", "red"]);

פרמטרים

שםסוגתיאור
cssValuesString[]מערך של ערכי CSS של צבעים, כמו ["red", "#acf"]. רכיב ה-n במערך מייצג את הצבע של קו ה-n בתרשים.

חזרה

EmbeddedPieChartBuilder – ה-builder הזה, שימושי ליצירת שרשורים.


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

פרמטרים

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

חזרה

EmbeddedChartBuilder – ה-builder הזה, ליצירת שרשורים


setLegendPosition(position)

מגדיר את המיקום של המקרא ביחס לתרשים. כברירת מחדל, אין מקרא.

// Creates a line chart builder and sets the legend position to right.
var builder = Charts.newLineChart();
builder.setLegendPosition(Charts.Position.RIGHT);

פרמטרים

שםסוגתיאור
positionPositionהמיקום של המקרא.

חזרה

EmbeddedPieChartBuilder – ה-builder הזה, שימושי ליצירת שרשורים.


setLegendTextStyle(textStyle)

מגדיר את סגנון הטקסט של מקרא התרשים.

// Creates a line chart builder and sets it up for a  blue, 26-point legend.
var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
var style = textStyleBuilder.build();
var builder = Charts.newLineChart();
builder.setLegendTextStyle(style);

פרמטרים

שםסוגתיאור
textStyleTextStyleסגנון הטקסט לשימוש במקרא של התרשים.

חזרה

EmbeddedPieChartBuilder – ה-builder הזה, שימושי ליצירת שרשורים.


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

פרמטרים

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

חזרה

EmbeddedChartBuilder – ה-builder הזה, ליצירת שרשורים


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

פרמטרים

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

חזרה

EmbeddedChartBuilder – ה-builder הזה, ליצירת שרשורים


setOption(option, value)

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

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

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

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

פרמטרים

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

חזרה

EmbeddedChartBuilder – ה-builder הזה, לשרשורים.


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

פרמטרים

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

חזרה

EmbeddedChartBuilder – ה-builder הזה, ליצירת שרשורים


setTitle(chartTitle)

מגדיר את שם התרשים. הכותרת מוצגת במרכז מעל התרשים.

// Creates a line chart builder and title to 'My Line Chart'.
var builder = Charts.newLineChart();
builder.setTitle('My Line Chart')

פרמטרים

שםסוגתיאור
chartTitleStringכותרת התרשים.

חזרה

EmbeddedPieChartBuilder – ה-builder הזה, שימושי ליצירת שרשורים.


setTitleTextStyle(textStyle)

מגדיר את סגנון הטקסט של כותרת התרשים.

// Creates a line chart builder and sets it up for a  blue, 26-point title.
var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
var style = textStyleBuilder.build();
var builder = Charts.newLineChart();
builder.setTitleTextStyle(style);

פרמטרים

שםסוגתיאור
textStyleTextStyleסגנון הטקסט שיופיע בכותרת התרשים. אפשר ליצור אובייקט TextStyleBuilder באמצעות קריאה ל-Charts.newTextStyle().

חזרה

EmbeddedPieChartBuilder – ה-builder הזה, שימושי ליצירת שרשורים.


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

פרמטרים

שםסוגתיאור
transposeBooleanאם הערך שלו הוא true, השורות והעמודות ששימשו לבניית התרשים הועברו.

חזרה

EmbeddedChartBuilder – ה-builder הזה, ליצירת שרשורים