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

Visio.Shape class

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

Представляет класс Shape.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: 1.1 ]

Свойства

comments

Возвращает коллекцию Comments.
context

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

Возвращает коллекцию ссылок для объекта Shape.
id

Идентификатор фигуры.
name

Имя фигуры.
select

Возвращает значение true, если фигура выделена. Пользователь может задать значение true, чтобы явно выбрать фигуру.
shapeDataItems

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

Возвращает коллекцию вложенных фигур.
text

Текст фигуры.
view

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

Методы

getAbsoluteBounds()

Возвращает объект AbsoluteBoundingBox, указывающий абсолютный ограничивающий прямоугольник фигуры.
getBounds()

Возвращает объект BoundingBox, определяющий ограничивающий прямоугольник фигуры.
load(options)

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

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

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

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()

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

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

comments

Возвращает коллекцию Comments.

readonly comments: Visio.CommentCollection;

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

Visio.CommentCollection

Комментарии

[ Набор API: 1.1 ]

context

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

context: RequestContext;

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

Visio.RequestContext

Возвращает коллекцию ссылок для объекта Shape.

readonly hyperlinks: Visio.HyperlinkCollection;

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

Visio.HyperlinkCollection

Комментарии

[ Набор API: 1.1 ]

id

Идентификатор фигуры.

readonly id: number;

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

number

Комментарии

[ Набор API: 1.1 ]

name

Имя фигуры.

readonly name: string;

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

string

Комментарии

[ Набор API: 1.1 ]

select

Возвращает значение true, если фигура выделена. Пользователь может задать значение true, чтобы явно выбрать фигуру.

select: boolean;

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

boolean

Комментарии

[ Набор API: 1.1 ]

shapeDataItems

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

readonly shapeDataItems: Visio.ShapeDataItemCollection;

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

Visio.ShapeDataItemCollection

Комментарии

[ Набор API: 1.1 ]

subShapes

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

readonly subShapes: Visio.ShapeCollection;

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

Visio.ShapeCollection

Комментарии

[ Набор API: 1.1 ]

text

Текст фигуры.

readonly text: string;

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

string

Комментарии

[ Набор API: 1.1 ]

view

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

readonly view: Visio.ShapeView;

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

Visio.ShapeView

Комментарии

[ Набор API: 1.1 ]

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

getAbsoluteBounds()

Возвращает объект AbsoluteBoundingBox, указывающий абсолютный ограничивающий прямоугольник фигуры.

getAbsoluteBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;

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

OfficeExtension.ClientResult<Visio.BoundingBox>

Комментарии

[ Набор API: 1.1 ]

getBounds()

Возвращает объект BoundingBox, определяющий ограничивающий прямоугольник фигуры.

getBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;

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

OfficeExtension.ClientResult<Visio.BoundingBox>

Комментарии

[ Набор API: 1.1 ]

load(options)

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

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

Параметры

options
Visio.Interfaces.ShapeLoadOptions

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

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

Visio.Shape

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Visio.Shape

Примеры

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shapeName = "Sample Name";
    const shape = activePage.shapes.getItem(shapeName);
    shape.load(["name", "id", "text", "select"]);
    return ctx.sync().then(function () {
        console.log(shape.name);
        console.log(shape.id);
        console.log(shape.text);
        console.log(shape.select);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    shape.view.highlight = { color: "#E7E7E7", width: 100 };
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Visio.Shape

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties
Visio.Interfaces.ShapeUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options
OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

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

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Visio.Shape): void;

Параметры

properties
Visio.Shape

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

void

toJSON()

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

toJSON(): Visio.Interfaces.ShapeData;

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

Visio.Interfaces.ShapeData