Excel.ChartLegend class
グラフに凡例を表します。
- Extends
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| format | 塗りつぶしとフォントの書式設定を含むグラフ凡例の書式設定を表します。 |
| height | グラフ上の凡例の高さをポイント単位で指定します。 凡例が表示されていない場合は、値が |
| left | グラフ上の凡例の左の値 (ポイント単位) を指定します。 凡例が表示されていない場合は、値が |
| legend |
凡例に含まれる凡例エントリのコレクションを表します。 |
| overlay | グラフの凡例をグラフの本文と重ねるかどうかを指定します。 |
| position | グラフ上の凡例の位置を指定します。 詳細は「 |
| show |
凡例がグラフに影があるかどうかを指定します。 |
| top | グラフの凡例の先頭を指定します。 |
| visible | グラフの凡例を表示するかどうかを指定します。 |
| width | グラフ上の凡例の幅をポイント単位で指定します。 凡例が表示されていない場合は、値が |
メソッド
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
format
塗りつぶしとフォントの書式設定を含むグラフ凡例の書式設定を表します。
readonly format: Excel.ChartLegendFormat;プロパティ値
注釈
height
グラフ上の凡例の高さをポイント単位で指定します。 凡例が表示されていない場合は、値が null されます。
height: number;プロパティ値
number
注釈
left
グラフ上の凡例の左の値 (ポイント単位) を指定します。 凡例が表示されていない場合は、値が null されます。
left: number;プロパティ値
number
注釈
legendEntries
凡例に含まれる凡例エントリのコレクションを表します。
readonly legendEntries: Excel.ChartLegendEntryCollection;プロパティ値
注釈
overlay
position
グラフ上の凡例の位置を指定します。 詳細は「Excel.ChartLegendPosition」をご覧ください。
position: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom";プロパティ値
Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom"
注釈
showShadow
top
visible
width
グラフ上の凡例の幅をポイント単位で指定します。 凡例が表示されていない場合は、値が null されます。
width: number;プロパティ値
number
注釈
メソッドの詳細
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.ChartLegendLoadOptions): Excel.ChartLegend;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.ChartLegend;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
例
// Get the position of Chart Legend from Chart1.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
const legend = chart.legend;
legend.load('position');
await context.sync();
console.log(legend.position);
});
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartLegend;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.ChartLegendUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Excel.Interfaces.ChartLegendUpdateData
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.ChartLegend): void;パラメーター
- properties
- Excel.ChartLegend
返品
void
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.ChartLegend オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ChartLegendData と型指定) を返します。
toJSON(): Excel.Interfaces.ChartLegendData;