Excel.SlicerCollection class

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

Obtém os itens filhos carregados nesta coleção.

readonly items: Excel.Slicer[];

Valor da propriedade

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

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();
});

Retorna o número de segmentações de dados na coleção.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

Obtém um objeto de segmentação de dados com o respetivo nome ou ID.

getItem(key: string): Excel.Slicer;

Parâmetros

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();
});

Obtém uma segmentação de dados com base em sua posição na coleção.

getItemAt(index: number): Excel.Slicer;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

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

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

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

Retornos

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

Retornos

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

Retornos

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;

Retornos