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
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
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;
戻り値
Office Add-ins