このページは Cloud Translation API によって翻訳されました。

Class EmbeddedTableChartBuilder

表グラフのビルダー。詳細については、Gviz のドキュメントをご覧ください。

メソッド

メソッド	戻り値の型	概要
`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`	このビルダーが変更するグラフからすべての範囲を削除します。
`enablePaging(enablePaging)`	`EmbeddedTableChartBuilder`	データのページングを有効にするかどうかを設定します。
`enablePaging(pageSize)`	`EmbeddedTableChartBuilder`	ページングを有効にして、各ページの行数を設定します。
`enablePaging(pageSize, startPage)`	`EmbeddedTableChartBuilder`	ページ設定を有効にし、各ページの行数と表示する最初のテーブルページを設定します（ページ番号はゼロベースです）。
`enableRtlTable(rtlEnabled)`	`EmbeddedTableChartBuilder`	表の列の順序を逆にして、列 0 が右端の列、最後の列が左端の列になるようにすることで、右から左の言語（アラビア語やヘブライ語など）の基本的なサポートを追加しました。
`enableSorting(enableSorting)`	`EmbeddedTableChartBuilder`	ユーザーが列見出しをクリックしたときに列を並べ替えるかどうかを設定します。
`getChartType()`	`ChartType`	現在のグラフタイプを返します。
`getContainer()`	`ContainerInfo`	グラフ `ContainerInfo` を返します。これは、グラフがシート上に表示される場所をカプセル化します。
`getRanges()`	`Range[]`	現在このグラフにデータを提供している範囲のリストのコピーを返します。
`removeRange(range)`	`EmbeddedChartBuilder`	このビルダーが変更するグラフから指定した範囲を削除します。
`setChartType(type)`	`EmbeddedChartBuilder`	グラフの種類を変更します。
`setFirstRowNumber(number)`	`EmbeddedTableChartBuilder`	データ表の最初の行の行番号を設定します。
`setHiddenDimensionStrategy(strategy)`	`EmbeddedChartBuilder`	非表示の行と列に使用する戦略を設定します。
`setInitialSortingAscending(column)`	`EmbeddedTableChartBuilder`	テーブルの最初の並べ替え（昇順）に使用する列のインデックスを設定します。
`setInitialSortingDescending(column)`	`EmbeddedTableChartBuilder`	テーブルの最初の並べ替え（降順）に使用する列のインデックスを設定します。
`setMergeStrategy(mergeStrategy)`	`EmbeddedChartBuilder`	複数の範囲が存在する場合に使用する統合戦略を設定します。
`setNumHeaders(headers)`	`EmbeddedChartBuilder`	ヘッダーとして扱う範囲の行または列の数を設定します。
`setOption(option, value)`	`EmbeddedChartBuilder`	このグラフの詳細オプションを設定します。
`setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)`	`EmbeddedChartBuilder`	位置を設定して、シート上のグラフの表示位置を変更します。
`setTransposeRowsAndColumns(transpose)`	`EmbeddedChartBuilder`	グラフの行と列を入れ替えるかどうかを設定します。
`showRowNumberColumn(showRowNumber)`	`EmbeddedTableChartBuilder`	行番号をテーブルの最初の列として表示するかどうかを設定します。
`useAlternatingRowStyle(alternate)`	`EmbeddedTableChartBuilder`	表グラフの奇数行と偶数行に交互の色スタイルを割り当てるかどうかを設定します。

詳細なドキュメント

`addRange(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`	追加する範囲。

戻る

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) を介して更新する必要があります。

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

戻る

EmbeddedChart - 作成されたグラフ（スプレッドシートに追加する必要があります）

`clearRanges()`

このビルダーが変更するグラフからすべての範囲を削除します。

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

戻る

EmbeddedChartBuilder - チェーン用のこのビルダー

`enablePaging(enablePaging)`

データのページングを有効にするかどうかを設定します。

デフォルトの動作では、ページングは無効になっています。ページングが有効な場合、デフォルトのページサイズは 10 です。

パラメータ

名前	型	説明
`enablePaging`	`Boolean`	ページングを有効にする場合は `true`、それ以外の場合は `false`。

戻る

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

`enablePaging(pageSize)`

ページングを有効にして、各ページの行数を設定します。

デフォルトのページサイズは 10 です。

// Creates a table chart builder and enables paging with page size of 5.
const builder = Charts.newTableChart();
builder.enablePaging(5);

パラメータ

名前	型	説明
`pageSize`	`Integer`	テーブルの各ページの行数。

戻る

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

`enablePaging(pageSize, startPage)`

ページ設定を有効にし、各ページの行数と表示する最初のテーブルページを設定します（ページ番号はゼロベースです）。

デフォルトのページサイズは 10、デフォルトの開始ページは 0 です。

// Creates a table chart builder and enables paging with page size of 5 and
// displays page 2 first.
const builder = Charts.newTableChart();
builder.enablePaging(5, 2);

パラメータ

名前	型	説明
`pageSize`	`Integer`	テーブルの各ページの行数。
`startPage`	`Integer`	表示する最初の表ページ（ページ番号は 0 ベース）。

戻る

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

`enableRtlTable(rtlEnabled)`

表の列の順序を逆にして、列 0 が右端の列、最後の列が左端の列になるようにすることで、右から左の言語（アラビア語やヘブライ語など）の基本的なサポートを追加しました。

