Excel.Chart class
ブック内のグラフ オブジェクトを表します。 グラフ オブジェクト モデルの詳細については、「Excel JavaScript API を使用してグラフを操作する」を参照してください。
- Extends
注釈
プロパティ
axes | グラフの軸を表します。 |
category |
ソース カテゴリ ラベルのレベルを参照するグラフ カテゴリ ラベル レベル列挙定数を指定します。 |
chart |
グラフの種類を指定します。 詳細は「 |
context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
data |
グラフのデータ ラベルを表します。 |
display |
空白のセルをグラフにプロットする方法を指定します。 |
format | グラフ領域の書式設定プロパティをカプセル化します。 |
height | グラフ オブジェクトの高さをポイント単位で指定します。 |
id | グラフの一意の ID。 |
left | グラフの左側からワークシートの原点までの距離 (ポイント単位)。 |
legend | グラフの凡例を表します。 |
name | グラフ オブジェクトの名前を指定します。 |
pivot |
ピボット グラフのオプションをカプセル化します。 |
plot |
グラフのプロット領域を表します。 |
plot |
列や行がグラフのデータ系列として使用される方法を指定します。 |
plot |
true の場合、可視セルだけがプロットされます。 false の場合、可視セルと非表示セルの両方がプロットされます。 |
series | グラフの 1 つのデータ系列またはデータ系列のコレクションを表します。 |
series |
ソース系列名のレベルを参照するグラフ系列名レベル列挙定数を指定します。 |
show |
ピボットグラフにすべてのフィールド ボタンを表示するかどうかを指定します。 |
show |
値が値軸の最大値より大きい場合にデータ ラベルを表示するかどうかを指定します。 値軸がデータ ポイントのサイズよりも小さくなった場合は、このプロパティを使用して、データ ラベルを表示するかどうかを設定できます。 このプロパティは、2-D グラフにのみ使用できます。 |
style | グラフのグラフ スタイルを指定します。 |
title | 指定したグラフのタイトル (タイトルのテキスト、表示/非表示、位置、書式設定など) を表します。 |
top | オブジェクトの上端から行 1 の上端 (ワークシート上) またはグラフ領域 (グラフ上) の上端までの距離をポイント単位で指定します。 |
width | グラフ オブジェクトの幅をポイント単位で指定します。 |
worksheet | 現在のグラフを含んでいるワークシート。 |
メソッド
activate() | Excel UI でグラフをアクティブにします。 |
delete() | グラフ オブジェクトを削除します。 |
get |
グラフ全体のデータ ソースを取得します。 データ範囲が空の場合、このメソッドは |
get |
グラフ全体のデータ ソースを取得します。 データ範囲が空の場合、このメソッドは |
get |
グラフのデータ テーブルを取得します。 グラフでデータ テーブルが許可されていない場合は、例外がスローされます。 |
get |
グラフのデータ テーブルを取得します。 グラフでデータ テーブルが許可されていない場合、このメソッドは |
get |
指定したディメンションに合わせてグラフをスケーリングすることで、グラフを Base64 でエンコードされたイメージとしてレンダリングします。 縦横比は、サイズ変更の一部として保持されます。 |
get |
指定したディメンションに合わせてグラフをスケーリングすることで、グラフを Base64 でエンコードされたイメージとしてレンダリングします。 縦横比は、サイズ変更の一部として保持されます。 |
load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
set |
グラフの元データをリセットします。 |
set |
グラフの元データをリセットします。 |
set |
ワークシート上のセルを基準にしてグラフを配置します。 |
toJSON() | API オブジェクトが |
イベント
on |
グラフがアクティブになったときに発生します。 |
on |
グラフが非アクティブ化されたときに発生します。 |
プロパティの詳細
axes
categoryLabelLevel
ソース カテゴリ ラベルのレベルを参照するグラフ カテゴリ ラベル レベル列挙定数を指定します。
categoryLabelLevel: number;
プロパティ値
number
注釈
chartType
グラフの種類を指定します。 詳細は「Excel.ChartType
」をご覧ください。
chartType: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel";
プロパティ値
Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel"
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;
プロパティ値
dataLabels
グラフのデータ ラベルを表します。
readonly dataLabels: Excel.ChartDataLabels;
プロパティ値
注釈
displayBlanksAs
空白のセルをグラフにプロットする方法を指定します。
displayBlanksAs: Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted";
プロパティ値
Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted"
注釈
format
グラフ領域の書式設定プロパティをカプセル化します。
readonly format: Excel.ChartAreaFormat;
プロパティ値
注釈
height
id
left
legend
グラフの凡例を表します。
readonly legend: Excel.ChartLegend;
プロパティ値
注釈
例
// Set to show legend of Chart1 and make it on top of the chart.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.legend.visible = true;
chart.legend.position = "Top";
chart.legend.overlay = false;
await context.sync()
console.log("Legend Shown ");
});
name
グラフ オブジェクトの名前を指定します。
name: string;
プロパティ値
string
注釈
例
// Rename the chart to new name, resize the chart to 200 points in both height and weight.
// Move Chart1 to 100 points to the top and left.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.name = "New Name";
chart.top = 100;
chart.left = 100;
chart.height = 200;
chart.width = 200;
await context.sync();
});
pivotOptions
ピボット グラフのオプションをカプセル化します。
readonly pivotOptions: Excel.ChartPivotOptions;
プロパティ値
注釈
plotArea
グラフのプロット領域を表します。
readonly plotArea: Excel.ChartPlotArea;
プロパティ値
注釈
plotBy
列や行がグラフのデータ系列として使用される方法を指定します。
plotBy: Excel.ChartPlotBy | "Rows" | "Columns";
プロパティ値
Excel.ChartPlotBy | "Rows" | "Columns"
注釈
plotVisibleOnly
true の場合、可視セルだけがプロットされます。 false の場合、可視セルと非表示セルの両方がプロットされます。
plotVisibleOnly: boolean;
プロパティ値
boolean
注釈
series
グラフの 1 つのデータ系列またはデータ系列のコレクションを表します。
readonly series: Excel.ChartSeriesCollection;
プロパティ値
注釈
seriesNameLevel
ソース系列名のレベルを参照するグラフ系列名レベル列挙定数を指定します。
seriesNameLevel: number;
プロパティ値
number
注釈
showAllFieldButtons
ピボットグラフにすべてのフィールド ボタンを表示するかどうかを指定します。
showAllFieldButtons: boolean;
プロパティ値
boolean
注釈
showDataLabelsOverMaximum
値が値軸の最大値より大きい場合にデータ ラベルを表示するかどうかを指定します。 値軸がデータ ポイントのサイズよりも小さくなった場合は、このプロパティを使用して、データ ラベルを表示するかどうかを設定できます。 このプロパティは、2-D グラフにのみ使用できます。
showDataLabelsOverMaximum: boolean;
プロパティ値
boolean
注釈
style
title
指定したグラフのタイトル (タイトルのテキスト、表示/非表示、位置、書式設定など) を表します。
readonly title: Excel.ChartTitle;
プロパティ値
注釈
top
オブジェクトの上端から行 1 の上端 (ワークシート上) またはグラフ領域 (グラフ上) の上端までの距離をポイント単位で指定します。
top: number;
プロパティ値
number
注釈
width
worksheet
現在のグラフを含んでいるワークシート。
readonly worksheet: Excel.Worksheet;
プロパティ値
注釈
メソッドの詳細
activate()
delete()
グラフ オブジェクトを削除します。
delete(): void;
戻り値
void
注釈
例
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.delete();
await context.sync();
});
getDataRange()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
グラフ全体のデータ ソースを取得します。 データ範囲が空の場合、このメソッドは EmptyChartSeries
エラーを返します。
getDataRange(): OfficeExtension.ClientResult<string>;
戻り値
OfficeExtension.ClientResult<string>
注釈
getDataRangeOrNullObject()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
グラフ全体のデータ ソースを取得します。 データ範囲が空の場合、このメソッドは isNullObject
プロパティを true
に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getDataRangeOrNullObject(): OfficeExtension.ClientResult<string>;
戻り値
OfficeExtension.ClientResult<string>
注釈
getDataTable()
グラフのデータ テーブルを取得します。 グラフでデータ テーブルが許可されていない場合は、例外がスローされます。
getDataTable(): Excel.ChartDataTable;
戻り値
注釈
getDataTableOrNullObject()
グラフのデータ テーブルを取得します。 グラフでデータ テーブルが許可されていない場合、このメソッドは isNullObject
プロパティを true
に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getDataTableOrNullObject(): Excel.ChartDataTable;
戻り値
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-table.yaml
// This function adds a data table to a chart that already exists on the worksheet.
await Excel.run(async (context) => {
// Retrieve the chart named "SalesChart" from the "Sample" worksheet.
const chart = context.workbook.worksheets.getItem("Sample").charts.getItem("SalesChart");
// Get the data table object for the chart and set it to visible.
const chartDataTable = chart.getDataTableOrNullObject();
chartDataTable.load("visible");
chartDataTable.visible = true;
await context.sync();
});
getImage(width, height, fittingMode)
指定したディメンションに合わせてグラフをスケーリングすることで、グラフを Base64 でエンコードされたイメージとしてレンダリングします。 縦横比は、サイズ変更の一部として保持されます。
getImage(width?: number, height?: number, fittingMode?: Excel.ImageFittingMode): OfficeExtension.ClientResult<string>;
パラメーター
- width
-
number
省略可能。 結果の画像の希望する幅。
- height
-
number
省略可能。 結果の画像の希望する高さ。
- fittingMode
- Excel.ImageFittingMode
省略可能。 グラフを指定したディメンションにスケーリングするために使用するメソッド (高さと幅の両方が設定されている場合)。
戻り値
OfficeExtension.ClientResult<string>
注釈
例
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
const image = chart.getImage();
await context.sync();
});
getImage(width, height, fittingModeString)
指定したディメンションに合わせてグラフをスケーリングすることで、グラフを Base64 でエンコードされたイメージとしてレンダリングします。 縦横比は、サイズ変更の一部として保持されます。
getImage(width?: number, height?: number, fittingModeString?: "Fit" | "FitAndCenter" | "Fill"): OfficeExtension.ClientResult<string>;
パラメーター
- width
-
number
省略可能。 結果の画像の希望する幅。
- height
-
number
省略可能。 結果の画像の希望する高さ。
- fittingModeString
-
"Fit" | "FitAndCenter" | "Fill"
省略可能。 グラフを指定したディメンションにスケーリングするために使用するメソッド (高さと幅の両方が設定されている場合)。
戻り値
OfficeExtension.ClientResult<string>
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync()
を呼び出す必要があります。
load(options?: Excel.Interfaces.ChartLoadOptions): Excel.Chart;
パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync()
を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.Chart;
パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
例
// Get a chart named "Chart1".
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.load('name');
await context.sync();
console.log(chart.name);
});
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync()
を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Chart;
パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand
は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.ChartUpdateData, options?: OfficeExtension.UpdateOptions): void;
パラメーター
- properties
- Excel.Interfaces.ChartUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.Chart): void;
パラメーター
- properties
- Excel.Chart
戻り値
void
setData(sourceData, seriesBy)
グラフの元データをリセットします。
setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy): void;
パラメーター
- sourceData
- Excel.Range
ソース データに対応する range オブジェクト。
- seriesBy
- Excel.ChartSeriesBy
列や行がグラフのデータ系列として使用される方法を指定します。 自動 (既定値)、行、列のいずれかを指定できます。 詳細は「Excel.ChartSeriesBy
」をご覧ください。
戻り値
void
注釈
例
// Set the sourceData to be the range at "A1:B4" and seriesBy to be "Columns".
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sheet1");
const chart = sheet.charts.getItem("Chart1");
const sourceData = sheet.getRange("A1:B4");
chart.setData(sourceData, "Columns");
await context.sync();
});
setData(sourceData, seriesByString)
グラフの元データをリセットします。
setData(sourceData: Range, seriesByString?: "Auto" | "Columns" | "Rows"): void;
パラメーター
- sourceData
- Excel.Range
ソース データに対応する range オブジェクト。
- seriesByString
-
"Auto" | "Columns" | "Rows"
列や行がグラフのデータ系列として使用される方法を指定します。 自動 (既定値)、行、列のいずれかを指定できます。 詳細は「Excel.ChartSeriesBy
」をご覧ください。
戻り値
void
注釈
setPosition(startCell, endCell)
ワークシート上のセルを基準にしてグラフを配置します。
setPosition(startCell: Range | string, endCell?: Range | string): void;
パラメーター
- startCell
-
Excel.Range | string
開始セル。 これは、グラフの移動先です。 開始セルは、ユーザーの右から左への表示の設定に応じて、左上のセルか、右上のセルとなります。
- endCell
-
Excel.Range | string
省略可能。 終了セル。 指定されている場合、グラフの幅と高さは、このセルまたは範囲を完全にカバーするように設定されます。
戻り値
void
注釈
例
await Excel.run(async (context) => {
const sheetName = "Charts";
const rangeSelection = "A1:B4";
const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeSelection);
const sourceData = sheetName + "!" + "A1:B4";
const chart = context.workbook.worksheets.getItem(sheetName).charts.add("pie", range, "auto");
chart.width = 500;
chart.height = 300;
chart.setPosition("C2", null);
await context.sync();
});
toJSON()
API オブジェクトがJSON.stringify()
に渡されたときにより便利な出力を提供するために、JavaScript toJSON()
メソッドをオーバーライドします。 (JSON.stringify
、それに渡されるオブジェクトの toJSON
メソッドを呼び出します)。元の Excel.Chart
オブジェクトは API オブジェクトですが、 toJSON
メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ChartData
として型指定) を返します。
toJSON(): Excel.Interfaces.ChartData;
戻り値
イベントの詳細
onActivated
グラフがアクティブになったときに発生します。
readonly onActivated: OfficeExtension.EventHandlers<Excel.ChartActivatedEventArgs>;
イベントの種類
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-chart-activated.yaml
await Excel.run(async (context) => {
const pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");
// Register the onActivated and onDeactivated event handlers.
pieChart.onActivated.add(chartActivated);
pieChart.onDeactivated.add(chartDeactivated);
await context.sync();
console.log("Added handlers for Chart onActivated and onDeactivated events.");
});
...
async function chartActivated(event) {
await Excel.run(async (context) => {
// Retrieve the worksheet.
const sheet = context.workbook.worksheets.getActiveWorksheet();
// Retrieve the activated chart by ID and load the name of the chart.
const activatedChart = sheet.charts.getItem(event.chartId);
activatedChart.load(["name"]);
await context.sync();
// Print out the activated chart's data.
console.log(`A chart was activated. ID: ${event.chartId}. Chart name: ${activatedChart.name}.`);
});
}
onDeactivated
グラフが非アクティブ化されたときに発生します。
readonly onDeactivated: OfficeExtension.EventHandlers<Excel.ChartDeactivatedEventArgs>;
イベントの種類
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-chart-activated.yaml
await Excel.run(async (context) => {
const pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");
// Register the onActivated and onDeactivated event handlers.
pieChart.onActivated.add(chartActivated);
pieChart.onDeactivated.add(chartDeactivated);
await context.sync();
console.log("Added handlers for Chart onActivated and onDeactivated events.");
});
...
async function chartDeactivated(event) {
await Excel.run(async (context) => {
// Callback function for when the chart is deactivated.
console.log("The pie chart is NOT active.");
});
}
Office Add-ins