Excel.Slicer class

リファレンス

パッケージ:: excel

ブック内の Slicer オブジェクトを表します。

Extends: OfficeExtension.ClientObject

注釈

プロパティ

caption	スライサーのキャプションを表します。
context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
height	スライサーの高さ (ポイント数) を表します。負の値または 0 を入力として設定すると、 `InvalidArgument` 例外がスローされます。
id	スライサーの一意の ID を表します。
isFilterCleared	スライサーに現在適用されているすべてのフィルターがクリアされている場合、値は `true` されます。
left	スライサーの左側からワークシートの左までの距離を表します (ポイント数)。負の値を入力として設定すると、 `InvalidArgument` エラーがスローされます。
name	スライサーの名前を表します。
nameInFormula	数式で使用するスライサーの名前を表します。
slicerItems	スライサーの一部であるスライサー項目のコレクションを表します。
slicerStyle	スライサーに適用されるスタイル。
sortBy	スライサーに含まれるアイテムの並べ替え順序を表します。使用可能な値は、"DataSourceOrder"、"昇順"、"降順" です。
style	スライサースタイルを表す定数値。使用可能な値は、"SlicerStyleLight1" から "SlicerStyleLight6"、"TableStyleOther1" から "TableStyleOther2"、"SlicerStyleDark1" から "SlicerStyleDark6" です。ブックに存在するカスタムのユーザー定義スタイルも指定できます。
top	スライサーの上端からワークシートの上端までの距離を表します (ポイント数)。負の値を入力として設定すると、 `InvalidArgument` エラーがスローされます。
width	スライサーの幅 (ポイント数) を表します。負の値または 0 を入力として設定すると、 `InvalidArgument` エラーがスローされます。
worksheet	スライサーを含んでいるワークシートを表します。

メソッド

clearFilters()	現在スライサーに適用されているすべてのフィルターを消去します。
delete()	スライサーを削除します。
getSelectedItems()	選択されたアイテムのキーの配列を返します。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
selectItems(items)	キーに基づいてスライサー項目を選択します。前の選択はクリアされます。配列が空の場合、すべての項目が既定で選択されます。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
setStyle(style)	スライサーに適用されるスタイルを設定します。
toJSON()	API オブジェクトが`JSON.stringify()`に渡されたときにより便利な出力を提供するために、JavaScript `toJSON()` メソッドをオーバーライドします。 (`JSON.stringify`、それに渡されるオブジェクトの `toJSON` メソッドを呼び出します)。元の `Excel.Slicer` オブジェクトは API オブジェクトですが、 `toJSON` メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( `Excel.Interfaces.SlicerData` として型指定) を返します。

プロパティの詳細

caption

スライサーのキャプションを表します。

caption: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.10 ]

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

height

スライサーの高さ (ポイント数) を表します。負の値または 0 を入力として設定すると、 InvalidArgument 例外がスローされます。

height: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.10 ]

id

スライサーの一意の ID を表します。

readonly id: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.10 ]

isFilterCleared

スライサーに現在適用されているすべてのフィルターがクリアされている場合、値は true されます。

readonly isFilterCleared: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.10 ]

left

スライサーの左側からワークシートの左までの距離を表します (ポイント数)。負の値を入力として設定すると、 InvalidArgument エラーがスローされます。

left: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.10 ]

name

スライサーの名前を表します。

name: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.10 ]

nameInFormula

注意

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

数式で使用するスライサーの名前を表します。

nameInFormula: string;

プロパティ値

string

注釈

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

slicerItems

スライサーの一部であるスライサー項目のコレクションを表します。

readonly slicerItems: Excel.SlicerItemCollection;

プロパティ値

Excel.SlicerItemCollection

注釈

[ API セット: ExcelApi 1.10 ]

slicerStyle

注意

スライサーに適用されるスタイル。

readonly slicerStyle: Excel.SlicerStyle;

プロパティ値

Excel.SlicerStyle

注釈

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

sortBy

スライサーに含まれるアイテムの並べ替え順序を表します。使用可能な値は、"DataSourceOrder"、"昇順"、"降順" です。

sortBy: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending";

プロパティ値

Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"

注釈

[ API セット: ExcelApi 1.10 ]

style

