次の方法で共有


Excel.ChartBoxwhiskerOptions class

ボックス グラフとウィスカー グラフのプロパティを表します。

Extends

注釈

[ API セット: ExcelApi 1.9 ]

プロパティ

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

quartileCalculation

ボックス グラフとウィスカ グラフの四分位数計算の種類を指定します。

showInnerPoints

ボックス グラフとウィスカ グラフに内側のポイントを表示するかどうかを指定します。

showMeanLine

ボックスグラフとウィスカチャートに平均線を表示するかどうかを指定します。

showMeanMarker

平均マーカーをボックスグラフとウィスカチャートに表示するかどうかを指定します。

showOutlierPoints

外れ値の点を箱グラフとウィスカ グラフに表示するかどうかを指定します。

メソッド

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

toJSON()

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.ChartBoxwhiskerOptions オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ChartBoxwhiskerOptionsData として型指定) を返します。

プロパティの詳細

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

quartileCalculation

ボックス グラフとウィスカ グラフの四分位数計算の種類を指定します。

quartileCalculation: Excel.ChartBoxQuartileCalculation | "Inclusive" | "Exclusive";

プロパティ値

Excel.ChartBoxQuartileCalculation | "Inclusive" | "Exclusive"

注釈

[ API セット: ExcelApi 1.9 ]

showInnerPoints

ボックス グラフとウィスカ グラフに内側のポイントを表示するかどうかを指定します。

showInnerPoints: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

showMeanLine

ボックスグラフとウィスカチャートに平均線を表示するかどうかを指定します。

showMeanLine: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

showMeanMarker

平均マーカーをボックスグラフとウィスカチャートに表示するかどうかを指定します。

showMeanMarker: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

showOutlierPoints

外れ値の点を箱グラフとウィスカ グラフに表示するかどうかを指定します。

showOutlierPoints: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

メソッドの詳細

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions): Excel.ChartBoxwhiskerOptions;

パラメーター

options
Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

propertyNamesAndPaths

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

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

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

パラメーター

properties
Excel.Interfaces.ChartBoxwhiskerOptionsUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options
OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.ChartBoxwhiskerOptions): void;

パラメーター

戻り値

void

toJSON()

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.ChartBoxwhiskerOptions オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ChartBoxwhiskerOptionsData として型指定) を返します。

toJSON(): Excel.Interfaces.ChartBoxwhiskerOptionsData;

戻り値