面グラフのビルダー。詳細については、Gviz の ドキュメントをご覧ください。
メソッド
詳細なドキュメント
add Range(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 | 追加する範囲。 |
戻る
Embedded
- チェーン用のこのビルダー
as Area Chart()
as Bar Chart()
as Column Chart()
グラフのタイプを ColumnChart に設定し、Embedded
を返します。
戻る
Embedded
- 縦棒グラフのビルダー
as Combo Chart()
as Histogram Chart()
グラフの種類を HistogramChart に設定し、Embedded
を返します。
戻る
Embedded
- ヒストグラム グラフのビルダー
as Line Chart()
as Pie Chart()
as Scatter Chart()
グラフのタイプを ScatterChart に設定し、Embedded
を返します。
戻る
Embedded
- 散布図のビルダー
as Table Chart()
グラフタイプを TableChart に設定し、Embedded
を返します。
戻る
Embedded
- テーブルグラフのビルダー
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);
戻る
Embedded
- 作成されたグラフ(スプレッドシートに追加する必要があります)
clear Ranges()
このビルダーが変更するグラフからすべての範囲を削除します。
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);
戻る
Embedded
- チェーン用のこのビルダー
get Chart Type()
get Container()
グラフ Container
を返します。これは、グラフがシート上に表示される場所をカプセル化します。
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(), );
戻る
Container
- グラフ コンテナの位置を含むオブジェクト
get Ranges()
現在このグラフにデータを提供している範囲のリストのコピーを返します。このリストを変更するには、add
と remove
を使用します。
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[]
- 作成するグラフのデータソースとして機能する範囲の配列
remove Range(range)
このビルダーが変更するグラフから指定した範囲を削除します。範囲がこのグラフにない場合、エラーはスローされません。
削除する範囲は、add
で追加した範囲と一致している必要があります。一致していない場合、グラフは変更されません。このメソッドを使用して、範囲から値の一部を削除することはできません。
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 | 削除する範囲。 |
戻る
Embedded
- チェーン用のこのビルダー
reverse Categories()
ドメイン軸での系列の描画を反転します。垂直範囲グラフ(折れ線グラフ、面グラフ、棒グラフなど)の場合、水平軸は右から左に描画されます。横方向の範囲グラフ(棒グラフなど)の場合、垂直軸は上から下に描画されます。円グラフの場合、スライスは反時計回りに描画されます。
// Creates a pie chart builder and sets drawing of the slices in a // counter-clockwise manner. const builder = Charts.newPieChart(); builder.reverseCategories();
戻る
Embedded
- このビルダーはチェーンに役立ちます。
set Background Color(cssValue)
グラフの背景色を設定します。
// Creates a line chart builder and sets the background color to gray const builder = Charts.newLineChart(); builder.setBackgroundColor('gray');
パラメータ
名前 | 型 | 説明 |
---|---|---|
css | String | 色の CSS 値("blue" や "#00f" など)。 |
戻る
Embedded
- このビルダーはチェーンに役立ちます。
set Chart Type(type)
グラフの種類を変更します。現在、埋め込みグラフの種類によってはサポートされていないものもあります。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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
type | Chart | このグラフを変更するタイプ。 |
戻る
Embedded
- チェーン用のこのビルダー
set Colors(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']);
パラメータ
名前 | 型 | 説明 |
---|---|---|
css | String[] | 色の CSS 値の配列(["red", "#acf"] など)。配列の n 番目の要素は、グラフの n 番目の線の色を表します。 |
戻る
Embedded
- このビルダーはチェーンに役立ちます。
set Hidden Dimension Strategy(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 | Chart | 非表示の行と列に使用する戦略。 |
戻る
Embedded
- チェーン用のこのビルダー
set Legend Position(position)
グラフに対する凡例の位置を設定します。デフォルトでは、凡例はありません。
// Creates a line chart builder and sets the legend position to right. const builder = Charts.newLineChart(); builder.setLegendPosition(Charts.Position.RIGHT);
パラメータ
名前 | 型 | 説明 |
---|---|---|
position | Position | 凡例の位置。 |
戻る
Embedded
- このビルダーはチェーンに役立ちます。
set Legend Text Style(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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
text | Text | グラフの凡例に使用するテキスト スタイル。 |
戻る
Embedded
- このビルダーはチェーンに役立ちます。
set Merge Strategy(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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
merge | Chart | 使用する統合戦略。 |
戻る
Embedded
- チェーン用のこのビルダー
set Num Headers(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 | ヘッダーとして扱う行または列の数。負の値を指定すると、ヘッダーが自動的に検出されます。 |
戻る
Embedded
- チェーン用のこのビルダー
set Option(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 | オプションの値。 |
戻る
Embedded
- チェーン用のこのビルダー。
set Point Style(style)
線のポイントのスタイルを設定します。デフォルトでは、ポイントに特定のスタイルはなく、線のみが表示されます。
// Creates a line chart builder and sets large point style. const builder = Charts.newLineChart(); builder.setPointStyle(Charts.PointStyle.LARGE);
パラメータ
名前 | 型 | 説明 |
---|---|---|
style | Point | 線のポイントに使用するスタイル。 |
戻る
Embedded
- このビルダーはチェーンに役立ちます。
関連情報
set Position(anchorRowPos, anchorColPos, offsetX, offsetY)
位置を設定して、シート上のグラフの表示位置を変更します。anchor
と anchor
は 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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
anchor | Integer | グラフの上部がこの行に固定されます。 |
anchor | Integer | グラフの左側はこの列に固定されます。 |
offsetX | Integer | グラフの右上隅がこのピクセル数だけオフセットされます。 |
offsetY | Integer | グラフの左下隅がこのピクセル数だけオフセットされます。 |
戻る
Embedded
- チェーン用のこのビルダー
set Range(start, end)
グラフの範囲を設定します。
データポイントが範囲外にある場合は、そのデータポイントを含むように範囲が拡大されます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Number | 範囲軸の最下位のグリッド線の値。 |
end | Number | 範囲軸の最も高いグリッド線の値。 |
戻る
Embedded
- このビルダーはチェーンに役立ちます。
set Stacked()
積み上げ線を使用します。つまり、線と棒の値が積み上げ(累積)されます。デフォルトでは、スタッキングは行われません。
戻る
Embedded
- このビルダーはチェーンに役立ちます。
set Title(chartTitle)
グラフのタイトルを設定します。タイトルはグラフの上に中央に表示されます。
// Creates a line chart builder and title to 'My Line Chart'. const builder = Charts.newLineChart(); builder.setTitle('My Line Chart');
パラメータ
名前 | 型 | 説明 |
---|---|---|
chart | String | グラフのタイトル。 |
戻る
Embedded
- このビルダーはチェーンに役立ちます。
set Title Text Style(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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
text | Text | グラフのタイトルに使用するテキスト スタイル。Text オブジェクトを作成するには、Charts.newTextStyle() を呼び出します。 |
戻る
Embedded
- このビルダーはチェーンに役立ちます。
set Transpose Rows And Columns(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 の場合、グラフの作成に使用される行と列が転置されます。 |
戻る
Embedded
- チェーン用のこのビルダー
set XAxis Text Style(textStyle)
横軸のテキスト スタイルを設定します。
// Creates a line chart builder and sets the X-axis text style to blue, 18-point // font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setXAxisTextStyle(textStyle);
パラメータ
名前 | 型 | 説明 |
---|---|---|
text | Text | 横軸のタイトルに使用するテキスト スタイル。Text オブジェクトを作成するには、Charts.newTextStyle() を呼び出します。 |
戻る
Embedded
- このビルダーはチェーンに役立ちます。
set XAxis Title(title)
横軸にタイトルを追加します。タイトルは中央に配置され、軸値ラベルの下に表示されます。
// Creates a line chart builder and sets the X-axis title. const builder = Charts.newLineChart(); builder.setTitle('X-axis Title');
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | X 軸のタイトル。 |
戻る
Embedded
- このビルダーはチェーンに役立ちます。
set XAxis Title Text Style(textStyle)
横軸のタイトル テキストのスタイルを設定します。
// Creates a line chart builder and sets the X-axis title text style to blue, // 18-point font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setXAxisTitleTextStyle(textStyle);
パラメータ
名前 | 型 | 説明 |
---|---|---|
text | Text | 横軸のタイトルに使用するテキスト スタイル。Text オブジェクトを作成するには、Charts.newTextStyle() を呼び出します。 |
戻る
Embedded
- このビルダーはチェーンに役立ちます。
set YAxis Text Style(textStyle)
縦軸のテキスト スタイルを設定します。
// Creates a line chart builder and sets the Y-axis text style to blue, 18-point // font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setYAxisTextStyle(textStyle);
パラメータ
名前 | 型 | 説明 |
---|---|---|
text | Text | 横軸のタイトルに使用するテキスト スタイル。Text オブジェクトを作成するには、Charts.newTextStyle() を呼び出します。 |
戻る
Embedded
- このビルダーはチェーンに役立ちます。
set YAxis Title(title)
縦軸にタイトルを追加します。タイトルは中央に配置され、値ラベルの左側に表示されます。
// Creates a line chart builder and sets the Y-axis title. const builder = Charts.newLineChart(); builder.setYAxisTitle('Y-axis Title');
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | Y 軸のタイトル。 |
戻る
Embedded
- このビルダーはチェーンに役立ちます。
set YAxis Title Text Style(textStyle)
縦軸のタイトル テキストのスタイルを設定します。
// Creates a line chart builder and sets the Y-axis title text style to blue, // 18-point font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setYAxisTitleTextStyle(textStyle);
パラメータ
名前 | 型 | 説明 |
---|---|---|
text | Text | 横軸のタイトルに使用するテキスト スタイル。Text オブジェクトを作成するには、Charts.newTextStyle() を呼び出します。 |
戻る
Embedded
- このビルダーはチェーンに役立ちます。
use Log Scale()
範囲軸を対数目盛にします(すべての値が正である必要があります)。範囲軸は、縦型グラフ(折れ線グラフ、面グラフ、縦棒グラフなど)では縦軸、横型グラフ(棒グラフなど)では横軸です。
戻る
Embedded
- このビルダーはチェーンに役立ちます。