Office.SetSelectedDataOptions interface

Пакет:
office

Предоставляет варианты вставки данных в выделенный фрагмент.

Комментарии

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/export-import-slide.yaml

async function addImageToCurrentSlide(
  imageBase64: string,
  options?: PowerPoint.ShapeAddOptions
): Promise<PowerPoint.Shape> {
  // Adds an image to the current slide.
  const setSelectedDataOptions: Office.SetSelectedDataOptions = {
    coercionType: Office.CoercionType.Image
  };
  if (options) {
    if (options.height) {
      setSelectedDataOptions.imageHeight = options.height;
    }
    if (options.left) {
      setSelectedDataOptions.imageLeft = options.left;
    }
    if (options.top) {
      setSelectedDataOptions.imageTop = options.top;
    }
    if (options.width) {
      setSelectedDataOptions.imageWidth = options.width;
    }
  }

  return new Promise((resolve, reject) => {
    Office.context.document.setSelectedDataAsync(
      imageBase64,
      setSelectedDataOptions,
      async (result: Office.AsyncResult<void>) => {
        if (result.error) {
          console.error(`ERROR in setSelectedDataAsync(): ${result.error}`);
          reject(result.error);
        } else {
          const shape = await PowerPoint.run(async (context) => {
            const slide = context.presentation.getSelectedSlides().getItemAt(0);
            slide.shapes.load();
            await context.sync();

            return slide.shapes.items[slide.shapes.items.length - 1];
          });
          resolve(shape);
        }
      }
    );
  });
}

Свойства

asyncContext

Определяемый пользователем элемент любого типа, возвращаемый без изменений в свойстве asyncContext объекта AsyncResult, который передается обратному вызову.
cellFormat

Используйте только с таблицей типов привязки и при передаче объекта TableData для параметра данных. Массив объектов, указывающий диапазон столбцов, строк или ячеек и указывающий в качестве пар "ключ-значение" форматирование ячеек, применяемое к нему.

Пример: [{cells: Office.Table.Data, format: {fontColor: "yellow"}}, {cells: {row: 3, column: 4}, format: {borderColor: "white", fontStyle: "bold"}}]
coercionType

Явно задает форму объекта данных. Значение , если не указано, выводится из типа данных.
imageHeight

Этот параметр подходит для вставки изображений. Обозначает высоту изображения. Если этот параметр указывается без параметра imageWidth, изображение масштабируется в соответствии с указанной высотой. Если указаны и ширина, и высота, то размер изображения меняется соответствующим образом. Если не указана ни высота, ни ширина, используются заданные по умолчанию размер и пропорции изображения. Это значение представлено в точках.
imageLeft

Этот параметр подходит для вставки изображений. Обозначает место вставки относительно левого края слайда в PowerPoint и выделенной на данный момент ячейки в Excel. Это значение не учитывается в Word. Это значение представлено в точках.
imageTop

Этот параметр подходит для вставки изображений. Указывает расположение вставки относительно верхней части слайда для PowerPoint и его связь с выбранной ячейкой в Excel. Это значение не учитывается в Word. Это значение представлено в точках.
imageWidth

Этот параметр подходит для вставки изображений. Обозначает ширину изображения. Если этот параметр указывается без параметра imageHeight, изображение масштабируется в соответствии с указанной шириной. Если указаны и ширина, и высота, то размер изображения меняется соответствующим образом. Если не указана ни высота, ни ширина, используются заданные по умолчанию размер и пропорции изображения. Это значение представлено в точках.
tableOptions

Для вставленной таблицы — это список пар "ключ-значение", определяющих параметры форматирования таблицы, такие как строка заголовка, строка итогового значения и строки с полосами. Пример: {bandedRows: true, filterButton: false}

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

asyncContext

Определяемый пользователем элемент любого типа, возвращаемый без изменений в свойстве asyncContext объекта AsyncResult, который передается обратному вызову.

asyncContext?: any

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

any

cellFormat

Используйте только с таблицей типов привязки и при передаче объекта TableData для параметра данных. Массив объектов, указывающий диапазон столбцов, строк или ячеек и указывающий в качестве пар "ключ-значение" форматирование ячеек, применяемое к нему.

Пример: [{cells: Office.Table.Data, format: {fontColor: "yellow"}}, {cells: {row: 3, column: 4}, format: {borderColor: "white", fontStyle: "bold"}}]

cellFormat?: RangeFormatConfiguration[]

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

Office.RangeFormatConfiguration[]

coercionType

Явно задает форму объекта данных. Значение , если не указано, выводится из типа данных.

coercionType?: Office.CoercionType | string

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

Office.CoercionType | string

imageHeight

Этот параметр подходит для вставки изображений. Обозначает высоту изображения. Если этот параметр указывается без параметра imageWidth, изображение масштабируется в соответствии с указанной высотой. Если указаны и ширина, и высота, то размер изображения меняется соответствующим образом. Если не указана ни высота, ни ширина, используются заданные по умолчанию размер и пропорции изображения. Это значение представлено в точках.

imageHeight?: number

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

number

imageLeft

Этот параметр подходит для вставки изображений. Обозначает место вставки относительно левого края слайда в PowerPoint и выделенной на данный момент ячейки в Excel. Это значение не учитывается в Word. Это значение представлено в точках.

imageLeft?: number

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

number

imageTop

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

imageTop?: number

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

number

imageWidth

Этот параметр подходит для вставки изображений. Обозначает ширину изображения. Если этот параметр указывается без параметра imageHeight, изображение масштабируется в соответствии с указанной шириной. Если указаны и ширина, и высота, то размер изображения меняется соответствующим образом. Если не указана ни высота, ни ширина, используются заданные по умолчанию размер и пропорции изображения. Это значение представлено в точках.

imageWidth?: number

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

number

tableOptions

Для вставленной таблицы — это список пар "ключ-значение", определяющих параметры форматирования таблицы, такие как строка заголовка, строка итогового значения и строки с полосами. Пример: {bandedRows: true, filterButton: false}

tableOptions?: object

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

object