Excel.ChartBinOptions class
ヒストグラム図とパレート図のビンのオプションをカプセル化します。
- Extends
注釈
プロパティ
allow |
ビン オーバーフローがヒストグラム グラフまたはパレート グラフで有効かどうかを指定します。 |
allow |
ヒストグラム チャートまたはパレート チャートでビンアンダーフローを有効にするかどうかを指定します。 |
context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
count | ヒストグラム グラフまたはパレート グラフのビン数を指定します。 |
overflow |
ヒストグラム グラフまたはパレート グラフのビン オーバーフロー値を指定します。 |
type | ヒストグラム グラフまたはパレート グラフのビンの種類を指定します。 |
underflow |
ヒストグラム グラフまたはパレート グラフのビンアンダーフロー値を指定します。 |
width | ヒストグラム グラフまたはパレート グラフのビン幅の値を指定します。 |
メソッド
load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
toJSON() | API オブジェクトが |
プロパティの詳細
allowOverflow
ビン オーバーフローがヒストグラム グラフまたはパレート グラフで有効かどうかを指定します。
allowOverflow: boolean;
プロパティ値
boolean
注釈
allowUnderflow
ヒストグラム チャートまたはパレート チャートでビンアンダーフローを有効にするかどうかを指定します。
allowUnderflow: boolean;
プロパティ値
boolean
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;
プロパティ値
count
overflowValue
ヒストグラム グラフまたはパレート グラフのビン オーバーフロー値を指定します。
overflowValue: number;
プロパティ値
number
注釈
type
ヒストグラム グラフまたはパレート グラフのビンの種類を指定します。
type: Excel.ChartBinType | "Category" | "Auto" | "BinWidth" | "BinCount";
プロパティ値
Excel.ChartBinType | "Category" | "Auto" | "BinWidth" | "BinCount"
注釈
underflowValue
ヒストグラム グラフまたはパレート グラフのビンアンダーフロー値を指定します。
underflowValue: number;
プロパティ値
number
注釈
width
メソッドの詳細
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync()
を呼び出す必要があります。
load(options?: Excel.Interfaces.ChartBinOptionsLoadOptions): Excel.ChartBinOptions;
パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
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
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.ChartBinOptions): void;
パラメーター
- properties
- Excel.ChartBinOptions
戻り値
void
toJSON()
API オブジェクトがJSON.stringify()
に渡されたときにより便利な出力を提供するために、JavaScript toJSON()
メソッドをオーバーライドします。 (JSON.stringify
、それに渡されるオブジェクトの toJSON
メソッドを呼び出します)。元の Excel.ChartBinOptions オブジェクトは API オブジェクトですが、 toJSON
メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ChartBinOptionsData
として型指定) を返します。
toJSON(): Excel.Interfaces.ChartBinOptionsData;
戻り値
Office Add-ins