Visio.ShapeDataItem class

  • 参考
包:
visio

表示 ShapeDataItem 对象。

Extends
OfficeExtension.ClientObject

注解

[ API 集： 1.1 ]

属性

context

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

指定形状数据项格式的字符串。
formattedValue

指定形状数据项格式值的字符串。
label

指定形状数据项标签的字符串。
value

指定形状数据项值的字符串。

方法

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
setMockData(data)

设置模拟数据
toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 而原始 Visio.ShapeDataItem 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Visio.Interfaces.ShapeDataItemData) ，该对象包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

context

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

context: RequestContext;

属性值

Visio.RequestContext

format

指定形状数据项格式的字符串。

readonly format: string;

属性值

string

注解

[ API 集： 1.1 ]

formattedValue

指定形状数据项格式值的字符串。

readonly formattedValue: string;

属性值

string

注解

[ API 集： 1.1 ]

label

指定形状数据项标签的字符串。

readonly label: string;

属性值

string

注解

[ API 集： 1.1 ]

value

指定形状数据项值的字符串。

readonly value: string;

属性值

string

注解

[ API 集： 1.1 ]

方法详细信息

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Visio.Interfaces.ShapeDataItemLoadOptions): Visio.ShapeDataItem;

参数

options
Visio.Interfaces.ShapeDataItemLoadOptions

提供要加载对象的属性的选项。

返回

Visio.ShapeDataItem

示例

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    const shapeDataItem = shape.shapeDataItems.getItem(0);
    shapeDataItem.load(["label", "value"]);
        return ctx.sync().then(function() {
            console.log(shapeDataItem.label);
            console.log(shapeDataItem.value);
        });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

Visio.ShapeDataItem

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNamesAndPaths

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

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Visio.ShapeDataItem

setMockData(data)

设置模拟数据

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

参数

data
Visio.Interfaces.ShapeDataItemData

返回

void

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 而原始 Visio.ShapeDataItem 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Visio.Interfaces.ShapeDataItemData) ，该对象包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Visio.Interfaces.ShapeDataItemData;

返回

Visio.Interfaces.ShapeDataItemData