Abstract base class for all shapes (atomic or compound) in a worksheet.

Constructors

Section titled "Constructors"

WorksheetShape 

new WorksheetShape(a: number): WorksheetShape

Returns WorksheetShape

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

bottomRightCornerCell

Section titled "bottomRightCornerCell"

Gets or sets the cell where the bottom-right corner of the shape resides.

 
get bottomRightCornerCell(): WorksheetCell

Returns WorksheetCell 

set bottomRightCornerCell(a: WorksheetCell): void

Parameters

Returns void

bottomRightCornerPosition

Section titled "bottomRightCornerPosition"

Gets or sets the position in the [[bottomRightCornerCell]] of the shape's bottom-right corner, expressed in percentages.

 
get bottomRightCornerPosition(): IgPoint

Returns IgPoint 

set bottomRightCornerPosition(a: IgPoint): void

Parameters

  • a: IgPoint

Returns void

fill

Section titled "fill"

Gets or sets the fill to use in the background of the shape.

 
get fill(): ShapeFill

Returns ShapeFill 

set fill(a: ShapeFill): void

Parameters

Returns void

flippedHorizontally

Section titled "flippedHorizontally"

Gets or sets the value which indicates whether the shape is flipped horizontally along the vertical center line.

 
get flippedHorizontally(): boolean

Returns boolean 

set flippedHorizontally(a: boolean): void

Parameters

  • a: boolean

Returns void

flippedVertically

Section titled "flippedVertically"

Gets or sets the value which indicates whether the shape is flipped vertically along the horizontal center line.

 
get flippedVertically(): boolean

Returns boolean 

set flippedVertically(a: boolean): void

Parameters

  • a: boolean

Returns void

outline

Section titled "outline"

Gets or sets the outline to use for the shape.

 
get outline(): ShapeOutline

Returns ShapeOutline 

set outline(a: ShapeOutline): void

Parameters

Returns void

positioningMode

Section titled "positioningMode"

Gets or sets the way shapes will be repositioned in excel when cells before or within the shape are resized.

 
get positioningMode(): ShapePositioningMode

Returns ShapePositioningMode 

set positioningMode(a: ShapePositioningMode): void

Parameters

Returns void

sheet

Section titled "sheet"

Gets the worksheet on which the shape resides. The worksheet on which the shape resides.

 
get sheet(): Sheet

Returns Sheet

topLeftCornerCell

Section titled "topLeftCornerCell"

Gets or sets the cell where the top-left corner of the shape resides.

 
get topLeftCornerCell(): WorksheetCell

Returns WorksheetCell 

set topLeftCornerCell(a: WorksheetCell): void

Parameters

Returns void

topLeftCornerPosition

Section titled "topLeftCornerPosition"

Gets or sets the position in the [[topLeftCornerCell]] of the shape's top-left corner, expressed in percentages.

 
get topLeftCornerPosition(): IgPoint

Returns IgPoint 

set topLeftCornerPosition(a: IgPoint): void

Parameters

  • a: IgPoint

Returns void

visible

Section titled "visible"

Gets or sets the value indicating whether the shape is visible on the worksheet. The value indicating whether the shape is visible on the worksheet.

 
get visible(): boolean

Returns boolean 

set visible(a: boolean): void

Parameters

  • a: boolean

Returns void

worksheet

Section titled "worksheet"

Gets the worksheet on which the shape resides. The worksheet on which the shape resides.

 
get worksheet(): Worksheet

Returns Worksheet

Methods

Section titled "Methods"

clearUnknownData

Section titled "clearUnknownData"

Clears the cached unknown shape data which was read in from a parsed excel file.

 
clearUnknownData(): void

Returns void

getBoundsInTwips

Section titled "getBoundsInTwips"

Gets the bounds of the shape in twips (1/20th of a point).

 
getBoundsInTwips(): IgRect

Returns IgRect

setBoundsInTwips

Section titled "setBoundsInTwips"

Sets the bounds of the shape in twips (1/20th of a point).

 
setBoundsInTwips(sheet: Sheet, bounds: IgRect): void

Parameters

  • sheet: Sheet

    The worksheet on which the shape should be placed.
  • bounds: IgRect

    The new bounds where the shape should be placed.

Returns void

createPredefinedShape

Section titled "createPredefinedShape"

Creates a shape which is predefined in Microsoft Excel.

 
createPredefinedShape(shapeType: PredefinedShapeType): WorksheetShape

Parameters

Returns WorksheetShape

staticInit

Section titled "staticInit" 
staticInit(): void

Returns void