WorksheetChart

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

new WorksheetChart(a: number): WorksheetChart

Returns WorksheetChart

Properties

$t

$t: Type

autoScaling

autoScaling: boolean

barShape

barShape: BarShape

bottomRightCornerCell

Inherited from: WorksheetShapeGroupBase

bottomRightCornerCell: WorksheetCell

bottomRightCornerPosition

Inherited from: WorksheetShapeGroupBase

bottomRightCornerPosition: IgPoint

chartTitle

chartTitle: ChartTitle

chartType

chartType: ChartType

depthPercent

depthPercent: number

displayBlanksAs

displayBlanksAs: DisplayBlanksAs

doughnutHoleSize

doughnutHoleSize: number

dropLines

dropLines: ChartDropLines

fill

Inherited from: WorksheetShapeGroupBase

fill: ShapeFill

firstSliceAngle

firstSliceAngle: number

flippedHorizontally

Inherited from: WorksheetShapeGroupBase

flippedHorizontally: boolean

flippedVertically

Inherited from: WorksheetShapeGroupBase

flippedVertically: boolean

gapDepth

gapDepth: number

gapWidth

gapWidth: number

heightPercent

heightPercent: number

highLowLines

highLowLines: ChartHighLowLines

legend

legend: Legend

outline

Inherited from: WorksheetShapeGroupBase

outline: ShapeOutline

perspective

perspective: number

plotVisibleOnly

plotVisibleOnly: boolean

positioningMode

Inherited from: WorksheetShapeGroupBase

positioningMode: ShapePositioningMode

rightAngleAxes

rightAngleAxes: boolean

rotationX

rotationX: number

rotationY

rotationY: number

secondPlotSize

secondPlotSize: number

seriesLines

seriesLines: ChartSeriesLines

seriesOverlap

seriesOverlap: number

topLeftCornerCell

Inherited from: WorksheetShapeGroupBase

topLeftCornerCell: WorksheetCell

topLeftCornerPosition

Inherited from: WorksheetShapeGroupBase

topLeftCornerPosition: IgPoint

upDownBars

upDownBars: UpDownBars

varyColors

varyColors: boolean

visible

Inherited from: WorksheetShapeGroupBase

visible: boolean

Accessors

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

barShapeResolved

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

get barShapeResolved(): BarShape

Returns BarShape

chartArea

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

get chartArea(): ChartArea

Returns ChartArea

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

plotArea

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

get plotArea(): PlotArea

Returns PlotArea

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

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

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

Inherited from: WorksheetShapeGroupBase

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

get worksheet(): Worksheet

Returns Worksheet

Methods

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

Inherited from: WorksheetShapeGroupBase

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

clearUnknownData(): void

Returns void

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

Inherited from: WorksheetShapeGroupBase

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

getBoundsInTwips(): IgRect

Returns IgRect

seriesCollection

Indexer

seriesCollection(index: number): Series

Parameters

index: number
A zero based index

Returns Series

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

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

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

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

Inherited from: WorksheetShapeGroupBase

Creates a shape which is predefined in Microsoft Excel.

createPredefinedShape(shapeType: PredefinedShapeType): WorksheetShape

Parameters

shapeType: PredefinedShapeType
The type of shape to create.

Returns WorksheetShape

staticInit

staticInit(): void