Excel.Slicer class

  • Referência
Pacote:
excel

Representa um Slicer objeto no livro.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

Propriedades

caption

Representa a legenda da segmentação de dados.
context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
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 entrada.
id

Representa o ID exclusivo da segmentação de dados.
isFilterCleared

O valor é true se todos os filtros atualmente aplicados na segmentação de dados estiverem limpos.
left

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

Representa o nome da segmentação de dados.
nameInFormula

Representa o nome da segmentação de dados usada na fórmula.
slicerItems

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

O estilo aplicado à 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", "Ascendente", "Descendente".
style

Valor constante que representa o estilo de segmentação de dados. Os valores possíveis são: "SlicerStyleLight1" através 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 InvalidArgument erro quando definido com um valor negativo como entrada.
width

Representa a largura, em pontos, da segmentação de dados. Gera um InvalidArgument erro quando definido com um 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(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
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(propertyNamesAndPaths)

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 dados com base nas respetivas chaves. As seleções anteriores são desmarcadas. Todos os itens serão selecionados por predefinição se a matriz estiver vazia.
set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
setStyle(style)

Define o estilo aplicado à segmentação de dados.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.Slicer é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.SlicerData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

caption

Representa a legenda da segmentação de dados.

caption: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

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 entrada.

height: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

id

Representa o ID exclusivo da segmentação de dados.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

isFilterCleared

O valor é true se todos os filtros atualmente aplicados na segmentação de dados estiverem limpos.

readonly isFilterCleared: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

left

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

left: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

name

Representa o nome da segmentação de dados.

name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

nameInFormula

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Representa o nome da segmentação de dados usada na fórmula.

nameInFormula: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

slicerItems

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

readonly slicerItems: Excel.SlicerItemCollection;

Valor da propriedade

Excel.SlicerItemCollection

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

slicerStyle

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

O estilo aplicado à segmentação de dados.

readonly slicerStyle: Excel.SlicerStyle;

Valor da propriedade

Excel.SlicerStyle

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

sortBy

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

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

Valor da propriedade

Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

style

Valor constante que representa o estilo de segmentação de dados. Os valores possíveis são: "SlicerStyleLight1" através 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

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const 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 InvalidArgument erro quando definido com um valor negativo como entrada.

top: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

width

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

width: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

worksheet

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

readonly worksheet: Excel.Worksheet;

Valor da propriedade

Excel.Worksheet

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

Detalhes do método

clearFilters()

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

clearFilters(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const slicer = context.workbook.slicers.getItem("Fruit Slicer");
    slicer.clearFilters();
    await context.sync();
});

delete()

Exclui a segmentação de dados.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.slicers.getItemAt(0).delete();
    await context.sync();
});

getSelectedItems()

Retorna uma matriz de chaves de itens selecionados.

getSelectedItems(): OfficeExtension.ClientResult<string[]>;

Retornos

OfficeExtension.ClientResult<string[]>

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

load(options)

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

load(options?: Excel.Interfaces.SlicerLoadOptions): Excel.Slicer;

Parâmetros

options
Excel.Interfaces.SlicerLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.Slicer

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[]): Excel.Slicer;

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.Slicer

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Slicer;

Parâmetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Excel.Slicer

selectItems(items)

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

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

Parâmetros

items

string[]

Opcional. Os nomes de itens de segmentação de dados especificados a selecionar.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const slicer = context.workbook.slicers.getItem("Fruit Slicer");
    slicer.selectItems(["Lemon", "Lime", "Orange"]);
    await context.sync();
});

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.SlicerUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Excel.Interfaces.SlicerUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Excel.Slicer): void;

Parâmetros

properties
Excel.Slicer

Retornos

void

setStyle(style)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Define o estilo aplicado à segmentação de dados.

setStyle(style: string | SlicerStyle | BuiltInSlicerStyle): void;

Parâmetros

style

string | Excel.SlicerStyle | Excel.BuiltInSlicerStyle

O estilo a aplicar à segmentação de dados. É InvalidArgument gerado um erro se for fornecida uma cadeia que não corresponda ao nome de qualquer estilo.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.Slicer é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.SlicerData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.SlicerData;

Retornos

Excel.Interfaces.SlicerData