Visio.Shape class

Ссылка

Пакет:: visio

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

Extends: OfficeExtension.ClientObject

Свойства

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)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setMockData(data)	Настройка макетных данных
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

context

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

context: RequestContext;

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

Visio.RequestContext

hyperlinks

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

readonly hyperlinks: Visio.HyperlinkCollection;

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

Visio.HyperlinkCollection

id

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

readonly id: number;

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

number

name

Имя фигуры.

readonly name: string;

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

string

select

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

select: boolean;

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

boolean

shapeDataItems

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

readonly shapeDataItems: Visio.ShapeDataItemCollection;

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

Visio.ShapeDataItemCollection

subShapes

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

readonly subShapes: Visio.ShapeCollection;

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

Visio.ShapeCollection

text

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

readonly text: string;

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

string

view

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

readonly view: Visio.ShapeView;

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

Visio.ShapeView

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

getAbsoluteBounds()

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

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

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

OfficeExtension.ClientResult<Visio.BoundingBox>

getBounds()

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

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

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

OfficeExtension.ClientResult<Visio.BoundingBox>

load(options)

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

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

Параметры

options: Visio.Interfaces.ShapeLoadOptions

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

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

Visio.Shape

load(propertyNames)

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)

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

setMockData(data)

Настройка макетных данных

setMockData(data: Visio.Interfaces.ShapeData): void;

Параметры

data: Visio.Interfaces.ShapeData

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

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

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

Visio.Shape class

Комментарии

Свойства

Методы

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

comments

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

Комментарии

context

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

hyperlinks

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

Комментарии

id

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

Комментарии

name

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

Комментарии

select

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

Комментарии

shapeDataItems

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

Комментарии

subShapes

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

Комментарии

text

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

Комментарии

view

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

Комментарии

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

getAbsoluteBounds()

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

Комментарии

getBounds()

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

Примеры

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

setMockData(data)

Параметры

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

toJSON()

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

Дополнительные ресурсы