これは、基になるデータの列番号には影響せず、表示順序にのみ影響します。このオプションをオンにしても、テーブルビジュアリゼーションでは完全な双方向（BiDi）言語の表示はサポートされていません。このオプションは、ページングを有効にしている場合（ページオプションを使用）、または必要なテーブルサイズよりも小さい高さと幅のオプションを指定しているためにテーブルにスクロールバーがある場合、無視されます。デフォルトの動作では、RTL サポートは無効になっています。

パラメータ

名前	型	説明
`rtlEnabled`	`Boolean`	右から左のサポートを有効にする場合は `true`、それ以外の場合は `false`。

戻る

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

`enableSorting(enableSorting)`

ユーザーが列見出しをクリックしたときに列を並べ替えるかどうかを設定します。

並べ替えが有効になっている場合、ユーザーが列ヘッダーをクリックすると、行が自動的に並べ替えられます。デフォルトの動作では、並べ替えが有効になっています。

パラメータ

名前	型	説明
`enableSorting`	`Boolean`	`true`: 列見出しをクリックして並べ替えを有効にします。それ以外の場合は `false` です。

戻る

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

`getChartType()`

現在のグラフタイプを返します。

戻る

ChartType - グラフの種類

`getContainer()`

グラフ ContainerInfo を返します。これは、グラフがシート上に表示される場所をカプセル化します。

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

戻る

ContainerInfo - グラフコンテナの位置を含むオブジェクト

`getRanges()`

現在このグラフにデータを提供している範囲のリストのコピーを返します。このリストを変更するには、addRange(range) と removeRange(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[] - 作成するグラフのデータソースとして機能する範囲の配列

`removeRange(range)`

このビルダーが変更するグラフから指定した範囲を削除します。範囲がこのグラフにない場合、エラーはスローされません。

削除する範囲は、addRange(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`	削除する範囲。

戻る

EmbeddedChartBuilder - チェーン用のこのビルダー

`setChartType(type)`

グラフの種類を変更します。現在、埋め込みグラフの種類によってはサポートされていないものもあります。ChartType をご覧ください。

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`	`ChartType`	このグラフを変更するタイプ。

戻る

EmbeddedChartBuilder - チェーン用のこのビルダー

`setFirstRowNumber(number)`

データ表の最初の行の行番号を設定します。

最初の行のデフォルトの行番号は 1 です。

// Creates a table chart builder and sets the first row to be 2.
const builder = Charts.newTableChart();
builder.setFirstRowNumber(2);

パラメータ

名前	型	説明
`number`	`Integer`	データ表の最初の行の行番号。

戻る

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

`setHiddenDimensionStrategy(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`	`ChartHiddenDimensionStrategy`	非表示の行と列に使用する戦略。

戻る

EmbeddedChartBuilder - チェーン用のこのビルダー

`setInitialSortingAscending(column)`

テーブルの最初の並べ替え（昇順）に使用する列のインデックスを設定します。

列は昇順で並べ替えられており、そのことを示す小さな矢印が付いています。

// Creates a table chart builder and sorts it by the second column (ascending).
const builder = Charts.newTableChart();
builder.setInitialSortingAscending(2);

パラメータ

名前	型	説明
`column`	`Integer`	テーブルの最初の並べ替えに使用する列番号。

戻る

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

`setInitialSortingDescending(column)`

テーブルの最初の並べ替え（降順）に使用する列のインデックスを設定します。

列は降順で並べ替えられており、そのことを示す小さな矢印が付いています。

// Creates a table chart builder and sorts it by the second column (descending).
const builder = Charts.newTableChart();
builder.setInitialSortingDescending(2);

パラメータ

名前	型	説明
`column`	`Integer`	テーブルの最初の並べ替えに使用する列番号。

戻る

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

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

パラメータ

名前	型	説明
`mergeStrategy`	`ChartMergeStrategy`	使用する統合戦略。

戻る

EmbeddedChartBuilder - チェーン用のこのビルダー

`setNumHeaders(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`	ヘッダーとして扱う行または列の数。負の値を指定すると、ヘッダーが自動的に検出されます。

戻る

EmbeddedChartBuilder - チェーン用のこのビルダー

`setOption(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`	オプションの値。

戻る

EmbeddedChartBuilder - チェーン用のこのビルダー。

`setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)`

位置を設定して、シート上のグラフの表示位置を変更します。anchorRowPos と anchorColPos は 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);

パラメータ

名前	型	説明
`anchorRowPos`	`Integer`	グラフの上部がこの行に固定されます。
`anchorColPos`	`Integer`	グラフの左側はこの列に固定されます。
`offsetX`	`Integer`	グラフの右上隅がこのピクセル数だけオフセットされます。
`offsetY`	`Integer`	グラフの左下隅がこのピクセル数だけオフセットされます。

戻る

EmbeddedChartBuilder - チェーン用のこのビルダー

`setTransposeRowsAndColumns(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` の場合、グラフの作成に使用される行と列が転置されます。

戻る

EmbeddedChartBuilder - チェーン用のこのビルダー

`showRowNumberColumn(showRowNumber)`

行番号をテーブルの最初の列として表示するかどうかを設定します。

デフォルトでは、行番号は表示されません。

パラメータ

名前	型	説明
`showRowNumber`	`Boolean`	表の最初の列に行番号を表示する場合は `true`、それ以外の場合は `false`。

戻る

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

`useAlternatingRowStyle(alternate)`

表グラフの奇数行と偶数行に交互の色スタイルを割り当てるかどうかを設定します。

デフォルトの動作では、行の色スタイルが交互になります。

パラメータ

名前	型	説明
`alternate`	`Boolean`	色のスタイルを交互に表示する場合は `true`、それ以外の場合は `false`。

戻る

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