ExcelScript.Slicer interface

パッケージ:

ExcelScript

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

注釈

例

/**
 * This script adds a slicer for an existing PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Pivot".
  const farmPivot = workbook.getPivotTable("Farm Pivot");

  // Create the slicer. 
  // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
  const fruitSlicer: ExcelScript.Slicer = workbook.addSlicer(
    farmPivot, /* The table or PivotTale to be sliced. */
    farmPivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
  );

  // Select the items to display.
  fruitSlicer.selectItems(["Lemon", "Lime"]);

  // Set the left margin of the slicer.
  fruitSlicer.setLeft(400);
}

メソッド

clearFilters()	現在スライサーに適用されているすべてのフィルターを消去します。
delete()	スライサーを削除します。
getCaption()	スライサーのキャプションを表します。
getHeight()	スライサーの高さ (ポイント数) を表します。 負の InvalidArgument 値または 0 を入力として設定すると、例外がスローされます。
getId()	スライサーの一意の ID を表します。
getIsFilterCleared()	値は、 true スライサーに現在適用されているすべてのフィルターがクリアされている場合です。
getLeft()	スライサーの左側からワークシートの左までの距離を表します (ポイント数)。 負の値を InvalidArgument 入力として設定するとエラーがスローされます。
getName()	スライサーの名前を表します。
getSelectedItems()	選択されたアイテムのキーの配列を返します。
getSlicerItem(key)	そのキーまたは名前を使用してスライサー アイテムを取得します。 スライサー項目が存在しない場合、このメソッドは を返します undefined。
getSlicerItems()	スライサーの一部であるスライサー項目のコレクションを表します。
getSortBy()	スライサーに含まれるアイテムの並べ替え順序を表します。 使用可能な値は、"DataSourceOrder"、"昇順"、"降順" です。
getStyle()	スライサー スタイルを表す定数値。 使用できる値は、"SlicerStyleLight1" から "SlicerStyleLight6"、"TableStyleOther1" から "TableStyleOther2"、"SlicerStyleDark1" から "SlicerStyleDark6" です。 ブックに存在するカスタムのユーザー定義スタイルも指定できます。
getTop()	スライサーの上端からワークシートの上端までの距離を表します (ポイント数)。 負の値を InvalidArgument 入力として設定するとエラーがスローされます。
getWidth()	スライサーの幅 (ポイント数) を表します。 負の値または 0 を InvalidArgument 入力として設定するとエラーがスローされます。
getWorksheet()	スライサーを含んでいるワークシートを表します。
selectItems(items)	キーに基づいてスライサー項目を選択します。 前の選択はクリアされます。 配列が空の場合、すべての項目が既定で選択されます。
setCaption(caption)	スライサーのキャプションを表します。
setHeight(height)	スライサーの高さ (ポイント数) を表します。 負の InvalidArgument 値または 0 を入力として設定すると、例外がスローされます。
setLeft(left)	スライサーの左側からワークシートの左までの距離を表します (ポイント数)。 負の値を InvalidArgument 入力として設定するとエラーがスローされます。
setName(name)	スライサーの名前を表します。
setSortBy(sortBy)	スライサーに含まれるアイテムの並べ替え順序を表します。 使用可能な値は、"DataSourceOrder"、"昇順"、"降順" です。
setStyle(style)	スライサー スタイルを表す定数値。 使用できる値は、"SlicerStyleLight1" から "SlicerStyleLight6"、"TableStyleOther1" から "TableStyleOther2"、"SlicerStyleDark1" から "SlicerStyleDark6" です。 ブックに存在するカスタムのユーザー定義スタイルも指定できます。
setTop(top)	スライサーの上端からワークシートの上端までの距離を表します (ポイント数)。 負の値を InvalidArgument 入力として設定するとエラーがスローされます。
setWidth(width)	スライサーの幅 (ポイント数) を表します。 負の値または 0 を InvalidArgument 入力として設定するとエラーがスローされます。

メソッドの詳細

clearFilters()

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

clearFilters(): void;

戻り値

void

delete()

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

delete(): void;

戻り値

void

getCaption()

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

getCaption(): string;

戻り値

string

getHeight()

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

getHeight(): number;

戻り値

number

getId()

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

getId(): string;

戻り値

string

getIsFilterCleared()

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

getIsFilterCleared(): boolean;

戻り値

boolean

getLeft()

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

getLeft(): number;

戻り値

number

getName()

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

getName(): string;

戻り値

string

getSelectedItems()

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

getSelectedItems(): string[];

戻り値

string[]

getSlicerItem(key)

そのキーまたは名前を使用してスライサー アイテムを取得します。 スライサー項目が存在しない場合、このメソッドは を返します undefined。

getSlicerItem(key: string): SlicerItem | undefined;

パラメーター

key

string

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

戻り値

ExcelScript.SlicerItem | undefined

getSlicerItems()

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

getSlicerItems(): SlicerItem[];

戻り値

ExcelScript.SlicerItem[]

getSortBy()

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

getSortBy(): SlicerSortType;

戻り値

ExcelScript.SlicerSortType

getStyle()

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

getStyle(): string;

戻り値

string

getTop()

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

getTop(): number;

戻り値

number

getWidth()

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

getWidth(): number;

戻り値

number

getWorksheet()

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

getWorksheet(): Worksheet;

戻り値

ExcelScript.Worksheet

selectItems(items)

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

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

パラメーター

items

string[]

オプション。 選択する指定されたスライサー項目名。

戻り値

void

setCaption(caption)

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

setCaption(caption: string): void;

パラメーター

caption

string

戻り値

void

setHeight(height)

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

setHeight(height: number): void;

パラメーター

height

number

戻り値

void

setLeft(left)

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

setLeft(left: number): void;

パラメーター

left

number

戻り値

void

setName(name)

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

setName(name: string): void;

パラメーター

name

string

戻り値

void

setSortBy(sortBy)

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

setSortBy(sortBy: SlicerSortType): void;

パラメーター

sortBy

ExcelScript.SlicerSortType

戻り値

void

setStyle(style)

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

setStyle(style: string): void;

パラメーター

style

string

戻り値

void

setTop(top)

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

setTop(top: number): void;

パラメーター

top

number

戻り値

void

setWidth(width)

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

setWidth(width: number): void;

パラメーター

width

number

戻り値

void