Excel.SlicerCollection interface

Representa uma coleção de todos os objetos slicery na pasta de trabalho ou em uma planilha.

Métodos

add(slicerSource, sourceField, slicerDestination)

Adiciona uma nova segmentação de dados à pasta de trabalho.

getCount()

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

getItem(key)

Obtém um objeto de segmentação de dados usando seu respectivo nome ou ID.

getItemAt(index)

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

getItemOrNullObject(key)

Obtém uma segmentação de dados usando seu nome ou id. Se a ela não existir, retornará um objeto null.

load(propertyNames)

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

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
        ): Slicer;

Parâmetros

slicerSource
string | PivotTable | Table

A fonte de dados na qual o novo slicer será baseado. Pode ser um objeto PivotTable, um objeto Table ou uma cadeia de caracteres. Quando um objeto PivotTable é passado, a fonte de dados é a fonte do objeto PivotTable. Quando um objeto Table é passado, a fonte de dados é o objeto Table. Quando uma cadeia de caracteres é passada, ela é interpretada como o nome/ID de uma tabela dinâmica.

sourceField
string | PivotField | number | TableColumn

O campo na fonte de dados a ser filtrado. Pode ser um objeto PivotField, um objeto TableColumn, a ID de um PivotField ou a ID/nome de TableColumn.

slicerDestination
string | Worksheet

Opcional. A planilha na qual a nova segmentação de trabalho será criada. Pode ser um objeto Worksheet ou o nome/ID de uma planilha. Esse parâmetro pode ser omitido se a coleção slicer for recuperada da planilha.

Retornos

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Pivot");
    let 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(): ClientResult<number>;

Retornos

ClientResult<number>

getItem(key)

Obtém um objeto de segmentação de dados usando seu respectivo nome ou ID.

getItem(key: string): Slicer;

Parâmetros

key
string

O nome ou a ID da segmentação de,.

Retornos

getItemAt(index)

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

getItemAt(index: number): Slicer;

Parâmetros

index
number

Valor de índice do objeto a ser recuperado. Indexados com zero.

Retornos

getItemOrNullObject(key)

Obtém uma segmentação de dados usando seu nome ou id. Se a ela não existir, retornará um objeto null.

getItemOrNullObject(key: string): Slicer;

Parâmetros

key
string

Nome ou ID da segmentação de, a ser recuperada.

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[]): void;

Parâmetros

propertyNames
string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

void