Represents a group of shapes in a worksheet. This group is also a shape which can be positioned and contained within another group or on a worksheet.

Constructors

Section titled "Constructors"

WorksheetChart 

new WorksheetChart(a: number): WorksheetChart

Returns WorksheetChart

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

autoScaling

Section titled "autoScaling"

True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart. The [[rightAngleAxes]] property must be True

 
get autoScaling(): boolean

Returns boolean 

set autoScaling(a: boolean): void

Parameters

  • a: boolean

Returns void

backWall

Section titled "backWall"

Returns a [[Wall]] object that allows the user to format the back wall of a 3-D chart. Read-only.

 
get backWall(): Wall

Returns Wall

barShape

Section titled "barShape"

Returns or sets the shape of [[Series]] bars. Applicable only to 3D bar-type charts.

 
get barShape(): BarShape | null

Returns BarShape | null 

set barShape(a: BarShape | null): void

Parameters

Returns void

barShapeResolved

Section titled "barShapeResolved"

Returns the resolved value of the [[barShape]] property.

 
get barShapeResolved(): BarShape

Returns BarShape

bottomRightCornerCell

Section titled "bottomRightCornerCell"

Inherited from: WorksheetShapeGroupBase

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"

Inherited from: WorksheetShapeGroupBase

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

chartArea

Section titled "chartArea"

Returns a [[chartArea]] object that represents the complete chart area for the chart. Read-only.

 
get chartArea(): ChartArea

Returns ChartArea

chartTitle

Section titled "chartTitle"

Returns or sets an [[chartTitle]] object.

 
get chartTitle(): ChartTitle

Returns ChartTitle 

set chartTitle(a: ChartTitle): void

Parameters

Returns void

chartType

Section titled "chartType"

Specifies the chart type.

 
get chartType(): ChartType

Returns ChartType 

set chartType(a: ChartType): void

Parameters

Returns void

depthPercent

Section titled "depthPercent"

Returns or sets the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).

 
get depthPercent(): number

Returns number 

set depthPercent(a: number): void

Parameters

  • a: number

Returns void

displayBlanksAs

Section titled "displayBlanksAs"

Returns or sets the way that blank cells are plotted on a chart.

 
get displayBlanksAs(): DisplayBlanksAs

Returns DisplayBlanksAs 

set displayBlanksAs(a: DisplayBlanksAs): void

Parameters

Returns void

doughnutHoleSize

Section titled "doughnutHoleSize"

Returns or sets the size of the hole in a doughnut chart, expressed as a percentage of the size of the encompassing circle.

 
get doughnutHoleSize(): number

Returns number 

set doughnutHoleSize(a: number): void

Parameters

  • a: number

Returns void

dropLines

Section titled "dropLines"

Returns or sets a [[ChartDropLines]] instance which determines the appearance for a stock chart's drop lines.

 
get dropLines(): ChartDropLines

Returns ChartDropLines 

set dropLines(a: ChartDropLines): void

Parameters

Returns void

fill

Section titled "fill"

Inherited from: WorksheetShapeGroupBase

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

firstSliceAngle

Section titled "firstSliceAngle"

Returns or sets the angle which determines the origin of the first slice, as relative to the 12 o'clock position of the emcompassing circle.

 
get firstSliceAngle(): number

Returns number 

set firstSliceAngle(a: number): void

Parameters

  • a: number

Returns void

flippedHorizontally

Section titled "flippedHorizontally"

Inherited from: WorksheetShapeGroupBase

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"

Inherited from: WorksheetShapeGroupBase

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

floor

Section titled "floor"

Returns a [[Wall]] object that allows the user to format the bottom wall of a 3-D chart. Read-only.

 
get floor(): Wall

Returns Wall

gapDepth

Section titled "gapDepth"

Returns or sets the gap depth in a 3-D chart, expressed as a percentage of the marker width. The value of this property must be between 0 and 500.

 
get gapDepth(): number

Returns number 

set gapDepth(a: number): void

Parameters

  • a: number

Returns void

gapWidth

Section titled "gapWidth"

Returns or sets the distance between the data series in a bar chart, as a percentage of the marker width. The value of this property must be between 0 and 500.

 
get gapWidth(): number

