Excel.Slicer class
ブック内の Slicer オブジェクトを表します。
- Extends
注釈
プロパティ
| caption | スライサーのキャプションを表します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| height | スライサーの高さ (ポイント数) を表します。 負の |
| id | スライサーの一意の ID を表します。 |
| is |
値は、 |
| left | スライサーの左側からワークシートの左までの距離を表します (ポイント数)。 負の値を |
| name | スライサーの名前を表します。 |
| name |
数式で使用するスライサーの名前を表します。 |
| slicer |
スライサーの一部であるスライサー項目のコレクションを表します。 |
| slicer |
スライサーに適用されるスタイル。 |
| sort |
スライサーに含まれるアイテムの並べ替え順序を表します。 使用可能な値は、"DataSourceOrder"、"昇順"、"降順" です。 |
| style | スライサー スタイルを表す定数値。 使用できる値は、"SlicerStyleLight1" から "SlicerStyleLight6"、"TableStyleOther1" から "TableStyleOther2"、"SlicerStyleDark1" から "SlicerStyleDark6" です。 ブックに存在するカスタムのユーザー定義スタイルも指定できます。 |
| top | スライサーの上端からワークシートの上端までの距離を表します (ポイント数)。 負の値を |
| width | スライサーの幅 (ポイント数) を表します。 負の値または 0 を |
| worksheet | スライサーを含んでいるワークシートを表します。 |
メソッド
| clear |
現在スライサーに適用されているすべてのフィルターを消去します。 |
| delete() | スライサーを削除します。 |
| get |
選択されたアイテムのキーの配列を返します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| select |
キーに基づいてスライサー項目を選択します。 前の選択はクリアされます。 配列が空の場合、すべての項目が既定で選択されます。 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| set |
スライサーに適用されるスタイルを設定します。 |
| toJSON() | API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
プロパティの詳細
caption
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
height
スライサーの高さ (ポイント数) を表します。 負の InvalidArgument 値または 0 を入力として設定すると、例外がスローされます。
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"、"昇順"、"降順" です。
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
スライサーの幅 (ポイント数) を表します。 負の値または 0 を 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
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
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 オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の Excel.Slicer オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.SlicerData型指定) を返します。
toJSON(): Excel.Interfaces.SlicerData;戻り値
Office Add-ins
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示