Visio.ShapeDataItem class

Represents the ShapeDataItem.

[ API set: 1.1 ]

Extends
OfficeExtension.ClientObject

Properties

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

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.

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Visio.ShapeDataItem object is an API object, the toJSON method returns a plain JavaScript object (typed as Visio.Interfaces.ShapeDataItemData) that contains shallow copies of any loaded child properties from the original object.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

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?: Visio.Interfaces.ShapeDataItemLoadOptions): Visio.ShapeDataItem;

Parameters

Returns

Remarks

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

load(option?: string | string[]): Visio.ShapeDataItem - Where option is a comma-delimited string or an array of strings that specify the properties to load.

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(["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)

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

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

Parameters

propertyNames
string | string[]

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

Returns

load(propertyNamesAndPaths)

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

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

Parameters

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

Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Visio.ShapeDataItem object is an API object, the toJSON method returns a plain JavaScript object (typed as Visio.Interfaces.ShapeDataItemData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Visio.Interfaces.ShapeDataItemData;

Returns