Class EmbeddedChart

תרשיםמוטמע

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

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

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

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

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

Methods

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

תיעוד מפורט

asDataSourceChart()

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

חזרה

‫DataSourceChart|null – תרשים מקור הנתונים.

getAs(contentType)

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

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

פרמטרים

שםסוגתיאור
contentTypeStringסוג ה-MIME שאליו רוצים להמיר. ברוב ה-BLOB, ‏ '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|null — מזהה תרשים קבוע.

getContainerInfo()

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

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

const containerInfo = chart.getContainerInfo();

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

getHiddenDimensionStrategy()

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

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

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

const range = sheet.getRange('A1:B10');
const range2 = sheet.getRange('C1:C10');
const 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()

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

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

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

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

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

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

getTransposeRowsAndColumns()

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

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

const range = sheet.getRange('A1:B5');
const 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) כדי לשמור את השינויים. 

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

חזרה

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