ExcelScript.Slicer interface

Paket:

ExcelScript

Stellt ein Slicer -Objekt in der Arbeitsmappe dar.

Hinweise

Beispiele

/**
 * 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);
}

Methoden

clearFilters()	Löscht alle Filter, die derzeit für den Datenschnitt verwendet werden.
delete()	Löscht den Datenschnitt.
getCaption()	Stellt die Beschriftung des Slicers dar.
getHeight()	Stellt die Höhe des Datenschnitts in typografischen Punkten dar. Löst eine Ausnahme aus InvalidArgument , wenn als Eingabe mit einem negativen Wert oder 0 (null) festgelegt wird.
getId()	Stellt die eindeutige ID des Slicers dar.
getIsFilterCleared()	Der Wert ist true , wenn alle Filter, die derzeit auf den Slicer angewendet werden, gelöscht werden.
getLeft()	Stellt den Abstand in Punkt von der linken Seite des Datenschnitts zur linken Seite des Arbeitsblatts dar. Löst einen Fehler aus InvalidArgument , wenn ein negativer Wert als Eingabe festgelegt wird.
getName()	Stellt den Namen des Datenschnitts dar.
getSelectedItems()	Gibt ein Array mit den Schlüsseln der ausgewählten Elemente zurück.
getSlicerItem(key)	Ruft ein Datenschnittelement anhand seines Schlüssels oder Namens ab. Wenn das Slicerelement nicht vorhanden ist, gibt diese Methode zurück undefined.
getSlicerItems()	Stellt die Auflistung von Slicerelementen dar, die Teil des Datenschnitts sind.
getSortBy()	Stellt die Sortierreihenfolge der Elemente im Datenschnitt dar. Mögliche Werte sind: "DataSourceOrder", "Ascending", "Descending".
getStyle()	Konstanter Wert, der das Slicerformat darstellt. Mögliche Werte sind: "SlicerStyleLight1" bis "SlicerStyleLight6", "TableStyleOther1" bis "TableStyleOther2", "SlicerStyleDark1" bis "SlicerStyleDark6". Es kann ebenfalls eine in der Arbeitsmappe vorhandene benutzerdefinierte Formatierung angegeben werden.
getTop()	Stellt den Abstand in Punkt von der Oberkante des Datenschnitts zur Oberkante des Arbeitsblatts dar. Löst einen Fehler aus InvalidArgument , wenn ein negativer Wert als Eingabe festgelegt wird.
getWidth()	Die Breite des Datenschnitts in Punkten. Löst einen Fehler aus InvalidArgument , wenn mit einem negativen Wert oder null als Eingabe festgelegt wird.
getWorksheet()	Stellt das Arbeitsblatt dar, das den Datenschnitt enthält.
selectItems(items)	Wählt Slicerelemente basierend auf ihren Schlüsseln aus. Die vorherige Auswahl ist deaktiviert. Alle Elemente werden standardmäßig ausgewählt, wenn das Array leer ist.
setCaption(caption)	Stellt die Beschriftung des Slicers dar.
setHeight(height)	Stellt die Höhe des Datenschnitts in typografischen Punkten dar. Löst eine Ausnahme aus InvalidArgument , wenn als Eingabe mit einem negativen Wert oder 0 (null) festgelegt wird.
setLeft(left)	Stellt den Abstand in Punkt von der linken Seite des Datenschnitts zur linken Seite des Arbeitsblatts dar. Löst einen Fehler aus InvalidArgument , wenn ein negativer Wert als Eingabe festgelegt wird.
setName(name)	Stellt den Namen des Datenschnitts dar.
setSortBy(sortBy)	Stellt die Sortierreihenfolge der Elemente im Datenschnitt dar. Mögliche Werte sind: "DataSourceOrder", "Ascending", "Descending".
setStyle(style)	Konstanter Wert, der das Slicerformat darstellt. Mögliche Werte sind: "SlicerStyleLight1" bis "SlicerStyleLight6", "TableStyleOther1" bis "TableStyleOther2", "SlicerStyleDark1" bis "SlicerStyleDark6". Es kann ebenfalls eine in der Arbeitsmappe vorhandene benutzerdefinierte Formatierung angegeben werden.
setTop(top)	Stellt den Abstand in Punkt von der Oberkante des Datenschnitts zur Oberkante des Arbeitsblatts dar. Löst einen Fehler aus InvalidArgument , wenn ein negativer Wert als Eingabe festgelegt wird.
setWidth(width)	Die Breite des Datenschnitts in Punkten. Löst einen Fehler aus InvalidArgument , wenn mit einem negativen Wert oder null als Eingabe festgelegt wird.

Details zur Methode

clearFilters()

Löscht alle Filter, die derzeit für den Datenschnitt verwendet werden.

clearFilters(): void;

Gibt zurück

void

delete()

Löscht den Datenschnitt.

delete(): void;

Gibt zurück

void

getCaption()

Stellt die Beschriftung des Slicers dar.

getCaption(): string;

Gibt zurück

string

getHeight()

Stellt die Höhe des Datenschnitts in typografischen Punkten dar. Löst eine Ausnahme aus InvalidArgument , wenn als Eingabe mit einem negativen Wert oder 0 (null) festgelegt wird.

getHeight(): number;

Gibt zurück

number

getId()

Stellt die eindeutige ID des Slicers dar.

getId(): string;

Gibt zurück

string

getIsFilterCleared()

Der Wert ist true , wenn alle Filter, die derzeit auf den Slicer angewendet werden, gelöscht werden.

getIsFilterCleared(): boolean;

Gibt zurück

boolean

getLeft()

Stellt den Abstand in Punkt von der linken Seite des Datenschnitts zur linken Seite des Arbeitsblatts dar. Löst einen Fehler aus InvalidArgument , wenn ein negativer Wert als Eingabe festgelegt wird.

getLeft(): number;

Gibt zurück

number

getName()

Stellt den Namen des Datenschnitts dar.

getName(): string;

Gibt zurück

string

getSelectedItems()

Gibt ein Array mit den Schlüsseln der ausgewählten Elemente zurück.

getSelectedItems(): string[];

Gibt zurück

string[]

getSlicerItem(key)

Ruft ein Datenschnittelement anhand seines Schlüssels oder Namens ab. Wenn das Slicerelement nicht vorhanden ist, gibt diese Methode zurück undefined.

getSlicerItem(key: string): SlicerItem | undefined;

Parameter

key

string

Schlüssel oder Name des abzurufenden Slicers.

Gibt zurück

ExcelScript.SlicerItem | undefined

getSlicerItems()

Stellt die Auflistung von Slicerelementen dar, die Teil des Datenschnitts sind.

getSlicerItems(): SlicerItem[];

Gibt zurück

ExcelScript.SlicerItem[]

getSortBy()

Stellt die Sortierreihenfolge der Elemente im Datenschnitt dar. Mögliche Werte sind: "DataSourceOrder", "Ascending", "Descending".

getSortBy(): SlicerSortType;

Gibt zurück

ExcelScript.SlicerSortType

getStyle()

Konstanter Wert, der das Slicerformat darstellt. Mögliche Werte sind: "SlicerStyleLight1" bis "SlicerStyleLight6", "TableStyleOther1" bis "TableStyleOther2", "SlicerStyleDark1" bis "SlicerStyleDark6". Es kann ebenfalls eine in der Arbeitsmappe vorhandene benutzerdefinierte Formatierung angegeben werden.

getStyle(): string;

Gibt zurück

string

getTop()

Stellt den Abstand in Punkt von der Oberkante des Datenschnitts zur Oberkante des Arbeitsblatts dar. Löst einen Fehler aus InvalidArgument , wenn ein negativer Wert als Eingabe festgelegt wird.

getTop(): number;

Gibt zurück

number

getWidth()

Die Breite des Datenschnitts in Punkten. Löst einen Fehler aus InvalidArgument , wenn mit einem negativen Wert oder null als Eingabe festgelegt wird.

getWidth(): number;

Gibt zurück

number

getWorksheet()

Stellt das Arbeitsblatt dar, das den Datenschnitt enthält.

getWorksheet(): Worksheet;

Gibt zurück

ExcelScript.Worksheet

selectItems(items)

Wählt Slicerelemente basierend auf ihren Schlüsseln aus. Die vorherige Auswahl ist deaktiviert. Alle Elemente werden standardmäßig ausgewählt, wenn das Array leer ist.

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

Parameter

items

string[]

Optional. Die angegebenen Slicerelementnamen, die ausgewählt werden sollen.

Gibt zurück

void

setCaption(caption)

Stellt die Beschriftung des Slicers dar.

setCaption(caption: string): void;

Parameter

caption

string

Gibt zurück

void

setHeight(height)

Stellt die Höhe des Datenschnitts in typografischen Punkten dar. Löst eine Ausnahme aus InvalidArgument , wenn als Eingabe mit einem negativen Wert oder 0 (null) festgelegt wird.

setHeight(height: number): void;

Parameter

height

number

Gibt zurück

void

setLeft(left)

Stellt den Abstand in Punkt von der linken Seite des Datenschnitts zur linken Seite des Arbeitsblatts dar. Löst einen Fehler aus InvalidArgument , wenn ein negativer Wert als Eingabe festgelegt wird.

setLeft(left: number): void;

Parameter

left

number

Gibt zurück

void

setName(name)

Stellt den Namen des Datenschnitts dar.

setName(name: string): void;

Parameter

name

string

Gibt zurück

void

setSortBy(sortBy)

Stellt die Sortierreihenfolge der Elemente im Datenschnitt dar. Mögliche Werte sind: "DataSourceOrder", "Ascending", "Descending".

setSortBy(sortBy: SlicerSortType): void;

Parameter

sortBy

ExcelScript.SlicerSortType

Gibt zurück

void

setStyle(style)

Konstanter Wert, der das Slicerformat darstellt. Mögliche Werte sind: "SlicerStyleLight1" bis "SlicerStyleLight6", "TableStyleOther1" bis "TableStyleOther2", "SlicerStyleDark1" bis "SlicerStyleDark6". Es kann ebenfalls eine in der Arbeitsmappe vorhandene benutzerdefinierte Formatierung angegeben werden.

setStyle(style: string): void;

Parameter

style

string

Gibt zurück

void

setTop(top)

Stellt den Abstand in Punkt von der Oberkante des Datenschnitts zur Oberkante des Arbeitsblatts dar. Löst einen Fehler aus InvalidArgument , wenn ein negativer Wert als Eingabe festgelegt wird.

setTop(top: number): void;

Parameter

top

number

Gibt zurück

void

setWidth(width)

Die Breite des Datenschnitts in Punkten. Löst einen Fehler aus InvalidArgument , wenn mit einem negativen Wert oder null als Eingabe festgelegt wird.

setWidth(width: number): void;

Parameter

width

number

Gibt zurück

void