Class EmbeddedTableChartBuilder

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ページングを有効にし、各ページの行数と表示する最初のテーブル ページを設定します（ページ番号は 0 から始まります）。
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);

パラメータ

名前型説明
rangeRange追加する範囲。

戻る

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 です。

パラメータ

名前型説明
enablePagingBooleanページングを有効にする場合は 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);

パラメータ

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

戻る

EmbeddedTableChartBuilder - このビルダー。チェーン処理に便利です。

enablePaging(pageSize, startPage)

ページングを有効にし、各ページの行数と表示する最初のテーブル ページを設定します（ページ番号は 0 から始まります）。

デフォルトのページサイズは 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);

パラメータ

名前型説明
pageSizeIntegerテーブルの各ページの行数。
startPageInteger表示する最初のテーブル ページ（ページ番号は 0 から始まります）。

戻る

EmbeddedTableChartBuilder - このビルダー。チェーン処理に便利です。

enableRtlTable(rtlEnabled)

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

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

パラメータ

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

戻る

EmbeddedTableChartBuilder - このビルダー。チェーン処理に便利です。

enableSorting(enableSorting)

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

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

パラメータ

名前型説明
enableSortingBooleantrue 列ヘッダーをクリックして並べ替えを有効にする場合、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 renders 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
// is not removed, and does not throw an exception
chartBuilder.removeRange(firstRange);
chartBuilder.removeRange(sheet.getRange('A6:B8'));

const chart = chartBuilder.build();

sheet.insertChart(chart);

パラメータ

名前型説明
rangeRange削除する範囲。

戻る

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

パラメータ

名前型説明
typeChartTypeこのグラフの変更先の種類。

戻る

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

setFirstRowNumber(number)

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

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

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

パラメータ

名前型説明
numberIntegerデータテーブルの最初の行の行番号。

戻る

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

パラメータ

名前型説明
strategyChartHiddenDimensionStrategy非表示の行と列に使用する戦略。

戻る

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

setInitialSortingAscending(column)

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

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

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

パラメータ

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

戻る

EmbeddedTableChartBuilder - このビルダー。チェーン処理に便利です。

setInitialSortingDescending(column)

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

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

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

パラメータ

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

戻る

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

パラメータ

名前型説明
mergeStrategyChartMergeStrategy使用する統合戦略。

戻る

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

パラメータ

名前型説明
headersIntegerヘッダーとして扱う行または列の数。負の値を指定すると、ヘッダーが自動検出されます。

戻る

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

パラメータ

名前型説明
optionStringオプションの名前。
valueObjectオプションの値。

戻る

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

パラメータ

名前型説明
anchorRowPosIntegerグラフの上部はこの行に固定されます。
anchorColPosIntegerグラフの左側はこの列に固定されます。
offsetXIntegerグラフの右上隅がこのピクセル数だけオフセットされます。
offsetYIntegerグラフの左下隅がこのピクセル数だけオフセットされます。

戻る

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

パラメータ

名前型説明
transposeBooleantrue の場合、グラフの作成に使用される行と列が転置されます。

戻る

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

showRowNumberColumn(showRowNumber)

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

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

パラメータ

名前型説明
showRowNumberBooleanテーブルの最初の列に行番号を表示する場合は true、それ以外の場合は false。

戻る

EmbeddedTableChartBuilder - このビルダー。チェーン処理に便利です。

useAlternatingRowStyle(alternate)

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

デフォルトの動作は、行の色が交互に変わるスタイルです。

パラメータ

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

戻る

EmbeddedTableChartBuilder - このビルダー。チェーン処理に便利です。