Edit

Share via

Visio.Shape class

  • Reference
Package:
visio

Represents the Shape class.

Extends
OfficeExtension.ClientObject

Remarks

[ API set: 1.1 ]

Properties

comments

Returns the Comments Collection.
context

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

Returns the Hyperlinks collection for a Shape object.
id

Shape's identifier.
name

Shape's name.
select

Returns true, if shape is selected. User can set true to select the shape explicitly.
shapeDataItems

Returns the Shape's Data Section.
subShapes

Gets SubShape Collection.
text

Shape's text.
view

Returns the view of the shape.

Methods

getAbsoluteBounds()

Returns the AbsoluteBoundingBox object that specifies absolute bounding box of the shape.
getBounds()

Returns the BoundingBox object that specifies bounding box of the shape.
load(options)

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.
set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.
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.Shape object is an API object, the toJSON method returns a plain JavaScript object (typed as Visio.Interfaces.ShapeData) that contains shallow copies of any loaded child properties from the original object.

Property Details

comments

Returns the Comments Collection.

readonly comments: Visio.CommentCollection;

Property Value

Visio.CommentCollection

Remarks

[ API set: 1.1 ]

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

Visio.RequestContext

Returns the Hyperlinks collection for a Shape object.

readonly hyperlinks: Visio.HyperlinkCollection;

Property Value

Visio.HyperlinkCollection

Remarks

[ API set: 1.1 ]

id

Shape's identifier.

readonly id: number;

Property Value

number

Remarks

[ API set: 1.1 ]

name

Shape's name.

readonly name: string;

Property Value

string

Remarks

[ API set: 1.1 ]

select

Returns true, if shape is selected. User can set true to select the shape explicitly.

select: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]

shapeDataItems

Returns the Shape's Data Section.

readonly shapeDataItems: Visio.ShapeDataItemCollection;

Property Value

Visio.ShapeDataItemCollection

Remarks

[ API set: 1.1 ]

subShapes

Gets SubShape Collection.

readonly subShapes: Visio.ShapeCollection;

Property Value

Visio.ShapeCollection

Remarks

[ API set: 1.1 ]

text

Shape's text.

readonly text: string;

Property Value

string

Remarks

[ API set: 1.1 ]

view

Returns the view of the shape.

readonly view: Visio.ShapeView;

Property Value

Visio.ShapeView

Remarks

[ API set: 1.1 ]

Method Details

getAbsoluteBounds()

Returns the AbsoluteBoundingBox object that specifies absolute bounding box of the shape.

getAbsoluteBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;

Returns

OfficeExtension.ClientResult<Visio.BoundingBox>

Remarks

[ API set: 1.1 ]

getBounds()

Returns the BoundingBox object that specifies bounding box of the shape.

getBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;

Returns

OfficeExtension.ClientResult<Visio.BoundingBox>

Remarks

[ API set: 1.1 ]

load(options)

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

load(options?: Visio.Interfaces.ShapeLoadOptions): Visio.Shape;

Parameters

options
Visio.Interfaces.ShapeLoadOptions

Provides options for which properties of the object to load.

Returns

Visio.Shape

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.Shape;

Parameters

propertyNames

string | string[]

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

Returns

Visio.Shape

Examples

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shapeName = "Sample Name";
    const shape = activePage.shapes.getItem(shapeName);
    shape.load(["name", "id", "text", "select"]);
    return ctx.sync().then(function () {
        console.log(shape.name);
        console.log(shape.id);
        console.log(shape.text);
        console.log(shape.select);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    shape.view.highlight = { color: "#E7E7E7", width: 100 };
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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.Shape;

Parameters

propertyNamesAndPaths

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

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

Visio.Shape

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Visio.Interfaces.ShapeUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Visio.Shape): void;

Parameters

properties
Visio.Shape

Returns

void

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.Shape object is an API object, the toJSON method returns a plain JavaScript object (typed as Visio.Interfaces.ShapeData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Visio.Interfaces.ShapeData;

Returns

Visio.Interfaces.ShapeData