PowerPoint.Shape class
Представляет одну фигуру на слайде.
- Extends
Комментарии
[ Набор API: PowerPointApi 1.3 ]
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| fill | Возвращает формат заливки фигуры. |
| height | Задает высоту фигуры (в точках). |
| id | Возвращает уникальный идентификатор фигуры. |
| left | Расстояние (в точках) от левой стороны фигуры до левой стороны слайда. |
| line |
Возвращает формат линии для фигуры. |
| name | Указывает имя этой фигуры. |
| tags | Возвращает коллекцию тегов в фигуре. |
| text |
Возвращает объект рамки с текстом для фигуры. |
| top | Расстояние (в точках) от верхнего края фигуры до верхнего края слайда. |
| type | Возвращает тип фигуры. Дополнительные сведения см. в статье PowerPoint.ShapeType . |
| width | Задает ширину фигуры (в точках). |
Методы
| delete() | Удаляет фигуру из коллекции фигур. Ничего не делает, если фигура не существует. |
| get |
Возвращает родительский объект PowerPoint.Slide , содержащий этот |
| get |
Возвращает родительский объект PowerPoint.SlideLayout , содержащий этот |
| get |
Возвращает родительский объект PowerPoint.SlideLayout , содержащий этот |
| get |
Возвращает родительский объект PowerPoint.SlideMaster , содержащий этот |
| get |
Возвращает родительский объект PowerPoint.SlideMaster , содержащий этот |
| get |
Возвращает родительский объект PowerPoint.Slide , содержащий этот |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
fill
Возвращает формат заливки фигуры.
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 = 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 = 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
Комментарии
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 = 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;Значение свойства
Комментарии
name
Указывает имя этой фигуры.
name: string;Значение свойства
string
Комментарии
tags
Возвращает коллекцию тегов в фигуре.
readonly tags: PowerPoint.TagCollection;Значение свойства
Комментарии
textFrame
Возвращает объект рамки с текстом для фигуры.
readonly textFrame: PowerPoint.TextFrame;Значение свойства
Комментарии
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 = 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";Значение свойства
PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table"
Комментарии
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 = 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
Комментарии
getParentSlide()
Возвращает родительский объект PowerPoint.Slide , содержащий этот Shapeобъект . Создает исключение, если эта фигура не принадлежит .Slide
getParentSlide(): PowerPoint.Slide;Возвращаемое значение
Комментарии
getParentSlideLayout()
Возвращает родительский объект PowerPoint.SlideLayout , содержащий этот Shapeобъект . Создает исключение, если эта фигура не принадлежит .SlideLayout
getParentSlideLayout(): PowerPoint.SlideLayout;Возвращаемое значение
Комментарии
getParentSlideLayoutOrNullObject()
Возвращает родительский объект PowerPoint.SlideLayout , содержащий этот Shapeобъект . Если эта фигура не принадлежит SlideLayoutобъекту , то возвращается объект со свойством isNullObject , которому присвоено значение true .
getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout;Возвращаемое значение
Комментарии
getParentSlideMaster()
Возвращает родительский объект PowerPoint.SlideMaster , содержащий этот Shapeобъект . Создает исключение, если эта фигура не принадлежит .SlideMaster
getParentSlideMaster(): PowerPoint.SlideMaster;Возвращаемое значение
Комментарии
getParentSlideMasterOrNullObject()
Возвращает родительский объект PowerPoint.SlideMaster , содержащий этот Shapeобъект . Если эта фигура не принадлежит SlideMasterобъекту , то возвращается объект со свойством isNullObject , которому присвоено значение true .
getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster;Возвращаемое значение
Комментарии
getParentSlideOrNullObject()
Возвращает родительский объект PowerPoint.Slide , содержащий этот Shapeобъект . Если эта фигура не принадлежит Slideобъекту , то возвращается объект со свойством isNullObject , которому присвоено значение true .
getParentSlideOrNullObject(): PowerPoint.Slide;Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: PowerPoint.Interfaces.ShapeLoadOptions): PowerPoint.Shape;Параметры
Предоставляет параметры свойств загружаемого объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): PowerPoint.Shape;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.Shape;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект PowerPoint.Shape является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как PowerPoint.Interfaces.ShapeData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): PowerPoint.Interfaces.ShapeData;Возвращаемое значение
Office Add-ins
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по