ExcelScript.TableColumn interface

Paket:

ExcelScript

Stellt eine Spalte in einer Tabelle dar.

Hinweise

Beispiele

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

Methoden

delete()	Löscht die Spalte aus der Tabelle.
getFilter()	Ruft den auf die Spalte angewendeten Filter ab.
getHeaderRowRange()	Ruft das Bereichsobjekt ab, das mit der Überschriftenzeile der Spalte verknüpft ist.
getId()	Gibt einen eindeutigen Schlüssel an, der die Spalte in der Tabelle angibt.
getIndex()	Gibt die Indexnummer der Spalte in der Spaltenauflistung der Tabelle zurück. Nullindiziert.
getName()	Gibt den Namen der Tabellenspalte an.
getRange()	Ruft das Bereichsobjekt ab, das mit der gesamten Spalte verknüpft ist.
getRangeBetweenHeaderAndTotal()	Ruft das Bereichsobjekt ab, das mit dem Datenteil der Spalte verknüpft ist.
getTotalRowRange()	Ruft das Bereichsobjekt ab, das mit der Ergebniszeile der Spalte verknüpft ist.
setName(name)	Gibt den Namen der Tabellenspalte an.

Details zur Methode

delete()

Löscht die Spalte aus der Tabelle.

delete(): void;

Gibt zurück

void

Beispiele

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

Ruft den auf die Spalte angewendeten Filter ab.

getFilter(): Filter;

Gibt zurück

ExcelScript.Filter

Beispiele

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

Ruft das Bereichsobjekt ab, das mit der Überschriftenzeile der Spalte verknüpft ist.

getHeaderRowRange(): Range;

Gibt zurück

ExcelScript.Range

getId()

Gibt einen eindeutigen Schlüssel an, der die Spalte in der Tabelle angibt.

getId(): number;

Gibt zurück

number

getIndex()

Gibt die Indexnummer der Spalte in der Spaltenauflistung der Tabelle zurück. Nullindiziert.

getIndex(): number;

Gibt zurück

number

getName()

Gibt den Namen der Tabellenspalte an.

getName(): string;

Gibt zurück

string

getRange()

Ruft das Bereichsobjekt ab, das mit der gesamten Spalte verknüpft ist.

getRange(): Range;

Gibt zurück

ExcelScript.Range

getRangeBetweenHeaderAndTotal()

Ruft das Bereichsobjekt ab, das mit dem Datenteil der Spalte verknüpft ist.

getRangeBetweenHeaderAndTotal(): Range;

Gibt zurück

ExcelScript.Range

Beispiele

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

Ruft das Bereichsobjekt ab, das mit der Ergebniszeile der Spalte verknüpft ist.

getTotalRowRange(): Range;

Gibt zurück

ExcelScript.Range

Beispiele

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

Gibt den Namen der Tabellenspalte an.

setName(name: string): void;

Parameter

name

string

Gibt zurück

void

Beispiele

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