Class EmbeddedTableChartBuilder

EmbeddedTableChartBuilder

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

メソッド

メソッド戻り値の型概要
addRange(range)EmbeddedChartBuilderこのビルダーで変更されるグラフに範囲を追加します。
asAreaChart()EmbeddedAreaChartBuilderグラフの種類を AreaChart に設定し、EmbeddedAreaChartBuilder を返します。
asBarChart()EmbeddedBarChartBuilderグラフの種類を BarChart に設定し、EmbeddedBarChartBuilder を返します。
asColumnChart()EmbeddedColumnChartBuilderグラフの種類を縦棒グラフに設定し、EmbeddedColumnChartBuilder を返します。
asComboChart()EmbeddedComboChartBuilderグラフの種類を ComboChart に設定し、EmbeddedComboChartBuilder を返します。
asHistogramChart()EmbeddedHistogramChartBuilderグラフの種類を HistogramChart に設定し、EmbeddedHistogramChartBuilder を返します。
asLineChart()EmbeddedLineChartBuilderグラフの種類を LineChart に設定し、EmbeddedLineChartBuilder を返します。
asPieChart()EmbeddedPieChartBuilderグラフの種類を円グラフに設定し、EmbeddedPieChartBuilder を返します。
asScatterChart()EmbeddedScatterChartBuilderグラフの種類を ScatterChart に設定し、EmbeddedScatterChartBuilder を返します。
asTableChart()EmbeddedTableChartBuilderグラフの種類を TableChart に設定し、EmbeddedTableChartBuilder を返します。
build()EmbeddedChartグラフに加えた変更がすべて反映されるグラフを作成します。
clearRanges()EmbeddedChartBuilderこのビルダーによって変更されるグラフからすべての範囲を削除します。
enablePaging(enablePaging)EmbeddedTableChartBuilderデータのページングを有効にするかどうかを設定します。
enablePaging(pageSize)EmbeddedTableChartBuilderページングを有効にし、各ページの行数を設定します。
enablePaging(pageSize, startPage)EmbeddedTableChartBuilderページングを有効にし、各ページの行数と最初に表示するテーブルページ(page)を設定します。 ゼロから始まります)。
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)

このビルダーで変更されるグラフに範囲を追加します。すでに範囲がすでに存在する場合は追加しません グラフに追加されます

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

sheet.insertChart(chart);

パラメータ

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

戻る

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


asAreaChart()

グラフの種類を AreaChart に設定し、EmbeddedAreaChartBuilder を返します。

戻る

EmbeddedAreaChartBuilder - 面グラフのビルダー


asBarChart()

グラフの種類を BarChart に設定し、EmbeddedBarChartBuilder を返します。

戻る

EmbeddedBarChartBuilder - 棒グラフのビルダー


asColumnChart()

グラフの種類を縦棒グラフに設定し、EmbeddedColumnChartBuilder を返します。

戻る

EmbeddedColumnChartBuilder - 縦棒グラフのビルダー


asComboChart()

グラフの種類を ComboChart に設定し、EmbeddedComboChartBuilder を返します。

戻る

EmbeddedComboChartBuilder - 複合グラフのビルダー


asHistogramChart()

グラフの種類を HistogramChart に設定し、EmbeddedHistogramChartBuilder を返します。

戻る

EmbeddedHistogramChartBuilder - ヒストグラム グラフのビルダー


asLineChart()

グラフの種類を LineChart に設定し、EmbeddedLineChartBuilder を返します。

戻る

EmbeddedLineChartBuilder - 折れ線グラフのビルダー


asPieChart()

グラフの種類を円グラフに設定し、EmbeddedPieChartBuilder を返します。

戻る

EmbeddedPieChartBuilder - 円グラフのビルダー


asScatterChart()

グラフの種類を ScatterChart に設定し、EmbeddedScatterChartBuilder を返します。

戻る

EmbeddedScatterChartBuilder - 散布図のビルダー


asTableChart()

グラフの種類を TableChart に設定し、EmbeddedTableChartBuilder を返します。

戻る

EmbeddedTableChartBuilder - 表グラフのビルダー


build()

グラフに加えた変更がすべて反映されるグラフを作成します。

この方法では、グラフがスプレッドシートの上に自動的に描画されることはありません。新しいグラフ sheet.insertChart(chart) を介して挿入し、既存のグラフを更新する必要があります sheet.updateChart(chart) 経由。

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

sheet.insertChart(chart);

戻る

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


clearRanges()

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

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

// This code updates the chart to use only the new ranges while preserving the existing
// formatting of the chart.
var chart = sheet.getCharts()[0];
var 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.
var builder = Charts.newTableChart();
builder.enablePaging(5);

