Class EmbeddedChart

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

روش‌ها

روش نوع بازگشتی شرح مختصر
as Data Source Chart() Data Source Chart |null اگر نمودار، نمودار منبع داده باشد، آن را به یک نمونه نمودار منبع داده تبدیل می‌کند، و در غیر این صورت، null .
get As(contentType) Blob داده‌های درون این شیء را به صورت یک blob تبدیل‌شده به نوع محتوای مشخص‌شده، برمی‌گرداند.
get Blob() Blob داده‌های درون این شیء را به صورت یک blob برمی‌گرداند.
get Chart Id() Integer|null یک شناسه پایدار برای نمودار برمی‌گرداند که در کل صفحه‌گسترده حاوی نمودار منحصر به فرد است و اگر نمودار در یک صفحه‌گسترده نباشد، null .
get Container Info() Container Info اطلاعات مربوط به محل قرارگیری نمودار در یک برگه را برمی‌گرداند.
get Hidden Dimension Strategy() Chart Hidden Dimension Strategy استراتژی مورد استفاده برای مدیریت سطرها و ستون‌های پنهان را برمی‌گرداند.
get Merge Strategy() Chart Merge Strategy استراتژی ادغام مورد استفاده در زمانی که بیش از یک محدوده وجود دارد را برمی‌گرداند.
get Num Headers() Integer تعداد ردیف‌ها یا ستون‌های محدوده‌ای که به عنوان سرصفحه در نظر گرفته می‌شوند را برمی‌گرداند.
get Options() Chart Options گزینه‌های این نمودار، مانند ارتفاع، رنگ‌ها و محورها را برمی‌گرداند.
get Ranges() Range[] محدوده‌هایی را که این نمودار به عنوان منبع داده استفاده می‌کند، برمی‌گرداند.
get Transpose Rows And Columns() Boolean اگر true ، جای سطرها و ستون‌های مورد استفاده برای پر کردن نمودار عوض می‌شود.
modify() Embedded Chart Builder یک Embedded Chart Builder برمی‌گرداند که می‌تواند برای تغییر این نمودار استفاده شود.

مستندات دقیق

asDataSourceChart()

اگر نمودار، نمودار منبع داده باشد، آن را به یک نمونه نمودار منبع داده تبدیل می‌کند، و در غیر این صورت، null .

بازگشت

DataSourceChart |null — نمودار منبع داده.

getAs(contentType)

داده‌های درون این شیء را به صورت یک blob تبدیل‌شده به نوع محتوای مشخص‌شده برمی‌گرداند. این متد پسوند مناسب را به نام فایل اضافه می‌کند - برای مثال، "myfile.pdf". با این حال، فرض می‌کند که بخشی از نام فایل که پس از آخرین نقطه (در صورت وجود) می‌آید، یک پسوند موجود است که باید جایگزین شود. در نتیجه، "ShoppingList.12.25.2014" به "ShoppingList.12.25.pdf" تبدیل می‌شود.

برای مشاهده سهمیه‌های روزانه برای تبدیل‌ها، به سهمیه‌های سرویس‌های گوگل مراجعه کنید. دامنه‌های جدید Google Workspace ممکن است موقتاً مشمول سهمیه‌های سختگیرانه‌تری باشند.

پارامترها

نام نوع توضیحات
content Type String نوع MIME برای تبدیل. برای اکثر blobها، 'application/pdf' تنها گزینه معتبر است. برای تصاویر با فرمت BMP، GIF، JPEG یا PNG، هر یک از 'image/bmp' ، 'image/gif' ، 'image/jpeg' یا 'image/png' نیز معتبر هستند. برای یک سند Google Docs، 'text/markdown' نیز معتبر است.

بازگشت

Blob - داده‌ها به عنوان یک حباب.

getBlob()

داده‌های درون این شیء را به صورت یک 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 — The number of rows or columns treated as headers. Negative values indicate the headers are auto-detected.

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 — سازنده‌ای برای ایجاد نمودارهای تعبیه‌شده.