PowerPoint.Table class

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

Extends

Комментарии

Набор API: PowerPointApi 1.8

Используется

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml

// Updates a table's values.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;

  // Add a table (which is a type of Shape).
  const shape = shapes.addTable(4, 3);
  let table = shape.getTable();
  table.load();
  await context.sync();

  // Update values in the table.
  for (let rowIndex = 0; rowIndex < table.rowCount; rowIndex++) {
    for (let columnIndex = 0; columnIndex < table.columnCount; columnIndex++) {
      const cell = table.getCellOrNullObject(rowIndex, columnIndex);
      cell.text = generateRandomString();
    }
  }

  await context.sync();
});

Свойства

columnCount

Получает количество столбцов в таблице.

columns

Возвращает коллекцию столбцов в таблице.

context

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

rowCount

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

rows

Возвращает коллекцию строк в таблице.

styleSettings

Возвращает параметры стиля таблицы.

values

Возвращает все значения в таблице.

Методы

clear(options)

Очищает табличные значения и форматирование.

getCellOrNullObject(rowIndex, columnIndex)

Возвращает ячейку в указанных rowIndex и columnIndex.

getMergedAreas()

Возвращает коллекцию ячеек, представляющих объединенные области таблицы.

getShape()

Возвращает объект фигуры для таблицы.

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

mergeCells(rowIndex, columnIndex, rowCount, columnCount)

Создает объединенную область, начиная с ячейки, указанной rowIndex и columnIndex. Объединенная область охватывает указанное количество строк и столбцов.

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.Table объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как PowerPoint.Interfaces.TableData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

columnCount

Получает количество столбцов в таблице.

readonly columnCount: number;

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

number

Комментарии

Набор API: PowerPointApi 1.8

columns

Возвращает коллекцию столбцов в таблице.

readonly columns: PowerPoint.TableColumnCollection;

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

Комментарии

Набор API: PowerPointApi 1.9

context

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

context: RequestContext;

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

rowCount

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

readonly rowCount: number;

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

number

Комментарии

Набор API: PowerPointApi 1.8

rows

Возвращает коллекцию строк в таблице.

readonly rows: PowerPoint.TableRowCollection;

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

Комментарии

Набор API: PowerPointApi 1.9

styleSettings

Возвращает параметры стиля таблицы.

readonly styleSettings: PowerPoint.TableStyleSettings;

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

Комментарии

Набор API: PowerPointApi 1.9

values

Возвращает все значения в таблице.

readonly values: string[][];

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

string[][]

Комментарии

Набор API: PowerPointApi 1.8

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

clear(options)

Очищает табличные значения и форматирование.

clear(options?: PowerPoint.TableClearOptions): void;

Параметры

options
PowerPoint.TableClearOptions

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

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

void

Комментарии

Набор API: PowerPointApi 1.9

getCellOrNullObject(rowIndex, columnIndex)

Возвращает ячейку в указанных rowIndex и columnIndex.

getCellOrNullObject(rowIndex: number, columnIndex: number): PowerPoint.TableCell;

Параметры

rowIndex

number

Отсчитываемый от нуля индекс строки ячейки.

columnIndex

number

Отсчитываемый от нуля индекс столбца ячейки.

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

Ячейка в указанной строке и столбце. Если ячейка является частью объединенной области, а не верхней левой ячейкой объединенной области, возвращается объект со свойством isNullObject , для свойства задано true значение . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

Комментарии

Набор API: PowerPointApi 1.8

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml

// Updates a table's values.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;

  // Add a table (which is a type of Shape).
  const shape = shapes.addTable(4, 3);
  let table = shape.getTable();
  table.load();
  await context.sync();

  // Update values in the table.
  for (let rowIndex = 0; rowIndex < table.rowCount; rowIndex++) {
    for (let columnIndex = 0; columnIndex < table.columnCount; columnIndex++) {
      const cell = table.getCellOrNullObject(rowIndex, columnIndex);
      cell.text = generateRandomString();
    }
  }

  await context.sync();
});

getMergedAreas()

Возвращает коллекцию ячеек, представляющих объединенные области таблицы.

getMergedAreas(): PowerPoint.TableCellCollection;

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

с TableCellCollection ячейками, представляющими объединенные области таблицы.

Комментарии

Набор API: PowerPointApi 1.8

getShape()

Возвращает объект фигуры для таблицы.

getShape(): PowerPoint.Shape;

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

Комментарии

Набор API: PowerPointApi 1.8

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: PowerPoint.Interfaces.TableLoadOptions): PowerPoint.Table;

Параметры

options
PowerPoint.Interfaces.TableLoadOptions

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

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

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): PowerPoint.Table;

Параметры

propertyNames

string | string[]

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

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

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.Table;

Параметры

propertyNamesAndPaths

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

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

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

mergeCells(rowIndex, columnIndex, rowCount, columnCount)

Создает объединенную область, начиная с ячейки, указанной rowIndex и columnIndex. Объединенная область охватывает указанное количество строк и столбцов.

mergeCells(rowIndex: number, columnIndex: number, rowCount: number, columnCount: number): void;

Параметры

rowIndex

number

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

columnIndex

number

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

rowCount

number

Количество строк для слияния с начальной ячейкой. Должно быть больше 0.

columnCount

number

Количество столбцов для слияния с начальной ячейкой. Должно быть больше 0.

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

void

Комментарии

Набор API: PowerPointApi 1.9

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.Table объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как PowerPoint.Interfaces.TableData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): PowerPoint.Interfaces.TableData;

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