Visio.ShapeDataItem class

Represents the ShapeDataItem.

[ API set: 1.1 ]

Extends
OfficeExtension.ClientObject

Properties

format

A string that specifies the format of the shape data item. Read-only.

[ API set: 1.1 ]

formattedValue

A string that specifies the formatted value of the shape data item. Read-only.

[ API set: 1.1 ]

label

A string that specifies the label of the shape data item. Read-only.

[ API set: 1.1 ]

value

A string that specifies the value of the shape data item. Read-only.

[ API set: 1.1 ]

Methods

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

toJSON()

Property Details

format

A string that specifies the format of the shape data item. Read-only.

[ API set: 1.1 ]

readonly format: string;
Property Value
string

formattedValue

A string that specifies the formatted value of the shape data item. Read-only.

[ API set: 1.1 ]

readonly formattedValue: string;
Property Value
string

label

A string that specifies the label of the shape data item. Read-only.

[ API set: 1.1 ]

readonly label: string;
Property Value
string

value

A string that specifies the value of the shape data item. Read-only.

[ API set: 1.1 ]

readonly value: string;
Property Value
string

Method Details

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

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

A comma-delimited string or an array of strings that specify the properties to load.

Returns
Remarks

In addition to this signature, this method has the following signatures:

load(option?: { select?: string; expand?: string; }): Visio.ShapeDataItem - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Visio.ShapeDataItem - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

Examples

Visio.run(session, function (ctx) {
    var activePage = ctx.document.getActivePage();
    var shape = activePage.shapes.getItem(0);
    var shapeDataItem = shape.shapeDataItems.getItem(0);
    shapeDataItem.load();
        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));
    }
});

toJSON()

toJSON(): Visio.Interfaces.ShapeDataItemData;
Returns