Excel.SlicerCollection class

  • リファレンス
パッケージ:
excel

ブックまたはワークシート内のすべてのスライサー オブジェクトのコレクションを表します。

Extends
OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi 1.10 ]

プロパティ

context

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

このコレクション内に読み込まれた子アイテムを取得します。

メソッド

add(slicerSource, sourceField, slicerDestination)

ブックに新しいスライサーを追加します。
getCount()

コレクションに含まれるスライサーの数を返します。
getItem(key)

名前または ID を使用してスライサー オブジェクトを取得します。
getItemAt(index)

コレクション内の位置に基づいてスライサーを取得します。
getItemOrNullObject(key)

名前または ID を使用してスライサーを取得します。 スライサーが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
load(options)

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

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

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

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

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

items

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: Excel.Slicer[];

プロパティ値

Excel.Slicer[]

メソッドの詳細

add(slicerSource, sourceField, slicerDestination)

ブックに新しいスライサーを追加します。

add(slicerSource: string | PivotTable | Table, sourceField: string | PivotField | number | TableColumn, slicerDestination?: string | Worksheet): Excel.Slicer;

パラメーター

slicerSource

string | Excel.PivotTable | Excel.Table

新しいスライサーの基になるデータ ソース。 PivotTable オブジェクト、Table オブジェクト、または文字列を指定できます。 ピボットテーブル オブジェクトが渡されると、データ ソースは PivotTable オブジェクトのソースになります。 Table オブジェクトが渡されると、データ ソースは Table オブジェクトです。 文字列が渡されると、ピボットテーブルまたはテーブルの名前または ID として解釈されます。

sourceField

string | Excel.PivotField | number | Excel.TableColumn

フィルター処理するデータ ソースのフィールド。 PivotField オブジェクト、TableColumn オブジェクト、PivotFieldの ID、またはTableColumnの名前または ID を指定できます。

slicerDestination

string | Excel.Worksheet

省略可能。 新しいスライサーが作成されるワークシート。 Worksheet オブジェクト、またはワークシートの名前または ID を指定できます。 スライサー コレクションがワークシートから取得される場合は、このパラメーターを省略できます。

戻り値

Excel.Slicer

新しいスライサー。

注釈

[ API セット: ExcelApi 1.10 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Pivot");
    const slicer = sheet.slicers.add(
        "Farm Sales", /* The slicer data source. For PivotTables, this can be the PivotTable object reference or name. */
        "Type" /* The field in the data source to filter by. For PivotTables, this can be a PivotField object reference or ID. */
    );
    slicer.name = "Fruit Slicer";
    await context.sync();
});

getCount()

コレクションに含まれるスライサーの数を返します。

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

注釈

[ API セット: ExcelApi 1.10 ]

getItem(key)

名前または ID を使用してスライサー オブジェクトを取得します。

getItem(key: string): Excel.Slicer;

パラメーター

key

string

スライサーの名前または ID。

戻り値

Excel.Slicer

注釈

[ API セット: ExcelApi 1.10 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const slicer = context.workbook.slicers.getItem("Fruit Slicer");
    slicer.caption = "Fruit Types";
    slicer.left = 395;
    slicer.top = 15;
    slicer.height = 135;
    slicer.width = 150;
    await context.sync();
});

getItemAt(index)

コレクション内の位置に基づいてスライサーを取得します。

getItemAt(index: number): Excel.Slicer;

パラメーター

index

number

取得するオブジェクトのインデックス値。 0 を起点とする番号になります。

戻り値

Excel.Slicer

注釈

[ API セット: ExcelApi 1.10 ]

getItemOrNullObject(key)

名前または ID を使用してスライサーを取得します。 スライサーが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getItemOrNullObject(key: string): Excel.Slicer;

パラメーター

key

string

取得するスライサーの名前または ID。

戻り値

Excel.Slicer

注釈

[ API セット: ExcelApi 1.10 ]

load(options)

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

load(options?: Excel.Interfaces.SlicerCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerCollection;

パラメーター

options

Excel.Interfaces.SlicerCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

戻り値

Excel.SlicerCollection

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

Excel.SlicerCollection

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SlicerCollection;

パラメーター

propertyNamesAndPaths
OfficeExtension.LoadOption

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

戻り値

Excel.SlicerCollection

toJSON()

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

toJSON(): Excel.Interfaces.SlicerCollectionData;

戻り値

Excel.Interfaces.SlicerCollectionData