Excel.TableColumn class
Представляет столбец в таблице.
- Extends
Комментарии
Используется
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| filter | Получает фильтр, примененный к столбцу. |
| id | Возвращает уникальный ключ, идентифицирующий столбец в таблице. |
| index | Возвращает номер индекса столбца в коллекции столбцов таблицы. Используется нулевой индекс. |
| name | Указывает имя столбца таблицы. |
| values | Представляет необработанные значения указанного диапазона. Возвращаемые данные могут быть строкой, числом или логическим значением. Ячейки, содержащие ошибку, вернут строку ошибки. Если возвращаемое значение начинается с плюса ("+"), минуса ("-") или знака равенства ("="), Excel интерпретирует это значение как формулу. |
| values |
JSON-представление значений в ячейках этого столбца таблицы. В отличие от , |
| values |
JSON-представление значений в ячейках этого столбца таблицы. В отличие от , |
Методы
| delete() | Удаляет столбец из таблицы. |
| get |
Получает объект диапазона, связанный с текстом данных столбца. |
| get |
Получает объект диапазона, связанный со строкой заголовков столбца. |
| get |
Получает объект диапазона, связанный со всем столбцом. |
| get |
Получает объект диапазона, связанный со строкой итогов столбца. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
filter
Получает фильтр, примененный к столбцу.
readonly filter: Excel.Filter;Значение свойства
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/get-visible-range-of-a-filtered-table.yaml
/** Filter the table*/
async function filterTable() {
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const expensesTable = sheet.tables.getItem("ExpensesTable");
const filter: Excel.Filter = expensesTable.columns.getItem("Amount").filter;
filter.apply({
filterOn: Excel.FilterOn.dynamic,
dynamicCriteria: Excel.DynamicFilterCriteria.belowAverage
});
await context.sync();
});
id
Возвращает уникальный ключ, идентифицирующий столбец в таблице.
readonly id: number;Значение свойства
number
Комментарии
index
Возвращает номер индекса столбца в коллекции столбцов таблицы. Используется нулевой индекс.
readonly index: number;Значение свойства
number
Комментарии
name
Указывает имя столбца таблицы.
name: string;Значение свойства
string
Комментарии
Набор API: ExcelApi 1.1 для получения имени; 1.4 для его настройки.
values
Представляет необработанные значения указанного диапазона. Возвращаемые данные могут быть строкой, числом или логическим значением. Ячейки, содержащие ошибку, вернут строку ошибки. Если возвращаемое значение начинается с плюса ("+"), минуса ("-") или знака равенства ("="), Excel интерпретирует это значение как формулу.
values: any[][];Значение свойства
any[][]
Комментарии
valuesAsJson
JSON-представление значений в ячейках этого столбца таблицы. В отличие от , TableColumn.valuesTableColumn.valuesAsJson поддерживает все типы данных, которые могут быть в ячейке. Примеры включают форматированные числовые значения и веб-изображения в дополнение к стандартным булевым, числовым и строковым значениям. Данные, возвращаемые этим API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения, заданном пользователем, используйте TableColumn.valuesAsJsonLocal.
valuesAsJson: CellValue[][];Значение свойства
Excel.CellValue[][]
Комментарии
valuesAsJsonLocal
JSON-представление значений в ячейках этого столбца таблицы. В отличие от , TableColumn.valuesTableColumn.valuesAsJsonLocal поддерживает все типы данных, которые могут быть в ячейке. Примеры включают форматированные числовые значения и веб-изображения в дополнение к стандартным булевым, числовым и строковым значениям. Данные, возвращаемые этим API, всегда соответствуют языковому стандарту отображения, выбранному пользователем. Для получения данных, не зависящих от языкового стандарта, используйте TableColumn.valuesAsJson.
valuesAsJsonLocal: CellValue[][];Значение свойства
Excel.CellValue[][]
Комментарии
Сведения о методе
delete()
Удаляет столбец из таблицы.
delete(): void;Возвращаемое значение
void
Комментарии
Примеры
await Excel.run(async (context) => {
const tableName = 'Table1';
const column = context.workbook.tables.getItem(tableName).columns.getItemAt(2);
column.delete();
await context.sync();
});
getDataBodyRange()
Получает объект диапазона, связанный с текстом данных столбца.
getDataBodyRange(): Excel.Range;Возвращаемое значение
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml
// Add checkboxes to the table.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getActiveWorksheet();
// Get the second column in the table, without the header.
const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();
// Change the boolean values to checkboxes.
range.control = {
type: Excel.CellControlType.checkbox
};
await context.sync();
});
getHeaderRowRange()
Получает объект диапазона, связанный со строкой заголовков столбца.
getHeaderRowRange(): Excel.Range;Возвращаемое значение
Комментарии
Примеры
await Excel.run(async (context) => {
const tableName = 'Table1';
const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
const headerRowRange = columns.getHeaderRowRange();
headerRowRange.load('address');
await context.sync();
console.log(headerRowRange.address);
});
getRange()
Получает объект диапазона, связанный со всем столбцом.
getRange(): Excel.Range;Возвращаемое значение
Комментарии
Примеры
await Excel.run(async (context) => {
const tableName = 'Table1';
const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
const columnRange = columns.getRange();
columnRange.load('address');
await context.sync();
console.log(columnRange.address);
});
getTotalRowRange()
Получает объект диапазона, связанный со строкой итогов столбца.
getTotalRowRange(): Excel.Range;Возвращаемое значение
Комментарии
Примеры
await Excel.run(async (context) => {
const tableName = 'Table1';
const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
const totalRowRange = columns.getTotalRowRange();
totalRowRange.load('address');
await context.sync();
console.log(totalRowRange.address);
});
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.TableColumnLoadOptions): Excel.TableColumn;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.TableColumn;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
Примеры
await Excel.run(async (context) => {
const tableName = 'Table1';
const column = context.workbook.tables.getItem(tableName).columns.getItem(0);
column.load('index');
await context.sync();
console.log(column.index);
});
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.TableColumn;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.TableColumnUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Excel.TableColumn): void;Параметры
- properties
- Excel.TableColumn
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.TableColumn объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.TableColumnData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.TableColumnData;