Returns number 

set gapWidth(a: number): void

Parameters

  • a: number

Returns void

heightPercent

Section titled "heightPercent"

Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent).

 
get heightPercent(): number

Returns number 

set heightPercent(a: number): void

Parameters

  • a: number

Returns void

highLowLines

Section titled "highLowLines"

Returns or sets a [[ChartHighLowLines]] instance which determines the appearance for a stock chart's high/low lines.

 
get highLowLines(): ChartHighLowLines

Returns ChartHighLowLines 

set highLowLines(a: ChartHighLowLines): void

Parameters

Returns void

legend

Section titled "legend"

Returns or sets a [[legend]] object which represents the legend for the chart.

 
get legend(): Legend

Returns Legend 

set legend(a: Legend): void

Parameters

Returns void

outline

Section titled "outline"

Inherited from: WorksheetShapeGroupBase

Gets or sets the outline to use for the shape.

 
get outline(): ShapeOutline

Returns ShapeOutline 

set outline(a: ShapeOutline): void

Parameters

Returns void

perspective

Section titled "perspective"

Returns or sets a value that represents the perspective for the 3-D chart view, expressed in degrees.

 
get perspective(): number

Returns number 

set perspective(a: number): void

Parameters

  • a: number

Returns void

plotArea

Section titled "plotArea"

Returns a PlotArea object that represents the plot area of a chart. Read-only.

 
get plotArea(): PlotArea

Returns PlotArea

plotVisibleOnly

Section titled "plotVisibleOnly"

True if only visible cells are plotted. False if both visible and hidden cells are plotted.

 
get plotVisibleOnly(): boolean

Returns boolean 

set plotVisibleOnly(a: boolean): void

Parameters

  • a: boolean

Returns void

positioningMode

Section titled "positioningMode"

Inherited from: WorksheetShapeGroupBase

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

rightAngleAxes

Section titled "rightAngleAxes"

True if the chart axes are at right angles, independent of chart rotation or elevation. Applies only to 3-D line, column, and bar charts.

 
get rightAngleAxes(): boolean

Returns boolean 

set rightAngleAxes(a: boolean): void

Parameters

  • a: boolean

Returns void

rotationX

Section titled "rotationX"

Returns or sets the rotation of a 3-D chart view around the X-axis, expressed in degrees.

 
get rotationX(): number

Returns number 

set rotationX(a: number): void

Parameters

  • a: number

Returns void

rotationY

Section titled "rotationY"

Returns or sets the rotation of a 3-D chart view around the Y-axis, expressed in degrees.

 
get rotationY(): number

Returns number 

set rotationY(a: number): void

Parameters

  • a: number

Returns void

secondPlotSize

Section titled "secondPlotSize"

Returns or sets the size of the second plot area in a 'bar of pie' or 'pie of pie' chart, expressed as a percentage of the first plot area's size.

 
get secondPlotSize(): number

Returns number 

set secondPlotSize(a: number): void

Parameters

  • a: number

Returns void

seriesLines

Section titled "seriesLines"

Determines the fill and width for the lines which connect the first and second plot areas in a 'bar of pie' or 'pie of pie' chart.

 
get seriesLines(): ChartSeriesLines

Returns ChartSeriesLines 

set seriesLines(a: ChartSeriesLines): void

Parameters

Returns void

seriesOverlap

Section titled "seriesOverlap"

Determines the amount by which intersecting [[Series]] overlap, expressed as a percentage of the bar size.

 
get seriesOverlap(): number

Returns number 

set seriesOverlap(a: number): void

Parameters

  • a: number

Returns void

sheet

Section titled "sheet"

Inherited from: WorksheetShapeGroupBase

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

 
get sheet(): Sheet

Returns Sheet

sideWall

Section titled "sideWall"

Returns a [[Wall]] object that allows the user to format the side wall of a 3-D chart. Read-only.

 
get sideWall(): Wall

Returns Wall

topLeftCornerCell

Section titled "topLeftCornerCell"

Inherited from: WorksheetShapeGroupBase

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"

Inherited from: WorksheetShapeGroupBase

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

upDownBars

Section titled "upDownBars"

