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

PowerPoint.Shape class

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

Представляет одну фигуру на слайде.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: PowerPointApi 1.3 ]

Примеры

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

// Changes the transparency of every geometric shape in the slide.
await PowerPoint.run(async (context) => {
  // Get the type of shape for every shape in the collection.
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type");
  await context.sync();

  // Change the shape transparency to be halfway transparent.
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.geometricShape) {
      shape.fill.transparency = 0.5;
    }
  });
  await context.sync();
});

Свойства

context

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

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

Возвращает формат заливки фигуры.
height

Задает высоту фигуры (в точках). InvalidArgument Создает исключение, если задано отрицательное значение.
id

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

Расстояние (в точках) от левой части фигуры до левой стороны слайда.
lineFormat

Возвращает формат линии для фигуры.
name

Указывает имя этой фигуры.
tags

Возвращает коллекцию тегов в фигуре.
textFrame

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

Расстояние (в точках) от верхнего края фигуры до верхнего края слайда.
type

Возвращает тип фигуры. Дополнительные сведения см. в статье PowerPoint.ShapeType .
width

Задает ширину фигуры (в точках). InvalidArgument Создает исключение, если задано отрицательное значение.

Методы

delete()

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

Возвращает родительский объект PowerPoint.Slide , содержащий этот Shapeобъект . Создает исключение, если эта фигура не принадлежит .Slide
getParentSlideLayout()

Возвращает родительский объект PowerPoint.SlideLayout , содержащий этот Shapeобъект . Создает исключение, если эта фигура не принадлежит .SlideLayout
getParentSlideLayoutOrNullObject()

Возвращает родительский объект PowerPoint.SlideLayout , содержащий этот Shapeобъект . Если эта фигура не принадлежит SlideLayoutобъекту , то возвращается объект со свойством isNullObject , которому присвоено значение true .
getParentSlideMaster()

Возвращает родительский объект PowerPoint.SlideMaster , содержащий этот Shapeобъект . Создает исключение, если эта фигура не принадлежит .SlideMaster
getParentSlideMasterOrNullObject()

Возвращает родительский объект PowerPoint.SlideMaster , содержащий этот Shapeобъект . Если эта фигура не принадлежит SlideMasterобъекту , то возвращается объект со свойством isNullObject , которому присвоено значение true .
getParentSlideOrNullObject()

Возвращает родительский объект PowerPoint.Slide , содержащий этот Shapeобъект . Если эта фигура не принадлежит Slideобъекту , то возвращается объект со свойством isNullObject , которому присвоено значение true .
load(options)

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

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

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

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

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

context

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

context: RequestContext;

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

PowerPoint.RequestContext

customXmlParts

Примечание

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

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

readonly customXmlParts: PowerPoint.CustomXmlPartCollection;

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

PowerPoint.CustomXmlPartCollection

Комментарии

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

fill

Возвращает формат заливки фигуры.

readonly fill: PowerPoint.ShapeFill;

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

PowerPoint.ShapeFill

Комментарии

[ Набор API: PowerPointApi 1.4 ]

Примеры

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

// Changes the selected shapes fill color to red.
await PowerPoint.run(async (context) => {
  const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  shapes.items.map((shape) => {
    shape.fill.setSolidColor("red");
  });
  await context.sync();
});

height

Задает высоту фигуры (в точках). InvalidArgument Создает исключение, если задано отрицательное значение.

height: number;

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

number

Комментарии

[ Набор API: PowerPointApi 1.4 ]

Примеры

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

// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
  const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  let maxHeight = 0;
  shapes.items.map((shape) => {
    shape.load("width,height");
  });
  await context.sync();
  shapes.items.map((shape) => {
    shape.left = currentLeft;
    shape.top = currentTop;
    currentLeft += shape.width;
    if (shape.height > maxHeight) maxHeight = shape.height;
  });
  await context.sync();
  currentLeft = 0;
  if (currentTop > slideHeight - 200) currentTop = 0;
});

id

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

readonly id: string;

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

string

Комментарии

[ Набор API: PowerPointApi 1.3 ]

left

Расстояние (в точках) от левой части фигуры до левой стороны слайда.

left: number;

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

number

Комментарии

[ Набор API: PowerPointApi 1.4 ]

Примеры

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

// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
  const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  let maxHeight = 0;
  shapes.items.map((shape) => {
    shape.load("width,height");
  });
  await context.sync();
  shapes.items.map((shape) => {
    shape.left = currentLeft;
    shape.top = currentTop;
    currentLeft += shape.width;
    if (shape.height > maxHeight) maxHeight = shape.height;
  });
  await context.sync();
  currentLeft = 0;
  if (currentTop > slideHeight - 200) currentTop = 0;
});

lineFormat

Возвращает формат линии для фигуры.

readonly lineFormat: PowerPoint.ShapeLineFormat;

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

PowerPoint.ShapeLineFormat

Комментарии

[ Набор API: PowerPointApi 1.4 ]

name

Указывает имя этой фигуры.

name: string;

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

string

Комментарии

[ Набор API: PowerPointApi 1.4 ]

tags

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

readonly tags: PowerPoint.TagCollection;

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

PowerPoint.TagCollection

Комментарии

[ Набор API: PowerPointApi 1.3 ]

textFrame

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

readonly textFrame: PowerPoint.TextFrame;

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

