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 داده های داخل این شی را به عنوان یک حباب تبدیل به نوع محتوای مشخص شده برگردانید.
getBlob() 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)

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

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

پارامترها

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

بازگشت

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


getBlob()

داده های داخل این شی را به صورت حباب برگردانید.

بازگشت

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