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

Class EmbeddedChartBuilder

EmbeddedChart の編集に使用されるビルダー。グラフに加えた変更は、再ビルドされたグラフで Sheet.updateChart(chart) が呼び出されるまで保存されません。

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B8');
let 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);

メソッド

メソッド	戻り値の型	概要
`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`	このビルダーが変更するグラフからすべての範囲を削除します。
`getChartType()`	`ChartType`	現在のグラフタイプを返します。
`getContainer()`	`ContainerInfo`	グラフ `ContainerInfo` を返します。これは、グラフがシート上に表示される場所をカプセル化します。
`getRanges()`	`Range[]`	現在このグラフにデータを提供している範囲のリストのコピーを返します。
`removeRange(range)`	`EmbeddedChartBuilder`	このビルダーが変更するグラフから指定した範囲を削除します。
`setChartType(type)`	`EmbeddedChartBuilder`	グラフの種類を変更します。
`setHiddenDimensionStrategy(strategy)`	`EmbeddedChartBuilder`	非表示の行と列に使用する戦略を設定します。
`setMergeStrategy(mergeStrategy)`	`EmbeddedChartBuilder`	複数の範囲が存在する場合に使用する統合戦略を設定します。
`setNumHeaders(headers)`	`EmbeddedChartBuilder`	ヘッダーとして扱う範囲の行または列の数を設定します。
`setOption(option, value)`	`EmbeddedChartBuilder`	このグラフの詳細オプションを設定します。
`setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)`	`EmbeddedChartBuilder`	位置を設定して、シート上のグラフの表示位置を変更します。
`setTransposeRowsAndColumns(transpose)`	`EmbeddedChartBuilder`	グラフの行と列を入れ替えるかどうかを設定します。

詳細なドキュメント

`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 - チェーン用のこのビルダー

`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 - チェーン用のこのビルダー

`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 - チェーン用のこのビルダー

`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 - チェーン用のこのビルダー