Class EmbeddedPieChartBuilder

埋め込み円グラフビルダー

円グラフのビルダー。詳細については、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このビルダーが変更するグラフからすべての範囲を削除します。
getChartType()ChartType現在のグラフタイプを返します。
getContainer()ContainerInfoグラフ ContainerInfo を返します。これは、グラフがシート上に表示される場所をカプセル化します。
getRanges()Range[]現在このグラフにデータを提供している範囲のリストのコピーを返します。
removeRange(range)EmbeddedChartBuilderこのビルダーが変更するグラフから指定した範囲を削除します。
reverseCategories()EmbeddedPieChartBuilderドメイン軸での系列の描画を反転します。
set3D()EmbeddedPieChartBuilderグラフを 3 次元に設定します。
setBackgroundColor(cssValue)EmbeddedPieChartBuilderグラフの背景色を設定します。
setChartType(type)EmbeddedChartBuilderグラフの種類を変更します。
setColors(cssValues)EmbeddedPieChartBuilderグラフの線の色を設定します。
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilder非表示の行と列に使用する戦略を設定します。
setLegendPosition(position)EmbeddedPieChartBuilderグラフに対する凡例の位置を設定します。
setLegendTextStyle(textStyle)EmbeddedPieChartBuilderグラフの凡例のテキスト スタイルを設定します。
setMergeStrategy(mergeStrategy)EmbeddedChartBuilder複数の範囲が存在する場合に使用する統合戦略を設定します。
setNumHeaders(headers)EmbeddedChartBuilderヘッダーとして扱う範囲の行または列の数を設定します。
setOption(option, value)EmbeddedChartBuilderこのグラフの詳細オプションを設定します。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilder位置を設定して、シート上のグラフの表示位置を変更します。
setTitle(chartTitle)EmbeddedPieChartBuilderグラフのタイトルを設定します。
setTitleTextStyle(textStyle)EmbeddedPieChartBuilderグラフのタイトルのテキスト スタイルを設定します。
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);

パラメータ

名前型説明
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 - チェーン用のこのビルダー

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

パラメータ

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

戻る

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

reverseCategories()

ドメイン軸での系列の描画を反転します。垂直範囲グラフ（折れ線グラフ、面グラフ、棒グラフなど）の場合、水平軸は右から左に描画されます。横方向の範囲グラフ（棒グラフなど）の場合、垂直軸は上から下に描画されます。円グラフの場合、スライスは反時計回りに描画されます。

// Creates a pie chart builder and sets drawing of the slices in a
// counter-clockwise manner.
const builder = Charts.newPieChart();
builder.reverseCategories();

戻る

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

set3D()

グラフを 3 次元に設定します。

戻る

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

setBackgroundColor(cssValue)

グラフの背景色を設定します。

// Creates a line chart builder and sets the background color to gray
const builder = Charts.newLineChart();
builder.setBackgroundColor('gray');

パラメータ

名前型説明
cssValueString色の CSS 値（"blue" や "#00f" など）。

戻る

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

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

setColors(cssValues)

グラフの線の色を設定します。

// Creates a line chart builder and sets the first two lines to be drawn in
// green and red, respectively.
const builder = Charts.newLineChart();
builder.setColors(['green', 'red']);

パラメータ

名前型説明
cssValuesString[]色の CSS 値の配列（["red", "#acf"] など）。配列の n 番目の要素は、グラフの n 番目の線の色を表します。

戻る

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

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

setLegendPosition(position)

グラフに対する凡例の位置を設定します。デフォルトでは、凡例はありません。

// Creates a line chart builder and sets the legend position to right.
const builder = Charts.newLineChart();
builder.setLegendPosition(Charts.Position.RIGHT);

パラメータ

名前型説明
positionPosition凡例の位置。

戻る

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

setLegendTextStyle(textStyle)

グラフの凡例のテキスト スタイルを設定します。 

// Creates a line chart builder and sets it up for a  blue, 26-point legend.
const textStyleBuilder =
    Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
const style = textStyleBuilder.build();
const builder = Charts.newLineChart();
builder.setLegendTextStyle(style);

パラメータ

名前型説明
textStyleTextStyleグラフの凡例に使用するテキスト スタイル。

戻る

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

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

setTitle(chartTitle)

グラフのタイトルを設定します。タイトルはグラフの上に中央に表示されます。 

// Creates a line chart builder and title to 'My Line Chart'.
const builder = Charts.newLineChart();
builder.setTitle('My Line Chart');

パラメータ

名前型説明
chartTitleStringグラフのタイトル。

戻る

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

setTitleTextStyle(textStyle)

グラフのタイトルのテキスト スタイルを設定します。 

// Creates a line chart builder and sets it up for a  blue, 26-point title.
const textStyleBuilder =
    Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
const style = textStyleBuilder.build();
const builder = Charts.newLineChart();
builder.setTitleTextStyle(style);

パラメータ

名前型説明
textStyleTextStyleグラフのタイトルに使用するテキスト スタイル。TextStyleBuilder オブジェクトを作成するには、Charts.newTextStyle() を呼び出します。

戻る

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

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