ExcelScript.Table interface

Representa uma tabela do Excel.

Métodos

addColumn(index, values, name)

Adiciona uma nova coluna à tabela.

addRow(index, values)

Adiciona uma linha à tabela.

addRows(index, values)

Adiciona uma ou mais linhas à tabela.

clearFilters()

Limpa todos os filtros aplicados à tabela no momento.

convertToRange()

Converte a tabela em um intervalo de células normal. Todos os dados são preservados.

delete()

Exclui a tabela.

deleteRowsAt(index, count)

Excluir um número especificado de linhas em um determinado índice.

getAutoFilter()

Representa o objeto AutoFilter da tabela.

getColumn(key)

Obtém um objeto column por nome ou ID. Se a coluna não existir, retornará um objeto null.

getColumnById(key)

Obtém um objeto Column por ID. Se a coluna não existir, retornará indefinido.

getColumnByName(key)

Obtém um objeto Column por nome. Se a coluna não existir, retornará indefinido.

getColumns()

Representa uma coleção de todas as colunas na tabela.

getHeaderRowRange()

Obtém o objeto de intervalo associado à linha de cabeçalho da tabela.

getHighlightFirstColumn()

Especifica se a primeira coluna contém formatação especial.

getHighlightLastColumn()

Especifica se a última coluna contém formatação especial.

getId()

Retorna um valor que identifica de forma exclusiva a tabela em uma determinada pasta de trabalho. O valor do identificador permanece o mesmo, ainda que a tabela seja renomeada.

getLegacyId()

Retorna uma ID numérica.

getName()

Nome da tabela.

getPredefinedTableStyle()

Valor da constante que representa o estilo de Tabela. Os valores possíveis são: "TableStyleLight1" por meio de "TableStyleLight21", "TableStyleMedium1" até "TableStyleMedium28", "TableStyleDark1" até "TableStyleDark11". Também é possível usar um estilo definido pelo usuário que esteja presente na planilha.

getRange()

Obtém o objeto de intervalo associado a toda a tabela.

getRangeBetweenHeaderAndTotal()

Obtém o objeto de intervalo associado ao corpo de dados da tabela.

getRowCount()

Obtém a quantidade de linhas na tabela.

getShowBandedColumns()

Especifica se as colunas mostram a formatação em tiras nas quais as colunas ímpares são realçadas de forma diferente de mesmo para tornar a leitura da tabela mais fácil.

getShowBandedRows()

Especifica se as linhas mostram a formatação em tiras nas quais as linhas ímpares são realçadas de forma diferente de mesmo para tornar a leitura da tabela mais fácil.

getShowFilterButton()

Especifica se os botões de filtro estão visíveis na parte superior de cada cabeçalho de coluna. Essa configuração só será permitida se a tabela tiver uma linha de cabeçalho.

getShowHeaders()

Especifica se a linha de cabeçalho está visível. Esse valor pode ser definido para mostrar ou remover a linha do cabeçalho.

getShowTotals()

Especifica se a linha de total está visível. Esse valor pode ser definido para mostrar ou remover a linha do total.

getSort()

Representa a classificação da tabela.

getTotalRowRange()

Obtém o objeto de intervalo associado à linha de totais da tabela.

getWorksheet()

A planilha que contém a tabela atual.

reapplyFilters()

Aplica novamente todos os filtros à tabela.

setHighlightFirstColumn(highlightFirstColumn)

Especifica se a primeira coluna contém formatação especial.

setHighlightLastColumn(highlightLastColumn)

Especifica se a última coluna contém formatação especial.

setName(name)

Nome da tabela.

setPredefinedTableStyle(predefinedTableStyle)

Valor da constante que representa o estilo de Tabela. Os valores possíveis são: "TableStyleLight1" por meio de "TableStyleLight21", "TableStyleMedium1" até "TableStyleMedium28", "TableStyleDark1" até "TableStyleDark11". Também é possível usar um estilo definido pelo usuário que esteja presente na planilha.

setShowBandedColumns(showBandedColumns)

Especifica se as colunas mostram a formatação em tiras nas quais as colunas ímpares são realçadas de forma diferente de mesmo para tornar a leitura da tabela mais fácil.

setShowBandedRows(showBandedRows)

Especifica se as linhas mostram a formatação em tiras nas quais as linhas ímpares são realçadas de forma diferente de mesmo para tornar a leitura da tabela mais fácil.

setShowFilterButton(showFilterButton)

Especifica se os botões de filtro estão visíveis na parte superior de cada cabeçalho de coluna. Essa configuração só será permitida se a tabela tiver uma linha de cabeçalho.

setShowHeaders(showHeaders)

Especifica se a linha de cabeçalho está visível. Esse valor pode ser definido para mostrar ou remover a linha do cabeçalho.

