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 שהומר לסוג התוכן שצוין. הזה method מוסיפה את הסיומת המתאימה לשם הקובץ, לדוגמה, "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' צריך להיות תואם גם תקין. במסמך של Google Docs, גם 'text/markdown' תקף.

חזרה

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

חזרה

ChartMergeStrategyMERGE_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 – כלי ליצירת תרשימים מוטמעים