Class EmbeddedChartBuilder

EmbeddedChartBuilder

Builder برای ویرایش EmbeddedChart استفاده می‌کرد. تغییرات ایجاد شده در نمودار تا زمانی که Sheet.updateChart(chart) در نمودار بازسازی‌شده فراخوانی نشود، ذخیره نمی‌شوند.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1: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);

روش ها

روش نوع برگشت شرح مختصر
addRange(range) EmbeddedChartBuilder محدوده ای را به نموداری که سازنده اصلاح می کند اضافه می کند.
asAreaChart() EmbeddedAreaChartBuilder نوع نمودار را روی AreaChart تنظیم می کند و EmbeddedAreaChartBuilder را برمی گرداند.
asBarChart() EmbeddedBarChartBuilder نوع نمودار را بر روی BarChart تنظیم می کند و EmbeddedBarChartBuilder را برمی گرداند.
asColumnChart() EmbeddedColumnChartBuilder نوع نمودار را روی ColumnChart تنظیم می کند و EmbeddedColumnChartBuilder را برمی گرداند.
asComboChart() EmbeddedComboChartBuilder نوع نمودار را روی ComboChart تنظیم می کند و EmbeddedComboChartBuilder را برمی گرداند.
asHistogramChart() EmbeddedHistogramChartBuilder نوع نمودار را روی HistogramChart تنظیم می کند و EmbeddedHistogramChartBuilder را برمی گرداند.
asLineChart() EmbeddedLineChartBuilder نوع نمودار را روی LineChart تنظیم می کند و EmbeddedLineChartBuilder را برمی گرداند.
asPieChart() EmbeddedPieChartBuilder نوع نمودار را روی PieChart تنظیم می کند و EmbeddedPieChartBuilder را برمی گرداند.
asScatterChart() EmbeddedScatterChartBuilder نوع نمودار را روی ScatterChart تنظیم می کند و EmbeddedScatterChartBuilder را برمی گرداند.
asTableChart() EmbeddedTableChartBuilder نوع نمودار را روی TableChart تنظیم می کند و EmbeddedTableChartBuilder را برمی گرداند.
build() EmbeddedChart نمودار را می سازد تا تمام تغییرات ایجاد شده در آن را منعکس کند.
clearRanges() EmbeddedChartBuilder همه محدوده‌ها را از نموداری که این سازنده اصلاح می‌کند حذف می‌کند.
getChartType() ChartType نوع نمودار فعلی را برمی‌گرداند.
getContainer() ContainerInfo نمودار ContainerInfo را برگردانید، که در آن جاهایی که نمودار روی برگه ظاهر می شود، محصور می شود.
getRanges() Range[] یک کپی از فهرست محدوده‌هایی که در حال حاضر داده‌های این نمودار را ارائه می‌دهند، برمی‌گرداند.
removeRange(range) EmbeddedChartBuilder محدوده مشخص شده را از نموداری که سازنده اصلاح می کند حذف می کند.
setChartType(type) EmbeddedChartBuilder نوع نمودار را تغییر می دهد.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder استراتژی را برای استفاده برای سطرها و ستون های مخفی تنظیم می کند.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder استراتژی ادغام را برای استفاده زمانی که بیش از یک محدوده وجود دارد تنظیم می کند.
setNumHeaders(headers) EmbeddedChartBuilder تعداد ردیف‌ها یا ستون‌های محدوده را که باید به عنوان سرصفحه در نظر گرفته شوند را تنظیم می‌کند.
setOption(option, value) EmbeddedChartBuilder گزینه های پیشرفته را برای این نمودار تنظیم می کند.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder موقعیت را تنظیم می کند، جایی که نمودار روی صفحه ظاهر می شود.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder تعیین می‌کند ردیف‌ها و ستون‌های نمودار جابه‌جا شوند یا خیر.

مستندات دقیق

addRange(range)

محدوده ای را به نموداری که سازنده اصلاح می کند اضافه می کند. اگر محدوده را قبلاً به نمودار اضافه کرده باشد، اضافه نمی کند.

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

sheet.insertChart(chart);

پارامترها

نام تایپ کنید توضیحات
range Range محدوده برای اضافه کردن.

بازگشت

EmbeddedChartBuilder - این سازنده، برای زنجیره زدن


asAreaChart()

نوع نمودار را روی AreaChart تنظیم می کند و EmbeddedAreaChartBuilder را برمی گرداند.

بازگشت

EmbeddedAreaChartBuilder - سازنده برای نمودار منطقه


asBarChart()

نوع نمودار را بر روی BarChart تنظیم می کند و EmbeddedBarChartBuilder را برمی گرداند.

بازگشت