setShowTotals(showTotals)

Especifica se a linha de total está visível. Esse valor pode ser definido para mostrar ou remover a linha do total.

Detalhes do método

addColumn(index, values, name)

Adiciona uma nova coluna à tabela.

addColumn(
            index?: number,
            values?: (boolean | string | number)[],
            name?: string
        ): TableColumn;

Parâmetros

index
number

Opcional. Especifica a posição relativa da nova coluna. Se for null ou -1, a adição ocorre no final. Colunas com um índice superior serão deslocadas para o lado. Indexado com zero.

values
(boolean | string | number)[]

Opcional. Uma matriz unidimensional de valores não formatados da coluna da tabela.

name
string

Opcional. Especifica o nome da nova coluna. Se for null, o nome padrão será usado.

Retornos

addRow(index, values)

Adiciona uma linha à tabela.

addRow(index?: number, values?: (boolean | string | number)[]): void;

Parâmetros

index
number

Opcional. Especifica a posição relativa da nova linha. Se for null ou -1, a adição ocorre no final. Todas as linhas abaixo da linha inserida serão deslocadas para baixo. Indexado com zero.

values
(boolean | string | number)[]

Opcional. Uma matriz de 1 dimensão de valores não formatados da linha da tabela.

Retornos

void

addRows(index, values)

Adiciona uma ou mais linhas à tabela.

addRows(index?: number, values?: (boolean | string | number)[][]): void;

Parâmetros

index
number

Opcional. Especifica a posição relativa da nova linha. Se for null ou -1, a adição ocorre no final. Todas as linhas abaixo da linha inserida serão deslocadas para baixo. Indexado com zero.

values
(boolean | string | number)[][]

Opcional. Uma matriz bidimensional de valores não formatados da linha da tabela.

Retornos

void

clearFilters()

Limpa todos os filtros aplicados à tabela no momento.

clearFilters(): void;

Retornos

void

convertToRange()

Converte a tabela em um intervalo de células normal. Todos os dados são preservados.

convertToRange(): Range;

Retornos

delete()

Exclui a tabela.

delete(): void;

Retornos

void

deleteRowsAt(index, count)

Excluir um número especificado de linhas em um determinado índice.

deleteRowsAt(index: number, count?: number): void;

Parâmetros

index
number

O valor de índice da linha a ser excluída. Cuidado: o índice da linha pode ter sido movido da hora que você determinou o valor a ser usado para remoção.

count
number

Número de linhas a serem excluídas. Por padrão, uma única linha será excluída.

Retornos

void

getAutoFilter()

Representa o objeto AutoFilter da tabela.

getAutoFilter(): AutoFilter;

Retornos

getColumn(key)

Obtém um objeto column por nome ou ID. Se a coluna não existir, retornará um objeto null.

getColumn(key: number | string): TableColumn | undefined;

Parâmetros

key
number | string

ID ou nome da coluna.

Retornos

TableColumn | undefined

getColumnById(key)

Obtém um objeto Column por ID. Se a coluna não existir, retornará indefinido.

getColumnById(key: number): TableColumn | undefined;

Parâmetros

key
number

ID da coluna.

Retornos

TableColumn | undefined

getColumnByName(key)

Obtém um objeto Column por nome. Se a coluna não existir, retornará indefinido.

getColumnByName(key: string): TableColumn | undefined;

Parâmetros

key
string

Nome da coluna.

Retornos

TableColumn | undefined

getColumns()

Representa uma coleção de todas as colunas na tabela.

getColumns(): TableColumn[];

Retornos

getHeaderRowRange()

Obtém o objeto de intervalo associado à linha de cabeçalho da tabela.

getHeaderRowRange(): Range;

Retornos

getHighlightFirstColumn()

Especifica se a primeira coluna contém formatação especial.

getHighlightFirstColumn(): boolean;

Retornos

boolean

getHighlightLastColumn()

Especifica se a última coluna contém formatação especial.

getHighlightLastColumn(): boolean;

Retornos

boolean

getId()

Retorna um valor que identifica de forma exclusiva a tabela em uma determinada pasta de trabalho. O valor do identificador permanece o mesmo, ainda que a tabela seja renomeada.

getId(): string;

Retornos

string

getLegacyId()

Retorna uma ID numérica.

getLegacyId(): string;

Retornos

string

getName()

Nome da tabela.

getName(): string;

Retornos

string

getPredefinedTableStyle()

Valor da constante que representa o estilo de Tabela. Os valores possíveis são: "TableStyleLight1" por meio de "TableStyleLight21", "TableStyleMedium1" até "TableStyleMedium28", "TableStyleDark1" até "TableStyleDark11". Também é possível usar um estilo definido pelo usuário que esteja presente na planilha.

