Class EmbeddedChartBuilder

نمودار ساز تعبیه شده

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

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

روش ها

روش نوع برگشت شرح مختصر
add Range(range) Embedded Chart Builder محدوده ای را به نموداری که سازنده اصلاح می کند اضافه می کند.
as Area Chart() Embedded Area Chart Builder نوع نمودار را روی AreaChart تنظیم می کند و یک Embedded Area Chart Builder برمی گرداند.
as Bar Chart() Embedded Bar Chart Builder نوع نمودار را بر روی BarChart تنظیم می کند و یک Embedded Bar Chart Builder برمی گرداند.
as Column Chart() Embedded Column Chart Builder نوع نمودار را روی ColumnChart تنظیم می کند و یک Embedded Column Chart Builder برمی گرداند.
as Combo Chart() Embedded Combo Chart Builder نوع نمودار را روی ComboChart تنظیم می کند و یک Embedded Combo Chart Builder برمی گرداند.
as Histogram Chart() Embedded Histogram Chart Builder نوع نمودار را روی HistogramChart تنظیم می کند و یک Embedded Histogram Chart Builder را برمی گرداند.
as Line Chart() Embedded Line Chart Builder نوع نمودار را روی LineChart تنظیم می کند و یک Embedded Line Chart Builder برمی گرداند.
as Pie Chart() Embedded Pie Chart Builder نوع نمودار را روی PieChart تنظیم می کند و یک Embedded Pie Chart Builder برمی گرداند.
as Scatter Chart() Embedded Scatter Chart Builder نوع نمودار را روی ScatterChart تنظیم می کند و یک Embedded Scatter Chart Builder برمی گرداند.
as Table Chart() Embedded Table Chart Builder نوع نمودار را روی TableChart تنظیم می‌کند و یک Embedded Table Chart Builder برمی‌گرداند.
build() Embedded Chart نمودار را می سازد تا تمام تغییرات ایجاد شده در آن را منعکس کند.
clear Ranges() Embedded Chart Builder همه محدوده‌ها را از نموداری که این سازنده اصلاح می‌کند حذف می‌کند.
get Chart Type() Chart Type نوع نمودار فعلی را برمی‌گرداند.
get Container() Container Info نمودار Container Info را برگردانید، که در آن جایی که نمودار روی برگه ظاهر می‌شود، کپسوله می‌شود.
get Ranges() Range[] یک کپی از فهرست محدوده‌هایی که در حال حاضر داده‌های این نمودار را ارائه می‌دهند، برمی‌گرداند.
remove Range(range) Embedded Chart Builder محدوده مشخص شده را از نموداری که سازنده اصلاح می کند حذف می کند.
set Chart Type(type) Embedded Chart Builder نوع نمودار را تغییر می دهد.
set Hidden Dimension Strategy(strategy) Embedded Chart Builder استراتژی را برای استفاده برای سطرها و ستون های مخفی تنظیم می کند.
set Merge Strategy(mergeStrategy) Embedded Chart Builder استراتژی ادغام را برای استفاده زمانی که بیش از یک محدوده وجود دارد تنظیم می کند.
set Num Headers(headers) Embedded Chart Builder تعداد ردیف‌ها یا ستون‌های محدوده را که باید به عنوان سرصفحه در نظر گرفته شوند را تنظیم می‌کند.
set Option(option, value) Embedded Chart Builder گزینه های پیشرفته را برای این نمودار تنظیم می کند.
set Position(anchorRowPos, anchorColPos, offsetX, offsetY) Embedded Chart Builder موقعیت را تنظیم می کند، جایی که نمودار روی صفحه ظاهر می شود.
set Transpose Rows And Columns(transpose) Embedded Chart Builder تعیین می‌کند ردیف‌ها و ستون‌های نمودار جابه‌جا شوند یا خیر.

مستندات دقیق

add Range(range)

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

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

sheet.insertChart(chart);

پارامترها

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

بازگشت

Embedded Chart Builder - این سازنده، برای زنجیر کردن


as Area Chart()

نوع نمودار را روی AreaChart تنظیم می کند و یک Embedded Area Chart Builder برمی گرداند.

بازگشت

Embedded Area Chart Builder - سازنده نمودار مساحتی


as Bar Chart()

نوع نمودار را بر روی BarChart تنظیم می کند و یک Embedded Bar Chart Builder برمی گرداند.

بازگشت

Embedded Bar Chart Builder - سازنده نمودار میله ای


as Column Chart()

