Visio.Shape class

包:

visio

表示 Shape 类。

Extends

OfficeExtension.ClientObject

注解

[ API 集： 1.1 ]

属性

comments	返回注释集合。
context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
hyperlinks	返回一组形状对象超链接。
id	形状的标识符。
name	形状的名称。
select	如果选择形状，则返回 true。 用户可以设置为 true，从而明确选择形状。
shapeDataItems	返回形状的数据部分。
subShapes	获取 SubShape 集合。
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

返回注释集合。

readonly comments: Visio.CommentCollection;

属性值

Visio.CommentCollection

注解

[ API 集： 1.1 ]

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Visio.RequestContext

hyperlinks

返回一组形状对象超链接。

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

获取 SubShape 集合。

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

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

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