getPredefinedTableStyle(): string;

Retornos

string

getRange()

Obtém o objeto de intervalo associado a toda a tabela.

getRange(): Range;

Retornos

getRangeBetweenHeaderAndTotal()

Obtém o objeto de intervalo associado ao corpo de dados da tabela.

getRangeBetweenHeaderAndTotal(): Range;

Retornos

getRowCount()

Obtém a quantidade de linhas na tabela.

getRowCount(): number;

Retornos

number

getShowBandedColumns()

Especifica se as colunas mostram a formatação em tiras nas quais as colunas ímpares são realçadas de forma diferente de mesmo para tornar a leitura da tabela mais fácil.

getShowBandedColumns(): boolean;

Retornos

boolean

getShowBandedRows()

Especifica se as linhas mostram a formatação em tiras nas quais as linhas ímpares são realçadas de forma diferente de mesmo para tornar a leitura da tabela mais fácil.

getShowBandedRows(): boolean;

Retornos

boolean

getShowFilterButton()

Especifica se os botões de filtro estão visíveis na parte superior de cada cabeçalho de coluna. Essa configuração só será permitida se a tabela tiver uma linha de cabeçalho.

getShowFilterButton(): boolean;

Retornos

boolean

getShowHeaders()

Especifica se a linha de cabeçalho está visível. Esse valor pode ser definido para mostrar ou remover a linha do cabeçalho.

getShowHeaders(): boolean;

Retornos

boolean

getShowTotals()

Especifica se a linha de total está visível. Esse valor pode ser definido para mostrar ou remover a linha do total.

getShowTotals(): boolean;

Retornos

boolean

getSort()

Representa a classificação da tabela.

getSort(): TableSort;

Retornos

getTotalRowRange()

Obtém o objeto de intervalo associado à linha de totais da tabela.

getTotalRowRange(): Range;

Retornos

getWorksheet()

A planilha que contém a tabela atual.

getWorksheet(): Worksheet;

Retornos

reapplyFilters()

Aplica novamente todos os filtros à tabela.

reapplyFilters(): void;

Retornos

void

setHighlightFirstColumn(highlightFirstColumn)

Especifica se a primeira coluna contém formatação especial.

setHighlightFirstColumn(highlightFirstColumn: boolean): void;

Parâmetros

highlightFirstColumn
boolean

Retornos

void

setHighlightLastColumn(highlightLastColumn)

Especifica se a última coluna contém formatação especial.

setHighlightLastColumn(highlightLastColumn: boolean): void;

Parâmetros

highlightLastColumn
boolean

Retornos

void

setName(name)

Nome da tabela.

setName(name: string): void;

Parâmetros

name
string

Retornos

void

setPredefinedTableStyle(predefinedTableStyle)

Valor da constante que representa o estilo de Tabela. Os valores possíveis são: "TableStyleLight1" por meio de "TableStyleLight21", "TableStyleMedium1" até "TableStyleMedium28", "TableStyleDark1" até "TableStyleDark11". Também é possível usar um estilo definido pelo usuário que esteja presente na planilha.

setPredefinedTableStyle(predefinedTableStyle: string): void;

Parâmetros

predefinedTableStyle
string

Retornos

void

setShowBandedColumns(showBandedColumns)

Especifica se as colunas mostram a formatação em tiras nas quais as colunas ímpares são realçadas de forma diferente de mesmo para tornar a leitura da tabela mais fácil.

setShowBandedColumns(showBandedColumns: boolean): void;

Parâmetros

showBandedColumns
boolean

Retornos

void

setShowBandedRows(showBandedRows)

Especifica se as linhas mostram a formatação em tiras nas quais as linhas ímpares são realçadas de forma diferente de mesmo para tornar a leitura da tabela mais fácil.

setShowBandedRows(showBandedRows: boolean): void;

Parâmetros

showBandedRows
boolean

Retornos

void

setShowFilterButton(showFilterButton)

Especifica se os botões de filtro estão visíveis na parte superior de cada cabeçalho de coluna. Essa configuração só será permitida se a tabela tiver uma linha de cabeçalho.

setShowFilterButton(showFilterButton: boolean): void;

Parâmetros

showFilterButton
boolean

Retornos

void

setShowHeaders(showHeaders)

Especifica se a linha de cabeçalho está visível. Esse valor pode ser definido para mostrar ou remover a linha do cabeçalho.

setShowHeaders(showHeaders: boolean): void;

Parâmetros

showHeaders
boolean

Retornos

void

setShowTotals(showTotals)

Especifica se a linha de total está visível. Esse valor pode ser definido para mostrar ou remover a linha do total.

setShowTotals(showTotals: boolean): void;

Parâmetros

showTotals
boolean

Retornos

void