EmbeddedBarChartBuilder - سازنده برای نمودار میله ای


asColumnChart()

نوع نمودار را روی ColumnChart تنظیم می کند و EmbeddedColumnChartBuilder را برمی گرداند.

بازگشت

EmbeddedColumnChartBuilder - سازنده برای نمودار ستونی


asComboChart()

نوع نمودار را روی ComboChart تنظیم می کند و EmbeddedComboChartBuilder را برمی گرداند.

بازگشت

EmbeddedComboChartBuilder - سازنده یک نمودار ترکیبی


asHistogramChart()

نوع نمودار را روی HistogramChart تنظیم می کند و EmbeddedHistogramChartBuilder را برمی گرداند.

بازگشت

EmbeddedHistogramChartBuilder - سازنده نمودار هیستوگرام


asLineChart()

نوع نمودار را روی LineChart تنظیم می کند و EmbeddedLineChartBuilder را برمی گرداند.

بازگشت

EmbeddedLineChartBuilder - سازنده برای نمودار خطی


asPieChart()

نوع نمودار را روی PieChart تنظیم می کند و EmbeddedPieChartBuilder را برمی گرداند.

بازگشت

EmbeddedPieChartBuilder - سازنده نمودار دایره ای


asScatterChart()

نوع نمودار را روی ScatterChart تنظیم می کند و EmbeddedScatterChartBuilder را برمی گرداند.

بازگشت

EmbeddedScatterChartBuilder - سازنده برای نمودار پراکندگی


asTableChart()

نوع نمودار را روی TableChart تنظیم می کند و EmbeddedTableChartBuilder را برمی گرداند.

بازگشت

EmbeddedTableChartBuilder - سازنده برای نمودار جدول


build()

نمودار را می سازد تا تمام تغییرات ایجاد شده در آن را منعکس کند.

این روش به طور خودکار نمودار را در بالای صفحه گسترده ترسیم نمی کند. یک نمودار جدید باید از طریق sheet.insertChart(chart) درج شود و نمودار موجود باید از طریق sheet.updateChart(chart) به‌روزرسانی شود.

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)
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

بازگشت

EmbeddedChart - نمودار ایجاد شده، که همچنان باید به صفحه گسترده اضافه شود


clearRanges()

همه محدوده‌ها را از نموداری که این سازنده اصلاح می‌کند حذف می‌کند.

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

// This code updates the chart to use only the new ranges while preserving the existing
// formatting of the chart.
var chart = sheet.getCharts()[0];
var newChart = chart
    .modify()
    .clearRanges()
    .addRange(sheet.getRange("A1:A5"))
    .addRange(sheet.getRange("B1:B5"))
    .build();
sheet.updateChart(newChart);

بازگشت

EmbeddedChartBuilder - این سازنده، برای زنجیره زدن


getChartType()

نوع نمودار فعلی را برمی‌گرداند.

بازگشت

ChartType - نوع نمودار


getContainer()

نمودار ContainerInfo را برگردانید، که در آن جاهایی که نمودار روی برگه ظاهر می شود، محصور می شود.

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

var chartBuilder = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(sheet.getRange("A1:B8"))
    .setPosition(5, 5, 0, 0);

// This method returns the exact same data as Chart#getContainerInfo()
var containerInfo = chartBuilder.getContainer();

// 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 - یک شی حاوی موقعیت ظرف نمودار


getRanges()

یک کپی از فهرست محدوده‌هایی که در حال حاضر داده‌های این نمودار را ارائه می‌دهند، برمی‌گرداند. از addRange(range) و removeRange(range) برای اصلاح این لیست استفاده کنید.

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

var chartBuilder = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(sheet.getRange("A1:B8"))
    .setPosition(5, 5, 0, 0);

var ranges = chartBuilder.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[] - آرایه ای از محدوده ها که به عنوان نموداری که قرار است منبع داده ساخته شود، عمل می کند


removeRange(range)

محدوده مشخص شده را از نموداری که سازنده اصلاح می کند حذف می کند. اگر محدوده در این نمودار نباشد خطایی ایجاد نمی کند.

محدوده حذف شده باید با محدوده اضافه شده از طریق addRange(range) مطابقت داشته باشد. در غیر این صورت تغییری در نمودار ایجاد نمی شود. این روش را نمی توان برای حذف بخشی از مقادیر از یک محدوده استفاده کرد.

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

var firstRange = sheet.getRange("A1:B5");
var secondRange = sheet.getRange("A6:B8");

var chartBuilder = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(firstRange)
    // This range will render in a different color
    .addRange(secondRange)
    .setPosition(5, 5, 0, 0);

