Excel.Slicer interface

Representa um objeto slicer na pasta de trabalho.

Propriedades

caption

Representa a legenda da segmentação de dados.

height

Representa a altura, em pontos, da segmentação de dados. Gera um "o argumento é inválido ou está ausente ou tem um formato incorreto." exceção quando definida com valor negativo ou zero como entrada.

id

Representa a id exclusiva da segmentação de dados.

isFilterCleared

Verdadeiro se todos os filtros atualmente aplicados na segmentação de dados estiverem desmarcados.

left

Representa a distância, em pontos, da lateral esquerda da segmentação de dados à esquerda da planilha. Gera um "o argumento é inválido ou está ausente ou tem um formato incorreto." exceção quando definida com valor negativo como entrada.

name

Representa o nome da segmentação de dados.

slicerItems

Representa a coleção de SlicerItems que faz parte da segmentação de dados.

sortBy

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

style

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

top

Representa a distância, em pontos, da borda superior da segmentação de dados na parte superior da planilha. Gera um "o argumento é inválido ou está ausente ou tem um formato incorreto." exceção quando definida com valor negativo como entrada.

width

Representa a largura, em pontos, da segmentação de dados. Gera um "o argumento é inválido ou está ausente ou tem um formato incorreto." exceção quando definida com valor negativo ou zero como entrada.

worksheet

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

Métodos

clearFilters()

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

delete()

Exclui a segmentação de dados.

getSelectedItems()

Retorna uma matriz de chaves de itens selecionados.

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

selectItems(items)

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

Detalhes da propriedade

caption

Representa a legenda da segmentação de dados.

caption: string;

Valor da propriedade

string

height

Representa a altura, em pontos, da segmentação de dados. Gera um "o argumento é inválido ou está ausente ou tem um formato incorreto." exceção quando definida com valor negativo ou zero como entrada.

height: number;

Valor da propriedade

number

id

Representa a id exclusiva da segmentação de dados.

readonly id: string;

Valor da propriedade

string

isFilterCleared

Verdadeiro se todos os filtros atualmente aplicados na segmentação de dados estiverem desmarcados.

readonly isFilterCleared: boolean;

Valor da propriedade

boolean

left

Representa a distância, em pontos, da lateral esquerda da segmentação de dados à esquerda da planilha. Gera um "o argumento é inválido ou está ausente ou tem um formato incorreto." exceção quando definida com valor negativo como entrada.

left: number;

Valor da propriedade

number

name

Representa o nome da segmentação de dados.

name: string;

Valor da propriedade

string

slicerItems

Representa a coleção de SlicerItems que faz parte da segmentação de dados.

readonly slicerItems: SlicerItemCollection;

Valor da propriedade

sortBy

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

sortBy: SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending";

Valor da propriedade

SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"

style

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

style: string;

Valor da propriedade

string

Exemplos

async function main(context: Excel.RequestContext) {
    let slicer = context.workbook.slicers.getItem("Fruit Slicer");
    slicer.style = "SlicerStyleLight6";
    await context.sync();
}

top

Representa a distância, em pontos, da borda superior da segmentação de dados na parte superior da planilha. Gera um "o argumento é inválido ou está ausente ou tem um formato incorreto." exceção quando definida com valor negativo como entrada.

top: number;

Valor da propriedade

number

width

Representa a largura, em pontos, da segmentação de dados. Gera um "o argumento é inválido ou está ausente ou tem um formato incorreto." exceção quando definida com valor negativo ou zero como entrada.

width: number;

Valor da propriedade

number

worksheet

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

readonly worksheet: Worksheet;

Valor da propriedade

Detalhes do método

clearFilters()

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

clearFilters(): void;

Retornos

void

Exemplos

async function main(context: Excel.RequestContext) {
    let slicer = context.workbook.slicers.getItem("Fruit Slicer");
    slicer.clearFilters();
    await context.sync();
}

delete()

Exclui a segmentação de dados.

delete(): void;

Retornos

void

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.slicers.getItemAt(0).delete();
    await context.sync();
}

getSelectedItems()

Retorna uma matriz de chaves de itens selecionados.

getSelectedItems(): ClientResult<string[]>;

Retornos

ClientResult<string>[]

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): void;

Parâmetros

propertyNames
string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

void

selectItems(items)

Seleciona itens de segmentação de itens com base em suas chaves. As seleções anteriores estã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 de itens especificados a serem selecionados.

Retornos

void

Exemplos

async function main(context: Excel.RequestContext) {
    let slicer = context.workbook.slicers.getItem("Fruit Slicer");
    slicer.selectItems(["Lemon", "Lime", "Orange"]);
    await context.sync();
}