ExcelScript.TableColumn interface

Pacote:

ExcelScript

Representa uma coluna em uma tabela.

Comentários

Exemplos

/**
 * This script shows how to get the range of a table column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the workbook.
  const table = workbook.getTables()[0];

  // Get the range of the table column named "Type".
  const typeColumn : ExcelScript.TableColumn = table.getColumn("Type");
  const range = typeColumn.getRange();

  // Do something with the range...
}

Métodos

delete()	Exclui a coluna da tabela.
getFilter()	Obtém o filtro aplicado à coluna.
getHeaderRowRange()	Obtém o objeto de intervalo associado à linha de cabeçalho da coluna.
getId()	Retorna uma chave exclusiva que identifica a coluna na tabela.
getIndex()	Retorna o número de índice da coluna na coleção de colunas da tabela. Indexado com zero.
getName()	Especifica o nome da coluna da tabela.
getRange()	Obtém o objeto de intervalo associado a toda a coluna.
getRangeBetweenHeaderAndTotal()	Obtém o objeto de intervalo associado ao corpo de dados da coluna.
getTotalRowRange()	Obtém o objeto de intervalo associado à linha de totais da coluna.
setName(name)	Especifica o nome da coluna da tabela.

Detalhes do método

delete()

Exclui a coluna da tabela.

delete(): void;

Retornos

void

Exemplos

/**
 * This script removes a specific column from a table.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the table named "Inventory".
    const table = workbook.getTable("Inventory");

    // If it exists, remove the column named "Category".
    let categoryColumn = table.getColumnByName("Category");
    if (categoryColumn) {
        categoryColumn.delete();
    }
}

getFilter()

Obtém o filtro aplicado à coluna.

getFilter(): Filter;

Retornos

ExcelScript.Filter

Exemplos

/**
 * This script adds a table filter to only show the top 10% of values 
 * belonging to a particular column.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the first table on the current worksheet.
    const table = workbook.getActiveWorksheet().getTables()[0];

    // Get the filter for the "PageViews" table column.
    const pageViewFilter = table.getColumnByName("PageViews").getFilter();

    // Apply a filter to only show the rows with the top 10% of values in this column.
    pageViewFilter.applyTopPercentFilter(10);
}

getHeaderRowRange()

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

getHeaderRowRange(): Range;

Retornos

ExcelScript.Range

getId()

Retorna uma chave exclusiva que identifica a coluna na tabela.

getId(): number;

Retornos

number

getIndex()

Retorna o número de índice da coluna na coleção de colunas da tabela. Indexado com zero.

getIndex(): number;

Retornos

number

getName()

Especifica o nome da coluna da tabela.

getName(): string;

Retornos

string

getRange()

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

getRange(): Range;

Retornos

ExcelScript.Range

getRangeBetweenHeaderAndTotal()

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

getRangeBetweenHeaderAndTotal(): Range;

Retornos

ExcelScript.Range

Exemplos

/**
 * This script adds a new column to a table.
 * It then sets the formulas in the new column to be the product
 * of the values in the two preceding columns.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the workbook.
  const table = workbook.getTables()[0];

  // Append an empty column to the table with the header "Total". 
  const totalColumn = table.addColumn(-1, null, "Total");

  // Get the names of the two preceding columns.
  const productColumnName1 = table.getColumns()[totalColumn.getIndex() - 1].getName();
  const productColumnName2 = table.getColumns()[totalColumn.getIndex() - 2].getName();
  
  // Set the formulas in the "Total" column to be the product of the two preceding columns.
  totalColumn.getRangeBetweenHeaderAndTotal().setFormula(
    `=[@[${productColumnName1}]]*[@[${productColumnName2}]]`
  );
}

getTotalRowRange()

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

getTotalRowRange(): Range;

Retornos

ExcelScript.Range

Exemplos

/**
 * This script logs the value in the total row of a table column.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the table named "Cities".
    const table = workbook.getTable("Cities");

    // Get the total row from the "Population" column.
    const column = table.getColumn("Population");
    const totalRange = column.getTotalRowRange();

    // Log the total value.
    console.log(totalRange.getValue());
}

setName(name)

Especifica o nome da coluna da tabela.

setName(name: string): void;

Parâmetros

name

string

Retornos

void

Exemplos

/**
 * This script renames a column in an existing table.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the "Employee" table.
  const employeeTable = workbook.getTable("Employee");

  // Rename a column from "EmplID" to "Employee ID".
  const idColumn = employeeTable.getColumnByName("EmplID");
  idColumn.setName("Employee ID");
}