Returns or sets a [[UpDownBars]] instance which determines the appearance for a stock chart's up/down bars.

 
get upDownBars(): UpDownBars

Returns UpDownBars 

set upDownBars(a: UpDownBars): void

Parameters

Returns void

varyColors

Section titled "varyColors"

Returns or sets a boolean value indicating whether the fill colors for series and data points are automatically selected by Excel.

 
get varyColors(): boolean

Returns boolean 

set varyColors(a: boolean): void

Parameters

  • a: boolean

Returns void

visible

Section titled "visible"

Inherited from: WorksheetShapeGroupBase

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

wallDefault

Section titled "wallDefault"

Returns a [[Wall]] object which represents the back and side walls, and floor of the chart. Applicable only for 3-D charts.

 
get wallDefault(): Wall

Returns Wall

worksheet

Section titled "worksheet"

Inherited from: WorksheetShapeGroupBase

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

 
get worksheet(): Worksheet

Returns Worksheet

Methods

Section titled "Methods"

axisCollection

Section titled "axisCollection"

Indexer

 
axisCollection(type: AxisType, group: AxisGroup): Axis

Parameters

  • type: AxisType

    The type of the axis.
  • group: AxisGroup

    The axis group, defaults to primary.

Returns Axis

clearUnknownData

Section titled "clearUnknownData"

Inherited from: WorksheetShapeGroupBase

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

 
clearUnknownData(): void

Returns void

comboChartGroups

Section titled "comboChartGroups"

Returns the [[ComboChartGroup]] instance associated with the specified 'chartType' and 'axisGroup', or null if no such instance exists.

 
comboChartGroups(chartType: ChartType, axisGroup: AxisGroup): ComboChartGroup

Parameters

  • chartType: ChartType

    A [[ChartType]] constant which identifies the combo chart group.
  • axisGroup: AxisGroup

    An [[AxisGroup]] constant which identifies the combo chart group.

Returns ComboChartGroup

getBoundsInTwips

Section titled "getBoundsInTwips"

Inherited from: WorksheetShapeGroupBase

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

 
getBoundsInTwips(): IgRect

Returns IgRect

seriesCollection

Section titled "seriesCollection"

Indexer

 
seriesCollection(index: number): Series

Parameters

  • index: number

    A zero based index

Returns Series

setBoundsInTwips

Section titled "setBoundsInTwips"

Inherited from: WorksheetShapeGroupBase

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

setComboChartSourceData

Section titled "setComboChartSourceData"

Sets the source data range for a combo chart.

 
setComboChartSourceData(dataRange: string, seriesChartTypes: ChartType[], plotByRows: boolean, cellReferenceMode: CellReferenceMode): void

Parameters

  • dataRange: string

    The data range for the combo chart
  • seriesChartTypes: ChartType[]

    An array of [[chartType]] constants which specify the chart type for each series yielded from the specified 'dataRange'.
  • plotByRows: boolean

    Optional. True to plot by rows where each row is a separate series or false to plot by columns where each column is a separate series. The default is false.
  • cellReferenceMode: CellReferenceMode

    Optional. Determines how to parse the dataRange.

Returns void

setSourceData

Section titled "setSourceData"

Sets the source data range for the chart.

 
setSourceData(dataRange: string, plotByRows: boolean, cellReferenceMode: CellReferenceMode): void

Parameters

  • dataRange: string

    The data range for the chart
  • plotByRows: boolean

    Optional. True to plot by rows where each row is a separate series or false to plot by columns where each column is a separate series. The default is false.
  • cellReferenceMode: CellReferenceMode

    Optional. Determines how to parse the dataRange.

Returns void

shapes

Section titled "shapes"

Inherited from: WorksheetShapeGroupBase

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

 
shapes(index: number): WorksheetShape

Parameters

  • index: number

    The zero-based index of the shape to get.

Returns WorksheetShape

createPredefinedShape

Section titled "createPredefinedShape"

Inherited from: WorksheetShapeGroupBase

Creates a shape which is predefined in Microsoft Excel.

 
createPredefinedShape(shapeType: PredefinedShapeType): WorksheetShape

Parameters

Returns WorksheetShape

staticInit

Section titled "staticInit" 
staticInit(): void

Returns void