A collection of [[WorksheetShape]] instances in a [[Worksheet]] or [[WorksheetShapeGroup]]. @see@see

Constructors

Section titled "Constructors"

WorksheetShapeCollection

new WorksheetShapeCollection(a: IWorksheetShapeOwner): WorksheetShapeCollection

Returns WorksheetShapeCollection

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

count

Section titled "count"

Gets the number of shapes in the collection. The number of shapes in the collection.

get count(): number

Returns number

Methods

Section titled "Methods"

add

Section titled "add"

Adds a predefined shape to the collection with the specified bounds.

add(shapeType: PredefinedShapeType, sheet: Sheet, boundsInTwips: IgRect): WorksheetShape

Parameters

  • shapeType: PredefinedShapeType

    The type of shape to add to the collection.
  • sheet: Sheet

    The [[sheet]] to which the 'boundsInTwips' relate.
  • boundsInTwips: IgRect

    The bounds of the shape on the 'sheet' in twips (1/20th of a point).

Returns WorksheetShape

addChart

Section titled "addChart"

Adds a chart to the collection with the specified bounds.

addChart(chartType: ChartType, sheet: Sheet, boundsInTwips: IgRect, chartInitializer: object): WorksheetChart

Parameters

  • chartType: ChartType

    The type of chart to add to the collection.
  • sheet: Sheet

    The [[sheet]] to which the 'boundsInTwips' relate.
  • boundsInTwips: IgRect

    The bounds of the shape on the 'sheet' in twips (1/20th of a point).
  • chartInitializer: object

    An optional callback for initializing the chart before it is added to the collection.

Returns WorksheetChart

clear

Section titled "clear"

Clears all shapes from the collection.

clear(): void

Returns void

contains

Section titled "contains"

Determines whether a shape is in the collection.

contains(shape: WorksheetShape): boolean

Parameters

Returns boolean

item

Section titled "item"

Gets the shape at the specified index in the collection. The shape at the specified index.

item(a: number): WorksheetShape

Parameters

  • a: number

Returns WorksheetShape

remove_1

Section titled "remove_1"

Removes the specified shape from the collection.

remove_1(shape: WorksheetShape): boolean

Parameters

Returns boolean

removeAt

Section titled "removeAt"

Removes the shape at the specified index from the collection.

removeAt(index: number): void

Parameters

  • index: number

    The index of the shape to remove from the collection.

Returns void

staticInit

Section titled "staticInit" 
staticInit(): void

Returns void