ig.excel.WorksheetChart

Represents a chart shape. This class does not allow for the editing of chart data. It is used for round-tripping chart data between loading and saving a workbook.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • autoScaling

    .autoScaling( );

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

  • autoScaling

    .autoScaling( value:boolean );

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

    • value
    • Type:boolean
  • axisCollection

    .axisCollection( );
    Return Type:
    ig.excel.AxisCollection
    Return Type Description:
    Returns a AxisCollection.

    Returns the axis collection (read-only)

  • axisCollection

    .axisCollection( type:ig.excel.AxisType, [group:ig.excel.AxisGroup] );
    Return Type:
    ig.excel.Axis
    Return Type Description:
    The corresponding axis or null if not in the collection.

    Indexer

    • type
    • Type:ig.excel.AxisType
    • The type of the axis.
    • group
    • Type:ig.excel.AxisGroup
    • Optional
    • The axis group, defaults to primary.
  • backWall

    .backWall( );
    Return Type:
    ig.excel.Wall
    Return Type Description:
    Returns a Wall.

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

  • barShape

    .barShape( );

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

    Remarks

    This property is applicable only to the following chart types:

    • Bar3DStacked
    • Column3DStacked
    • ConeBarStacked
    • ConeColStacked
    • PyramidBarStacked
    • PyramidColStacked
    • CylinderBarStacked
    • CylinderColStacked
    • Bar3DStacked100
    • Column3DStacked100
    • ConeBarStacked100
    • ConeColStacked100
    • PyramidBarStacked100
    • PyramidColStacked100
    • CylinderBarStacked100
    • CylinderColStacked100
    • Column3D
    • PyramidCol
    • ConeCol
    • CylinderCol

    Use this property to set the bar shape for all series bars.

    To set the shape for a particular series bar, use the Series.barShape property.

  • barShape

    .barShape( value:ig.excel.BarShape );

    Sets the shape of Series bars. Applicable only to 3D bar-type charts.

    • value
    • Type:ig.excel.BarShape

    Remarks

    This property is applicable only to the following chart types:

    • Bar3DStacked
    • Column3DStacked
    • ConeBarStacked
    • ConeColStacked
    • PyramidBarStacked
    • PyramidColStacked
    • CylinderBarStacked
    • CylinderColStacked
    • Bar3DStacked100
    • Column3DStacked100
    • ConeBarStacked100
    • ConeColStacked100
    • PyramidBarStacked100
    • PyramidColStacked100
    • CylinderBarStacked100
    • CylinderColStacked100
    • Column3D
    • PyramidCol
    • ConeCol
    • CylinderCol

    Use this property to set the bar shape for all series bars.

    To set the shape for a particular series bar, use the Series.barShape property.

  • barShapeResolved

    .barShapeResolved( );
    Return Type:
    ig.excel.BarShape
    Return Type Description:
    Returns a BarShape.

    Returns the resolved value of the WorksheetChart.barShape property.

  • bottomRightCornerCell
    Inherited

    .bottomRightCornerCell( );
    Return Type:
    ig.excel.WorksheetCell
    Return Type Description:
    The cell where the bottom-right corner of the shape resides.

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

    Exceptions

    Exception Description
    ig.ArgumentException The value assigned is a cell whose worksheet is not the same as this shape's worksheet.
    ig.ArgumentNullException The value assigned is null and this shape already exists on a worksheet or group.

    Remarks

    This anchor cell, along with the WorksheetShape.topLeftCornerCell, determines where the shape will be positioned on the worksheet. In addition, the WorksheetShape.bottomRightCornerPosition and WorksheetShape.topLeftCornerPosition properties allow for finer control of the shape's position.

  • bottomRightCornerCell
    Inherited

    .bottomRightCornerCell( value:ig.excel.WorksheetCell );
    Return Type:
    ig.excel.WorksheetCell
    Return Type Description:
    The cell where the bottom-right corner of the shape resides.

    Sets the cell where the bottom-right corner of the shape resides.

    • value
    • Type:ig.excel.WorksheetCell

    Exceptions

    Exception Description
    ig.ArgumentException The value assigned is a cell whose worksheet is not the same as this shape's worksheet.
    ig.ArgumentNullException The value assigned is null and this shape already exists on a worksheet or group.

    Remarks

    This anchor cell, along with the WorksheetShape.topLeftCornerCell, determines where the shape will be positioned on the worksheet. In addition, the WorksheetShape.bottomRightCornerPosition and WorksheetShape.topLeftCornerPosition properties allow for finer control of the shape's position.

  • bottomRightCornerPosition
    Inherited

    .bottomRightCornerPosition( );
    Return Type:
    object
    Return Type Description:
    The position in the bottom-right corner cell of the shape's bottom-right corner. This will be an object with numeric values for properties 'x' and 'y'.

    Gets the position in the WorksheetShape.bottomRightCornerCell of the shape's bottom-right corner, expressed in percentages.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException Either coordinate of the value assigned is outside the range of 0.0 to 100.0.

    Remarks

    These percentages are expressed as distance across the associated dimension of the cell, starting at the top-left corner of the cell. For example, (0.0, 0.0) represents the top-left corner of the cell, whereas (100.0, 100.0) represents the bottom-right corner of the cell. (50.0, 10.0) would represent the location in the cell which is centered horizontally, and a tenth of the way down from the top.

  • bottomRightCornerPosition
    Inherited

    .bottomRightCornerPosition( value:object );
    Return Type:
    object
    Return Type Description:
    The position in the bottom-right corner cell of the shape's bottom-right corner. This will be an object with numeric values for properties 'x' and 'y'.

    Sets the position in the WorksheetShape.bottomRightCornerCell of the shape's bottom-right corner, expressed in percentages.

    • value
    • Type:object
    • This can be an object with numeric values for properties 'x' and 'y', such as { x: 1, y: 2 }.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException Either coordinate of the value assigned is outside the range of 0.0 to 100.0.

    Remarks

    These percentages are expressed as distance across the associated dimension of the cell, starting at the top-left corner of the cell. For example, (0.0, 0.0) represents the top-left corner of the cell, whereas (100.0, 100.0) represents the bottom-right corner of the cell. (50.0, 10.0) would represent the location in the cell which is centered horizontally, and a tenth of the way down from the top.

  • chartArea

    .chartArea( );
    Return Type:
    ig.excel.ChartArea
    Return Type Description:
    Returns a ChartArea.

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

  • chartTitle

    .chartTitle( );
    Return Type:
    ig.excel.ChartTitle
    Return Type Description:
    Returns a ChartTitle.

    Returns an WorksheetChart.chartTitle object.

  • chartTitle

    .chartTitle( value:ig.excel.ChartTitle );
    Return Type:
    ig.excel.ChartTitle
    Return Type Description:
    Returns a ChartTitle.

    Sets an WorksheetChart.chartTitle object.

    • value
    • Type:ig.excel.ChartTitle
  • chartType

    .chartType( );
    Return Type:
    ig.excel.ChartType
    Return Type Description:
    Returns a ChartType.

    Specifies the chart type.

    Remarks

    All chart types are supported by the WorksheetChart type; no derived classes exist or are necessary to support different chart types.

    Note that changing the chart type may cause related property values to be changed.

    For example, when transitioning from a chart type which supports line markers, The Series.markerStyle property is changed to reflect the new chart style.

    Using another example, when transitioning from a chart type which does not support axes, such as a pie or doughnut chart, to a chart type that does support them, the WorksheetChart.axisCollection is modified accordingly.

  • chartType

    .chartType( value:ig.excel.ChartType );
    Return Type:
    ig.excel.ChartType
    Return Type Description:
    Returns a ChartType.

    Specifies the chart type.

    • value
    • Type:ig.excel.ChartType

    Remarks

    All chart types are supported by the WorksheetChart type; no derived classes exist or are necessary to support different chart types.

    Note that changing the chart type may cause related property values to be changed.

    For example, when transitioning from a chart type which supports line markers, The Series.markerStyle property is changed to reflect the new chart style.

    Using another example, when transitioning from a chart type which does not support axes, such as a pie or doughnut chart, to a chart type that does support them, the WorksheetChart.axisCollection is modified accordingly.

  • clearUnknownData
    Inherited

    .clearUnknownData( );

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

    Exceptions

    Exception Description
    ig.InvalidOperationException This method is called on an UnknownShape instance.

    Remarks

    This method will only be needed until all shape information is supported and customizable. After all shape data can be controlled, this method will become obsolete. Currently, all unsupported data will be stored with the shape for round-tripping purposes. For example, if an Excel file with complex and unsupported shapes is loaded into a Workbook instance, some cell values are changed, and it is saved to the same file, the complex shapes will still exist in the workbook. However, if a loaded shape needs to be modified before it is saved back, this method allows for that unsupported data to be removed while all supported data is maintained.

    Note: This method only clears unsupported data. In future versions of the product, as more shape data is supported, this method will have different effects on the shape, until eventually all data is supported and this method will have no effect on the shape.

  • comboChartGroups

    .comboChartGroups( );
    Return Type:
    ig.excel.ComboChartGroupCollection
    Return Type Description:
    Returns a ComboChartGroupCollection.

    Returns a collection of the ComboChartGroup instances associated with this chart.

    Remarks

    The properties of the WorksheetChart class which apply only to a specific chart type are not applicable for combo charts. For example, the WorksheetChart.gapWidth property, which applies to bar charts, is not used for bar charts which appear within a combo chart. The reason for this is that combo charts support multiple occurrences of the same chart type, making the WorksheetChart-level properties ambiguous in the context of a combo chart.

    This class makes it possible to set chart-specific properties for one or more occurrences of a particular chart type, for a particular axis group.

    For example, consider a combo chart with two ClusteredColumn series, one on the primary axis and another on the secondary. To set the WorksheetChart.gapWidth property for the chart on the primary axis, add an item to this collection with a WorksheetChart.chartType of ClusteredColumn, and an AxisGroup of Primary. On the ComboChartGroup instance returned from the collection's Add method, set the GapWidth property to the desired value.

    When the chart is serialized, this collection is checked against each series in the combo chart. If the ChartType and the AxisGroup match the respective properties on a ComboChartGroup instance, the value of that instance's GapWidth property is applied to the chart element for that series. Because the other clustered column series exists on the secondary axis, the property is not applied to that series, since while it has the same ChartType, its AxisGroup is different.

  • comboChartGroups

    .comboChartGroups( chartType:ig.excel.ChartType, axisGroup:ig.excel.AxisGroup );
    Return Type:
    ig.excel.ComboChartGroup
    Return Type Description:
    A new or existing ComboChartGroup instance.

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

    • chartType
    • Type:ig.excel.ChartType
    • A ChartType constant which identifies the combo chart group.
    • axisGroup
    • Type:ig.excel.AxisGroup
    • An AxisGroup constant which identifies the combo chart group.
  • createPredefinedShape
    Inherited

    .createPredefinedShape( shapeType:ig.excel.PredefinedShapeType );
    Return Type:
    ig.excel.WorksheetShape
    Return Type Description:
    A WorksheetShape-derived instance representing the predefined shape.

    Creates a shape which is predefined in Microsoft Excel.

    • shapeType
    • Type:ig.excel.PredefinedShapeType
    • The type of shape to create.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException shapeType is not defined in the PredefinedShapeType enumeration.
  • depthPercent

    .depthPercent( );

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

  • depthPercent

    .depthPercent( value:number );

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

    • value
    • Type:number
  • displayBlanksAs

    .displayBlanksAs( );
    Return Type:
    ig.excel.DisplayBlanksAs
    Return Type Description:
    Returns a DisplayBlanksAs.

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

  • displayBlanksAs

    .displayBlanksAs( value:ig.excel.DisplayBlanksAs );
    Return Type:
    ig.excel.DisplayBlanksAs
    Return Type Description:
    Returns a DisplayBlanksAs.

    Sets the way that blank cells are plotted on a chart.

    • value
    • Type:ig.excel.DisplayBlanksAs
  • doughnutHoleSize

    .doughnutHoleSize( );

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

    Remarks

    This property is only applicable to doughnut charts.

    The valid range for this property is 0 through 90, inclusive.

  • doughnutHoleSize

    .doughnutHoleSize( value:number );

    Sets the size of the hole in a doughnut chart, expressed as a percentage of the size of the encompassing circle.

    • value
    • Type:number

    Remarks

    This property is only applicable to doughnut charts.

    The valid range for this property is 0 through 90, inclusive.

  • dropLines

    .dropLines( );
    Return Type:
    ig.excel.ChartDropLines
    Return Type Description:
    Returns a ChartDropLines.

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

    Remarks

    This property is only applicable for stock charts.

    High/low lines are not displayed by default; to enable them, assign a ChartDropLinesto this property. to null.

  • dropLines

    .dropLines( value:ig.excel.ChartDropLines );
    Return Type:
    ig.excel.ChartDropLines
    Return Type Description:
    Returns a ChartDropLines.

    Sets a ChartDropLines instance which determines the appearance for a stock chart's drop lines.

    • value
    • Type:ig.excel.ChartDropLines

    Remarks

    This property is only applicable for stock charts.

    High/low lines are not displayed by default; to enable them, assign a ChartDropLinesto this property. to null.

  • fill
    Inherited

    .fill( );
    Return Type:
    ig.excel.ShapeFill
    Return Type Description:
    A ShapeFill-derived instance describing the fill of the shape, or null for no fill.

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

    Remarks

    Note: some shapes, such as connectors or groups, cannot have a fill set. For these shapes, the value on this property will be ignored and lost when the workbook is saved.

  • fill
    Inherited

    .fill( value:ig.excel.ShapeFill );
    Return Type:
    ig.excel.ShapeFill
    Return Type Description:
    A ShapeFill-derived instance describing the fill of the shape, or null for no fill.

    Sets the fill to use in the background of the shape.

    • value
    • Type:ig.excel.ShapeFill

    Remarks

    Note: some shapes, such as connectors or groups, cannot have a fill set. For these shapes, the value on this property will be ignored and lost when the workbook is saved.

  • firstSliceAngle

    .firstSliceAngle( );

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

    Remarks

    This property is only applicable to pie and doughnut charts.

    The valid range for this property is 0 through 360, inclusive. Fractional angles are not supported; nor are negative angles.

    By default, the first slice begins at the "12 o'clock" position of the pie chart, i.e., the top center point of the encompassing circle.

    Use this property to offset the origin of the first slice; for example, a value of 30 positions the first slice at the 1 o'clock position, 60 at the 2 o'clock position, 90 for 3 o'clock, etc.

    Larger values move along the circumference of the emcompassing circle in a clockwise direction, with a value of 0 or 360 both coinciding with the 12 o'clock position.

  • firstSliceAngle

    .firstSliceAngle( value:number );

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

    • value
    • Type:number

    Remarks

    This property is only applicable to pie and doughnut charts.

    The valid range for this property is 0 through 360, inclusive. Fractional angles are not supported; nor are negative angles.

    By default, the first slice begins at the "12 o'clock" position of the pie chart, i.e., the top center point of the encompassing circle.

    Use this property to offset the origin of the first slice; for example, a value of 30 positions the first slice at the 1 o'clock position, 60 at the 2 o'clock position, 90 for 3 o'clock, etc.

    Larger values move along the circumference of the emcompassing circle in a clockwise direction, with a value of 0 or 360 both coinciding with the 12 o'clock position.

  • flippedHorizontally
    Inherited

    .flippedHorizontally( );

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

    Exceptions

    Exception Description
    ig.InvalidOperationException The value is set to True and this shape doesn't allow flipping or rotating, such as a WorksheetChart.
  • flippedHorizontally
    Inherited

    .flippedHorizontally( value:boolean );

    Sets the value which indicates whether the shape is flipped horizontally along the vertical center line.

    • value
    • Type:boolean

    Exceptions

    Exception Description
    ig.InvalidOperationException The value is set to True and this shape doesn't allow flipping or rotating, such as a WorksheetChart.
  • flippedVertically
    Inherited

    .flippedVertically( );

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

    Exceptions

    Exception Description
    ig.InvalidOperationException The value is set to True and this shape doesn't allow flipping or rotating, such as a WorksheetChart.
  • flippedVertically
    Inherited

    .flippedVertically( value:boolean );

    Sets the value which indicates whether the shape is flipped vertically along the horizontal center line.

    • value
    • Type:boolean

    Exceptions

    Exception Description
    ig.InvalidOperationException The value is set to True and this shape doesn't allow flipping or rotating, such as a WorksheetChart.
  • floor

    .floor( );
    Return Type:
    ig.excel.Wall
    Return Type Description:
    Returns a Wall.

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

  • gapDepth

    .gapDepth( );

    Returns 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.

  • gapDepth

    .gapDepth( value:number );

    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.

    • value
    • Type:number
  • gapWidth

    .gapWidth( );

    Returns 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.

  • gapWidth

    .gapWidth( value:number );

    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.

    • value
    • Type:number
  • getBoundsInTwips
    Inherited

    .getBoundsInTwips( );
    Return Type:
    object
    Return Type Description:
    The bounds of the shape on its worksheet. This will be an object with numeric values for properties 'x', 'y', 'width', 'height', 'left', 'top', 'right', and 'bottom'.

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

    Exceptions

    Exception Description
    ig.InvalidOperationException The WorksheetShape.topLeftCornerCell or WorksheetShape.bottomRightCornerCell are null, in which case the shape has no bounds.

    Remarks

    The bounds returned by this method are only valid with the current configuration of the worksheet. If any rows or columns before or within the shape are resized, these bounds will no longer reflect the position of the shape.

  • getBoundsInTwips
    Inherited

    .getBoundsInTwips( options:ig.excel.PositioningOptions );
    Return Type:
    object
    Return Type Description:
    The bounds of the shape on its worksheet. This will be an object with numeric values for properties 'x', 'y', 'width', 'height', 'left', 'top', 'right', and 'bottom'.

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

    • options
    • Type:ig.excel.PositioningOptions
    • The options to use when getting the bounds of the shape.

    Exceptions

    Exception Description
    ig.InvalidOperationException The WorksheetShape.topLeftCornerCell or WorksheetShape.bottomRightCornerCell are null, in which case the shape has no bounds.

    Remarks

    The bounds returned by this method are only valid with the current configuration of the worksheet. If any rows or columns before or within the shape are resized, these bounds will no longer reflect the position of the shape.

  • heightPercent

    .heightPercent( );

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

  • heightPercent

    .heightPercent( value:number );

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

    • value
    • Type:number
  • highLowLines

    .highLowLines( );
    Return Type:
    ig.excel.ChartHighLowLines
    Return Type Description:
    Returns a ChartHighLowLines.

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

    Remarks

    This property is only applicable for stock charts.

    High/low lines depict the high and low prices for a stock chart.

    High/low lines are displayed by default; to disable them, set this property to null.

  • highLowLines

    .highLowLines( value:ig.excel.ChartHighLowLines );
    Return Type:
    ig.excel.ChartHighLowLines
    Return Type Description:
    Returns a ChartHighLowLines.

    Sets a ChartHighLowLines instance which determines the appearance for a stock chart's high/low lines.

    • value
    • Type:ig.excel.ChartHighLowLines

    Remarks

    This property is only applicable for stock charts.

    High/low lines depict the high and low prices for a stock chart.

    High/low lines are displayed by default; to disable them, set this property to null.

  • legend

    .legend( );
    Return Type:
    ig.excel.Legend
    Return Type Description:
    Returns a Legend.

    Returns a WorksheetChart.legend object which represents the legend for the chart.

    See Also

  • legend

    .legend( value:ig.excel.Legend );
    Return Type:
    ig.excel.Legend
    Return Type Description:
    Returns a Legend.

    Sets a WorksheetChart.legend object which represents the legend for the chart.

    • value
    • Type:ig.excel.Legend

    See Also

  • outline
    Inherited

    .outline( );
    Return Type:
    ig.excel.ShapeOutline
    Return Type Description:
    A ShapeOutline-derived instance describing the outline of the shape, or null for no outline.

    Gets the outline to use for the shape.

    Remarks

    Note: some shapes, such as comments or groups, cannot have a outline set. For these shapes, the value on this property will be ignored and lost when the workbook is saved.

  • outline
    Inherited

    .outline( value:ig.excel.ShapeOutline );
    Return Type:
    ig.excel.ShapeOutline
    Return Type Description:
    A ShapeOutline-derived instance describing the outline of the shape, or null for no outline.

    Sets the outline to use for the shape.

    • value
    • Type:ig.excel.ShapeOutline

    Remarks

    Note: some shapes, such as comments or groups, cannot have a outline set. For these shapes, the value on this property will be ignored and lost when the workbook is saved.

  • perspective

    .perspective( );

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

    Remarks

    This property supports values within the inclusive range of 0 and 120.

  • perspective

    .perspective( value:number );

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

    • value
    • Type:number

    Remarks

    This property supports values within the inclusive range of 0 and 120.

  • plotArea

    .plotArea( );
    Return Type:
    ig.excel.PlotArea
    Return Type Description:
    Returns a PlotArea.

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

  • plotVisibleOnly

    .plotVisibleOnly( );

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

  • plotVisibleOnly

    .plotVisibleOnly( value:boolean );

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

    • value
    • Type:boolean
  • positioningMode
    Inherited

    .positioningMode( );
    Return Type:
    ig.excel.ShapePositioningMode
    Return Type Description:
    The way shapes will be repositioned in excel when cells before or within the shape are resized.

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

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the ShapePositioningMode enumeration.

    Remarks

    This value will not be saved for shapes contained in a WorksheetShapeGroup, which inherit their positioning mode from their parent group.

  • positioningMode
    Inherited

    .positioningMode( value:ig.excel.ShapePositioningMode );
    Return Type:
    ig.excel.ShapePositioningMode
    Return Type Description:
    The way shapes will be repositioned in excel when cells before or within the shape are resized.

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

    • value
    • Type:ig.excel.ShapePositioningMode

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The value assigned is not defined in the ShapePositioningMode enumeration.

    Remarks

    This value will not be saved for shapes contained in a WorksheetShapeGroup, which inherit their positioning mode from their parent group.

  • rightAngleAxes

    .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.

  • rightAngleAxes

    .rightAngleAxes( value:boolean );

    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.

    • value
    • Type:boolean
  • rotationX

    .rotationX( );

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

    Remarks

    This property controls the viewing perspective by rotating the chart around the horizontal axis, such that the top of the chart appears to move closer or further away.

    This property is only applicable to 3D charts.

  • rotationX

    .rotationX( value:number );

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

    • value
    • Type:number

    Remarks

    This property controls the viewing perspective by rotating the chart around the horizontal axis, such that the top of the chart appears to move closer or further away.

    This property is only applicable to 3D charts.

  • rotationY

    .rotationY( );

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

    Remarks

    This property controls the viewing perspective by rotating the chart around the vertical axis, such that the left edge of the chart appears to move closer or further away.

    This property is only applicable to 3D charts.

  • rotationY

    .rotationY( value:number );

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

    • value
    • Type:number

    Remarks

    This property controls the viewing perspective by rotating the chart around the vertical axis, such that the left edge of the chart appears to move closer or further away.

    This property is only applicable to 3D charts.

  • secondPlotSize

    .secondPlotSize( );

    Returns 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.

    Remarks

    This property is only applicable for the BarOfPie and PieOfPie chart types.

    This property supports values in the range of 5 to 200, inclusively.

  • secondPlotSize

    .secondPlotSize( value:number );

    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.

    • value
    • Type:number

    Remarks

    This property is only applicable for the BarOfPie and PieOfPie chart types.

    This property supports values in the range of 5 to 200, inclusively.

  • seriesCollection

    .seriesCollection( );
    Return Type:
    ig.excel.SeriesCollection
    Return Type Description:
    Returns a SeriesCollection.

    Returns the series collection (read-only)

  • seriesCollection

    .seriesCollection( index:number );
    Return Type:
    ig.excel.Series

    Indexer

    • index
    • Type:number
    • A zero based index

    See Also

  • seriesLines

    .seriesLines( );
    Return Type:
    ig.excel.ChartSeriesLines
    Return Type Description:
    Returns a ChartSeriesLines.

    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.

    Remarks

    This property is only applicable for the BarOfPie and PieOfPie chart types.

  • seriesLines

    .seriesLines( value:ig.excel.ChartSeriesLines );
    Return Type:
    ig.excel.ChartSeriesLines
    Return Type Description:
    Returns a ChartSeriesLines.

    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.

    • value
    • Type:ig.excel.ChartSeriesLines

    Remarks

    This property is only applicable for the BarOfPie and PieOfPie chart types.

  • seriesOverlap

    .seriesOverlap( );

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

    Remarks

    This property is only applicable for 2D bar charts.

  • seriesOverlap

    .seriesOverlap( value:number );

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

    • value
    • Type:number

    Remarks

    This property is only applicable for 2D bar charts.

  • setBoundsInTwips
    Inherited

    .setBoundsInTwips( sheet:ig.excel.Sheet, bounds:object );

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

    • sheet
    • Type:ig.excel.Sheet
    • The worksheet on which the shape should be placed.
    • bounds
    • Type:object
    • The new bounds where the shape should be placed. This can be an object with numeric values for properties 'x', 'y', 'width', and 'height' or 'left', 'top', 'right', and 'bottom' such as { x: 1, y: 2, width: 100, height: 200 }.

    Exceptions

    Exception Description
    ig.ArgumentNullException sheet is null.

    Remarks

    The shape will only be positioned at the specified bounds while the worksheet remains in the current configuration. Depending on the WorksheetShape.positioningMode of the shape, it may change bounds if any rows or columns before or within the shape are resized.

    See Also

  • setBoundsInTwips
    Inherited

    .setBoundsInTwips( sheet:ig.excel.Sheet, bounds:object, options:ig.excel.PositioningOptions );

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

    • sheet
    • Type:ig.excel.Sheet
    • The sheet on which the shape should be placed.
    • bounds
    • Type:object
    • The new bounds where the shape should be placed. This can be an object with numeric values for properties 'x', 'y', 'width', and 'height' or 'left', 'top', 'right', and 'bottom' such as { x: 1, y: 2, width: 100, height: 200 }.
    • options
    • Type:ig.excel.PositioningOptions
    • The options to use when setting the bounds of the shape.

    Exceptions

    Exception Description
    ig.ArgumentNullException sheet is null.

    Remarks

    The shape will only be positioned at the specified bounds while the worksheet remains in the current configuration. Depending on the WorksheetShape.positioningMode of the shape, it may change bounds if any rows or columns before or within the shape are resized.

  • setComboChartSourceData

    .setComboChartSourceData( dataRange:string, seriesChartTypes:ig.excel.ChartType[], [plotByRows:boolean], [cellReferenceMode:ig.excel.CellReferenceMode] );

    Sets the source data range for a combo chart.

    • dataRange
    • Type:string
    • The data range for the combo chart
    • seriesChartTypes
    • Type:ig.excel.ChartType[]
    • An array of WorksheetChart.chartType constants which specify the chart type for each series yielded from the specified dataRange.
    • plotByRows
    • Type:boolean
    • Optional
    • 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
    • Type:ig.excel.CellReferenceMode
    • Optional
    • Optional. Determines how to parse the dataRange.

    Exceptions

    Exception Description
    ig.Error The current value of the WorksheetChart.chartType property is not Combo.
    ig.Error The specified seriesChartTypes array contains one or more values which are not supported within a combo chart.
    ig.Error The specified seriesChartTypes array contains a combination of values which would require more than the maximum allowable number of axes (two).

    Remarks

    Combo charts support multiple chart types within the main chart, with each different chart type being associated with one or more Series.

    Use this method to populate the WorksheetChart.seriesCollection for a combo chart.

    For example, given a dataRange which yields three series, the caller can specify an array with three elements as the value of the seriesChartTypes parameter. Each array element is then applied to the corresponding series, in the same order in which they appear in the array.

    Duplicate ChartType values can appear in the seriesChartTypes array, in which case the corresponding series appear within the same chart. For example, specifying an array with ClusteredColumn, Line, and Line results in a combo chart with the first series appearing in a clustered column chart, and the remaining series appearing in a line chart.

    Specifying null for the value of the seriesChartTypes parameter is treated the same as a two-element array containing 'ColumnClustered' and 'Line', resulting in a clustered column chart for the first series, and a line chart for the remaining series.

    If fewer values are present in the seriesChartTypes array than the number of series yielded from the specified dataRange, the remaining series acquire the same ChartType and AxisGroup as the last element in the seriesChartTypes array. If more values are present in the array than the number of series yielded, these values are ignored.

    Certain chart type values are invalid for a combo chart; if any of these chart types are present in the array, an exception is thrown, listing the invalid chart types.

    The following table lists the ChartType values which are supported in combo charts, grouped by series type:

    SeriesType ChartType (supported in combo charts)
    AreaArea, AreaStacked, AreaStacked100
    BarColumnClustered, ColumnStacked, ColumnStacked100, BarClustered, BarStacked, BarStacked100, BarOfPie
    LineLine, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100
    PiePie, PieExploded, PieOfPie, Doughnut, DoughnutExploded
    RadarRadar, RadarFilled, RadarMarkers
    ScatterXYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    BubbleNot Supported
    SurfaceNot Supported

    Combo charts support a maximum of two axis groups. If the combination of values in the seriesChartTypes array necessitates more than two axis groups, an exception is thrown.

    Combo charts require a minimum of two Series. If the specified dataRange yields less that two series, an exception is thrown.

    If the combination of series used in a combo chart is indistinguishable from a non-combo chart, the chart may not be recognized by Excel as a combo chart. For example, adding two series, one of type Radar and one of type RadarMarkers, is a valid combination. When opened in Excel, however, such a chart will not be recognized as a combo chart, since the combination of series does not necessitate multiple chart elements. All relevant property values are persisted, however, and there is no distinguishable difference between the original chart and the serialized one.

  • setSourceData

    .setSourceData( dataRange:string, [plotByRows:boolean], [cellReferenceMode:ig.excel.CellReferenceMode] );

    Sets the source data range for the chart.

    • dataRange
    • Type:string
    • The data range for the chart
    • plotByRows
    • Type:boolean
    • Optional
    • 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
    • Type:ig.excel.CellReferenceMode
    • Optional
    • Optional. Determines how to parse the dataRange.

    Remarks

    For combo charts, this method always displays the first series in a clustered column chart, with all subsequent series displayed in line charts. Use the WorksheetChart.setComboChartSourceData to customize the series charts for a combo chart.

  • shapes
    Inherited

    .shapes( );
    Return Type:
    ig.excel.WorksheetShapeCollection
    Return Type Description:
    The collection of shapes contained in the group.

    Gets the collection of shapes contained in the group.

  • shapes
    Inherited

    .shapes( index:number );
    Return Type:
    ig.excel.WorksheetShape
    Return Type Description:
    The shape at the specified index.

    Gets the shape at the specified index in the collection.

    • index
    • Type:number
    • The zero-based index of the shape to get.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than zero or index is greater than or equal to WorksheetShapeCollection.count.
  • sheet

    .sheet( );
    Return Type:
    ig.excel.Sheet
    Return Type Description:
    Returns a Sheet.

    Gets the worksheet on which the shape resides.

    See Also

  • sideWall

    .sideWall( );
    Return Type:
    ig.excel.Wall
    Return Type Description:
    Returns a Wall.

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

  • topLeftCornerCell
    Inherited

    .topLeftCornerCell( );
    Return Type:
    ig.excel.WorksheetCell
    Return Type Description:
    The cell where the top-left corner of the shape resides.

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

    Exceptions

    Exception Description
    ig.ArgumentException The value assigned is a cell whose worksheet is not the same as this shape's worksheet.
    ig.ArgumentNullException The value assigned is null and this shape already exists on a worksheet or group.

    Remarks

    This anchor cell, along with the WorksheetShape.bottomRightCornerCell, determines where the shape will be positioned on the worksheet. In addition, the WorksheetShape.bottomRightCornerPosition and WorksheetShape.topLeftCornerPosition properties allow for finer control of the shape's position.

  • topLeftCornerCell
    Inherited

    .topLeftCornerCell( value:ig.excel.WorksheetCell );
    Return Type:
    ig.excel.WorksheetCell
    Return Type Description:
    The cell where the top-left corner of the shape resides.

    Sets the cell where the top-left corner of the shape resides.

    • value
    • Type:ig.excel.WorksheetCell

    Exceptions

    Exception Description
    ig.ArgumentException The value assigned is a cell whose worksheet is not the same as this shape's worksheet.
    ig.ArgumentNullException The value assigned is null and this shape already exists on a worksheet or group.

    Remarks

    This anchor cell, along with the WorksheetShape.bottomRightCornerCell, determines where the shape will be positioned on the worksheet. In addition, the WorksheetShape.bottomRightCornerPosition and WorksheetShape.topLeftCornerPosition properties allow for finer control of the shape's position.

  • topLeftCornerPosition
    Inherited

    .topLeftCornerPosition( );
    Return Type:
    object
    Return Type Description:
    The position in the top-left corner cell of the shape's top-left corner. This will be an object with numeric values for properties 'x' and 'y'.

    Gets the position in the WorksheetShape.topLeftCornerCell of the shape's top-left corner, expressed in percentages.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException Either coordinate of the value assigned is outside the range of 0.0 to 100.0.

    Remarks

    These percentages are expressed as distance across the associated dimension of the cell, starting at the top-left corner of the cell. For example, (0.0, 0.0) represents the top-left corner of the cell, whereas (100.0, 100.0) represents the bottom-right corner of the cell. (50.0, 10.0) would represent the location in the cell which is centered horizontally, and a tenth of the way down from the top.

  • topLeftCornerPosition
    Inherited

    .topLeftCornerPosition( value:object );
    Return Type:
    object
    Return Type Description:
    The position in the top-left corner cell of the shape's top-left corner. This will be an object with numeric values for properties 'x' and 'y'.

    Sets the position in the WorksheetShape.topLeftCornerCell of the shape's top-left corner, expressed in percentages.

    • value
    • Type:object
    • This can be an object with numeric values for properties 'x' and 'y', such as { x: 1, y: 2 }.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException Either coordinate of the value assigned is outside the range of 0.0 to 100.0.

    Remarks

    These percentages are expressed as distance across the associated dimension of the cell, starting at the top-left corner of the cell. For example, (0.0, 0.0) represents the top-left corner of the cell, whereas (100.0, 100.0) represents the bottom-right corner of the cell. (50.0, 10.0) would represent the location in the cell which is centered horizontally, and a tenth of the way down from the top.

  • upDownBars

    .upDownBars( );
    Return Type:
    ig.excel.UpDownBars
    Return Type Description:
    Returns a UpDownBars.

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

    Remarks

    This property is only applicable for stock charts.

    Up/down bars depict gains or losses across a series for a stock chart.

  • upDownBars

    .upDownBars( value:ig.excel.UpDownBars );
    Return Type:
    ig.excel.UpDownBars
    Return Type Description:
    Returns a UpDownBars.

    Sets a UpDownBars instance which determines the appearance for a stock chart's up/down bars.

    • value
    • Type:ig.excel.UpDownBars

    Remarks

    This property is only applicable for stock charts.

    Up/down bars depict gains or losses across a series for a stock chart.

  • varyColors

    .varyColors( );

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

    Remarks

    This property defaults to true, causing fill colors for series and data points to be automatically selected by Excel.

    The automatically selected color can always be overridden for individual series and/or data points using the Series.fill, Series.line, and DataPoint.fill properties.

    In cases where VaryColors is set to true, but a fill is explicitly assigned, the assigned fill is used for the associated series or data point, while series or data points which have no explicitly assigned fill will have a fill color automatically selected.

  • varyColors

    .varyColors( value:boolean );

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

    • value
    • Type:boolean

    Remarks

    This property defaults to true, causing fill colors for series and data points to be automatically selected by Excel.

    The automatically selected color can always be overridden for individual series and/or data points using the Series.fill, Series.line, and DataPoint.fill properties.

    In cases where VaryColors is set to true, but a fill is explicitly assigned, the assigned fill is used for the associated series or data point, while series or data points which have no explicitly assigned fill will have a fill color automatically selected.

  • visible
    Inherited

    .visible( );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether the shape is visible on the worksheet.

    Gets the value indicating whether the shape is visible on the worksheet.

  • visible
    Inherited

    .visible( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    The value indicating whether the shape is visible on the worksheet.

    Sets the value indicating whether the shape is visible on the worksheet.

    • value
    • Type:boolean
  • wallDefault

    .wallDefault( );
    Return Type:
    ig.excel.Wall
    Return Type Description:
    Returns a Wall.

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

    Remarks

    Use this property to apply the same settings for the back wall, side wall, and floor.

    Use the WorksheetChart.backWall property to control the appearance of the back wall.

    Use the WorksheetChart.sideWall property to control the appearance of the side wall.

    Use the WorksheetChart.floor property to control the appearance of the bottom wall.

    The BackWall, SideWall, and Floor properties take precedence over this property.

  • worksheet
    Inherited

    .worksheet( );
    Return Type:
    ig.excel.Worksheet
    Return Type Description:
    The worksheet on which the shape resides.

    Gets the worksheet on which the shape resides.

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.