ExcelScript.Slicer interface

Pacote:

ExcelScript

Representa um Slicer objeto na pasta de trabalho.

Comentários

Exemplos

/**
 * 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()	Limpa todos os filtros aplicados à segmentação de dados no momento.
delete()	Exclui a segmentação de dados.
getCaption()	Representa a legenda da segmentação.
getHeight()	Representa a altura, em pontos, da segmentação de dados. Gera uma exceção InvalidArgument quando definida com um valor negativo ou zero como uma entrada.
getId()	Representa a ID exclusiva da segmentação.
getIsFilterCleared()	O valor será true se todos os filtros aplicados atualmente na segmentação forem desmarcados.
getLeft()	Representa a distância, em pontos, da lateral esquerda da segmentação de dados à esquerda da planilha. Lança um InvalidArgument erro quando definido com um valor negativo como uma entrada.
getName()	Representa o nome da segmentação.
getSelectedItems()	Retorna uma matriz de chaves de itens selecionados.
getSlicerItem(key)	Obtém um item da segmentação de dados usando sua chave ou nome. Se o item slicer não existir, esse método retornará undefined.
getSlicerItems()	Representa a coleção de itens de segmentação que fazem parte da segmentação.
getSortBy()	Representa a ordem de classificação dos itens na segmentação de dados. Os valores possíveis são: "DataSourceOrder", "Ascending", "Descending".
getStyle()	Valor constante que representa o estilo de segmentação. Os valores possíveis são: "SlicerStyleLight1" por meio de "SlicerStyleLight6", "TableStyleOther1" por meio de "TableStyleOther2", "SlicerStyleDark1" por meio de "SlicerStyleDark6". Também é possível usar um estilo definido pelo usuário que esteja presente na planilha.
getTop()	Representa a distância, em pontos, da borda superior da segmentação de dados na parte superior da planilha. Lança um InvalidArgument erro quando definido com um valor negativo como uma entrada.
getWidth()	Representa a largura, em pontos, da segmentação de dados. Lança um InvalidArgument erro quando definido com um valor negativo ou zero como uma entrada.
getWorksheet()	Representa a planilha que contém a segmentação de dados.
selectItems(items)	Seleciona itens de segmentação com base em suas chaves. As seleções anteriores são desmarcadas. Todos os itens serão selecionados por padrão se a matriz estiver vazia.
setCaption(caption)	Representa a legenda da segmentação.
setHeight(height)	Representa a altura, em pontos, da segmentação de dados. Gera uma exceção InvalidArgument quando definida com um valor negativo ou zero como uma entrada.
setLeft(left)	Representa a distância, em pontos, da lateral esquerda da segmentação de dados à esquerda da planilha. Lança um InvalidArgument erro quando definido com um valor negativo como uma entrada.
setName(name)	Representa o nome da segmentação.
setSortBy(sortBy)	Representa a ordem de classificação dos itens na segmentação de dados. Os valores possíveis são: "DataSourceOrder", "Ascending", "Descending".
setStyle(style)	Valor constante que representa o estilo de segmentação. Os valores possíveis são: "SlicerStyleLight1" por meio de "SlicerStyleLight6", "TableStyleOther1" por meio de "TableStyleOther2", "SlicerStyleDark1" por meio de "SlicerStyleDark6". Também é possível usar um estilo definido pelo usuário que esteja presente na planilha.
setTop(top)	Representa a distância, em pontos, da borda superior da segmentação de dados na parte superior da planilha. Lança um InvalidArgument erro quando definido com um valor negativo como uma entrada.
setWidth(width)	Representa a largura, em pontos, da segmentação de dados. Lança um InvalidArgument erro quando definido com um valor negativo ou zero como uma entrada.

Detalhes do método

clearFilters()

Limpa todos os filtros aplicados à segmentação de dados no momento.

clearFilters(): void;

Retornos

void

delete()

Exclui a segmentação de dados.

delete(): void;

Retornos

void

getCaption()

Representa a legenda da segmentação.

getCaption(): string;

Retornos

string

getHeight()

Representa a altura, em pontos, da segmentação de dados. Gera uma exceção InvalidArgument quando definida com um valor negativo ou zero como uma entrada.

getHeight(): number;

Retornos

number

getId()

Representa a ID exclusiva da segmentação.

getId(): string;

Retornos

string

getIsFilterCleared()

O valor será true se todos os filtros aplicados atualmente na segmentação forem desmarcados.

getIsFilterCleared(): boolean;

Retornos

boolean

getLeft()

Representa a distância, em pontos, da lateral esquerda da segmentação de dados à esquerda da planilha. Lança um InvalidArgument erro quando definido com um valor negativo como uma entrada.

getLeft(): number;

Retornos

number

getName()

Representa o nome da segmentação.

getName(): string;

Retornos

string

getSelectedItems()

Retorna uma matriz de chaves de itens selecionados.

getSelectedItems(): string[];

Retornos

string[]

getSlicerItem(key)

Obtém um item da segmentação de dados usando sua chave ou nome. Se o item slicer não existir, esse método retornará undefined.

getSlicerItem(key: string): SlicerItem | undefined;

Parâmetros

key

string

Chave ou nome da segmentação a ser recuperada.

Retornos

ExcelScript.SlicerItem | undefined

getSlicerItems()

Representa a coleção de itens de segmentação que fazem parte da segmentação.

getSlicerItems(): SlicerItem[];

Retornos

ExcelScript.SlicerItem[]

getSortBy()

Representa a ordem de classificação dos itens na segmentação de dados. Os valores possíveis são: "DataSourceOrder", "Ascending", "Descending".

getSortBy(): SlicerSortType;

Retornos

ExcelScript.SlicerSortType

getStyle()

Valor constante que representa o estilo de segmentação. Os valores possíveis são: "SlicerStyleLight1" por meio de "SlicerStyleLight6", "TableStyleOther1" por meio de "TableStyleOther2", "SlicerStyleDark1" por meio de "SlicerStyleDark6". Também é possível usar um estilo definido pelo usuário que esteja presente na planilha.

getStyle(): string;

Retornos

string

getTop()

Representa a distância, em pontos, da borda superior da segmentação de dados na parte superior da planilha. Lança um InvalidArgument erro quando definido com um valor negativo como uma entrada.

getTop(): number;

Retornos

number

getWidth()

Representa a largura, em pontos, da segmentação de dados. Lança um InvalidArgument erro quando definido com um valor negativo ou zero como uma entrada.

getWidth(): number;

Retornos

number

getWorksheet()

Representa a planilha que contém a segmentação de dados.

getWorksheet(): Worksheet;

Retornos

ExcelScript.Worksheet

selectItems(items)

Seleciona itens de segmentação com base em suas chaves. As seleções anteriores são desmarcadas. Todos os itens serão selecionados por padrão se a matriz estiver vazia.

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

Parâmetros

items

string[]

Opcional. Os nomes de item de segmentação especificados a serem selecionados.

Retornos

void

setCaption(caption)

Representa a legenda da segmentação.

setCaption(caption: string): void;

Parâmetros

caption

string

Retornos

void

setHeight(height)

Representa a altura, em pontos, da segmentação de dados. Gera uma exceção InvalidArgument quando definida com um valor negativo ou zero como uma entrada.

setHeight(height: number): void;

Parâmetros

height

number

Retornos

void

setLeft(left)

Representa a distância, em pontos, da lateral esquerda da segmentação de dados à esquerda da planilha. Lança um InvalidArgument erro quando definido com um valor negativo como uma entrada.

setLeft(left: number): void;

Parâmetros

left

number

Retornos

void

setName(name)

Representa o nome da segmentação.

setName(name: string): void;

Parâmetros

name

string

Retornos

void

setSortBy(sortBy)

Representa a ordem de classificação dos itens na segmentação de dados. Os valores possíveis são: "DataSourceOrder", "Ascending", "Descending".

setSortBy(sortBy: SlicerSortType): void;

Parâmetros

sortBy

ExcelScript.SlicerSortType

Retornos

void

setStyle(style)

Valor constante que representa o estilo de segmentação. Os valores possíveis são: "SlicerStyleLight1" por meio de "SlicerStyleLight6", "TableStyleOther1" por meio de "TableStyleOther2", "SlicerStyleDark1" por meio de "SlicerStyleDark6". Também é possível usar um estilo definido pelo usuário que esteja presente na planilha.

setStyle(style: string): void;

Parâmetros

style

string

Retornos

void

setTop(top)

Representa a distância, em pontos, da borda superior da segmentação de dados na parte superior da planilha. Lança um InvalidArgument erro quando definido com um valor negativo como uma entrada.

setTop(top: number): void;

Parâmetros

top

number

Retornos

void

setWidth(width)

Representa a largura, em pontos, da segmentação de dados. Lança um InvalidArgument erro quando definido com um valor negativo ou zero como uma entrada.

setWidth(width: number): void;

Parâmetros

width

number

Retornos

void