Excel.TableRow class

Ссылка

Пакет:: excel

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

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

Extends: OfficeExtension.ClientObject

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
index	Возвращает номер индекса строки в коллекции строк таблицы. Используется нулевой индекс.
values	Представляет необработанные значения указанного диапазона. Возвращаемые данные могут быть строковыми, числовыми или логическими. Ячейки, содержащие ошибку, вернут строку ошибки. Если возвращаемое значение начинается с плюса ("+"), минуса ("-") или знака равенства ("="), Excel интерпретирует это значение как формулу.
valuesAsJson	Представление значений в ячейках в этой строке таблицы в формате JSON. В отличие от `TableRow.values`поддерживает `TableRow.valuesAsJson` все типы данных, которые могут находиться в ячейке. Примеры включают форматированные числовые значения и веб-изображения, а также стандартные логические, числовые и строковые значения. Данные, возвращаемые из этого API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения пользователя, используйте .`TableRow.valuesAsJsonLocal`
valuesAsJsonLocal	Представление значений в ячейках в этой строке таблицы в формате JSON. В отличие от `TableRow.values`поддерживает `TableRow.valuesAsJsonLocal` все типы данных, которые могут находиться в ячейке. Примеры включают форматированные числовые значения и веб-изображения, а также стандартные логические, числовые и строковые значения. Данные, возвращаемые из этого API, всегда соответствуют языковому стандарту отображения пользователя. Чтобы получить данные, не зависящие от языкового стандарта, используйте .`TableRow.valuesAsJson`

Методы

delete()	Удаляет строку из таблицы.
getRange()	Получает объект диапазона, связанный со всей строкой.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный объект Excel.TableRow является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.TableRowData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

index

Возвращает номер индекса строки в коллекции строк таблицы. Используется нулевой индекс.

readonly index: number;

Значение свойства

number

values

Представляет необработанные значения указанного диапазона. Возвращаемые данные могут быть строковыми, числовыми или логическими. Ячейки, содержащие ошибку, вернут строку ошибки. Если возвращаемое значение начинается с плюса ("+"), минуса ("-") или знака равенства ("="), Excel интерпретирует это значение как формулу.

values: any[][];

Значение свойства

any[][]

valuesAsJson

Представление значений в ячейках в этой строке таблицы в формате JSON. В отличие от TableRow.valuesподдерживает TableRow.valuesAsJson все типы данных, которые могут находиться в ячейке. Примеры включают форматированные числовые значения и веб-изображения, а также стандартные логические, числовые и строковые значения. Данные, возвращаемые из этого API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения пользователя, используйте .TableRow.valuesAsJsonLocal

valuesAsJson: CellValue[][];

Значение свойства

Excel.CellValue[][]

valuesAsJsonLocal

Представление значений в ячейках в этой строке таблицы в формате JSON. В отличие от TableRow.valuesподдерживает TableRow.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;

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

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;

Параметры

options: Excel.Interfaces.TableRowLoadOptions

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

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

Excel.TableRow

load(propertyNames)

load(propertyNames?: string | string[]): Excel.TableRow;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

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

Excel.TableRow

Примеры

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)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.TableRow;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

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

Excel.TableRow

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Excel.Interfaces.TableRowUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options: OfficeExtension.UpdateOptions

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

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

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;

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

Excel.Interfaces.TableRowData

Поделиться через

Excel.TableRow class

Комментарии

Свойства

Методы

Сведения о свойстве

context

Значение свойства

index

Значение свойства

Комментарии

values

Значение свойства

Комментарии

valuesAsJson

Значение свойства

Комментарии

valuesAsJsonLocal

Значение свойства

Комментарии

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

delete()

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

Комментарии

Примеры

getRange()

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

Комментарии

Примеры

load(options)

Параметры

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

load(propertyNames)

Параметры

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

Примеры

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

Дополнительные ресурсы