ExcelScript.Table interface

Referenz

Paket:: ExcelScript

Stellt eine Excel-Tabelle dar.

Hinweise

Beispiele

/**
 * This script creates a table from the current sheet's used range.
 * It then adds a total row to the table with the SUM of the last column.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the used range of the current worksheet.
    const sheet = workbook.getActiveWorksheet();
    const range = sheet.getUsedRange();

    // Create a table that has headers from that range.
    const table = sheet.addTable(range, true);

    // Have the table display the SUM for the last column.
    table.setShowTotals(true);
    const lastColumn = table.getColumn(table.getColumns().length);
    lastColumn.getTotalRowRange().setFormula(`=SUBTOTAL(109,[${lastColumn.getName()}])`);
}

Methoden

addColumn(index, values, name)	Fügt der Tabelle eine neue Spalte hinzu.
addRow(index, values)	Fügt der Tabelle eine Zeile hinzu.
addRows(index, values)	Fügt der Tabelle mindestens eine Zeile hinzu.
clearFilters()	Löscht alle Filter, die derzeit in der Tabelle verwendet werden.
convertToRange()	Wandelt die Tabelle in einen normalen Bereich von Zellen um. Alle Daten werden beibehalten.
delete()	Löscht die Tabelle.
deleteRowsAt(index, count)	Löscht eine angegebene Anzahl von Zeilen an einem bestimmten Index.
getAutoFilter()	Stellt das `AutoFilter` -Objekt der Tabelle dar.
getColumn(key)	Ruft ein Spaltenobjekt nach Name oder ID ab. Wenn die Spalte nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getColumnById(key)	Ruft ein Spaltenobjekt nach ID ab. Wenn die Spalte nicht vorhanden ist, gibt undefined zurück.
getColumnByName(key)	Ruft ein Spaltenobjekt nach Name ab. Wenn die Spalte nicht vorhanden ist, gibt undefined zurück.
getColumns()	Stellt eine Auflistung aller Spalten in der Tabelle dar.
getHeaderRowRange()	Ruft das Bereichsobjekt ab, das mit der Überschriftenzeile der Tabelle verknüpft ist.
getHighlightFirstColumn()	Gibt an, ob die erste Spalte eine spezielle Formatierung enthält.
getHighlightLastColumn()	Gibt an, ob die letzte Spalte spezielle Formatierungen enthält.
getId()	Gibt einen Wert zurück, der das Arbeitsblatt in einer bestimmten Arbeitsmappe eindeutig identifiziert. Der Wert des Bezeichners bleibt unverändert, auch wenn die Tabelle umbenannt wird.
getLegacyId()	Gibt eine numerische ID zurück.
getName()	Der Name der Tabelle.
getPredefinedTableStyle()	Konstanter Wert, der das Tabellenformat darstellt. Mögliche Werte sind: "TableStyleLight1" bis "TableStyleLight21", "TableStyleMedium1" bis "TableStyleMedium28", "TableStyleDark1" bis "TableStyleDark11". Es kann ebenfalls eine in der Arbeitsmappe vorhandene benutzerdefinierte Formatierung angegeben werden.
getRange()	Ruft das Bereichsobjekt ab, das mit der gesamten Tabelle verknüpft ist.
getRangeBetweenHeaderAndTotal()	Ruft das Bereichsobjekt ab, das mit dem Datenteil der Tabelle verknüpft ist.
getRowCount()	Ruft die Anzahl der Zeilen in der Tabelle ab.
getShowBandedColumns()	Gibt an, ob die Spalten eine gebänderte Formatierung aufweisen, in der ungerade Spalten anders hervorgehoben sind als gerade, um das Lesen der Tabelle zu vereinfachen.
getShowBandedRows()	Gibt an, ob die Zeilen eine gebänderte Formatierung aufweisen, in der ungerade Zeilen anders hervorgehoben sind als gerade, um das Lesen der Tabelle zu vereinfachen.
getShowFilterButton()	Gibt an, ob die Filterschaltflächen oben in jeder Spaltenüberschrift angezeigt werden. Diese Einstellung ist nur zulässig, wenn die Tabelle eine Kopfzeile enthält.
getShowHeaders()	Gibt an, ob die Kopfzeile sichtbar ist. Dieser Wert kann festgelegt werden, um die Kopfzeile anzuzeigen, oder sie zu entfernen.
getShowTotals()	Gibt an, ob die Gesamtzeile sichtbar ist. Dieser Wert kann so festgelegt werden, dass die Ergebniszeile angezeigt oder ausgeblendet wird.
getSort()	Stellt die Sortierung für die Tabelle dar.
getTotalRowRange()	Ruft das Bereichsobjekt ab, das mit der Ergebniszeile der Tabelle verknüpft ist.
getWorksheet()	Das Arbeitsblatt, das die aktuelle Tabelle enthält.
reapplyFilters()	Wendet alle Filter erneut an, die derzeit in der Tabelle vorhanden sind.
resize(newRange)	Ändern Sie die Größe der Tabelle in den neuen Bereich. Der neue Bereich muss sich mit dem ursprünglichen Tabellenbereich überlappen, und die Kopfzeilen (oder der Anfang der Tabelle) müssen sich in derselben Zeile befinden.
setHighlightFirstColumn(highlightFirstColumn)	Gibt an, ob die erste Spalte eine spezielle Formatierung enthält.
setHighlightLastColumn(highlightLastColumn)	Gibt an, ob die letzte Spalte spezielle Formatierungen enthält.
setName(name)	Der Name der Tabelle.
setPredefinedTableStyle(predefinedTableStyle)	Konstanter Wert, der das Tabellenformat darstellt. Mögliche Werte sind: "TableStyleLight1" bis "TableStyleLight21", "TableStyleMedium1" bis "TableStyleMedium28", "TableStyleDark1" bis "TableStyleDark11". Es kann ebenfalls eine in der Arbeitsmappe vorhandene benutzerdefinierte Formatierung angegeben werden.
setShowBandedColumns(showBandedColumns)	Gibt an, ob die Spalten eine gebänderte Formatierung aufweisen, in der ungerade Spalten anders hervorgehoben sind als gerade, um das Lesen der Tabelle zu vereinfachen.
setShowBandedRows(showBandedRows)	Gibt an, ob die Zeilen eine gebänderte Formatierung aufweisen, in der ungerade Zeilen anders hervorgehoben sind als gerade, um das Lesen der Tabelle zu vereinfachen.
setShowFilterButton(showFilterButton)	Gibt an, ob die Filterschaltflächen oben in jeder Spaltenüberschrift angezeigt werden. Diese Einstellung ist nur zulässig, wenn die Tabelle eine Kopfzeile enthält.
setShowHeaders(showHeaders)	Gibt an, ob die Kopfzeile sichtbar ist. Dieser Wert kann festgelegt werden, um die Kopfzeile anzuzeigen, oder sie zu entfernen.
setShowTotals(showTotals)	Gibt an, ob die Gesamtzeile sichtbar ist. Dieser Wert kann so festgelegt werden, dass die Ergebniszeile angezeigt oder ausgeblendet wird.

Details zur Methode

addColumn(index, values, name)

Fügt der Tabelle eine neue Spalte hinzu.

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

Parameter

index: number

Optional. Gibt die relative Position der neuen Spalte an. Bei NULL oder -1 erfolgt die Erweiterung am Ende. Spalten mit einem höheren Index werden auf die Seite verschoben. Nullindiziert.

values: (boolean | string | number)[]

Optional. Ein eindimensionales Array unformatierter Werte der Tabellenspalte.

name: string

Optional. Gibt den Namen der neuen Spalte an. Bei NULL wird der Standardname verwendet.

Gibt zurück

ExcelScript.TableColumn

Beispiele

/**
 * This script adds a new column to a table.
 */
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". 
  table.addColumn(-1, null, "Total");
}

