C

Shapes

Show Usages

A container class that models the VSDX Shapes object, stores all Shape instances and provides factory methods for them.

Members

Show:

Properties

parent

: VsdxObject

Methods

createForeignShape

(
master?: Master
fillStyle?: VsdxStyleSheet
lineStyle?: VsdxStyleSheet
textStyle?: VsdxStyleSheet
): ForeignShape

Creates a new foreign Shape, i.e, a Shape of type 'Foreign'.

Parameters

master?: Master
fillStyle?: VsdxStyleSheet
lineStyle?: VsdxStyleSheet
textStyle?: VsdxStyleSheet

Return Value

createForeignShape

(
master?: Master
fillStyle?: VsdxStyleSheet
lineStyle?: VsdxStyleSheet
textStyle?: VsdxStyleSheet
): ForeignShape

Creates a new foreign Shape, i.e, a Shape of type 'Foreign'.

Parameters

master?: Master

An optional master.

fillStyle?: VsdxStyleSheet

The fillStyle to apply to this shape.

lineStyle?: VsdxStyleSheet

The lineStyle to apply to this shape.

textStyle?: VsdxStyleSheet

The textStyle to apply to this shape.

Return Value

createGroupShape

(
master?: Master
fillStyle?: VsdxStyleSheet
lineStyle?: VsdxStyleSheet
textStyle?: VsdxStyleSheet
): GroupShape

Creates a new group Shape, i.e, a Shape of type 'Group'.

Parameters

master?: Master
fillStyle?: VsdxStyleSheet
lineStyle?: VsdxStyleSheet
textStyle?: VsdxStyleSheet

Return Value

createGroupShape

(
master?: Master
fillStyle?: VsdxStyleSheet
lineStyle?: VsdxStyleSheet
textStyle?: VsdxStyleSheet
): GroupShape

Creates a new group Shape, i.e, a Shape of type 'Group'.

Parameters

master?: Master

An optional master.

fillStyle?: VsdxStyleSheet

The fillStyle to apply to this shape.

lineStyle?: VsdxStyleSheet

The lineStyle to apply to this shape.

textStyle?: VsdxStyleSheet

The textStyle to apply to this shape.

Return Value

createShape

(
master?: Master
fillStyle?: VsdxStyleSheet
lineStyle?: VsdxStyleSheet
textStyle?: VsdxStyleSheet
): Shape

Creates a new Shape.

Parameters

master?: Master
fillStyle?: VsdxStyleSheet
lineStyle?: VsdxStyleSheet
textStyle?: VsdxStyleSheet

Return Value

createShape

(
master?: Master
fillStyle?: VsdxStyleSheet
lineStyle?: VsdxStyleSheet
textStyle?: VsdxStyleSheet
): Shape

Creates a new Shape.

Parameters

master?: Master

An optional master.

fillStyle?: VsdxStyleSheet

The fillStyle to apply to this shape.

lineStyle?: VsdxStyleSheet

The lineStyle to apply to this shape.

textStyle?: VsdxStyleSheet

The textStyle to apply to this shape.

Return Value

createShapeWithMaster

(
master: Master
fillStyle?: VsdxStyleSheet
lineStyle?: VsdxStyleSheet
textStyle?: VsdxStyleSheet
): Shape

Creates a new Shape with the same type as the first shape of the given master.

Parameters

master: Master
fillStyle?: VsdxStyleSheet
lineStyle?: VsdxStyleSheet
textStyle?: VsdxStyleSheet

Return Value

createShapeWithMaster

(
master: Master
fillStyle?: VsdxStyleSheet
lineStyle?: VsdxStyleSheet
textStyle?: VsdxStyleSheet
): Shape

Creates a new Shape with the same type as the first shape of the given master.

Parameters

master: Master

The master. Must have exactly one toplevel shape. The type of the created shape will be the same as this shape.

fillStyle?: VsdxStyleSheet

The fillStyle to apply to this shape.

lineStyle?: VsdxStyleSheet

The lineStyle to apply to this shape.

textStyle?: VsdxStyleSheet

The textStyle to apply to this shape.

Return Value

get

(i: number): Shape

Returns the item at the given index.

Parameters

Return Value

getEnumerator

(): IEnumerator<Shape>

Return Value

sort

(comparator?: any)

Parameters

comparator?: any