Excel.SlicerCollection class
Representa uma coleção de todos os objetos slicer na pasta de trabalho ou em uma planilha.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.10 ]
Propriedades
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| add(slicer |
Adiciona uma nova segmentação de dados à pasta de trabalho. |
| get |
Retorna o número de segmentações de dados na coleção. |
| get |
Obtém um objeto slicer usando seu nome ou ID. |
| get |
Obtém uma segmentação de dados com base em sua posição na coleção. |
| get |
Obtém uma segmentação usando seu nome ou ID. Se a segmentação não existir, esse método retornará um objeto com sua |
| 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 |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.Slicer[];Valor da propriedade
Detalhes do método
add(slicerSource, sourceField, slicerDestination)
Adiciona uma nova segmentação de dados à pasta de trabalho.
add(slicerSource: string | PivotTable | Table, sourceField: string | PivotField | number | TableColumn, slicerDestination?: string | Worksheet): Excel.Slicer;Parâmetros
- slicerSource
-
string | Excel.PivotTable | Excel.Table
A fonte de dados na qual a nova segmentação será baseada. Pode ser um PivotTable objeto, um Table objeto ou uma cadeia de caracteres. Quando um objeto PivotTable é passado, a fonte de dados é a fonte do PivotTable objeto. Quando um Table objeto é passado, a fonte de dados é o Table objeto. Quando uma cadeia de caracteres é passada, ela é interpretada como o nome ou a ID de uma tabela ou tabela dinâmica.
- sourceField
-
string | Excel.PivotField | number | Excel.TableColumn
O campo na fonte de dados a ser filtrado. Pode ser um PivotField objeto, um TableColumn objeto, a ID de um PivotField ou o nome ou ID de um TableColumn.
- slicerDestination
-
string | Excel.Worksheet
Opcional. A planilha na qual a nova segmentação será criada. Pode ser um Worksheet objeto ou o nome ou ID de uma planilha. Esse parâmetro poderá ser omitido se a coleção slicer for recuperada de uma planilha.
Retornos
A nova segmentação.
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.getItem("Pivot");
const slicer = sheet.slicers.add(
"Farm Sales", /* The slicer data source. For PivotTables, this can be the PivotTable object reference or name. */
"Type" /* The field in the data source to filter by. For PivotTables, this can be a PivotField object reference or ID. */
);
slicer.name = "Fruit Slicer";
await context.sync();
});
getCount()
Retorna o número de segmentações de dados na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
getItem(key)
Obtém um objeto slicer usando seu nome ou ID.
getItem(key: string): Excel.Slicer;Parâmetros
- key
-
string
O nome ou A ID da segmentação de dados.
Retornos
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.caption = "Fruit Types";
slicer.left = 395;
slicer.top = 15;
slicer.height = 135;
slicer.width = 150;
await context.sync();
});
getItemAt(index)
Obtém uma segmentação de dados com base em sua posição na coleção.
getItemAt(index: number): Excel.Slicer;Parâmetros
- index
-
number
Valor de índice do objeto a ser recuperado. Indexados com zero.
Retornos
Comentários
getItemOrNullObject(key)
Obtém uma segmentação usando seu nome ou ID. Se a segmentação não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getItemOrNullObject(key: string): Excel.Slicer;Parâmetros
- key
-
string
Nome ou ID da segmentação a ser recuperada.
Retornos
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.SlicerCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerCollection;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.SlicerCollection;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?: OfficeExtension.LoadOption): Excel.SlicerCollection;Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
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.) Considerando que o objeto original Excel.SlicerCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.SlicerCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.SlicerCollectionData;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