Excel.ChartBinOptions class

ヒストグラム図とパレート図のビンのオプションをカプセル化します。

Extends

プロパティ

allowOverflow

ヒストグラム図またはパレート図でビン オーバーフローが有効かどうかを指定します。

allowUnderflow

ヒストグラム チャートまたはパレート チャートでビン アンダーフローが有効かどうかを指定します。

context

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

count

ヒストグラム図またはパレート図のビン数を指定します。

overflowValue

ヒストグラム図またはパレート図のビン オーバーフロー値を指定します。

type

ヒストグラム図またはパレート図のビンの種類を指定します。

underflowValue

ヒストグラム グラフまたはパレート図のビン アンダーフロー値を指定します。

width

ヒストグラム図またはパレート図のビン幅の値を指定します。

メソッド

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.ChartBinOptions オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ChartBinOptionsData と型指定) を返します。

プロパティの詳細

allowOverflow

ヒストグラム図またはパレート図でビン オーバーフローが有効かどうかを指定します。

allowOverflow: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

allowUnderflow

ヒストグラム チャートまたはパレート チャートでビン アンダーフローが有効かどうかを指定します。

allowUnderflow: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

context

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

context: RequestContext;

プロパティ値

count

ヒストグラム図またはパレート図のビン数を指定します。

count: number;

プロパティ値

number

注釈

API セット: ExcelApi 1.9

overflowValue

ヒストグラム図またはパレート図のビン オーバーフロー値を指定します。

overflowValue: number;

プロパティ値

number

注釈

API セット: ExcelApi 1.9

type

ヒストグラム図またはパレート図のビンの種類を指定します。

type: Excel.ChartBinType | "Category" | "Auto" | "BinWidth" | "BinCount";

プロパティ値

Excel.ChartBinType | "Category" | "Auto" | "BinWidth" | "BinCount"

注釈

API セット: ExcelApi 1.9

underflowValue

ヒストグラム グラフまたはパレート図のビン アンダーフロー値を指定します。

underflowValue: number;

プロパティ値

number

注釈

API セット: ExcelApi 1.9

width

ヒストグラム図またはパレート図のビン幅の値を指定します。

width: number;

プロパティ値

number

注釈

API セット: ExcelApi 1.9

メソッドの詳細

load(options)

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

load(options?: Excel.Interfaces.ChartBinOptionsLoadOptions): Excel.ChartBinOptions;

パラメーター

options
Excel.Interfaces.ChartBinOptionsLoadOptions

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

返品

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

返品

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

返品

set(properties, options)

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

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

パラメーター

properties
Excel.Interfaces.ChartBinOptionsUpdateData

メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。

options
OfficeExtension.UpdateOptions

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

返品

void

set(properties)

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

set(properties: Excel.ChartBinOptions): void;

パラメーター

返品

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartBinOptionsData;

返品