PowerPoint.Shape class

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

context: RequestContext;

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

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

readonly customXmlParts: PowerPoint.CustomXmlPartCollection;

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

Комментарии

[ Набор API: PowerPointApi 1.7 ]

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

readonly fill: 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();
});

Возвращает объект , связанный ShapeGroup с фигурой. Если тип фигуры не groupявляется , то этот метод возвращает ошибку GeneralException .

readonly group: PowerPoint.ShapeGroup;

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

Комментарии

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

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

height: 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;
});

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

readonly id: string;

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

Комментарии

[ Набор API: PowerPointApi 1.3 ]

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

left: 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;
});

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

• Уровень 0 означает, что фигура не является частью группы.

• Уровень 1 означает, что фигура является частью группы верхнего уровня.

• Уровень больше 1 указывает, что фигура является вложенной группой.

readonly level: number;

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

Комментарии

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

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

readonly lineFormat: PowerPoint.ShapeLineFormat;

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

Комментарии

[ Набор API: PowerPointApi 1.4 ]

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

name: string;

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

Комментарии

[ Набор API: PowerPointApi 1.4 ]

Возвращает родительскую группу этой фигуры. Если фигура не входит в группу, этот метод возвращает ошибку GeneralException .

readonly parentGroup: PowerPoint.Shape;

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

Комментарии

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

Возвращает свойства, которые применяются специально к этому заполнителю. Если тип фигуры не placeholderявляется , то этот метод возвращает ошибку GeneralException .

readonly placeholderFormat: PowerPoint.PlaceholderFormat;

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

Комментарии

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

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

readonly tags: PowerPoint.TagCollection;

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

Комментарии

[ Набор API: PowerPointApi 1.3 ]

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

readonly textFrame: PowerPoint.TextFrame;

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

Комментарии

[ Набор API: PowerPointApi 1.4 ]

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

top: 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;
});

Возвращает тип фигуры. Дополнительные сведения см. в статье 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";

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

Комментарии

[ Набор 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();
});

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

width: 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(): 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();
});

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

getParentSlide(): PowerPoint.Slide;

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

Комментарии

[ Набор API: PowerPointApi 1.5 ]

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

getParentSlideLayout(): PowerPoint.SlideLayout;

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

Комментарии

[ Набор API: PowerPointApi 1.5 ]

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

getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout;

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

Комментарии

[ Набор API: PowerPointApi 1.5 ]

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

getParentSlideMaster(): PowerPoint.SlideMaster;

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

Комментарии

[ Набор API: PowerPointApi 1.5 ]

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

getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster;

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

Комментарии

[ Набор API: PowerPointApi 1.5 ]

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

getParentSlideOrNullObject(): PowerPoint.Slide;

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

Комментарии

[ Набор API: PowerPointApi 1.5 ]

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

toJSON(): PowerPoint.Interfaces.ShapeData;

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