Excel.Slicer class
Representa um Slicer objeto na pasta de trabalho.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.10 ]
Propriedades
| caption | Representa a legenda da segmentação. |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| height | Representa a altura, em pontos, da segmentação de dados. Gera uma exceção |
| id | Representa a ID exclusiva da segmentação. |
| is |
O valor será |
| left | Representa a distância, em pontos, da lateral esquerda da segmentação de dados à esquerda da planilha. Lança um |
| name | Representa o nome da segmentação. |
| name |
Representa o nome da segmentação de dados usada na fórmula. |
| slicer |
Representa a coleção de itens de segmentação que fazem parte da segmentação. |
| slicer |
O estilo aplicado à segmentação. |
| sort |
Representa a ordem de classificação dos itens na segmentação de dados. Os valores possíveis são: "DataSourceOrder", "Ascending", "Descending". |
| 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. |
| top | Representa a distância, em pontos, da borda superior da segmentação de dados na parte superior da planilha. Lança um |
| width | Representa a largura, em pontos, da segmentação de dados. Lança um |
| worksheet | Representa a planilha que contém a segmentação de dados. |
Métodos
| clear |
Limpa todos os filtros aplicados à segmentação de dados no momento. |
| delete() | Exclui a segmentação de dados. |
| get |
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 |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| select |
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. |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente. |
| set |
Define o estilo aplicado à segmentação. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
caption
Representa a legenda da segmentação.
caption: string;Valor da propriedade
string
Comentários
context
O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;Valor da propriedade
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.
height: number;Valor da propriedade
number
Comentários
id
Representa a ID exclusiva da segmentação.
readonly id: string;Valor da propriedade
string
Comentários
isFilterCleared
O valor será true se todos os filtros aplicados atualmente na segmentação forem desmarcados.
readonly isFilterCleared: boolean;Valor da propriedade
boolean
Comentários
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.
left: number;Valor da propriedade
number
Comentários
name
Representa o nome da segmentação.
name: string;Valor da propriedade
string
Comentários
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
slicerItems
Representa a coleção de itens de segmentação que fazem parte da segmentação.
readonly slicerItems: Excel.SlicerItemCollection;Valor da propriedade
Comentários
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.
readonly slicerStyle: Excel.SlicerStyle;Valor da propriedade
Comentários
sortBy
Representa a ordem de classificação dos itens na segmentação de dados. Os valores possíveis são: "DataSourceOrder", "Ascending", "Descending".
sortBy: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending";Valor da propriedade
Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"
Comentários
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.
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. Lança um InvalidArgument erro quando definido com um valor negativo como uma entrada.
top: number;Valor da propriedade
number
Comentários
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.
width: number;Valor da propriedade
number
Comentários
worksheet
Representa a planilha que contém a segmentação de dados.
readonly worksheet: Excel.Worksheet;Valor da propriedade
Comentários
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
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
Fornece opções para quais propriedades do objeto carregar.
Retornos
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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
Retornos
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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
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
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. Você pode passar um objeto simples com as propriedades apropriadas 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 estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base em um 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.
setStyle(style: string | SlicerStyle | BuiltInSlicerStyle): void;Parâmetros
- style
-
string | Excel.SlicerStyle | Excel.BuiltInSlicerStyle
O estilo a ser aplicado à segmentação. Um InvalidArgument erro será gerado se uma cadeia de caracteres for fornecida que não corresponda ao nome de nenhum estilo.
Retornos
void
Comentários
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.Slicer original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.SlicerData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.SlicerData;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de