複合グラフのビルダー。詳しくは、Google ビジュアリゼーションのドキュメントをご覧ください。
Methods
詳細なドキュメント
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
range | Range | 追加する範囲。 |
リターン
EmbeddedChartBuilder
- このビルダー(チェーン用)
asAreaChart()
asBarChart()
asColumnChart()
グラフの種類を ColumnChart に設定し、EmbeddedColumnChartBuilder
を返します。
リターン
EmbeddedColumnChartBuilder
- 縦棒グラフのビルダー
asComboChart()
グラフの種類を ComboChart に設定し、EmbeddedComboChartBuilder
を返します。
リターン
EmbeddedComboChartBuilder
- 複合グラフのビルダー
asHistogramChart()
グラフの種類を HistogramChart に設定し、EmbeddedHistogramChartBuilder
を返します。
リターン
EmbeddedHistogramChartBuilder
- ヒストグラム グラフのビルダー
asLineChart()
asPieChart()
asScatterChart()
グラフの種類を ScatterChart に設定し、EmbeddedScatterChartBuilder
を返します。
リターン
EmbeddedScatterChartBuilder
- 散布図のビルダー
asTableChart()
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()
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
range | Range | 削除する範囲。 |
リターン
EmbeddedChartBuilder
- このビルダー(チェーン用)
reverseCategories()
領域軸で系列の描画を逆にします。縦範囲のグラフ(折れ線グラフ、面グラフ、縦棒グラフなど)では、横軸は右から左に描画されます。横範囲のグラフ(棒グラフなど)の場合、縦軸は上から下に向かって描画されます。円グラフの場合、スライスは反時計回りに描画されます。
// Creates a pie chart builder and sets drawing of the slices in a counter-clockwise manner. var builder = Charts.newPieChart(); builder.reverseCategories();
リターン
EmbeddedComboChartBuilder
- このビルダー。チェーンに役立ちます。
setBackgroundColor(cssValue)
グラフの背景色を設定します。
// Creates a line chart builder and sets the background color to gray var builder = Charts.newLineChart(); builder.setBackgroundColor("gray");
パラメータ
名前 | 型 | 説明 |
---|---|---|
cssValue | String | 色の CSS 値("blue" 、"#00f" など)。 |
リターン
EmbeddedComboChartBuilder
- このビルダー。チェーンに役立ちます。
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
type | ChartType | このグラフの変更先の型。 |
リターン
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"]);
パラメータ
名前 | 型 | 説明 |
---|---|---|
cssValues | String[] | カラー CSS 値の配列(["red", "#acf"] など)。配列の n 番目の要素は、グラフの n 番目の線の色を表します。 |
リターン
EmbeddedComboChartBuilder
- このビルダー。チェーンに役立ちます。
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
strategy | ChartHiddenDimensionStrategy | 非表示の行と列に使用する戦略。 |
リターン
EmbeddedChartBuilder
- このビルダー(チェーン用)
setLegendPosition(position)
グラフに関する凡例の位置を設定します。デフォルトでは、凡例はありません。
// Creates a line chart builder and sets the legend position to right. var builder = Charts.newLineChart(); builder.setLegendPosition(Charts.Position.RIGHT);
パラメータ
名前 | 型 | 説明 |
---|---|---|
position | Position | 凡例の位置。 |
リターン
EmbeddedComboChartBuilder
- このビルダー。チェーンに役立ちます。
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
textStyle | TextStyle | グラフの凡例に使用するテキスト スタイル。 |
リターン
EmbeddedComboChartBuilder
- このビルダー。チェーンに役立ちます。
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
mergeStrategy | ChartMergeStrategy | 使用するマージ戦略。 |
リターン
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
headers | Integer | ヘッダーとして扱う行または列の数。負の値を指定すると、ヘッダーが自動検出されます。 |
リターン
EmbeddedChartBuilder
- このビルダー(チェーン用)
setOption(option, value)
このグラフの詳細オプションを設定します。使用可能なオプションの一覧については、グラフ構成オプションをご覧ください。
この方法では、指定したオプションがこのグラフの種類に対して有効かどうかや、値が正しい形式/構造であるかは検証されません。
次の例は、タイトルを変更して凡例を設定する方法を示しています。
builder.setOption('title', 'Earnings projections'); builder.setOption('legend', {position: 'top', textStyle: {color: 'blue', fontSize: 16}});
パラメータ
名前 | 型 | 説明 |
---|---|---|
option | String | オプションの名前。 |
value | Object | オプションの値。 |
リターン
EmbeddedChartBuilder
- チェーン用のこのビルダー。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)
位置を設定し、シート上でグラフを表示する位置を変更します。anchorRowPos
と anchorColPos
は 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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
anchorRowPos | Integer | グラフの上部がこの行に固定されています。 |
anchorColPos | Integer | グラフの左側がこの列に固定されています。 |
offsetX | Integer | グラフの右上は、ここで指定したピクセル数でオフセットされます。 |
offsetY | Integer | グラフの左下隅が、このピクセル数でオフセットされます。 |
リターン
EmbeddedChartBuilder
- このビルダー(チェーン用)
setRange(start, end)
グラフの範囲を設定します。
範囲外のデータポイントがある場合は、それらのデータポイントを含むように範囲が拡大されます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Number | 範囲軸の最も低いグリッド線の値。 |
end | Number | 範囲の軸の最も高いグリッド線の値。 |
リターン
EmbeddedComboChartBuilder
- このビルダー。チェーンに役立ちます。
setStacked()
積み上げ折れ線を使用します。つまり、線と棒の値が積み重ねられます。デフォルトでは、スタックはありません。
リターン
EmbeddedComboChartBuilder
- このビルダー。チェーンに役立ちます。
setTitle(chartTitle)
グラフのタイトルを設定します。タイトルはグラフの中央に表示されます。
// Creates a line chart builder and title to 'My Line Chart'. var builder = Charts.newLineChart(); builder.setTitle('My Line Chart')
パラメータ
名前 | 型 | 説明 |
---|---|---|
chartTitle | String | グラフのタイトルが表示されます。 |
リターン
EmbeddedComboChartBuilder
- このビルダー。チェーンに役立ちます。
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
textStyle | TextStyle | グラフのタイトルに使用するテキスト スタイルです。TextStyleBuilder オブジェクトを作成するには、Charts.newTextStyle() を呼び出します。 |
リターン
EmbeddedComboChartBuilder
- このビルダー。チェーンに役立ちます。
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
transpose | Boolean | true の場合、グラフの作成に使用される行と列が転置されます。 |
リターン
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
textStyle | TextStyle | 横軸のタイトルに使用するテキスト スタイル。TextStyleBuilder オブジェクトを作成するには、Charts.newTextStyle() を呼び出します。 |
リターン
EmbeddedComboChartBuilder
- このビルダー。チェーンに役立ちます。
setXAxisTitle(title)
横軸にタイトルを追加します。タイトルは中央に配置され、軸の値のラベルの下に表示されます。
// Creates a line chart builder and sets the X-axis title. var builder = Charts.newLineChart(); builder.setTitle('X-axis Title')
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | X 軸のタイトル。 |
リターン
EmbeddedComboChartBuilder
- このビルダー。チェーンに役立ちます。
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
textStyle | TextStyle | 横軸のタイトルに使用するテキスト スタイル。TextStyleBuilder オブジェクトを作成するには、Charts.newTextStyle() を呼び出します。 |
リターン
EmbeddedComboChartBuilder
- このビルダー。チェーンに役立ちます。
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
textStyle | TextStyle | 横軸のタイトルに使用するテキスト スタイル。TextStyleBuilder オブジェクトを作成するには、Charts.newTextStyle() を呼び出します。 |
リターン
EmbeddedComboChartBuilder
- このビルダー。チェーンに役立ちます。
setYAxisTitle(title)
縦軸にタイトルを追加します。タイトルは中央に配置され、値のラベルの左側に表示されます。
// Creates a line chart builder and sets the Y-axis title. var builder = Charts.newLineChart(); builder.setYAxisTitle('Y-axis Title')
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | Y 軸のタイトル。 |
リターン
EmbeddedComboChartBuilder
- このビルダー。チェーンに役立ちます。
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
textStyle | TextStyle | 横軸のタイトルに使用するテキスト スタイル。TextStyleBuilder オブジェクトを作成するには、Charts.newTextStyle() を呼び出します。 |
リターン
EmbeddedComboChartBuilder
- このビルダー。チェーンに役立ちます。
useLogScale()
範囲の軸を対数スケールにします(すべての値を正数にする必要があります)。範囲の軸は、垂直グラフ(折れ線、面、縦など)では縦軸、横棒グラフ(棒グラフなど)では横軸です。
リターン
EmbeddedComboChartBuilder
- このビルダー。チェーンに役立ちます。