Excel.SlicerItem class

パッケージ:

excel

スライサー内のスライサー項目を表します。

Extends

OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi 1.10 ]

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
hasData	値は、 true スライサー項目にデータがある場合です。
isSelected	値は、 true スライサー項目が選択されている場合です。 この値を設定すると、他のスライサー項目の選択された状態はクリアされません。 既定では、スライサー項目が選択されている唯一の項目の場合、選択を解除すると、すべての項目が選択されます。
key	スライサー アイテムを表す一意の値を表します。
name	Excel UI に表示されるタイトルを表します。

メソッド

load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
toJSON()	API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の Excel.SlicerItem オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.SlicerItemData型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

hasData

値は、 true スライサー項目にデータがある場合です。

readonly hasData: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.10 ]

isSelected

値は、 true スライサー項目が選択されている場合です。 この値を設定すると、他のスライサー項目の選択された状態はクリアされません。 既定では、スライサー項目が選択されている唯一の項目の場合、選択を解除すると、すべての項目が選択されます。

isSelected: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.10 ]

key

スライサー アイテムを表す一意の値を表します。

readonly key: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.10 ]

name

Excel UI に表示されるタイトルを表します。

readonly name: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.10 ]

メソッドの詳細

load(options)

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

load(options?: Excel.Interfaces.SlicerItemLoadOptions): Excel.SlicerItem;

パラメーター

options

Excel.Interfaces.SlicerItemLoadOptions

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

戻り値

Excel.SlicerItem

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

Excel.SlicerItem

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

戻り値

Excel.SlicerItem

set(properties, options)

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

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

パラメーター

properties

Excel.Interfaces.SlicerItemUpdateData

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

options

OfficeExtension.UpdateOptions

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

戻り値

void

set(properties)

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

set(properties: Excel.SlicerItem): void;

パラメーター

properties

Excel.SlicerItem

戻り値

void

toJSON()

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

toJSON(): Excel.Interfaces.SlicerItemData;

戻り値

Excel.Interfaces.SlicerItemData