Class DataViewDefinitionBuilder

データビュー定義ビルダー

DataViewDefinition オブジェクトのビルダー。

ビルダーの使用例を次に示します。データは Google スプレッドシートからインポートされます。

function doGet() {
  // This example creates two table charts side by side. One uses a data view
  // definition to restrict the number of displayed columns.

  // Get sample data from a spreadsheet.
  const dataSourceUrl = 'https://docs.google.com/spreadsheet/tq?range=A1%3AF' +
      '&key=0Aq4s9w_HxMs7dHpfX05JdmVSb1FpT21sbXd4NVE3UEE&gid=4&headers=-1';

  // Create a chart to display all of the data.
  const originalChart = Charts.newTableChart()
                            .setDimensions(600, 500)
                            .setDataSourceUrl(dataSourceUrl)
                            .build();

  // Create another chart to display a subset of the data (only columns 1 and
  // 4).
  const dataViewDefinition = Charts.newDataViewDefinition().setColumns([0, 3]);
  const limitedChart = Charts.newTableChart()
                           .setDimensions(200, 500)
                           .setDataSourceUrl(dataSourceUrl)
                           .setDataViewDefinition(dataViewDefinition)
                           .build();

  const htmlOutput = HtmlService.createHtmlOutput();
  const originalChartData = Utilities.base64Encode(
      originalChart.getAs('image/png').getBytes(),
  );
  const originalChartUrl =
      `data:image/png;base64,${encodeURI(originalChartData)}`;
  const limitedChartData = Utilities.base64Encode(
      limitedChart.getAs('image/png').getBytes(),
  );
  const limitedChartUrl =
      `data:image/png;base64,${encodeURI(limitedChartData)}`;
  htmlOutput.append('<table><tr><td>');
  htmlOutput.append(`<img border="1" src="${originalChartUrl}">`);
  htmlOutput.append('</td><td>');
  htmlOutput.append(`<img border="1" src="${limitedChartUrl}">`);
  htmlOutput.append('</td></tr></table>');
  return htmlOutput;
}

メソッド

メソッド戻り値の型概要
build()DataViewDefinitionこのビルダーを使用して作成されたデータビュー定義オブジェクトを構築して返します。
setColumns(columns)DataViewDefinitionBuilderデータビューに含める列のインデックスを設定し、ロール列情報を指定します。

詳細なドキュメント

build()

このビルダーを使用して作成されたデータビュー定義オブジェクトを構築して返します。

戻る

DataViewDefinition - このビルダーを使用して作成されたデータビュー定義オブジェクト。

setColumns(columns)

データビューに含める列のインデックスを設定し、ロール列情報を指定します。この列番号のサブセットは、データビューが派生元のデータソースの列を参照します。

列のロールには、その列のデータの目的が記述されます。たとえば、列にはツールチップ テキスト、データポイントのアノテーション、不確実性インジケータを表すデータが格納されます。詳細については、Google グラフのドキュメントのデータテーブルのロールをご覧ください。

A1 ～ C3 に次のデータが入力されているスプレッドシートがあるとします。 

'abc', 20, 'blue';
'def', 30, 'red';
'ghi', 40, 'orange';
 次のコードは、各棒が異なる色の棒グラフを作成します。色は、スタイルの「ロール列」で割り当てられます。
const COLUMN_SPEC = [
  0,  // categories
  1,  // counts
  {sourceColumn: 2, role: 'style'},
];

function roleColumnChart() {
  const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
  const sheet = spreadsheet.getActiveSheet();
  const viewSpec =
      Charts.newDataViewDefinition().setColumns(COLUMN_SPEC).build();
  const chartBuilder = sheet.newChart()
                           .setChartType(Charts.ChartType.BAR)
                           .setDataViewDefinition(viewSpec)
                           .setOption('useFirstColumnAsDomain', true)
                           .setPosition(5, 1, 0, 0)
                           .setOption('hAxis', {title: 'Counts'})
                           .setOption('vAxis', {title: 'Categories'})
                           .addRange(sheet.getRange('A1:C3'));
  sheet.insertChart(chartBuilder.build());
}

パラメータ

名前型説明
columnsObject[]データビューに含める列インデックスまたは列の説明（オブジェクト）の配列。列の説明は、列の役割を定義します。データテーブルとデータビュー列の列挙は 0 から始まります。

戻る

DataViewDefinitionBuilder - このビルダーはチェーンに役立ちます。