ExcelScript.Table interface

Представляет таблицу Excel. Чтобы узнать больше об объектной модели таблиц, прочтите работу с таблицами с помощью API JavaScript для Excel.

Методы

addColumn(index, values, name)

Добавляет новый столбец в таблицу.

addRow(index, values)

Добавляет одну строку в таблицу.

addRows(index, values)

Добавляет одну или несколько строк в таблицу.

clearFilters()

Удаляет все фильтры, примененные к таблице.

convertToRange()

Преобразовывает таблицу в обычный диапазон ячеек. Все данные сохраняются.

delete()

Удаляет таблицу.

deleteRowsAt(index, count)

Удаление указанного числа строк по заданному индексу.

getAutoFilter()

Представляет объект AutoFilter таблицы.

getColumn(key)

Возвращает объект столбца по имени или ИД. Если столбец не существует, возвращает пустой объект.

getColumnById(key)

Получает объект Column по ИДЕНТИФИКАТОРу. Если столбец не существует, будет возвращено значение undefine.

getColumnByName(key)

Получает объект Column по имени. Если столбец не существует, будет возвращено значение undefine.

getColumns()

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

getHeaderRowRange()

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

getHighlightFirstColumn()

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

getHighlightLastColumn()

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

getId()

Возвращает значение, однозначно идентифицирующее таблицу в данной книге. Значение идентификатора остается прежним, даже если переименовать таблицу.

getLegacyId()

Возвращает числовой идентификатор.

getName()

Имя таблицы.

Имя набора таблицы должно соответствовать рекомендациям, указанным в статье Переименование статьи таблицы Excel .

getPredefinedTableStyle()

Постоянное значение, представляющее стиль таблицы. Возможные значения: "TableStyleLight1", "TableStyleLight21", "TableStyleMedium1", "TableStyleMedium28", "TableStyleDark1" и "TableStyleDark11". Также можно указать настраиваемый пользовательский стиль, имеющийся в книге.

getRange()

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

getRangeBetweenHeaderAndTotal()

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

getShowBandedColumns()

Указывает, будут ли в столбцах отображаться чередующиеся форматирование, в котором четные столбцы выделяются не так, как в четном, чтобы упростить чтение таблицы.

getShowBandedRows()

Указывает, будут ли в строках отображаться полосные форматирования, в результате которой нечетные строки выделяются не так, как в четном, чтобы облегчить чтение таблицы.

getShowFilterButton()

Указывает, отображаются ли кнопки фильтра в верхней части каждого заголовка столбца. Это свойство можно использовать, только если таблица содержит строку заголовков.

getShowHeaders()

Указывает, отображается ли строка заголовков. Можно задать это значение, чтобы отобразить или скрыть строку заголовков.

getShowTotals()

Указывает, отображается ли строка итогов. Можно задать это значение, чтобы отобразить или скрыть строку итогов.

getSort()

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

getTotalRowRange()

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

getWorksheet()

Лист, содержащий текущую таблицу.

reapplyFilters()

Повторно применяет все текущие фильтры к таблице.

setHighlightFirstColumn(highlightFirstColumn)

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

setHighlightLastColumn(highlightLastColumn)

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

setName(name)

Имя таблицы.

Имя набора таблицы должно соответствовать рекомендациям, указанным в статье Переименование статьи таблицы Excel .

setPredefinedTableStyle(predefinedTableStyle)

Постоянное значение, представляющее стиль таблицы. Возможные значения: "TableStyleLight1", "TableStyleLight21", "TableStyleMedium1", "TableStyleMedium28", "TableStyleDark1" и "TableStyleDark11". Также можно указать настраиваемый пользовательский стиль, имеющийся в книге.

setShowBandedColumns(showBandedColumns)

Указывает, будут ли в столбцах отображаться чередующиеся форматирование, в котором четные столбцы выделяются не так, как в четном, чтобы упростить чтение таблицы.

setShowBandedRows(showBandedRows)

Указывает, будут ли в строках отображаться полосные форматирования, в результате которой нечетные строки выделяются не так, как в четном, чтобы облегчить чтение таблицы.

setShowFilterButton(showFilterButton)

Указывает, отображаются ли кнопки фильтра в верхней части каждого заголовка столбца. Это свойство можно использовать, только если таблица содержит строку заголовков.

