Class EmbeddedColumnChartBuilder

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。
EmbeddedColumnChartBuilder

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

Methods

方法戻り値の型概要
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()EmbeddedColumnChartBuilderドメイン軸で系列の描画を逆にします。
setBackgroundColor(cssValue)EmbeddedColumnChartBuilderグラフの背景色を設定します。
setChartType(type)EmbeddedChartBuilderグラフの種類を変更します。
setColors(cssValues)EmbeddedColumnChartBuilderグラフの折れ線の色を設定します。
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilder非表示の行や列に使用する方法を設定します。
setLegendPosition(position)EmbeddedColumnChartBuilderグラフに対する凡例の位置を設定します。
setLegendTextStyle(textStyle)EmbeddedColumnChartBuilderグラフの凡例のテキスト スタイルを設定します。
setMergeStrategy(mergeStrategy)EmbeddedChartBuilder複数の範囲が存在する場合に使用する統合戦略を設定します。
setNumHeaders(headers)EmbeddedChartBuilderヘッダーとして扱う範囲の行または列の数を設定します。
setOption(option, value)EmbeddedChartBuilderこのグラフの詳細オプションを設定します。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilder位置を設定し、シート上のグラフの位置を変更します。
setRange(start, end)EmbeddedColumnChartBuilderグラフの範囲を設定します。
setStacked()EmbeddedColumnChartBuilder積み上げ線を使用します。つまり、線と棒グラフの値は積み重ね(累積)されます。
setTitle(chartTitle)EmbeddedColumnChartBuilderグラフのタイトルを設定します。
setTitleTextStyle(textStyle)EmbeddedColumnChartBuilderグラフのタイトルのテキスト スタイルを設定します。
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderグラフの行と列を転置するかどうかを設定します。
setXAxisTextStyle(textStyle)EmbeddedColumnChartBuilder横軸のテキスト スタイルを設定します。
setXAxisTitle(title)EmbeddedColumnChartBuilder横軸にタイトルを追加します。
setXAxisTitleTextStyle(textStyle)EmbeddedColumnChartBuilder横軸のタイトルのテキスト スタイルを設定します。
setYAxisTextStyle(textStyle)EmbeddedColumnChartBuilder縦軸のテキスト スタイルを設定します。
setYAxisTitle(title)EmbeddedColumnChartBuilder縦軸にタイトルを追加します。
setYAxisTitleTextStyle(textStyle)EmbeddedColumnChartBuilder縦軸のタイトルのテキスト スタイルを設定します。
useLogScale()EmbeddedColumnChartBuilder範囲軸を対数目盛にします(すべての値が正の値である必要があります)。

詳細なドキュメント

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

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

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


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


reverseCategories()

ドメイン軸で系列の描画を逆にします。縦棒グラフ(折れ線グラフ、面グラフ、縦棒グラフなど)の場合、横軸は右から左に描画されます。横範囲のグラフ(棒グラフなど)の場合、縦軸は上から下に向かって描画されます。円グラフの場合、スライスは反時計回りに描画されます。

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

戻る

EmbeddedColumnChartBuilder - チェーンに役立つビルダー。


setBackgroundColor(cssValue)

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

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

パラメータ

名前説明
cssValueString色の CSS 値("blue""#00f" など)。

戻る

EmbeddedColumnChartBuilder - チェーンに役立つビルダー。


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


setColors(cssValues)

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

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

パラメータ

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

戻る

EmbeddedColumnChartBuilder - チェーンに役立つビルダー。


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


setLegendPosition(position)

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

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

パラメータ

名前説明
positionPosition凡例の位置。

戻る

EmbeddedColumnChartBuilder - チェーンに役立つビルダー。


setLegendTextStyle(textStyle)

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

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

パラメータ

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

戻る

EmbeddedColumnChartBuilder - チェーンに役立つビルダー。


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


setRange(start, end)

グラフの範囲を設定します。

データポイントが範囲外にある場合、範囲は、それらのデータポイントを含むように拡張されます。

パラメータ

名前説明
startNumber範囲軸の最下位のグリッド線の値。
endNumber範囲軸の最高グリッド線の値。

戻る

EmbeddedColumnChartBuilder - チェーンに役立つビルダー。


setStacked()

積み上げ線を使用します。つまり、線と棒グラフの値は積み重ね(累積)されます。デフォルトでは、スタックはありません。

戻る

EmbeddedColumnChartBuilder - チェーンに役立つビルダー。


setTitle(chartTitle)

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

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

パラメータ

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

戻る

EmbeddedColumnChartBuilder - チェーンに役立つビルダー。


setTitleTextStyle(textStyle)

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

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

パラメータ

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

戻る

EmbeddedColumnChartBuilder - チェーンに役立つビルダー。


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


setXAxisTextStyle(textStyle)

横軸のテキスト スタイルを設定します。

// Creates a line chart builder and sets the X-axis text style to blue, 18-point font.
var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
var builder = Charts.newLineChart();
builder.setXAxisTextStyle(textStyle);

パラメータ

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

戻る

EmbeddedColumnChartBuilder - チェーンに役立つビルダー。


setXAxisTitle(title)

横軸にタイトルを追加します。タイトルは中央に配置され、軸の値ラベルの下に表示されます。

// Creates a line chart builder and sets the X-axis title.
var builder = Charts.newLineChart();
builder.setTitle('X-axis Title')

パラメータ

名前説明
titleStringX 軸のタイトル。

戻る

EmbeddedColumnChartBuilder - チェーンに役立つビルダー。


setXAxisTitleTextStyle(textStyle)

横軸のタイトルのテキスト スタイルを設定します。

// Creates a line chart builder and sets the X-axis title text style to blue, 18-point font.
var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
var builder = Charts.newLineChart();
builder.setXAxisTitleTextStyle(textStyle);

パラメータ

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

戻る

EmbeddedColumnChartBuilder - チェーンに役立つビルダー。


setYAxisTextStyle(textStyle)

縦軸のテキスト スタイルを設定します。

// Creates a line chart builder and sets the Y-axis text style to blue, 18-point font.
var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
var builder = Charts.newLineChart();
builder.setYAxisTextStyle(textStyle);

パラメータ

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

戻る

EmbeddedColumnChartBuilder - チェーンに役立つビルダー。


setYAxisTitle(title)

縦軸にタイトルを追加します。タイトルは中央に位置し、値ラベルの左側に表示されます。

// Creates a line chart builder and sets the Y-axis title.
var builder = Charts.newLineChart();
builder.setYAxisTitle('Y-axis Title')

パラメータ

名前説明
titleStringY 軸のタイトル。

戻る

EmbeddedColumnChartBuilder - チェーンに役立つビルダー。


setYAxisTitleTextStyle(textStyle)

縦軸のタイトルのテキスト スタイルを設定します。

// Creates a line chart builder and sets the Y-axis title text style to blue, 18-point font.
var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
var builder = Charts.newLineChart();
builder.setYAxisTitleTextStyle(textStyle);

パラメータ

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

戻る

EmbeddedColumnChartBuilder - チェーンに役立つビルダー。


useLogScale()

範囲軸を対数目盛にします(すべての値が正の値である必要があります)。範囲軸は、縦グラフ(折れ線グラフ、面グラフ、縦棒グラフなど)の縦軸、横軸(棒グラフなど)の横軸です。

戻る

EmbeddedColumnChartBuilder - チェーンに役立つビルダー。