PowerPoint.Slide class

  • Ссылка
Пакет:
powerpoint

Представляет один слайд презентации.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: PowerPointApi 1.2 ]

Свойства

context

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

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

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

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

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

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

Методы

delete()

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

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

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

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

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

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

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

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

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

context

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

context: RequestContext;

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

PowerPoint.RequestContext

id

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

readonly id: string;

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

string

Комментарии

[ Набор API: PowerPointApi 1.2 ]

layout

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

readonly layout: PowerPoint.SlideLayout;

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

PowerPoint.SlideLayout

Комментарии

[ Набор API: PowerPointApi 1.3 ]

shapes

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

readonly shapes: PowerPoint.ShapeCollection;

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

PowerPoint.ShapeCollection

Комментарии

[ Набор API: PowerPointApi 1.3 ]

slideMaster

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

readonly slideMaster: PowerPoint.SlideMaster;

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

PowerPoint.SlideMaster

Комментарии

[ Набор API: PowerPointApi 1.3 ]

tags

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

readonly tags: PowerPoint.TagCollection;

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

PowerPoint.TagCollection

Комментарии

[ Набор API: PowerPointApi 1.3 ]

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

delete()

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

delete(): void;

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

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 = context.presentation.getSelectedSlides();
  const slideCount = slides.getCount();
  slides.load("items");
  await context.sync();
  slides.items.map((slide) => {
    slide.delete();
  });
});

exportAsBase64()

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

exportAsBase64(): OfficeExtension.ClientResult<string>;

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

OfficeExtension.ClientResult<string>

Комментарии

[ Набор API: PowerPointApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

getImageAsBase64(options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

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

Параметры

options
PowerPoint.SlideGetImageOptions

Необязательный параметр. Параметры для указания нужного размера изображения слайда.

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

OfficeExtension.ClientResult<string>

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

Комментарии

[ Набор API: PowerPointApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

load(options)

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

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

Параметры

options
PowerPoint.Interfaces.SlideLoadOptions

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

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

PowerPoint.Slide

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

PowerPoint.Slide

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

PowerPoint.Slide

setSelectedShapes(shapeIds)

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

setSelectedShapes(shapeIds: string[]): void;

Параметры

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 = 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");
  await context.sync();
  const shapes = slide1.shapes;
  const shape1 = shapes.getItemAt(0);
  const shape2 = shapes.getItemAt(1);
  shape1.load("id");
  shape2.load("id");
  await context.sync();
  slide1.setSelectedShapes([shape1.id, shape2.id]);
  await context.sync();
});

toJSON()

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

toJSON(): PowerPoint.Interfaces.SlideData;

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

PowerPoint.Interfaces.SlideData