setShowHeaders(showHeaders)

Указывает, отображается ли строка заголовков. Можно задать это значение, чтобы отобразить или скрыть строку заголовков.

setShowTotals(showTotals)

Указывает, отображается ли строка итогов. Можно задать это значение, чтобы отобразить или скрыть строку итогов.

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

addColumn(index, values, name)

Добавляет новый столбец в таблицу.

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

Параметры

index
number

Необязательный. Определяет относительную позицию нового столбца. Если задано значение null или -1, столбец добавляется в конце. Столбцы с более высокими значениями индекса смещаются в сторону. Используется нулевой индекс.

values
(boolean | string | number)[]

Необязательный. 1 мерный массив неформатированных значений столбца таблицы.

name
string

Необязательный параметр. Задает имя нового столбца. Если значение пустое, используется имя по умолчанию.

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

addRow(index, values)

Добавляет одну строку в таблицу.

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

Параметры

index
number

Необязательный параметр. Определяет относительную позицию новой строки. Если задано значение null или -1, столбец добавляется в конце. Все строки ниже вставляемой строки сдвигаются вниз. Используется нулевой индекс.

values
(boolean | string | number)[]

Необязательный параметр. 1 мерный массив неформатированных значений строки таблицы.

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

void

addRows(index, values)

Добавляет одну или несколько строк в таблицу.

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

Параметры

index
number

Необязательный параметр. Определяет относительную позицию новой строки. Если задано значение null или -1, столбец добавляется в конце. Все строки ниже вставляемой строки сдвигаются вниз. Используется нулевой индекс.

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

Необязательный параметр. Двухмерный массив неформатированных значений строки таблицы.

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

void

clearFilters()

Удаляет все фильтры, примененные к таблице.

clearFilters(): void;

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

void

convertToRange()

Преобразовывает таблицу в обычный диапазон ячеек. Все данные сохраняются.

convertToRange(): Range;

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

delete()

Удаляет таблицу.

delete(): void;

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

void

deleteRowsAt(index, count)

Удаление указанного числа строк по заданному индексу.

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

Параметры

index
number

Значение индекса удаляемой строки. Внимание! индекс строки мог быть перемещен со времени, когда вы определили значение, которое будет использоваться для удаления.

count
number

Количество удаляемых строк. По умолчанию будет удалена одна строка.

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

void

getAutoFilter()

Представляет объект AutoFilter таблицы.

getAutoFilter(): AutoFilter;

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

getColumn(key)

Возвращает объект столбца по имени или ИД. Если столбец не существует, возвращает пустой объект.

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

Параметры

key
number | string

Имя или ИД столбца.

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

TableColumn | undefined

getColumnById(key)

Получает объект Column по ИДЕНТИФИКАТОРу. Если столбец не существует, будет возвращено значение undefine.

getColumnById(key: number): TableColumn | undefined;

Параметры

key
number

Идентификатор столбца.

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

TableColumn | undefined

getColumnByName(key)

Получает объект Column по имени. Если столбец не существует, будет возвращено значение undefine.

getColumnByName(key: string): TableColumn | undefined;

Параметры

key
string

Имя столбца.

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

TableColumn | undefined

getColumns()

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

getColumns(): TableColumn[];

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

getHeaderRowRange()

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

getHeaderRowRange(): Range;

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

getHighlightFirstColumn()

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

getHighlightFirstColumn(): boolean;

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

boolean

getHighlightLastColumn()

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

getHighlightLastColumn(): boolean;

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

boolean

getId()

Возвращает значение, однозначно идентифицирующее таблицу в данной книге. Значение идентификатора остается прежним, даже если переименовать таблицу.

getId(): string;

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

string

getLegacyId()

Возвращает числовой идентификатор.

getLegacyId(): string;

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

string

getName()

Имя таблицы.

Имя набора таблицы должно соответствовать рекомендациям, указанным в статье Переименование статьи таблицы Excel .

getName(): string;

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

string

getPredefinedTableStyle()

Постоянное значение, представляющее стиль таблицы. Возможные значения: "TableStyleLight1", "TableStyleLight21", "TableStyleMedium1", "TableStyleMedium28", "TableStyleDark1" и "TableStyleDark11". Также можно указать настраиваемый пользовательский стиль, имеющийся в книге.