パラメータ

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

戻る

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


enablePaging(pageSize, startPage)

ページングを有効にし、各ページの行数と最初に表示するテーブルページ(page)を設定します。 ゼロから始まります)。

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

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

パラメータ

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

戻る

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


enableRtlTable(rtlEnabled)

右から左に記述する言語(アラビア語やヘブライ語など)の基本的なサポートが追加されました。 行の順序が並べ替えられます。つまり、列 0 は右端、最後の列は クリックします。

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

パラメータ

名前説明
rtlEnabledBoolean右から左へのサポートを有効にする場合は truefalse できません。

戻る

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


enableSorting(enableSorting)

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

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

パラメータ

名前説明
enableSortingBoolean列ヘッダーをクリックして並べ替えを有効にするには true、そうでない場合は false

戻る

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


getChartType()

現在のグラフの種類を返します。

戻る

ChartType - グラフの種類


getContainer()

グラフ ContainerInfo を返します。これにより、グラフがグラフに表示される位置がカプセル化されます。 できます。

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

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

// 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 - グラフコンテナの位置を含むオブジェクト


getRanges()

現在このグラフのデータを提供している範囲のリストのコピーを返します。このリストを変更するには、addRange(range)removeRange(range) を使用します。

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

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

var ranges = chartBuilder.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[] - 構築するグラフのデータソースとして機能する範囲の配列


removeRange(range)

指定した範囲を、このビルダーによって変更されるグラフから削除します。次の場合はエラーを返さない その範囲はこのグラフにはありません。

削除された範囲は、addRange(range) を介して追加された範囲と一致する必要があります。 それ以外の場合、グラフは変更されません。このメソッドを使用して値を部分的に削除することはできません 選択できます。

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

var firstRange = sheet.getRange("A1:B5");
var secondRange = sheet.getRange("A6:B8");

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

var chart = chartBuilder.build();

sheet.insertChart(chart);

パラメータ

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

戻る

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


setChartType(type)

グラフの種類を変更します。現在のところ、すべての埋め込みグラフの種類がサポートされているわけではありません。ChartType をご覧ください。

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)
    .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.
var builder = Charts.newTableChart();
builder.setFirstRowNumber(2);

パラメータ

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

戻る

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


setHiddenDimensionStrategy(strategy)

非表示の行と列に使用する戦略を設定します。デフォルトは 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();

sheet.insertChart(chart);

パラメータ

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

戻る

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


setInitialSortingAscending(column)

テーブルを最初に並べ替える際の基準となる列のインデックスを設定します (昇順)。

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

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

パラメータ

名前説明
columnIntegerテーブルを最初に並べ替える際に基準とする列番号を指定します。

戻る

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


setInitialSortingDescending(column)

テーブルを最初に並べ替える際の基準となる列のインデックスを設定します (降順)。

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

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

パラメータ

名前説明
columnIntegerテーブルを最初に並べ替える際に基準とする列番号を指定します。

戻る

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


setMergeStrategy(mergeStrategy)

複数の範囲が存在する場合に使用するマージ戦略を設定します。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("C:C10");
var 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)

ヘッダーとして扱う範囲の行数または列数を設定します。

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

sheet.insertChart(chart);

パラメータ

名前説明
headersIntegerヘッダーとして使用する行または列の数。負の値を使用するとヘッダーが発生 指定することもできます。

戻る

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


setOption(option, value)

このグラフの詳細オプションを設定します。使用可能なオプションの一覧については、グラフ 構成オプションをご覧ください。

このメソッドでは、指定したオプションがこのグラフの種類で有効かどうかや、 値が正しい形式/構造である。

この例では、タイトルを変更して凡例を設定する方法を示しています。

builder.setOption('title', 'Earnings projections');
builder.setOption('legend', {position: 'top', textStyle: {color: 'blue', fontSize: 16}});

パラメータ

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

戻る

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


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

シート上でのグラフの表示位置を変更して、位置を設定します。anchorRowPosanchorColPos は 1 から始まります。

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

sheet.insertChart(chart);

パラメータ

名前説明
anchorRowPosIntegerグラフの上側がこの行に固定されています。
anchorColPosIntegerグラフの左側がこの列に固定されます。
offsetXIntegerグラフの右上隅を、ここで指定したピクセル数でオフセットします。
offsetYIntegerグラフの左下隅のオフセットを、ここで指定したピクセル数にします。

戻る

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


setTransposeRowsAndColumns(transpose)

グラフの行と列を転置するかどうかを設定します。true に設定すると、行と 列が入れ替わります。デフォルトは false です。

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)
    .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 - このビルダーはチェーンに役立ちます。