ExcelScript.Slicer interface

Paquete:

ExcelScript

Representa un Slicer objeto en el libro.

Comentarios

Ejemplos

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

Métodos

clearFilters()	Borra todos los filtros aplicados actualmente en la segmentación.
delete()	Elimina la segmentación.
getCaption()	Representa el título de la segmentación de datos.
getHeight()	Indica el alto, en puntos, de la segmentación. Produce una InvalidArgument excepción cuando se establece con un valor negativo o cero como entrada.
getId()	Representa el identificador único de la segmentación de datos.
getIsFilterCleared()	El valor es true si se borran todos los filtros aplicados actualmente en la segmentación de datos.
getLeft()	La distancia, en puntos, desde el lado izquierdo de la segmentación hasta el izquierdo de la hoja de cálculo. Produce un InvalidArgument error cuando se establece con un valor negativo como entrada.
getName()	Representa el nombre de la segmentación de datos.
getSelectedItems()	Devuelve una matriz de claves de los elementos seleccionados.
getSlicerItem(key)	Obtiene un elemento de segmentación mediante su nombre o la clave. Si el elemento de segmentación de datos no existe, este método devuelve undefined.
getSlicerItems()	Representa la colección de elementos de segmentación de datos que forman parte de la segmentación de datos.
getSortBy()	Indica el orden de los elementos de la segmentación. Los valores posibles son: "DataSourceOrder", "Ascending", "Descending".
getStyle()	Valor constante que representa el estilo de segmentación de datos. Los valores posibles son: "SlicerStyleLight1" a "SlicerStyleLight6", "TableStyleOther1" a "TableStyleOther2", "SlicerStyleDark1" a "SlicerStyleDark6". También puede especificarse un estilo personalizado definido por el usuario presente en el libro.
getTop()	La distancia, en puntos, desde el borde superior de la segmentación hasta la parte superior de la hoja de cálculo. Produce un InvalidArgument error cuando se establece con un valor negativo como entrada.
getWidth()	Indica el ancho, en puntos, de la segmentación. Produce un InvalidArgument error cuando se establece con un valor negativo o cero como entrada.
getWorksheet()	Indica la hoja de cálculo que contiene la segmentación.
selectItems(items)	Selecciona los elementos de segmentación en función de sus claves. Se borran las selecciones anteriores. Todos los elementos se seleccionarán de forma predeterminada si la matriz está vacía.
setCaption(caption)	Representa el título de la segmentación de datos.
setHeight(height)	Indica el alto, en puntos, de la segmentación. Produce una InvalidArgument excepción cuando se establece con un valor negativo o cero como entrada.
setLeft(left)	La distancia, en puntos, desde el lado izquierdo de la segmentación hasta el izquierdo de la hoja de cálculo. Produce un InvalidArgument error cuando se establece con un valor negativo como entrada.
setName(name)	Representa el nombre de la segmentación de datos.
setSortBy(sortBy)	Indica el orden de los elementos de la segmentación. Los valores posibles son: "DataSourceOrder", "Ascending", "Descending".
setStyle(style)	Valor constante que representa el estilo de segmentación de datos. Los valores posibles son: "SlicerStyleLight1" a "SlicerStyleLight6", "TableStyleOther1" a "TableStyleOther2", "SlicerStyleDark1" a "SlicerStyleDark6". También puede especificarse un estilo personalizado definido por el usuario presente en el libro.
setTop(top)	La distancia, en puntos, desde el borde superior de la segmentación hasta la parte superior de la hoja de cálculo. Produce un InvalidArgument error cuando se establece con un valor negativo como entrada.
setWidth(width)	Indica el ancho, en puntos, de la segmentación. Produce un InvalidArgument error cuando se establece con un valor negativo o cero como entrada.

Detalles del método

clearFilters()

Borra todos los filtros aplicados actualmente en la segmentación.

clearFilters(): void;

Devoluciones

void

delete()

Elimina la segmentación.

delete(): void;

Devoluciones

void

getCaption()

Representa el título de la segmentación de datos.

getCaption(): string;

Devoluciones

string

getHeight()

Indica el alto, en puntos, de la segmentación. Produce una InvalidArgument excepción cuando se establece con un valor negativo o cero como entrada.

getHeight(): number;

Devoluciones

number

getId()

Representa el identificador único de la segmentación de datos.

getId(): string;

Devoluciones

string

getIsFilterCleared()

El valor es true si se borran todos los filtros aplicados actualmente en la segmentación de datos.

getIsFilterCleared(): boolean;

Devoluciones

boolean

getLeft()