getPredefinedTableStyle(): string;

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

string

getRange()

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

getRange(): Range;

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

getRangeBetweenHeaderAndTotal()

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

getRangeBetweenHeaderAndTotal(): Range;

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

getShowBandedColumns()

Указывает, будут ли в столбцах отображаться чередующиеся форматирование, в котором четные столбцы выделяются не так, как в четном, чтобы упростить чтение таблицы.

getShowBandedColumns(): boolean;

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

boolean

getShowBandedRows()

Указывает, будут ли в строках отображаться полосные форматирования, в результате которой нечетные строки выделяются не так, как в четном, чтобы облегчить чтение таблицы.

getShowBandedRows(): boolean;

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

boolean

getShowFilterButton()

Указывает, отображаются ли кнопки фильтра в верхней части каждого заголовка столбца. Это свойство можно использовать, только если таблица содержит строку заголовков.

getShowFilterButton(): boolean;

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

boolean

getShowHeaders()

Указывает, отображается ли строка заголовков. Можно задать это значение, чтобы отобразить или скрыть строку заголовков.

getShowHeaders(): boolean;

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

boolean

getShowTotals()

Указывает, отображается ли строка итогов. Можно задать это значение, чтобы отобразить или скрыть строку итогов.

getShowTotals(): boolean;

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

boolean

getSort()

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

getSort(): TableSort;

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

getTotalRowRange()

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

getTotalRowRange(): Range;

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

getWorksheet()

Лист, содержащий текущую таблицу.

getWorksheet(): Worksheet;

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

reapplyFilters()

Повторно применяет все текущие фильтры к таблице.

reapplyFilters(): void;

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

void

setHighlightFirstColumn(highlightFirstColumn)

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

setHighlightFirstColumn(highlightFirstColumn: boolean): void;

Параметры

highlightFirstColumn
boolean

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

void

setHighlightLastColumn(highlightLastColumn)

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

setHighlightLastColumn(highlightLastColumn: boolean): void;

Параметры

highlightLastColumn
boolean

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

void

setName(name)

Имя таблицы.

Имя набора таблицы должно соответствовать рекомендациям, указанным в статье Переименование статьи таблицы Excel .

setName(name: string): void;

Параметры

name
string

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

void

setPredefinedTableStyle(predefinedTableStyle)

Постоянное значение, представляющее стиль таблицы. Возможные значения: "TableStyleLight1", "TableStyleLight21", "TableStyleMedium1", "TableStyleMedium28", "TableStyleDark1" и "TableStyleDark11". Также можно указать настраиваемый пользовательский стиль, имеющийся в книге.

setPredefinedTableStyle(predefinedTableStyle: string): void;

Параметры

predefinedTableStyle
string

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

void

setShowBandedColumns(showBandedColumns)

Указывает, будут ли в столбцах отображаться чередующиеся форматирование, в котором четные столбцы выделяются не так, как в четном, чтобы упростить чтение таблицы.

setShowBandedColumns(showBandedColumns: boolean): void;

Параметры

showBandedColumns
boolean

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

void

setShowBandedRows(showBandedRows)

Указывает, будут ли в строках отображаться полосные форматирования, в результате которой нечетные строки выделяются не так, как в четном, чтобы облегчить чтение таблицы.

setShowBandedRows(showBandedRows: boolean): void;

Параметры

showBandedRows
boolean

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

void

setShowFilterButton(showFilterButton)

Указывает, отображаются ли кнопки фильтра в верхней части каждого заголовка столбца. Это свойство можно использовать, только если таблица содержит строку заголовков.

setShowFilterButton(showFilterButton: boolean): void;

Параметры

showFilterButton
boolean

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

void

setShowHeaders(showHeaders)

Указывает, отображается ли строка заголовков. Можно задать это значение, чтобы отобразить или скрыть строку заголовков.

setShowHeaders(showHeaders: boolean): void;

Параметры

showHeaders
boolean

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

void

setShowTotals(showTotals)

Указывает, отображается ли строка итогов. Можно задать это значение, чтобы отобразить или скрыть строку итогов.

setShowTotals(showTotals: boolean): void;

Параметры

showTotals
boolean

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

void