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( );

    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( );

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

    See Also

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

    See Also

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

    See Also

  • barShapeResolved

    .barShapeResolved( );

    Returns the resolved value of the WorksheetChart.barShape property.

    See Also

  • chartArea

    .chartArea( );

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

  • chartTitle

    .chartTitle( );

    Returns an WorksheetChart.chartTitle object.

  • chartTitle

    .chartTitle( value:ig.excel.ChartTitle );

    Sets an WorksheetChart.chartTitle object.

    • value
    • Type:ig.excel.ChartTitle

  • chartType

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

    See Also

  • chartType

    .chartType( value:ig.excel.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.

    See Also

  • 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( );

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

  • displayBlanksAs

    .displayBlanksAs( value:ig.excel.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.

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

  • floor

    .floor( );

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

    See Also

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

    See Also

  • 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

    See Also

  • gapWidth

    .gapWidth( );

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

    See Also

  • gapWidth

    .gapWidth( value:number );

    Sets the distance between the data series in a 3-D chart, as a percentage of the marker width. The value of this property must be between 0 and 500.

    • value
    • Type:number

    See Also

  • 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

  • legend

    .legend( );

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

  • legend

    .legend( value:ig.excel.Legend );

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

    • value
    • Type:ig.excel.Legend

  • perspective

    .perspective( );

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

  • perspective

    .perspective( value:number );

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

    • value
    • Type:number

  • plotArea

    .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

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

    See Also

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

    See Also

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

    See Also

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

    See Also

  • 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( );

    Returns the series collection (read-only)

  • seriesCollection

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

    Indexer

    • index
    • Type:number
    • A zero based index

  • seriesLines

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

    Remarks

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

    See Also

  • seriesLines

    .seriesLines( value:ig.excel.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.

    See Also

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

  • sideWall

    .sideWall( );

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

    See Also

  • wallDefault

    .wallDefault( );

    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.

    See Also

  • worksheet

    .worksheet( );

    Gets the worksheet on which the shape resides.

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