La distancia, en puntos, desde el lado izquierdo de la segmentación hasta el izquierdo de la hoja de cálculo. Produce un InvalidArgument error cuando se establece con un valor negativo como entrada.

getLeft(): number;

Devoluciones

number

getName()

Representa el nombre de la segmentación de datos.

getName(): string;

Devoluciones

string

getSelectedItems()

Devuelve una matriz de claves de los elementos seleccionados.

getSelectedItems(): string[];

Devoluciones

string[]

getSlicerItem(key)

Obtiene un elemento de segmentación mediante su nombre o la clave. Si el elemento de segmentación de datos no existe, este método devuelve undefined.

getSlicerItem(key: string): SlicerItem | undefined;

Parámetros

key

string

Clave o nombre de la segmentación de datos que se va a recuperar.

Devoluciones

ExcelScript.SlicerItem | undefined

getSlicerItems()

Representa la colección de elementos de segmentación de datos que forman parte de la segmentación de datos.

getSlicerItems(): SlicerItem[];

Devoluciones

ExcelScript.SlicerItem[]

getSortBy()

Indica el orden de los elementos de la segmentación. Los valores posibles son: "DataSourceOrder", "Ascending", "Descending".

getSortBy(): SlicerSortType;

Devoluciones

ExcelScript.SlicerSortType

getStyle()

Valor constante que representa el estilo de segmentación de datos. Los valores posibles son: "SlicerStyleLight1" a "SlicerStyleLight6", "TableStyleOther1" a "TableStyleOther2", "SlicerStyleDark1" a "SlicerStyleDark6". También puede especificarse un estilo personalizado definido por el usuario presente en el libro.

getStyle(): string;

Devoluciones

string

getTop()

La distancia, en puntos, desde el borde superior de la segmentación hasta la parte superior de la hoja de cálculo. Produce un InvalidArgument error cuando se establece con un valor negativo como entrada.

getTop(): number;

Devoluciones

number

getWidth()

Indica el ancho, en puntos, de la segmentación. Produce un InvalidArgument error cuando se establece con un valor negativo o cero como entrada.

getWidth(): number;

Devoluciones

number

getWorksheet()

Indica la hoja de cálculo que contiene la segmentación.

getWorksheet(): Worksheet;

Devoluciones

ExcelScript.Worksheet

selectItems(items)

Selecciona los elementos de segmentación en función de sus claves. Se borran las selecciones anteriores. Todos los elementos se seleccionarán de forma predeterminada si la matriz está vacía.

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

Parámetros

items

string[]

Opcional. Nombres de elemento de segmentación especificados que se van a seleccionar.

Devoluciones

void

setCaption(caption)

Representa el título de la segmentación de datos.

setCaption(caption: string): void;

Parámetros

caption

string

Devoluciones

void

setHeight(height)

Indica el alto, en puntos, de la segmentación. Produce una InvalidArgument excepción cuando se establece con un valor negativo o cero como entrada.

setHeight(height: number): void;

Parámetros

height

number

Devoluciones

void

setLeft(left)

La distancia, en puntos, desde el lado izquierdo de la segmentación hasta el izquierdo de la hoja de cálculo. Produce un InvalidArgument error cuando se establece con un valor negativo como entrada.

setLeft(left: number): void;

Parámetros

left

number

Devoluciones

void

setName(name)

Representa el nombre de la segmentación de datos.

setName(name: string): void;

Parámetros

name

string

Devoluciones

void

setSortBy(sortBy)

Indica el orden de los elementos de la segmentación. Los valores posibles son: "DataSourceOrder", "Ascending", "Descending".

setSortBy(sortBy: SlicerSortType): void;

Parámetros

sortBy

ExcelScript.SlicerSortType

Devoluciones

void

setStyle(style)

Valor constante que representa el estilo de segmentación de datos. Los valores posibles son: "SlicerStyleLight1" a "SlicerStyleLight6", "TableStyleOther1" a "TableStyleOther2", "SlicerStyleDark1" a "SlicerStyleDark6". También puede especificarse un estilo personalizado definido por el usuario presente en el libro.

setStyle(style: string): void;

Parámetros

style

string

Devoluciones

void

setTop(top)

La distancia, en puntos, desde el borde superior de la segmentación hasta la parte superior de la hoja de cálculo. Produce un InvalidArgument error cuando se establece con un valor negativo como entrada.

setTop(top: number): void;

Parámetros

top

number

Devoluciones

void

setWidth(width)

Indica el ancho, en puntos, de la segmentación. Produce un InvalidArgument error cuando se establece con un valor negativo o cero como entrada.

setWidth(width: number): void;

Parámetros

width

number

Devoluciones

void