addRow(index, values)

Fügt der Tabelle eine Zeile hinzu.

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

Parameter

index: number

Optional. Gibt die relative Position der neuen Zeile an. Bei NULL oder -1 erfolgt die Erweiterung am Ende. Alle Zeilen unterhalb der eingefügten Zeile werden nach unten verschoben. Nullindiziert.

values: (boolean | string | number)[]

Optional. Ein eindimensionales Array unformatierter Werte der Tabellenzeile.

Gibt zurück

void

Beispiele

/**
 * This script adds a row to an existing table.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the first table in the current worksheet.
    const selectedSheet = workbook.getActiveWorksheet();
    const table = selectedSheet.getTables()[0];

    // Initialize the data to be added as a table row.
    // Note that length of the array must match the number of columns in the table.
    let rowData = ["Carrots", "Vegetable", 750];

    // Add a row to the end of the table.
    table.addRow(-1, rowData);
}

addRows(index, values)

Fügt der Tabelle mindestens eine Zeile hinzu.

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

Parameter

index: number

Optional. Gibt die relative Position der neuen Zeile an. Bei NULL oder -1 erfolgt die Erweiterung am Ende. Alle Zeilen unterhalb der eingefügten Zeile werden nach unten verschoben. Nullindiziert.

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

Optional. Ein 2-dimensionales Array von unformatierten Werten der Tabellenzeile.

Gibt zurück

void

Beispiele

/**
 * This script adds multiple rows to an existing table.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the first table in the current worksheet.
    const selectedSheet = workbook.getActiveWorksheet();
    const table = selectedSheet.getTables()[0];

    // Initialize the data to be added as table rows.
    // Note that length of the array must match the number of columns in the table.
    let rowData = [["Apples", "Fruit", 5000],
                  ["Celery", "Vegetable", 600],
                  ["Onions", "Vegetable", 1500]];

    // Add the rows to the end of the table.
    table.addRows(-1, rowData);
}

clearFilters()

Löscht alle Filter, die derzeit in der Tabelle verwendet werden.

clearFilters(): void;

Gibt zurück

void

convertToRange()

Wandelt die Tabelle in einen normalen Bereich von Zellen um. Alle Daten werden beibehalten.

convertToRange(): Range;

Gibt zurück

ExcelScript.Range

Beispiele

/**
 * This script converts a table to a range and removes the formatting.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the first table in the current worksheet.
    const selectedSheet = workbook.getActiveWorksheet();
    const table = selectedSheet.getTables()[0];

    // Convert the table to a range.
    const formerTable = table.convertToRange();

    // Remove the formatting from the table
    formerTable.clear(ExcelScript.ClearApplyTo.formats);
}

delete()

Löscht die Tabelle.

delete(): void;

Gibt zurück

void

Beispiele

/**
 * This script deletes a table. 
 * This removes all associated data and formatting.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the table named "Inventory".
    const table = workbook.getTable("Inventory");

    // Delete the table.
    table.delete();
}

deleteRowsAt(index, count)

Löscht eine angegebene Anzahl von Zeilen an einem bestimmten Index.

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

Parameter

index: number

Der Indexwert der zu löschenden Zeile. Achtung: Der Index der Zeile ist möglicherweise seit dem Zeitpunkt verschoben, zu dem Sie den für das Entfernen zu verwendenden Wert ermittelt haben.

count: number

Anzahl der zu löschenden Zeilen. Standardmäßig wird eine einzelne Zeile gelöscht. Hinweis: Das Gleichzeitige Löschen von mehr als 1.000 Zeilen kann zu einem Power Automate-Timeout führen.

Gibt zurück

void

getAutoFilter()

Stellt das AutoFilter -Objekt der Tabelle dar.

getAutoFilter(): AutoFilter;

Gibt zurück

ExcelScript.AutoFilter

getColumn(key)

Ruft ein Spaltenobjekt nach Name oder ID ab. Wenn die Spalte nicht vorhanden ist, gibt diese Methode zurück undefined.

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

Parameter

key: number | string

Spaltenname oder ID.

Gibt zurück

ExcelScript.TableColumn | undefined

Beispiele

/**
 * This script adjusts the indentation of a specific table column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the current worksheet.
  const selectedSheet = workbook.getActiveWorksheet();
  const table = selectedSheet.getTables()[0];

  // Get the data range of the second column.
  const secondColumn = table.getColumn(2);
  const data = secondColumn.getRangeBetweenHeaderAndTotal();

  // Add an indentation of 1 character space to the data range.
  data.getFormat().adjustIndent(1);
}

getColumnById(key)

Ruft ein Spaltenobjekt nach ID ab. Wenn die Spalte nicht vorhanden ist, gibt undefined zurück.

getColumnById(key: number): TableColumn | undefined;

Parameter

key: number

Spalten-ID.

Gibt zurück

ExcelScript.TableColumn | undefined

getColumnByName(key)

Ruft ein Spaltenobjekt nach Name ab. Wenn die Spalte nicht vorhanden ist, gibt undefined zurück.

getColumnByName(key: string): TableColumn | undefined;

Parameter

key: string

Spaltenname.

Gibt zurück

ExcelScript.TableColumn | undefined

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();
    }
}

getColumns()

Stellt eine Auflistung aller Spalten in der Tabelle dar.

getColumns(): TableColumn[];

Gibt zurück

ExcelScript.TableColumn[]

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}]]`
  );
}

getHeaderRowRange()

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

getHeaderRowRange(): Range;

Gibt zurück

ExcelScript.Range

Beispiele

/**
 * This script centers the text in a table's header row cells.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table on the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const table = currentSheet.getTables()[0];

  // Get the header range.
  const headerRange = table.getHeaderRowRange();

  // Set the horizontal text alignment to `center`.
  headerRange.getFormat().setHorizontalAlignment(ExcelScript.HorizontalAlignment.center);
}

getHighlightFirstColumn()

Gibt an, ob die erste Spalte eine spezielle Formatierung enthält.

getHighlightFirstColumn(): boolean;

Gibt zurück

boolean

getHighlightLastColumn()

Gibt an, ob die letzte Spalte spezielle Formatierungen enthält.

getHighlightLastColumn(): boolean;

Gibt zurück

boolean

getId()

Gibt einen Wert zurück, der das Arbeitsblatt in einer bestimmten Arbeitsmappe eindeutig identifiziert. Der Wert des Bezeichners bleibt unverändert, auch wenn die Tabelle umbenannt wird.

getId(): string;

Gibt zurück

string

getLegacyId()

Gibt eine numerische ID zurück.

getLegacyId(): string;

Gibt zurück

string

getName()

Der Name der Tabelle.

getName(): string;

Gibt zurück

string

getPredefinedTableStyle()

Konstanter Wert, der das Tabellenformat darstellt. Mögliche Werte sind: "TableStyleLight1" bis "TableStyleLight21", "TableStyleMedium1" bis "TableStyleMedium28", "TableStyleDark1" bis "TableStyleDark11". Es kann ebenfalls eine in der Arbeitsmappe vorhandene benutzerdefinierte Formatierung angegeben werden.

getPredefinedTableStyle(): string;

Gibt zurück

string

getRange()

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

getRange(): Range;

Gibt zurück

ExcelScript.Range

Beispiele

/**
 * This script removes any extra formatting that's been applied to a table. 
 * This leaves only the base table style effects.
 * Any formatting outside of the table will be left as is.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table on the current worksheet.
  let worksheet = workbook.getActiveWorksheet();
  let table = worksheet.getTables()[0];

  // Get the range used by the table.
  let range = table.getRange();

  // Clear all the formatting that is not applied by the table and the table style.
  range.clear(ExcelScript.ClearApplyTo.formats);
}

getRangeBetweenHeaderAndTotal()

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

getRangeBetweenHeaderAndTotal(): Range;

Gibt zurück

ExcelScript.Range

getRowCount()

Ruft die Anzahl der Zeilen in der Tabelle ab.

getRowCount(): number;

Gibt zurück

number

getShowBandedColumns()

Gibt an, ob die Spalten eine gebänderte Formatierung aufweisen, in der ungerade Spalten anders hervorgehoben sind als gerade, um das Lesen der Tabelle zu vereinfachen.

getShowBandedColumns(): boolean;

Gibt zurück

boolean

getShowBandedRows()

Gibt an, ob die Zeilen eine gebänderte Formatierung aufweisen, in der ungerade Zeilen anders hervorgehoben sind als gerade, um das Lesen der Tabelle zu vereinfachen.

getShowBandedRows(): boolean;

Gibt zurück

boolean

getShowFilterButton()

Gibt an, ob die Filterschaltflächen oben in jeder Spaltenüberschrift angezeigt werden. Diese Einstellung ist nur zulässig, wenn die Tabelle eine Kopfzeile enthält.

getShowFilterButton(): boolean;

Gibt zurück

boolean

getShowHeaders()

Gibt an, ob die Kopfzeile sichtbar ist. Dieser Wert kann festgelegt werden, um die Kopfzeile anzuzeigen, oder sie zu entfernen.

getShowHeaders(): boolean;

Gibt zurück

boolean

getShowTotals()

Gibt an, ob die Gesamtzeile sichtbar ist. Dieser Wert kann so festgelegt werden, dass die Ergebniszeile angezeigt oder ausgeblendet wird.

getShowTotals(): boolean;

Gibt zurück

boolean

getSort()

Stellt die Sortierung für die Tabelle dar.

getSort(): TableSort;

Gibt zurück

ExcelScript.TableSort

getTotalRowRange()

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

getTotalRowRange(): Range;

Gibt zurück

ExcelScript.Range

getWorksheet()

Das Arbeitsblatt, das die aktuelle Tabelle enthält.

getWorksheet(): Worksheet;

Gibt zurück

ExcelScript.Worksheet

reapplyFilters()

Wendet alle Filter erneut an, die derzeit in der Tabelle vorhanden sind.

reapplyFilters(): void;

Gibt zurück

void

Beispiele

/**
 * This script reapplies the filters on every table in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get all the tables.
  const tables = workbook.getTables();

  // Iterate over every table.
  tables.forEach((table) => {
    // Reapply the filters to account for new table entries.
    table.reapplyFilters();
  });
}

resize(newRange)

Ändern Sie die Größe der Tabelle in den neuen Bereich. Der neue Bereich muss sich mit dem ursprünglichen Tabellenbereich überlappen, und die Kopfzeilen (oder der Anfang der Tabelle) müssen sich in derselben Zeile befinden.

resize(newRange: Range | string): void;

Parameter

newRange: ExcelScript.Range | string

Das Bereichsobjekt oder die Bereichsadresse, die verwendet wird, um die neue Größe der Tabelle zu bestimmen.

Gibt zurück

void

setHighlightFirstColumn(highlightFirstColumn)

Gibt an, ob die erste Spalte eine spezielle Formatierung enthält.

setHighlightFirstColumn(highlightFirstColumn: boolean): void;

Parameter

highlightFirstColumn: boolean

Gibt zurück

void

setHighlightLastColumn(highlightLastColumn)

Gibt an, ob die letzte Spalte spezielle Formatierungen enthält.

setHighlightLastColumn(highlightLastColumn: boolean): void;

Parameter

highlightLastColumn: boolean

Gibt zurück

void

setName(name)

Der Name der Tabelle.

setName(name: string): void;

Parameter

name: string

Gibt zurück

void

setPredefinedTableStyle(predefinedTableStyle)

setPredefinedTableStyle(predefinedTableStyle: string): void;

Parameter

predefinedTableStyle: string

Gibt zurück

void

setShowBandedColumns(showBandedColumns)

Gibt an, ob die Spalten eine gebänderte Formatierung aufweisen, in der ungerade Spalten anders hervorgehoben sind als gerade, um das Lesen der Tabelle zu vereinfachen.

setShowBandedColumns(showBandedColumns: boolean): void;

Parameter

showBandedColumns: boolean

Gibt zurück

void

setShowBandedRows(showBandedRows)

Gibt an, ob die Zeilen eine gebänderte Formatierung aufweisen, in der ungerade Zeilen anders hervorgehoben sind als gerade, um das Lesen der Tabelle zu vereinfachen.

setShowBandedRows(showBandedRows: boolean): void;

Parameter

showBandedRows: boolean

Gibt zurück

void

setShowFilterButton(showFilterButton)

Gibt an, ob die Filterschaltflächen oben in jeder Spaltenüberschrift angezeigt werden. Diese Einstellung ist nur zulässig, wenn die Tabelle eine Kopfzeile enthält.

setShowFilterButton(showFilterButton: boolean): void;

Parameter

showFilterButton: boolean

Gibt zurück

void

setShowHeaders(showHeaders)

Gibt an, ob die Kopfzeile sichtbar ist. Dieser Wert kann festgelegt werden, um die Kopfzeile anzuzeigen, oder sie zu entfernen.

setShowHeaders(showHeaders: boolean): void;

Parameter

showHeaders: boolean

Gibt zurück

void

Beispiele

/**
 * This script makes a table's headers not visible in the grid.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the table named "CoverageTable".
    const coverageTable = workbook.getTable("CoverageTable");

    // Make the header row not visible.
    coverageTable.setShowHeaders(false);
}

setShowTotals(showTotals)

Gibt an, ob die Gesamtzeile sichtbar ist. Dieser Wert kann so festgelegt werden, dass die Ergebniszeile angezeigt oder ausgeblendet wird.

setShowTotals(showTotals: boolean): void;

Parameter

showTotals: boolean

Gibt zurück

void

Beispiele

/**
 * This script adds the Total Row to an existing table.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the first table in the current worksheet.
    const selectedSheet = workbook.getActiveWorksheet();
    const table = selectedSheet.getTables()[0];

    // Set the Total Row to show.
    table.setShowTotals(true);
}