Visio.Interfaces.ShapeData interface

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

Properties

comments

Returns the Comments Collection. Read-only.

[ API set: 1.1 ]

hyperlinks

Returns the Hyperlinks collection for a Shape object. Read-only.

[ API set: 1.1 ]

id

Shape's identifier. Read-only.

[ API set: 1.1 ]

name

Shape's name. Read-only.

[ API set: 1.1 ]

select

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

[ API set: 1.1 ]

shapeDataItems

Returns the Shape's Data Section. Read-only.

[ API set: 1.1 ]

subShapes

Gets SubShape Collection. Read-only.

[ API set: 1.1 ]

text

Shape's text. Read-only.

[ API set: 1.1 ]

view

Returns the view of the shape. Read-only.

[ API set: 1.1 ]

Property Details

comments

Returns the Comments Collection. Read-only.

[ API set: 1.1 ]

comments?: Visio.Interfaces.CommentData[];

Property Value

Returns the Hyperlinks collection for a Shape object. Read-only.

[ API set: 1.1 ]

hyperlinks?: Visio.Interfaces.HyperlinkData[];

Property Value

id

Shape's identifier. Read-only.

[ API set: 1.1 ]

id?: number;

Property Value

number

name

Shape's name. Read-only.

[ API set: 1.1 ]

name?: string;

Property Value

string

select

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

[ API set: 1.1 ]

select?: boolean;

Property Value

boolean

shapeDataItems

Returns the Shape's Data Section. Read-only.

[ API set: 1.1 ]

shapeDataItems?: Visio.Interfaces.ShapeDataItemData[];

Property Value

subShapes

Gets SubShape Collection. Read-only.

[ API set: 1.1 ]

subShapes?: Visio.Interfaces.ShapeData[];

Property Value

text

Shape's text. Read-only.

[ API set: 1.1 ]

text?: string;

Property Value

string

view

Returns the view of the shape. Read-only.

[ API set: 1.1 ]

view?: Visio.Interfaces.ShapeViewData;

Property Value