ShapeDataItem object (JavaScript API for Visio)

Applies to: Visio Online

Represents the ShapeDataItem.

Properties

Property	Type	Description
format	string	A string that specifies the format of the shape data item. Read-only.
formattedValue	string	A string that specifies the formatted value of the shape data item. Read-only.
label	string	A string that specifies the label of the shape data item. Read-only.
value	string	A string that specifies the value of the shape data item. Read-only.

See property access examples.

Relationships

None

Methods

Method	Return Type	Description
load(param: object)	void	Fills the proxy object created in JavaScript layer with property and object values specified in the parameter.

Method Details

load(param: object)

Fills the proxy object created in JavaScript layer with property and object values specified in the parameter.

Syntax

object.load(param);

Parameters

Parameter	Type	Description
param	object	Optional. Accepts parameter and relationship names as delimited string or an array. Or, provide loadOption object.

Returns

void

Property access examples

Visio.run(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));
        }
});

taItem.value); }); }).catch(function(error) { console.log("Error: " + error); if (error instanceof OfficeExtension.Error) { console.log("Debug info: " + JSON.stringify(error.debugInfo)); } });

Docs