Edit

Visio.Interfaces.ShapeData interface

An interface describing the data returned by calling shape.toJSON().

Remarks

Used by

Properties

comments

Returns the Comments Collection.

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.

Property Details

comments

Returns the Comments Collection.

comments?: Visio.Interfaces.CommentData[];

Property Value

Remarks

API set: 1.1

Returns the Hyperlinks collection for a Shape object.

hyperlinks?: Visio.Interfaces.HyperlinkData[];

Property Value

Remarks

API set: 1.1

id

Shape's identifier.

id?: number;

Property Value

number

Remarks

API set: 1.1

name

Shape's name.

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.

shapeDataItems?: Visio.Interfaces.ShapeDataItemData[];

Property Value

Remarks

API set: 1.1

subShapes

Gets SubShape Collection.

subShapes?: Visio.Interfaces.ShapeData[];

Property Value

Remarks

API set: 1.1

text

Shape's text.

text?: string;

Property Value

string

Remarks

API set: 1.1

view

Returns the view of the shape.

view?: Visio.Interfaces.ShapeViewData;

Property Value

Remarks

API set: 1.1