Excel.SlicerCollection class

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

ブックまたはワークシート上のすべてのスライサーオブジェクトのコレクションを表します。Represents a collection of all the slicer objects on the workbook or a worksheet.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

Extends

プロパティ

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

items

このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.

メソッド

add(slicerSource, sourceField, slicerDestination)

ブックに新しいスライサーを追加します。Adds a new slicer to the workbook.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getCount()

コレクションに含まれるスライサーの数を返します。Returns the number of slicers in the collection.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItem(key)

名前または ID を使用してスライサー オブジェクトを取得します。Gets a slicer object using its name or id.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItemAt(index)

コレクション内の位置に基づいてスライサーを取得します。Gets a slicer based on its position in the collection.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItemOrNullObject(key)

名前または ID に基づいてスライサーを取得します。スライサーが存在しない場合は null オブジェクトを返します。Gets a slicer using its name or id. If the slicer does not exist, will return a null object.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(option)
toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元Excel.SlicerCollectionのオブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.SlicerCollectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.SlicerCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.SlicerCollectionData) を使用して、コレクションのアイテムから読み込まれたプロパティの浅いコピーを持つ "items" 配列を含みます。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

プロパティの詳細

context

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

items

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.

readonly items: Excel.Slicer[];

プロパティ値

Excel.Slicer[]

メソッドの詳細

add(slicerSource, sourceField, slicerDestination)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

ブックに新しいスライサーを追加します。Adds a new slicer to the workbook.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

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

パラメーター

slicerSource
string | PivotTable | Table

新しいスライサーの基となるデータソース。The data source that the new slicer will be based on. PivotTable オブジェクト、Table オブジェクト、または文字列を指定できます。It can be a PivotTable object, a Table object or a string. PivotTable オブジェクトが渡されると、データソースは PivotTable オブジェクトのソースになります。When a PivotTable object is passed, the data source is the source of the PivotTable object. Table オブジェクトが渡されると、データソースは Table オブジェクトになります。When a Table object is passed, the data source is the Table object. 文字列が渡されると、PivotTable/Table の名前または id として解釈されます。When a string is passed, it is interpreted as the name/id of a PivotTable/Table.

sourceField
string | PivotField | number | TableColumn

フィルター処理の対象となるデータソース内のフィールド。The field in the data source to filter by. PivotField オブジェクト、TableColumn オブジェクト、PivotField の id、または TableColumn の id または名前を指定できます。It can be a PivotField object, a TableColumn object, the id of a PivotField or the id/name of TableColumn.

slicerDestination
string | Worksheet

省略可能。Optional. 新しいスライサーを作成するワークシートを指定します。The worksheet where the new slicer will be created in. ワークシートオブジェクト、またはワークシートの名前/id を指定できます。It can be a Worksheet object or the name/id of a worksheet. スライサーコレクションをワークシートから取得する場合は、このパラメーターを省略できます。This parameter can be omitted if the slicer collection is retrieved from worksheet.

戻り値

新しいスライサー。The new slicer.

Examples

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()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

コレクションに含まれるスライサーの数を返します。Returns the number of slicers in the collection.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

getItem(key)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

名前または ID を使用してスライサー オブジェクトを取得します。Gets a slicer object using its name or id.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItem(key: string): Excel.Slicer;

パラメーター

key
string

スライサーの名前または id。The name or id of the slicer.

戻り値

Examples

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)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

コレクション内の位置に基づいてスライサーを取得します。Gets a slicer based on its position in the collection.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItemAt(index: number): Excel.Slicer;

パラメーター

index
number

取得するオブジェクトのインデックス値。Index value of the object to be retrieved. 0 を起点とする番号になります。Zero-indexed.

戻り値

getItemOrNullObject(key)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

名前または ID に基づいてスライサーを取得します。スライサーが存在しない場合は null オブジェクトを返します。Gets a slicer using its name or id. If the slicer does not exist, will return a null object.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItemOrNullObject(key: string): Excel.Slicer;

パラメーター

key
string

取得するスライサーの名前または Id。Name or Id of the slicer to be retrieved.

戻り値

load(option)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

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

パラメーター

option
Excel.Interfaces.SlicerCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.SlicerCollection-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.SlicerCollection - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.SlicerCollection-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.SlicerCollection - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.SlicerCollection-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.SlicerCollection - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(option)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

パラメーター

戻り値

toJSON()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元Excel.SlicerCollectionのオブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.SlicerCollectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.SlicerCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.SlicerCollectionData) を使用して、コレクションのアイテムから読み込まれたプロパティの浅いコピーを持つ "items" 配列を含みます。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.SlicerCollectionData;

戻り値