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 במקרה אחר.
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'. במסמך ב-Google Docs, הערך 'text/markdown' תקף גם כן.

חזרה

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


getBlob()

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

חזרה

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


getChartId()

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

חזרה

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


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

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

חזרה

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

חזרה

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


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