Excel.TableRow class
Представляет строку в таблице.
Обратите внимание, что в отличие от диапазонов или столбцов, которые будут корректировать добавление новых строк или столбцов перед ними, TableRow объект представляет физическое расположение строки таблицы, но не данных. Это означает, что при сортировке данных или добавлении новых строк строка таблицы будет по-прежнему указывать на индекс, для которого она была создана.
- Extends
Комментарии
Используется
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| index | Возвращает номер индекса строки в коллекции строк таблицы. Используется нулевой индекс. |
| values | Представляет необработанные значения указанного диапазона. Возвращаемые данные могут быть строкой, числом или логическим значением. Ячейки, содержащие ошибку, вернут строку ошибки. Если возвращаемое значение начинается с плюса ("+"), минуса ("-") или знака равенства ("="), Excel интерпретирует это значение как формулу. |
| values |
JSON-представление значений в ячейках этой строки таблицы. В отличие от , |
| values |
JSON-представление значений в ячейках этой строки таблицы. В отличие от , |
Методы
| delete() | Удаляет строку из таблицы. |
| get |
Получает объект диапазона, связанный со всей строкой. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
index
Возвращает номер индекса строки в коллекции строк таблицы. Используется нулевой индекс.
readonly index: number;Значение свойства
number
Комментарии
values
Представляет необработанные значения указанного диапазона. Возвращаемые данные могут быть строкой, числом или логическим значением. Ячейки, содержащие ошибку, вернут строку ошибки. Если возвращаемое значение начинается с плюса ("+"), минуса ("-") или знака равенства ("="), Excel интерпретирует это значение как формулу.
values: any[][];Значение свойства
any[][]
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml
await Excel.run(async (context) => {
let sheet = context.workbook.worksheets.getItem("Sample");
let randomResult = context.workbook.functions.randBetween(1, 3000).load("value");
await context.sync();
const row: Excel.TableRow = sheet.tables.getItem("SalesTable").rows.getItemAt(0);
let newValue = [["Frames", 5000, 7000, 6544, randomResult.value, "=SUM(B2:E2)"]];
row.values = newValue;
row.load("values");
await context.sync();
});
valuesAsJson
JSON-представление значений в ячейках этой строки таблицы. В отличие от , TableRow.valuesTableRow.valuesAsJson поддерживает все типы данных, которые могут быть в ячейке. Примеры включают форматированные числовые значения и веб-изображения в дополнение к стандартным булевым, числовым и строковым значениям. Данные, возвращаемые этим API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения, заданном пользователем, используйте TableRow.valuesAsJsonLocal.
valuesAsJson: CellValue[][];Значение свойства
Excel.CellValue[][]
Комментарии
valuesAsJsonLocal
JSON-представление значений в ячейках этой строки таблицы. В отличие от , TableRow.valuesTableRow.valuesAsJsonLocal поддерживает все типы данных, которые могут быть в ячейке. Примеры включают форматированные числовые значения и веб-изображения в дополнение к стандартным булевым, числовым и строковым значениям. Данные, возвращаемые этим API, всегда соответствуют языковому стандарту отображения, выбранному пользователем. Для получения данных, не зависящих от языкового стандарта, используйте TableRow.valuesAsJson.
valuesAsJsonLocal: CellValue[][];Значение свойства
Excel.CellValue[][]
Комментарии
Сведения о методе
delete()
Удаляет строку из таблицы.
delete(): void;Возвращаемое значение
void
Комментарии
Примеры
await Excel.run(async (context) => {
const tableName = 'Table1';
const row = context.workbook.tables.getItem(tableName).rows.getItemAt(2);
row.delete();
await context.sync();
});
getRange()
Получает объект диапазона, связанный со всей строкой.
getRange(): Excel.Range;Возвращаемое значение
Комментарии
Примеры
await Excel.run(async (context) => {
const tableName = 'Table1';
const row = context.workbook.tables.getItem(tableName).rows.getItemAt(0);
const rowRange = row.getRange();
rowRange.load('address');
await context.sync();
console.log(rowRange.address);
});
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.TableRowLoadOptions): Excel.TableRow;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.TableRow;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
Примеры
await Excel.run(async (context) => {
const tableName = 'Table1';
const row = context.workbook.tables.getItem(tableName).rows.getItemAt(0);
row.load('index');
await context.sync();
console.log(row.index);
});
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.TableRow;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.TableRowUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Excel.TableRow): void;Параметры
- properties
- Excel.TableRow
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.TableRow объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.TableRowData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.TableRowData;