Excel.Slicer class
ブック内の Slicer オブジェクトを表します。
- Extends
注釈
使用元
プロパティ
| caption | スライサーのキャプションを表します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| height | スライサーの高さをポイント単位で指定します。 入力として負の値またはゼロに設定された場合、 |
| id | スライサーの一意の ID を表します。 |
| is |
スライサーに現在適用されているフィルターがすべてクリアされている場合、値は |
| left | スライサーの左側からワークシートの左までの距離を表します (ポイント数)。 入力として負の値を指定して設定すると、 |
| name | スライサーの名前を表します。 |
| name |
数式で使用されるスライサー名を指定します。 |
| slicer |
スライサーの一部であるスライサー項目のコレクションを表します。 |
| slicer |
スライサーに適用されるスタイル。 |
| sort |
スライサー内の項目の並べ替え順序を指定します。 指定可能な値は、"DataSourceOrder"、"Ascending"、"Descending" です。 |
| style | スライサーのスタイルを表す定数値。 指定可能な値は、"SlicerStyleLight1" から "SlicerStyleLight6"、"TableStyleOther1" から "TableStyleOther2"、"SlicerStyleDark1" から "SlicerStyleDark6" です。 ブックに存在するカスタムのユーザー定義スタイルも指定できます。 |
| top | スライサーの上端からワークシートの上端までの距離を表します (ポイント数)。 入力として負の値を指定して設定すると、 |
| width | スライサーの幅 (ポイント数) を表します。 入力として負の値またはゼロを設定すると、 |
| worksheet | スライサーを含んでいるワークシートを表します。 |
メソッド
| clear |
現在スライサーに適用されているすべてのフィルターを消去します。 |
| delete() | スライサーを削除します。 |
| get |
選択されたアイテムのキーの配列を返します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| select |
キーに基づいてスライサー項目を選択します。 前の選択はクリアされます。 配列が空の場合、既定ではすべての項目が選択されます。 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| set |
スライサーに適用されるスタイルを設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
caption
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
height
スライサーの高さをポイント単位で指定します。 入力として負の値またはゼロに設定された場合、 InvalidArgument 例外をスローします。
height: number;プロパティ値
number
注釈
id
isFilterCleared
スライサーに現在適用されているフィルターがすべてクリアされている場合、値は true です。
readonly isFilterCleared: boolean;プロパティ値
boolean
注釈
left
スライサーの左側からワークシートの左までの距離を表します (ポイント数)。 入力として負の値を指定して設定すると、 InvalidArgument エラーがスローされます。
left: number;プロパティ値
number
注釈
name
nameInFormula
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
数式で使用されるスライサー名を指定します。
nameInFormula: string;プロパティ値
string
注釈
slicerItems
スライサーの一部であるスライサー項目のコレクションを表します。
readonly slicerItems: Excel.SlicerItemCollection;プロパティ値
注釈
slicerStyle
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
スライサーに適用されるスタイル。
readonly slicerStyle: Excel.SlicerStyle;プロパティ値
注釈
sortBy
スライサー内の項目の並べ替え順序を指定します。 指定可能な値は、"DataSourceOrder"、"Ascending"、"Descending" です。
sortBy: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending";プロパティ値
Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"
注釈
style
スライサーのスタイルを表す定数値。 指定可能な値は、"SlicerStyleLight1" から "SlicerStyleLight6"、"TableStyleOther1" から "TableStyleOther2"、"SlicerStyleDark1" から "SlicerStyleDark6" です。 ブックに存在するカスタムのユーザー定義スタイルも指定できます。
style: string;プロパティ値
string
注釈
例
// 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
注釈
width
スライサーの幅 (ポイント数) を表します。 入力として負の値またはゼロを設定すると、 InvalidArgument エラーがスローされます。
width: number;プロパティ値
number
注釈
worksheet
スライサーを含んでいるワークシートを表します。
readonly worksheet: Excel.Worksheet;プロパティ値
注釈
メソッドの詳細
clearFilters()
現在スライサーに適用されているすべてのフィルターを消去します。
clearFilters(): void;返品
void
注釈
例
// 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
注釈
例
// 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[]>
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.SlicerLoadOptions): Excel.Slicer;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.Slicer;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Slicer;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
selectItems(items)
キーに基づいてスライサー項目を選択します。 前の選択はクリアされます。 配列が空の場合、既定ではすべての項目が選択されます。
selectItems(items?: string[]): void;パラメーター
- items
-
string[]
省略可能。 選択する指定されたスライサー項目名。
返品
void
注釈
例
// 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
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.Slicer): void;パラメーター
- properties
- Excel.Slicer
返品
void
setStyle(style)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
スライサーに適用されるスタイルを設定します。
setStyle(style: string | SlicerStyle | BuiltInSlicerStyle): void;パラメーター
- style
-
string | Excel.SlicerStyle | Excel.BuiltInSlicerStyle
スライサーに適用するスタイル。 スタイルの名前と一致しない文字列が指定された場合、 InvalidArgument エラーがスローされます。
返品
void
注釈
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.Slicer オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.SlicerData と型指定) を返します。
toJSON(): Excel.Interfaces.SlicerData;