スライサースタイルを表す定数値。使用可能な値は、"SlicerStyleLight1" から "SlicerStyleLight6"、"TableStyleOther1" から "TableStyleOther2"、"SlicerStyleDark1" から "SlicerStyleDark6" です。ブックに存在するカスタムのユーザー定義スタイルも指定できます。

style: string;

プロパティ値

string

注釈

[ 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.style = "SlicerStyleLight6";
    await context.sync();
});

top

スライサーの上端からワークシートの上端までの距離を表します (ポイント数)。負の値を入力として設定すると、 InvalidArgument エラーがスローされます。

top: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.10 ]

width

スライサーの幅 (ポイント数) を表します。負の値または 0 を入力として設定すると、 InvalidArgument エラーがスローされます。

width: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.10 ]

worksheet

スライサーを含んでいるワークシートを表します。

readonly worksheet: Excel.Worksheet;

プロパティ値

Excel.Worksheet

注釈

[ API セット: ExcelApi 1.10 ]

メソッドの詳細

clearFilters()

現在スライサーに適用されているすべてのフィルターを消去します。

clearFilters(): void;

戻り値

void

注釈

[ 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.clearFilters();
    await context.sync();
});

delete()

スライサーを削除します。

delete(): void;

戻り値

void

注釈

[ 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.getActiveWorksheet();
    sheet.slicers.getItemAt(0).delete();
    await context.sync();
});

getSelectedItems()

選択されたアイテムのキーの配列を返します。

getSelectedItems(): OfficeExtension.ClientResult<string[]>;

戻り値

OfficeExtension.ClientResult<string[]>

注釈

[ API セット: ExcelApi 1.10 ]

load(options)

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

load(options?: Excel.Interfaces.SlicerLoadOptions): Excel.Slicer;

パラメーター

options: Excel.Interfaces.SlicerLoadOptions

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

戻り値

Excel.Slicer

load(propertyNames)

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

パラメーター

propertyNames: string | string[]

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

戻り値

Excel.Slicer

load(propertyNamesAndPaths)

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

パラメーター

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

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

戻り値

Excel.Slicer

selectItems(items)

キーに基づいてスライサー項目を選択します。前の選択はクリアされます。配列が空の場合、すべての項目が既定で選択されます。

selectItems(items?: string[]): void;

パラメーター

items: string[]

省略可能。選択する指定されたスライサー項目名。

戻り値

void

注釈

[ 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.selectItems(["Lemon", "Lime", "Orange"]);
    await context.sync();
});

set(properties, options)

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

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

パラメーター

properties: Excel.Interfaces.SlicerUpdateData

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

options: OfficeExtension.UpdateOptions

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

戻り値

void

set(properties)

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

set(properties: Excel.Slicer): void;

パラメーター

properties: Excel.Slicer

戻り値

void

setStyle(style)

注意

スライサーに適用されるスタイルを設定します。

setStyle(style: string | SlicerStyle | BuiltInSlicerStyle): void;

パラメーター

style: string | Excel.SlicerStyle | Excel.BuiltInSlicerStyle

スライサーに適用するスタイル。スタイルの名前と一致しない文字列が指定されている場合は、 InvalidArgument エラーがスローされます。

戻り値

void

注釈

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

toJSON()

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

toJSON(): Excel.Interfaces.SlicerData;

戻り値

Excel.Interfaces.SlicerData

次の方法で共有

Excel.Slicer class

注釈

プロパティ

メソッド

プロパティの詳細

caption

プロパティ値

注釈

context

プロパティ値

height

プロパティ値

注釈

id

プロパティ値

注釈

isFilterCleared

プロパティ値

注釈

left

プロパティ値

注釈

name

プロパティ値

注釈

nameInFormula

プロパティ値

注釈

slicerItems

プロパティ値

注釈

slicerStyle

プロパティ値

注釈

sortBy

プロパティ値

注釈

style

プロパティ値

注釈

例

top

プロパティ値

注釈

width

プロパティ値

注釈

worksheet

プロパティ値

注釈

メソッドの詳細

clearFilters()

戻り値

注釈

例

delete()

戻り値

注釈

例

getSelectedItems()

戻り値

注釈

load(options)

パラメーター

戻り値

load(propertyNames)

パラメーター

戻り値

load(propertyNamesAndPaths)

パラメーター

戻り値

selectItems(items)

パラメーター

戻り値

注釈

例

set(properties, options)

パラメーター

戻り値