Excel.Chart class
ブック内のグラフ オブジェクトを表します。 グラフ オブジェクト モデルの詳細については、「 Excel JavaScript API を使用したグラフの操作」を参照してください。
- Extends
注釈
プロパティ
| axes | グラフの軸を表します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| data |
グラフのデータ ラベルを表します。 |
| format | グラフ領域の書式設定プロパティをカプセル化します。 |
| height | グラフ オブジェクトの高さをポイント単位で指定します。 |
| left | グラフの左側からワークシートの原点までの距離 (ポイント単位)。 |
| legend | グラフの凡例を表します。 |
| name | グラフ オブジェクトの名前を指定します。 |
| series | グラフの 1 つのデータ系列またはデータ系列のコレクションを表します。 |
| title | 指定したグラフのタイトル (タイトルのテキスト、表示/非表示、位置、書式設定など) を表します。 |
| top | オブジェクトの上端から行 1 の上端 (ワークシート上) またはグラフ領域 (グラフ上) の上端までの距離をポイント単位で指定します。 |
| width | グラフ オブジェクトの幅をポイント単位で指定します。 |
メソッド
| delete() | グラフ オブジェクトを削除します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| set |
グラフの元データをリセットします。 |
| set |
グラフの元データをリセットします。 |
| set |
ワークシート上のセルを基準にしてグラフを配置します。 |
| toJSON() | API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
プロパティの詳細
axes
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
dataLabels
グラフのデータ ラベルを表します。
readonly dataLabels: Excel.ChartDataLabels;プロパティ値
注釈
format
グラフ領域の書式設定プロパティをカプセル化します。
readonly format: Excel.ChartAreaFormat;プロパティ値
注釈
height
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();
});
series
グラフの 1 つのデータ系列またはデータ系列のコレクションを表します。
readonly series: Excel.ChartSeriesCollection;プロパティ値
注釈
title
指定したグラフのタイトル (タイトルのテキスト、表示/非表示、位置、書式設定など) を表します。
readonly title: Excel.ChartTitle;プロパティ値
注釈
top
オブジェクトの上端から行 1 の上端 (ワークシート上) またはグラフ領域 (グラフ上) の上端までの距離をポイント単位で指定します。
top: number;プロパティ値
number
注釈
width
メソッドの詳細
delete()
グラフ オブジェクトを削除します。
delete(): void;戻り値
void
注釈
例
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.delete();
await context.sync();
});
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 オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の Excel.Chart オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.ChartData型指定) を返します。
toJSON(): Excel.Interfaces.ChartData;戻り値
Office Add-ins
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示