Class EmbeddedChart

EmbeddedChart

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

בדוגמה הבאה מוסבר איך לשנות תרשים קיים:

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

בדוגמה הבאה מוסבר איך ליצור תרשים חדש:

function newChart(range, sheet) {
  var sheet = SpreadsheetApp.getActiveSheet();
  var chartBuilder = sheet.newChart();
  chartBuilder.addRange(range)
      .setChartType(Charts.ChartType.LINE)
      .setOption('title', 'My Line Chart!');
  sheet.insertChart(chartBuilder.build());
}

שיטות

שיטהסוג הערך שמוחזרתיאור קצר
asDataSourceChart()DataSourceChartמעביר למופע של תרשים מקור נתונים אם התרשים הוא תרשים של מקור נתונים, או null אם לא.
getAs(contentType)Blobהחזרת הנתונים שבתוך האובייקט הזה כ-blob שהומר לסוג התוכן שצוין.
getBlob()Blobהחזרת הנתונים שבתוך האובייקט הזה כ-blob.
getChartId()Integerהפונקציה מחזירה מזהה קבוע לתרשים שייחודי בכל הגיליון האלקטרוני שמכיל את התרשים, או null אם התרשים לא נמצא בגיליון אלקטרוני.
getContainerInfo()ContainerInfoמחזירה מידע על מיקום התרשים בתוך גיליון.
getHiddenDimensionStrategy()ChartHiddenDimensionStrategyמחזירה את האסטרטגיה שתשמש לטיפול בשורות ועמודות מוסתרות.
getMergeStrategy()ChartMergeStrategyמחזירה את אסטרטגיית המיזוג שנעשה בה שימוש כאשר קיים יותר מטווח אחד.
getNumHeaders()Integerמחזירה את מספר השורות או העמודות הטווח שיטופל ככותרות.
getOptions()ChartOptionsמחזירה את האפשרויות לתרשים זה, כגון גובה, צבעים וצירים.
getRanges()Range[]מחזירה את הטווחים המשמשים את התרשים כמקור נתונים.
getTransposeRowsAndColumns()Booleanאם הערך הוא true, השורות והעמודות שמשמשות לאכלוס התרשים מתחלפות.
modify()EmbeddedChartBuilderמחזירה EmbeddedChartBuilder שניתן להשתמש בו כדי לשנות את התרשים.

תיעוד מפורט

asDataSourceChart()

מעביר למופע של תרשים מקור נתונים אם התרשים הוא תרשים של מקור נתונים, או null אם לא.

החזרות

DataSourceChart – התרשים של מקור הנתונים.


getAs(contentType)

החזרת הנתונים שבתוך האובייקט הזה כ-blob שהומר לסוג התוכן שצוין. השיטה הזו מוסיפה את הסיומת המתאימה לשם הקובץ, לדוגמה, 'myfile.pdf'. עם זאת, ההנחה היא שהחלק שמופיע בשם הקובץ אחרי הנקודה האחרונה (אם יש כזה) הוא תוסף קיים שצריך להחליף. בעקבות זאת, הערך "ShoppingList.12.25.2014" הופך ל-"ShoppingList.12.25.pdf".

במאמר מכסות לשירותי Google תוכלו לראות את המכסות היומיות להמרות. באופן זמני, דומיינים חדשים ב-Google Workspace עשויים להיות כפופים למכסות מחמירות יותר.

פרמטרים

שםתיאורהתיאור
contentTypeStringסוג ה-MIME שאליו יש להמיר. ברוב ה-blobs, 'application/pdf' היא האפשרות החוקית היחידה. עבור תמונות בפורמט BMP, GIF, JPEG או PNG, ניתן גם להשתמש בכל אחד מהערכים 'image/bmp', 'image/gif', 'image/jpeg' או 'image/png'.

החזרות

Blob – הנתונים כ-blob.


getBlob()

החזרת הנתונים שבתוך האובייקט הזה כ-blob.

החזרות

Blob – הנתונים כ-blob.


getChartId()

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

החזרות

Integer - מזהה תרשים יציב.


getContainerInfo()

מחזירה מידע על מיקום התרשים בתוך גיליון.

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

var containerInfo = chart.getContainerInfo();

// 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 – אובייקט שמכיל את המיקום של מאגר התגים בתרשים


getHiddenDimensionStrategy()

מחזירה את האסטרטגיה שתשמש לטיפול בשורות ועמודות מוסתרות. ברירת המחדל היא 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()

// Logs the strategy to use for hidden rows and columns which is
// Charts.ChartHiddenDimensionStrategy.IGNORE_COLUMNS in this case.
Logger.log(chart.getHiddenDimensionStrategy());

החזרות

ChartHiddenDimensionStrategy – השיטה שתשמש להסתרת שורות ועמודות.


getMergeStrategy()

מחזירה את אסטרטגיית המיזוג שנעשה בה שימוש כאשר קיים יותר מטווח אחד. במקרה של 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("C1:C10");
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(range)
    .addRange(range2)
    .setMergeStrategy(Charts.ChartMergeStrategy.MERGE_ROWS)
    .setPosition(5, 5, 0, 0)
    .build()

// Logs whether rows of multiple ranges are merged, which is MERGE_ROWS in this case.
Logger.log(chart.getMergeStrategy());

החזרות

ChartMergeStrategy - MERGE_ROWS אם שורות ממוזגות בין טווחים מרובים; MERGE_COLUMNS אם העמודות ממוזגות בין מספר טווחים


getNumHeaders()

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

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

// Logs the number of rows or columns to use as headers, which is 1 in this case.
Logger.log(chart.getHeaders());

החזרות

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


getOptions()

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

האפשרויות שהוחזרו לא ניתנות לשינוי.

החזרות

ChartOptions – האפשרויות לתרשים הזה, כמו גובה, צבעים וצירים.


getRanges()

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

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

var ranges = chart.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[] – מערך של טווחים שמשמשים כמקור הנתונים של התרשים


getTransposeRowsAndColumns()

אם הערך הוא true, השורות והעמודות שמשמשות לאכלוס התרשים מתחלפות. ברירת המחדל היא false.

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

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

// Logs whether rows and columns should be transposed, which is true in this case.
Logger.log(chart.getTransposeRowsAndColumns());

החזרות

Boolean - true אם השורות והעמודות שמשמשות לבניית התרשים הן מדורגות.


modify()

מחזירה EmbeddedChartBuilder שניתן להשתמש בו כדי לשנות את התרשים. צריך להפעיל את sheet.updateChart(chart) כדי לשמור את השינויים.

var sheet = SpreadsheetApp.getActiveSheet();
var chart = sheet.getCharts()[0];
chart = chart.modify()
    .setOption('width', 800)
    .setOption('height', 640)
    .setPosition(5, 5, 0, 0)
    .build();
sheet.updateChart(chart);

החזרות

EmbeddedChartBuilder – כלי ליצירת תרשימים מוטמעים