ExcelScript.PivotField interface

Representa o Excel PivotField.

Métodos

applyFilter(filter)

Define um ou mais PivotFilters atuais do campo e os aplica ao campo. Se os filtros fornecidos forem inválidos ou não puderem ser aplicados, uma exceção será lançada.

clearAllFilters()

Limpa todos os critérios de todos os filtros de campo. Isso removerá qualquer filtragem ativa no campo.

clearFilter(filterType)

Limpa todos os critérios existentes do filtro do campo de determinado tipo (se houver algum aplicado no momento).

getFilters()

Obtém todos os filtros aplicados no campo no momento.

getId()

ID do PivotField..

getItems()

Retorna PivotFields associados ao PivotField.

getName()

Nome do PivotField.

getPivotItem(name)

Obtém um PivotItem pelo nome. Se o PivotItem não existir, retornará um objeto NULL.

getShowAllItems()

Determina se deseja mostrar todos os itens de PivotField.

getSubtotals()

Subtotais de PivotField.

isFiltered(filterType)

Verifica se há filtros aplicados no campo.

setName(name)

Nome do PivotField.

setShowAllItems(showAllItems)

Determina se deseja mostrar todos os itens de PivotField.

setSubtotals(subtotals)

Subtotais de PivotField.

sortByLabels(sortBy)

Classifica o PivotField. Se um DataPivotHierarchy for especificado, a classificação será aplicada com base nele, se a classificação não for baseada no campo PivotField.

sortByValues(sortBy, valuesHierarchy, pivotItemScope)

Classifica o Campo dinâmico por valores especificados em um determinado escopo. O escopo define quais valores específicos serão usados para classificar quando houver vários valores do mesmo DataPivotHierarchy.

Detalhes do método

applyFilter(filter)

Define um ou mais PivotFilters atuais do campo e os aplica ao campo. Se os filtros fornecidos forem inválidos ou não puderem ser aplicados, uma exceção será lançada.

applyFilter(filter: PivotFilters): void;

Parâmetros

filter
PivotFilters

Um PivotFilter específico configurado ou uma interface PivotFilters que contém vários filtros configurados.

Retornos

void

clearAllFilters()

Limpa todos os critérios de todos os filtros de campo. Isso removerá qualquer filtragem ativa no campo.

clearAllFilters(): void;

Retornos

void

clearFilter(filterType)

Limpa todos os critérios existentes do filtro do campo de determinado tipo (se houver algum aplicado no momento).

clearFilter(filterType: PivotFilterType): void;

Parâmetros

filterType
PivotFilterType

O tipo de filtro no campo do qual limpar todos os critérios.

Retornos

void

getFilters()

Obtém todos os filtros aplicados no campo no momento.

getFilters(): PivotFilters;

Retornos

getId()

ID do PivotField..

getId(): string;

Retornos

string

getItems()

Retorna PivotFields associados ao PivotField.

getItems(): PivotItem[];

Retornos

getName()

Nome do PivotField.

getName(): string;

Retornos

string

getPivotItem(name)

Obtém um PivotItem pelo nome. Se o PivotItem não existir, retornará um objeto NULL.

getPivotItem(name: string): PivotItem | undefined;

Parâmetros

name
string

Nome do PivotItem a ser recuperado.

Retornos

PivotItem | undefined

getShowAllItems()

Determina se deseja mostrar todos os itens de PivotField.

getShowAllItems(): boolean;

Retornos

boolean

getSubtotals()

Subtotais de PivotField.

getSubtotals(): Subtotals;

Retornos

isFiltered(filterType)

Verifica se há filtros aplicados no campo.

isFiltered(filterType?: PivotFilterType): boolean;

Parâmetros

filterType
PivotFilterType

O tipo de filtro a ser verificado. Se nenhum tipo for fornecido, este método verificará se o filtro foi aplicado.

Retornos

boolean

setName(name)

Nome do PivotField.

setName(name: string): void;

Parâmetros

name
string

Retornos

void

setShowAllItems(showAllItems)

Determina se deseja mostrar todos os itens de PivotField.

setShowAllItems(showAllItems: boolean): void;

Parâmetros

showAllItems
boolean

Retornos

void

setSubtotals(subtotals)

Subtotais de PivotField.

setSubtotals(subtotals: Subtotals): void;

Parâmetros

subtotals
Subtotals

Retornos

void

sortByLabels(sortBy)

Classifica o PivotField. Se um DataPivotHierarchy for especificado, a classificação será aplicada com base nele, se a classificação não for baseada no campo PivotField.

sortByLabels(sortBy: SortBy): void;

Parâmetros

sortBy
SortBy

Especifica se a classificação é feita em ordem crescente ou decrescente.

Retornos

void

sortByValues(sortBy, valuesHierarchy, pivotItemScope)

Classifica o Campo dinâmico por valores especificados em um determinado escopo. O escopo define quais valores específicos serão usados para classificar quando houver vários valores do mesmo DataPivotHierarchy.

sortByValues(
            sortBy: SortBy,
            valuesHierarchy: DataPivotHierarchy,
            pivotItemScope?: Array<PivotItem | string>
        ): void;

Parâmetros

sortBy
SortBy

Especifica se a classificação é feita em ordem crescente ou decrescente.

valuesHierarchy
DataPivotHierarchy

Especifica a hierarquia de valores no eixo dos dados a ser usado para a classificação.

pivotItemScope
Array<PivotItem | string>

Os itens que devem ser usados para o escopo da classificação. Eles serão os itens que compõem a linha ou coluna que você deseja classificar. Se uma cadeia de caracteres é usada em vez de um PivotItem, a cadeia de caracteres representa a ID do PivotItem. Se não houver nenhum item além da hierarquia de dados no eixo que você deseja classificar, isso poderá ficar vazio.

Retornos

void