// Note that you can use either of these two formats, but the range
// MUST match up with a range that was added via addRange(), or it
// will not be removed, and will not throw an exception
chartBuilder.removeRange(firstRange);
chartBuilder.removeRange(sheet.getRange("A6:B8"));

var chart = chartBuilder.build();

sheet.insertChart(chart);

پارامترها

نام تایپ کنید توضیحات
range Range محدوده ای که باید حذف شود.

بازگشت

EmbeddedChartBuilder - این سازنده، برای زنجیره زدن


setChartType(type)

نوع نمودار را تغییر می دهد. همه انواع نمودارهای جاسازی شده در حال حاضر پشتیبانی نمی شوند. ChartType ببینید.

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)
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

پارامترها

نام تایپ کنید توضیحات
type ChartType نوع تغییر این نمودار

بازگشت

EmbeddedChartBuilder - این سازنده، برای زنجیره زدن


setHiddenDimensionStrategy(strategy)

استراتژی را برای استفاده برای سطرها و ستون های مخفی تنظیم می کند. پیش‌فرض 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();

sheet.insertChart(chart);

پارامترها

نام تایپ کنید توضیحات
strategy ChartHiddenDimensionStrategy استراتژی مورد استفاده برای سطرها و ستون های مخفی.

بازگشت

EmbeddedChartBuilder - این سازنده، برای زنجیره زدن


setMergeStrategy(mergeStrategy)

استراتژی ادغام را برای استفاده زمانی که بیش از یک محدوده وجود دارد تنظیم می کند. اگر 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("C:C10");
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(range)
    .addRange(range2)
    .setMergeStrategy(Charts.ChartMergeStrategy.MERGE_ROWS)
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

پارامترها

نام تایپ کنید توضیحات
mergeStrategy ChartMergeStrategy استراتژی ادغام برای استفاده

بازگشت

EmbeddedChartBuilder - این سازنده، برای زنجیره زدن


setNumHeaders(headers)

تعداد ردیف‌ها یا ستون‌های محدوده را که باید به عنوان سرصفحه در نظر گرفته شوند را تنظیم می‌کند.

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

sheet.insertChart(chart);

پارامترها

نام تایپ کنید توضیحات
headers Integer تعداد سطرها یا ستون هایی که باید به عنوان سرصفحه در نظر گرفته شوند. مقادیر منفی باعث می شود هدرها به صورت خودکار شناسایی شوند.

بازگشت

EmbeddedChartBuilder - این سازنده، برای زنجیره زدن


setOption(option, value)

گزینه های پیشرفته را برای این نمودار تنظیم می کند. برای مشاهده لیستی از گزینه های موجود، گزینه های پیکربندی نمودار را ببینید.

این روش گزینه ای را که مشخص کرده اید برای این نوع نمودار معتبر است و همچنین اگر مقدار از قالب/ساختار صحیح باشد، اعتبار سنجی نمی کند.

این مثال نحوه تغییر عنوان و تنظیم یک افسانه را نشان می دهد.

builder.setOption('title', 'Earnings projections');
builder.setOption('legend', {position: 'top', textStyle: {color: 'blue', fontSize: 16}});

پارامترها

نام تایپ کنید توضیحات
option String نام گزینه.
value Object ارزش گزینه.

بازگشت

EmbeddedChartBuilder - این سازنده، برای زنجیر کردن.


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

موقعیت را تنظیم می کند، جایی که نمودار روی صفحه ظاهر می شود. anchorRowPos و anchorColPos دارای 1 ایندکس هستند.

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)
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

پارامترها

نام تایپ کنید توضیحات
anchorRowPos Integer سمت بالای نمودار در این ردیف لنگر انداخته است.
anchorColPos Integer سمت چپ نمودار در این ستون لنگر انداخته است.
offsetX Integer گوشه سمت راست بالای نمودار با این تعداد پیکسل جبران شده است.
offsetY Integer گوشه سمت چپ پایین نمودار با این تعداد پیکسل جبران شده است.

بازگشت

EmbeddedChartBuilder - این سازنده، برای زنجیره زدن


setTransposeRowsAndColumns(transpose)

تعیین می‌کند ردیف‌ها و ستون‌های نمودار جابه‌جا شوند یا خیر. اگر روی true تنظیم شود، سطرها و ستون ها تغییر می کنند. پیش فرض ها به false .

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)
    .setTransposeRowsAndColumns(true)
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

پارامترها

نام تایپ کنید توضیحات
transpose Boolean اگر true ، سطرها و ستون‌های مورد استفاده برای ساخت نمودار جابه‌جا می‌شوند.

بازگشت

EmbeddedChartBuilder - این سازنده، برای زنجیره زدن