نوع نمودار را روی ColumnChart تنظیم می کند و یک Embedded Column Chart Builder برمی گرداند.

بازگشت

Embedded Column Chart Builder - سازنده نمودار ستونی


as Combo Chart()

نوع نمودار را روی ComboChart تنظیم می کند و یک Embedded Combo Chart Builder برمی گرداند.

بازگشت

Embedded Combo Chart Builder - سازنده نمودار ترکیبی


as Histogram Chart()

نوع نمودار را روی HistogramChart تنظیم می کند و یک Embedded Histogram Chart Builder را برمی گرداند.

بازگشت

Embedded Histogram Chart Builder - سازنده نمودار هیستوگرام


as Line Chart()

نوع نمودار را روی LineChart تنظیم می کند و یک Embedded Line Chart Builder برمی گرداند.

بازگشت

Embedded Line Chart Builder - سازنده نمودار خطی


as Pie Chart()

نوع نمودار را روی PieChart تنظیم می کند و یک Embedded Pie Chart Builder برمی گرداند.

بازگشت

Embedded Pie Chart Builder - سازنده نمودار دایره ای


as Scatter Chart()

نوع نمودار را روی ScatterChart تنظیم می کند و یک Embedded Scatter Chart Builder برمی گرداند.

بازگشت

Embedded Scatter Chart Builder - سازنده نمودار پراکندگی


as Table Chart()

نوع نمودار را روی TableChart تنظیم می‌کند و یک Embedded Table Chart Builder برمی‌گرداند.

بازگشت

Embedded Table Chart Builder - سازنده نمودار جدول


build()

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

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

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

sheet.insertChart(chart);

بازگشت

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


clear Ranges()

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

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

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

بازگشت

Embedded Chart Builder - این سازنده، برای زنجیر کردن


get Chart Type()

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

بازگشت

Chart Type - نوع نمودار


get Container()

نمودار Container Info را برگردانید، که در آن جایی که نمودار روی صفحه ظاهر می‌شود، کپسوله می‌شود.

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

const 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()
const containerInfo = chartBuilder.getContainer();

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

بازگشت

Container Info - یک شی حاوی موقعیت ظرف نمودار


get Ranges()

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

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

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

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


remove Range(range)

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

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

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

const firstRange = sheet.getRange('A1:B5');
const secondRange = sheet.getRange('A6:B8');

const 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'));

const chart = chartBuilder.build();

sheet.insertChart(chart);

پارامترها

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

بازگشت

Embedded Chart Builder - این سازنده، برای زنجیر کردن


set Chart Type(type)

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

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

sheet.insertChart(chart);

پارامترها

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

بازگشت

Embedded Chart Builder - این سازنده، برای زنجیر کردن


set Hidden Dimension Strategy(strategy)

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

sheet.insertChart(chart);

پارامترها

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

بازگشت

Embedded Chart Builder - این سازنده، برای زنجیر کردن


set Merge Strategy(mergeStrategy)

استراتژی ادغام را برای استفاده زمانی که بیش از یک محدوده وجود دارد تنظیم می کند. اگر 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('C:C10');
const 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);

پارامترها

نام تایپ کنید توضیحات
merge Strategy Chart Merge Strategy استراتژی ادغام برای استفاده

بازگشت

Embedded Chart Builder - این سازنده، برای زنجیر کردن


set Num Headers(headers)

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

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

sheet.insertChart(chart);

پارامترها

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

بازگشت

Embedded Chart Builder - این سازنده، برای زنجیر کردن


set Option(option, value)

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

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

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

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const sheet = spreadsheet.getSheets()[0];
const chart = sheet.newChart()
 .setOption('title', 'Earnings projections')
 .setOption('legend', {
   position: 'top',
   textStyle: { color: 'blue', fontSize: 16 },
 }).build();

پارامترها

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

بازگشت

Embedded Chart Builder - این سازنده، برای زنجیره زدن.


set Position(anchorRowPos, anchorColPos, offsetX, offsetY)

موقعیت را تنظیم می کند، جایی که نمودار روی صفحه ظاهر می شود. anchor Row Pos و anchor Col Pos دارای 1 ایندکس هستند.

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

sheet.insertChart(chart);

پارامترها

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

بازگشت

Embedded Chart Builder - این سازنده، برای زنجیر کردن


set Transpose Rows And Columns(transpose)

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

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

sheet.insertChart(chart);

پارامترها

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

بازگشت

Embedded Chart Builder - این سازنده، برای زنجیر کردن