PowerPoint.TextFrame

Комментарии

[ Набор API: PowerPointApi 1.4 ]

top

Расстояние (в точках) от верхнего края фигуры до верхнего края слайда.

top: number;

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

number

Комментарии

[ Набор API: PowerPointApi 1.4 ]

Примеры

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

// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
  const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  let maxHeight = 0;
  shapes.items.map((shape) => {
    shape.load("width,height");
  });
  await context.sync();
  shapes.items.map((shape) => {
    shape.left = currentLeft;
    shape.top = currentTop;
    currentLeft += shape.width;
    if (shape.height > maxHeight) maxHeight = shape.height;
  });
  await context.sync();
  currentLeft = 0;
  if (currentTop > slideHeight - 200) currentTop = 0;
});

type

Возвращает тип фигуры. Дополнительные сведения см. в статье PowerPoint.ShapeType .

readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox";

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

PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox"

Комментарии

[ Набор API: PowerPointApi 1.4 ]

Примеры

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

// Changes the transparency of every geometric shape in the slide.
await PowerPoint.run(async (context) => {
  // Get the type of shape for every shape in the collection.
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type");
  await context.sync();

  // Change the shape transparency to be halfway transparent.
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.geometricShape) {
      shape.fill.transparency = 0.5;
    }
  });
  await context.sync();
});

width

Задает ширину фигуры (в точках). InvalidArgument Создает исключение, если задано отрицательное значение.

width: number;

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

number

Комментарии

[ Набор API: PowerPointApi 1.4 ]

Примеры

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

// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
  const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  let maxHeight = 0;
  shapes.items.map((shape) => {
    shape.load("width,height");
  });
  await context.sync();
  shapes.items.map((shape) => {
    shape.left = currentLeft;
    shape.top = currentTop;
    currentLeft += shape.width;
    if (shape.height > maxHeight) maxHeight = shape.height;
  });
  await context.sync();
  currentLeft = 0;
  if (currentTop > slideHeight - 200) currentTop = 0;
});

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

delete()

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

delete(): void;

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

void

Комментарии

[ Набор API: PowerPointApi 1.3 ]

Примеры

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

// This function gets the collection of shapes on the first slide,
// and then iterates through them, deleting each one.
await PowerPoint.run(async (context) => {
  const slide: PowerPoint.Slide = context.presentation.slides.getItemAt(0);
  const shapes: PowerPoint.ShapeCollection = slide.shapes;

  // Load all the shapes in the collection without loading their properties.
  shapes.load("items/$none");

  await context.sync();

  shapes.items.forEach((shape) => shape.delete());

  await context.sync();
});

getParentSlide()

Возвращает родительский объект PowerPoint.Slide , содержащий этот Shapeобъект . Создает исключение, если эта фигура не принадлежит .Slide

getParentSlide(): PowerPoint.Slide;

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

PowerPoint.Slide

Комментарии

[ Набор API: PowerPointApi 1.5 ]

getParentSlideLayout()

Возвращает родительский объект PowerPoint.SlideLayout , содержащий этот Shapeобъект . Создает исключение, если эта фигура не принадлежит .SlideLayout

getParentSlideLayout(): PowerPoint.SlideLayout;

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

PowerPoint.SlideLayout

Комментарии

[ Набор API: PowerPointApi 1.5 ]

getParentSlideLayoutOrNullObject()

Возвращает родительский объект PowerPoint.SlideLayout , содержащий этот Shapeобъект . Если эта фигура не принадлежит SlideLayoutобъекту , то возвращается объект со свойством isNullObject , которому присвоено значение true .

getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout;

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

PowerPoint.SlideLayout

Комментарии

[ Набор API: PowerPointApi 1.5 ]

getParentSlideMaster()

Возвращает родительский объект PowerPoint.SlideMaster , содержащий этот Shapeобъект . Создает исключение, если эта фигура не принадлежит .SlideMaster

getParentSlideMaster(): PowerPoint.SlideMaster;

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

PowerPoint.SlideMaster

Комментарии

[ Набор API: PowerPointApi 1.5 ]

getParentSlideMasterOrNullObject()

Возвращает родительский объект PowerPoint.SlideMaster , содержащий этот Shapeобъект . Если эта фигура не принадлежит SlideMasterобъекту , то возвращается объект со свойством isNullObject , которому присвоено значение true .

getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster;

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

PowerPoint.SlideMaster

Комментарии

[ Набор API: PowerPointApi 1.5 ]

getParentSlideOrNullObject()

Возвращает родительский объект PowerPoint.Slide , содержащий этот Shapeобъект . Если эта фигура не принадлежит Slideобъекту , то возвращается объект со свойством isNullObject , которому присвоено значение true .

getParentSlideOrNullObject(): PowerPoint.Slide;

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

PowerPoint.Slide

Комментарии

[ Набор API: PowerPointApi 1.5 ]

load(options)

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

load(options?: PowerPoint.Interfaces.ShapeLoadOptions): PowerPoint.Shape;

Параметры

options
PowerPoint.Interfaces.ShapeLoadOptions

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

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

PowerPoint.Shape

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

PowerPoint.Shape

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

PowerPoint.Shape

toJSON()

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

toJSON(): PowerPoint.Interfaces.ShapeData;

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

PowerPoint.Interfaces.ShapeData