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عرض البيانات داخل هذا الكائن على هيئة كائن ثنائي كبير (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 التي تم إنشاؤها حديثًا لحصص أكثر صرامة مؤقتًا.

المَعلمات

الاسمTypeالوصف
contentTypeStringنوع MIME المطلوب التحويل إليه. بالنسبة إلى معظم الكائنات الثنائية الكبيرة، يكون 'application/pdf' هو الخيار الصالح الوحيد. بالنسبة إلى الصور بتنسيق BMP أو GIF أو JPEG أو PNG، يكون أي من 'image/bmp' أو 'image/gif' أو 'image/jpeg' أو 'image/png' صالحًا أيضًا.

استرجاع الكرة

Blob — البيانات في صورة كائن ثنائي كبير (blob).

getBlob()

عرض البيانات داخل هذا الكائن على هيئة كائن ثنائي كبير (blob).

استرجاع الكرة

Blob — البيانات في صورة كائن ثنائي كبير (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 - أداة إنشاء لإنشاء الرسوم البيانية المضمّنة