Excel.ChartLegend class

グラフに凡例を表します。Represents the legend in a chart.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

Extends

プロパティ

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

format

塗りつぶしとフォントの書式設定を含む、グラフの凡例の書式設定を表します。Represents the formatting of a chart legend, which includes fill and font formatting. 値の取得のみ可能です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

height

グラフの凡例の高さをポイント単位で表します。Represents the height, in points, of the legend on the chart. 凡例が表示されていない場合は Null。Null if legend is not visible.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

left

グラフの凡例の左のポイントを表します。Represents the left, in points, of a chart legend. 凡例が表示されていない場合は Null。Null if legend is not visible.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

legendEntries

凡例に含まれる凡例エントリのコレクションを表します。Represents a collection of legendEntries in the legend. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

overlay

グラフの凡例をグラフの本体に重ねるかどうかを指定するブール型の値です。Boolean value for whether the chart legend should overlap with the main body of the chart.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

position

グラフの凡例の位置を表します。Represents the position of the legend on the chart. 詳細については、「ChartLegendPosition」を参照してください。See Excel.ChartLegendPosition for details.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

showShadow

凡例がグラフに影付きかどうかを表します。Represents if the legend has a shadow on the chart.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

top

グラフ凡例の上を表します。Represents the top of a chart legend.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

visible

ChartLegend オブジェクトを表示または非表示にするかを表すブール型の値。A boolean value the represents the visibility of a ChartLegend object.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

width

グラフの凡例の幅をポイント単位で表します。Represents the width, in points, of the legend on the chart. 凡例が表示されていない場合は Null。Null if legend is not visible.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

メソッド

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の chartlegend オブジェクトは API オブジェクトであるのに対してtoJSON 、メソッドはプレーンな JavaScript オブジェクト (として型指定されます) を返します。Excel.Interfaces.ChartLegendData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ChartLegend object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartLegendData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

プロパティの詳細

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

format

塗りつぶしとフォントの書式設定を含む、グラフの凡例の書式設定を表します。Represents the formatting of a chart legend, which includes fill and font formatting. 値の取得のみ可能です。Read-only.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

readonly format: Excel.ChartLegendFormat;

プロパティ値

height

グラフの凡例の高さをポイント単位で表します。Represents the height, in points, of the legend on the chart. 凡例が表示されていない場合は Null。Null if legend is not visible.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

height: number;

プロパティ値

number

left

グラフの凡例の左のポイントを表します。Represents the left, in points, of a chart legend. 凡例が表示されていない場合は Null。Null if legend is not visible.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

left: number;

プロパティ値

number

legendEntries

凡例に含まれる凡例エントリのコレクションを表します。Represents a collection of legendEntries in the legend. 読み取り専用です。Read-only.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

readonly legendEntries: Excel.ChartLegendEntryCollection;

プロパティ値

overlay

グラフの凡例をグラフの本体に重ねるかどうかを指定するブール型の値です。Boolean value for whether the chart legend should overlap with the main body of the chart.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

overlay: boolean;

プロパティ値

boolean

position

グラフの凡例の位置を表します。Represents the position of the legend on the chart. 詳細については、「ChartLegendPosition」を参照してください。See Excel.ChartLegendPosition for details.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

position: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom";

プロパティ値

Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom"

showShadow

凡例がグラフに影付きかどうかを表します。Represents if the legend has a shadow on the chart.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

showShadow: boolean;

プロパティ値

boolean

top

グラフ凡例の上を表します。Represents the top of a chart legend.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

top: number;

プロパティ値

number

visible

ChartLegend オブジェクトを表示または非表示にするかを表すブール型の値。A boolean value the represents the visibility of a ChartLegend object.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

visible: boolean;

プロパティ値

boolean

width

グラフの凡例の幅をポイント単位で表します。Represents the width, in points, of the legend on the chart. 凡例が表示されていない場合は Null。Null if legend is not visible.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

width: number;

プロパティ値

number

メソッドの詳細

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(option?: Excel.Interfaces.ChartLegendLoadOptions): Excel.ChartLegend;

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.ChartLegend-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.ChartLegend - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.ChartLegend-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.ChartLegend - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartLegend-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartLegend - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.ChartLegend;

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

Examples

// Get the position of Chart Legend from Chart1
Excel.run(function (ctx) { 
    var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    var legend = chart.legend;
    legend.load('position');
    return ctx.sync().then(function() {
            console.log(legend.position);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
// Set to show legend of Chart1 and make it on top of the chart.
Excel.run(function (ctx) { 
    var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.legend.visible = true;
    chart.legend.position = "top"; 
    chart.legend.overlay = false; 
    return ctx.sync().then(function() {
            console.log("Legend Shown ");
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartLegend;

パラメーター

propertyNamesAndPaths
{ select?: string; expand?: string; }

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.ChartLegendUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties
Interfaces.ChartLegendUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.ChartLegend): void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.ChartLegend): void;

パラメーター

properties
Excel.ChartLegend

戻り値

void

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の chartlegend オブジェクトは API オブジェクトであるのに対してtoJSON 、メソッドはプレーンな JavaScript オブジェクト (として型指定されます) を返します。Excel.Interfaces.ChartLegendData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ChartLegend object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartLegendData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ChartLegendData;

戻り値