ExcelScript.Slicer interface

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

注釈

使用元

ExcelScript.Workbook: addSlicer、 getActiveSlicer、 getSlicer、 getSlicers
ExcelScript.Worksheet: addSlicer、 getSlicer、 getSlicers

例

/**
 * 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()	スライサーの高さをポイント単位で指定します。負の値または 0 を入力として設定すると、 `InvalidArgument` 例外がスローされます。
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)	スライサーの高さをポイント単位で指定します。負の値または 0 を入力として設定すると、 `InvalidArgument` 例外がスローされます。
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()

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

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)

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

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

注釈

使用元

例

メソッド

メソッドの詳細

clearFilters()

返品

delete()

返品

getCaption()

返品

getHeight()

返品

getId()

返品

getIsFilterCleared()

返品

getLeft()

返品

getName()

返品

getSelectedItems()

返品

getSlicerItem(key)

パラメーター

返品

getSlicerItems()

返品

getSortBy()

返品

getStyle()

返品

getTop()

返品

getWidth()

返品

getWorksheet()

返品

selectItems(items)

パラメーター

返品

setCaption(caption)

パラメーター

返品

setHeight(height)

パラメーター

返品

setLeft(left)

パラメーター

返品

setName(name)

パラメーター

返品

setSortBy(sortBy)

パラメーター

返品

setStyle(style)

パラメーター

返品

setTop(top)

パラメーター

返品

setWidth(width)

パラメーター

返品

フィードバック