Excel.SlicerCollection class
Representa uma coleção de todos os objetos de segmentação de dados no livro ou numa folha de cálculo.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.10 ]
Propriedades
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã 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 de segmentação de dados com o respetivo 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 de dados com o respetivo nome ou ID. Se a segmentação de dados não existir, este método devolve um objeto com a respetiva |
| 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 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
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 origem de dados na qual a nova segmentação de dados será baseada. Pode ser um PivotTable objeto, um Table objeto ou uma cadeia. Quando um objeto de tabela dinâmica é transmitido, a origem de dados é a origem do PivotTable objeto. Quando um Table objeto é transmitido, a origem de dados é o Table objeto . Quando uma cadeia é transmitida, é interpretada como o nome ou ID de uma tabela dinâmica ou tabela.
- sourceField
-
string | Excel.PivotField | number | Excel.TableColumn
O campo na origem de dados pelo qual filtrar. Pode ser um PivotField objeto, um TableColumn objeto, o ID de um PivotField ou o nome ou ID de um TableColumn.
- slicerDestination
-
string | Excel.Worksheet
Opcional. A folha de cálculo na qual a nova segmentação de dados será criada. Pode ser um Worksheet objeto ou o nome ou ID de uma folha de cálculo. Este parâmetro pode ser omitido se a coleção de segmentação de dados for obtida a partir de uma folha de cálculo.
Retornos
A nova segmentação de dados.
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 de segmentação de dados com o respetivo nome ou ID.
getItem(key: string): Excel.Slicer;Parâmetros
- key
-
string
O nome ou 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 de dados com o respetivo nome ou ID. Se a segmentação de dados não existir, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getItemOrNullObject(key: string): Excel.Slicer;Parâmetros
- key
-
string
Nome ou ID da segmentação de dados a obter.
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 as propriedades do objeto a 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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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 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
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.SlicerCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito 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;