Visio.ShapeDataItem class
表示 ShapeDataItem 对象。
属性
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| format | 指定形状数据项格式的字符串。 |
| formatted |
指定形状数据项格式值的字符串。 |
| label | 指定形状数据项标签的字符串。 |
| value | 指定形状数据项值的字符串。 |
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
format
formattedValue
label
value
方法详细信息
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(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[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Visio.ShapeDataItem;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Visio.ShapeDataItem 对象是一个 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型化为 Visio.Interfaces.ShapeDataItemData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Visio.Interfaces.ShapeDataItemData;