ExcelScript.TableColumn interface

Пакет:

ExcelScript

Представляет столбец в таблице.

Комментарии

Примеры

/**
 * 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...
}

Методы

delete()	Удаляет столбец из таблицы.
getFilter()	Извлекает фильтр, примененный к столбцу.
getHeaderRowRange()	Получает объект диапазона, связанный со строкой заголовков столбца.
getId()	Возвращает уникальный ключ, идентифицирующий столбец в таблице.
getIndex()	Возвращает номер индекса столбца в коллекции столбцов таблицы. Используется нулевой индекс.
getName()	Указывает имя столбца таблицы.
getRange()	Получает объект диапазона, связанный со всем столбцом.
getRangeBetweenHeaderAndTotal()	Получает объект диапазона, связанный с текстом данных столбца.
getTotalRowRange()	Получает объект диапазона, связанный со строкой итогов столбца.
setName(name)	Указывает имя столбца таблицы.

Сведения о методе

delete()

Удаляет столбец из таблицы.

delete(): void;

Возвращаемое значение

void

Примеры

/**
 * 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()

Извлекает фильтр, примененный к столбцу.

getFilter(): Filter;

Возвращаемое значение

ExcelScript.Filter

Примеры

/**
 * 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()

Получает объект диапазона, связанный со строкой заголовков столбца.

getHeaderRowRange(): Range;

Возвращаемое значение

ExcelScript.Range

getId()

Возвращает уникальный ключ, идентифицирующий столбец в таблице.

getId(): number;

Возвращаемое значение

number

getIndex()

Возвращает номер индекса столбца в коллекции столбцов таблицы. Используется нулевой индекс.

getIndex(): number;

Возвращаемое значение

number

getName()

Указывает имя столбца таблицы.

getName(): string;

Возвращаемое значение

string

getRange()

Получает объект диапазона, связанный со всем столбцом.

getRange(): Range;

Возвращаемое значение

ExcelScript.Range

getRangeBetweenHeaderAndTotal()

Получает объект диапазона, связанный с текстом данных столбца.

getRangeBetweenHeaderAndTotal(): Range;

Возвращаемое значение

ExcelScript.Range

Примеры

/**
 * 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()

Получает объект диапазона, связанный со строкой итогов столбца.

getTotalRowRange(): Range;

Возвращаемое значение

ExcelScript.Range

Примеры

/**
 * 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)

Указывает имя столбца таблицы.

setName(name: string): void;

Параметры

name

string

Возвращаемое значение

void

Примеры

/**
 * 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");
}