PowerPoint.Slide class

Возвращает фон слайда.

readonly background: PowerPoint.SlideBackground;

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

Комментарии

Набор API: PowerPointApi 1.10

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-set-background-fill.yaml

// Gets the background fill type of the first selected slide.
await PowerPoint.run(async (context) => {
  const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
  const fill: PowerPoint.SlideBackgroundFill = slide.background.fill;
  fill.load("type");
  await context.sync();

  const fillType = fill.type as PowerPoint.SlideBackgroundFillType;
  console.log(`Background fill type: ${fillType}`);
});

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

context: RequestContext;

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

Возвращает коллекцию настраиваемых XML-частей на слайде.

readonly customXmlParts: PowerPoint.CustomXmlPartCollection;

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

Комментарии

Набор API: PowerPointApi 1.7

Возвращает коллекцию гиперссылок на слайде.

readonly hyperlinks: PowerPoint.HyperlinkCollection;

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

Комментарии

Набор API: PowerPointApi 1.6

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/hyperlinks/manage-hyperlinks.yaml

// Sets a hyperlink on the first selected shape.
await PowerPoint.run(async (context) => {
  const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
  const shape: PowerPoint.Shape = context.presentation.getSelectedShapes().getItemAt(0).load("id,type");
  const hyperlinks: PowerPoint.HyperlinkCollection = slide.hyperlinks;
  const hyperlinkAddOptions: PowerPoint.HyperlinkAddOptions = {
    address: "https://bing.com",
    screenTip: "Screen tip for shape",
  };
  let hyperlink: PowerPoint.Hyperlink = hyperlinks.add(shape, hyperlinkAddOptions).load("address,screenTip");
  try {
    await context.sync();
  } catch {
    console.warn("Confirm that you have at least one slide and you've selected a shape on the active slide.");
    return;
  }

  console.log(
    `Added link "${hyperlink.address}" (screen tip: "${hyperlink.screenTip}") to the first selected shape (ID: ${shape.id}, type: ${shape.type}).`,
  );
});

Возвращает уникальный идентификатор слайда.

readonly id: string;

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

Комментарии

Набор API: PowerPointApi 1.2

Возвращает отсчитываемый от нуля индекс слайда, представляющий его позицию в презентации.

readonly index: number;

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

Комментарии

Набор API: PowerPointApi 1.8

Возвращает макет слайда.

readonly layout: PowerPoint.SlideLayout;

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

Комментарии

Набор API: PowerPointApi 1.3

Возвращает коллекцию фигур на слайде.

readonly shapes: PowerPoint.ShapeCollection;

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

Комментарии

Набор API: PowerPointApi 1.3

SlideMaster Возвращает объект , представляющий содержимое слайда по умолчанию.

readonly slideMaster: PowerPoint.SlideMaster;

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

Комментарии

Набор API: PowerPointApi 1.3

Возвращает коллекцию тегов на слайде.

readonly tags: PowerPoint.TagCollection;

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

Комментарии

Набор API: PowerPointApi 1.3

Возвращает значение ThemeColorScheme слайда.

readonly themeColorScheme: PowerPoint.ThemeColorScheme;

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

Комментарии

Набор API: PowerPointApi 1.10

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-set-theme-color-scheme.yaml

// Gets the theme color scheme for the first slide and logs all theme color values.
await PowerPoint.run(async (context) => {
  const slide = context.presentation.slides.getItemAt(0);
  const colorScheme: PowerPoint.ThemeColorScheme = slide.themeColorScheme;

  // Queue up getThemeColor calls for each theme color.
  const colorResults = themeColorNames.map((colorName) => colorScheme.getThemeColor(colorName));
  await context.sync();

  // Display the results.
  console.log("Theme colors for slide 1:");
  themeColorNames.forEach((colorName, index) => {
    console.log(`  ${colorName}: ${colorResults[index].value}`);
  });
});

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

applyLayout(slideLayout: PowerPoint.SlideLayout): void;

Параметры

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

Комментарии

Набор API: PowerPointApi 1.8

Удаляет слайд из презентации. Ничего не делает, если слайд не существует.

delete(): void;

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

Комментарии

Набор API: PowerPointApi 1.2

Примеры

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

// Deletes the selected slides.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slides: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();
  const slideCount = slides.getCount();
  slides.load("items");
  await context.sync();
  slides.items.map((slide) => {
    slide.delete();
  });
});

Экспортирует слайд в собственный файл презентации, возвращаемый как данные в кодировке Base64.

Примечание. Этот метод оптимизирован для экспорта одного слайда. Экспорт нескольких слайдов может повлиять на производительность.

exportAsBase64(): OfficeExtension.ClientResult<string>;

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

Комментарии

Набор API: PowerPointApi 1.8

Примеры

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

// Exports current slide.
await PowerPoint.run(async (context) => {
  const slide = context.presentation.getSelectedSlides().getItemAt(0);
  const slideBase64DataResult = slide.exportAsBase64();
  const imageBase64DataResult = slide.getImageAsBase64({ height: 300 });
  await context.sync();

  localStorage.setItem("exportedSlide", slideBase64DataResult.value);
  localStorage.setItem("exportedSlideImage", imageBase64DataResult.value);

  updateSlideImage(imageBase64DataResult.value);

  console.log("Slide was exported.");
});

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

getImageAsBase64(options?: PowerPoint.SlideGetImageOptions): OfficeExtension.ClientResult<string>;

Параметры

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

Строка изображения слайда в кодировке Base64 в формате PNG.

Комментарии

Набор API: PowerPointApi 1.8

Примеры

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

// Exports current slide.
await PowerPoint.run(async (context) => {
  const slide = context.presentation.getSelectedSlides().getItemAt(0);
  const slideBase64DataResult = slide.exportAsBase64();
  const imageBase64DataResult = slide.getImageAsBase64({ height: 300 });
  await context.sync();

  localStorage.setItem("exportedSlide", slideBase64DataResult.value);
  localStorage.setItem("exportedSlideImage", imageBase64DataResult.value);

  updateSlideImage(imageBase64DataResult.value);

  console.log("Slide was exported.");
});

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

load(options?: PowerPoint.Interfaces.SlideLoadOptions): PowerPoint.Slide;

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

Перемещение слайда в новую позицию в презентации.

moveTo(slideIndex: number): void;

Параметры

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

Комментарии

Набор API: PowerPointApi 1.8

Выбирает указанные фигуры. Существующий выбор фигуры заменяется новым выделением.

setSelectedShapes(shapeIds: string[]): void;

Параметры

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

Комментарии

Набор API: PowerPointApi 1.5

Примеры

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

// Reselects shapes that were saved previously.
await PowerPoint.run(async (context) => {
  const slide1: PowerPoint.Slide = context.presentation.slides.getItem(savedSlideSelection[0]);
  await context.sync();
  slide1.setSelectedShapes(savedShapeSelection);
  await context.sync();
});

...

// Selects the first two shapes on slide 1.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slide1 = context.presentation.slides.getItemAt(0);
  slide1.load("shapes/items/type");
  await context.sync();

  const shapes = slide1.shapes.items.filter((item) => item.type === PowerPoint.ShapeType.geometricShape);
  const shape1: PowerPoint.Shape = shapes[0];
  const shape2: PowerPoint.Shape = shapes[1];
  shape1.load("id");
  shape2.load("id");
  await context.sync();

  console.log(`IDs: ${shape1.id}, ${shape2.id}`);
  slide1.setSelectedShapes([shape1.id, shape2.id]);
  await context.sync();
});

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

toJSON(): PowerPoint.Interfaces.SlideData;

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