ig.excel.Series

An object that represents a specific series in a chart

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.

  • applyPicToEnd

    .applyPicToEnd( );

    Apply the picture to the end of the series.

  • applyPicToEnd

    .applyPicToEnd( value:boolean );

    Apply the picture to the end of the series.

    • value
    • Type:boolean

  • applyPicToFront

    .applyPicToFront( );

    Apply the picture to the front of the series.

  • applyPicToFront

    .applyPicToFront( value:boolean );

    Apply the picture to the front of the series.

    • value
    • Type:boolean

  • applyPicToSides

    .applyPicToSides( );

    Apply the picture to the sides.

  • applyPicToSides

    .applyPicToSides( value:boolean );

    Apply the picture to the sides.

    • value
    • Type:boolean

  • axisBinning

    .axisBinning( );
    Return Type:
    ig.excel.CategoryAxisBinning
    Return Type Description:
    Returns a CategoryAxisBinning.

    Returns a CategoryAxisBinning instance which determines the binning properties for the category axis on a histogram or pareto chart.

    Remarks

    This property is only applicable for histogram and pareto charts.

    See Also

  • axisBinning

    .axisBinning( value:ig.excel.CategoryAxisBinning );
    Return Type:
    ig.excel.CategoryAxisBinning
    Return Type Description:
    Returns a CategoryAxisBinning.

    Sets a CategoryAxisBinning instance which determines the binning properties for the category axis on a histogram or pareto chart.

    • value
    • Type:ig.excel.CategoryAxisBinning

    Remarks

    This property is only applicable for histogram and pareto charts.

    See Also

  • axisGroup

    .axisGroup( );
    Return Type:
    ig.excel.AxisGroup
    Return Type Description:
    Returns a AxisGroup.

    Specifies which axis group this series applies to.

    Exceptions

    Exception Description
    ig.Error The target axis already contains a chart type which cannot share axes with this series because of the value of the Series.chartType property of this series.

    Remarks

    This property is only applicable for combo charts.

    This property defaults to Primary, causing all series to be plotted on the primary axis unless otherwise specified.

    To plot this series on the secondary value axis, set this property to Secondary.

    Setting this property to Secondary triggers creation of secondary category and value axes.

    Not all series can be plotted on the same axis; the following table lists each ChartType along with the other ChartTypes which can be plotted on the same axis:

    ChartTypeValid on same axis
    ColumnClusteredLine, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    ColumnStackedLine, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    ColumnStacked100Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    BarClusteredBarClustered only
    BarStackedBarStacked only
    BarStacked100BarStacked100 only
    LineColumnClustered, ColumnStacked, ColumnStacked100, LineMarkers, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    LineStackedColumnClustered, ColumnStacked, ColumnStacked100, LineMarkersStacked, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    LineStacked100ColumnClustered, ColumnStacked, ColumnStacked100, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    LineMarkersColumnClustered, ColumnStacked, ColumnStacked100, Line, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    LineMarkersStackedColumnClustered, ColumnStacked, ColumnStacked100, LineStacked, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    LineMarkersStacked100ColumnClustered, ColumnStacked, ColumnStacked100, LineStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    AreaColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    AreaStackedColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    AreaStacked100ColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    PiePieExploded, BarOfPie, PieOfPie, Doughnut, DoughnutExploded
    PieExplodedPie, BarOfPie, PieOfPie, Doughnut, DoughnutExploded
    BarOfPiePie, PieExploded, PieOfPie, Doughnut, DoughnutExploded
    PieOfPiePie, PieExploded, BarOfPie, Doughnut, DoughnutExploded
    DoughnutPie, PieExploded, BarOfPie, PieOfPie, DoughnutExploded
    DoughnutExplodedPie, PieExploded, BarOfPie, PieOfPie, Doughnut
    XYScatterColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    XYScatterLinesColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    XYScatterLinesNoMarkersColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterSmooth, XYScatterSmoothNoMarkers
    XYScatterSmoothColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmoothNoMarkers
    XYScatterSmoothNoMarkersColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth
    RadarRadarFilled, RadarMarkers
    RadarFilledRadar, RadarMarkers
    RadarMarkersRadar, RadarFilled

    Attempting to set the series axis to the same value as an incompatible series causes an exception to be thrown.

    See Also

  • axisGroup

    .axisGroup( value:ig.excel.AxisGroup );
    Return Type:
    ig.excel.AxisGroup
    Return Type Description:
    Returns a AxisGroup.

    Specifies which axis group this series applies to.

    • value
    • Type:ig.excel.AxisGroup

    Exceptions

    Exception Description
    ig.Error The target axis already contains a chart type which cannot share axes with this series because of the value of the Series.chartType property of this series.

    Remarks

    This property is only applicable for combo charts.

    This property defaults to Primary, causing all series to be plotted on the primary axis unless otherwise specified.

    To plot this series on the secondary value axis, set this property to Secondary.

    Setting this property to Secondary triggers creation of secondary category and value axes.

    Not all series can be plotted on the same axis; the following table lists each ChartType along with the other ChartTypes which can be plotted on the same axis:

    ChartTypeValid on same axis
    ColumnClusteredLine, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    ColumnStackedLine, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    ColumnStacked100Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    BarClusteredBarClustered only
    BarStackedBarStacked only
    BarStacked100BarStacked100 only
    LineColumnClustered, ColumnStacked, ColumnStacked100, LineMarkers, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    LineStackedColumnClustered, ColumnStacked, ColumnStacked100, LineMarkersStacked, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    LineStacked100ColumnClustered, ColumnStacked, ColumnStacked100, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    LineMarkersColumnClustered, ColumnStacked, ColumnStacked100, Line, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    LineMarkersStackedColumnClustered, ColumnStacked, ColumnStacked100, LineStacked, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    LineMarkersStacked100ColumnClustered, ColumnStacked, ColumnStacked100, LineStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    AreaColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    AreaStackedColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    AreaStacked100ColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    PiePieExploded, BarOfPie, PieOfPie, Doughnut, DoughnutExploded
    PieExplodedPie, BarOfPie, PieOfPie, Doughnut, DoughnutExploded
    BarOfPiePie, PieExploded, PieOfPie, Doughnut, DoughnutExploded
    PieOfPiePie, PieExploded, BarOfPie, Doughnut, DoughnutExploded
    DoughnutPie, PieExploded, BarOfPie, PieOfPie, DoughnutExploded
    DoughnutExplodedPie, PieExploded, BarOfPie, PieOfPie, Doughnut
    XYScatterColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    XYScatterLinesColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLinesNoMarkers, XYScatterSmooth, XYScatterSmoothNoMarkers
    XYScatterLinesNoMarkersColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterSmooth, XYScatterSmoothNoMarkers
    XYScatterSmoothColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmoothNoMarkers
    XYScatterSmoothNoMarkersColumnClustered, ColumnStacked, ColumnStacked100, Line, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, Area, AreaStacked, AreaStacked100, XYScatter, XYScatterLines, XYScatterLinesNoMarkers, XYScatterSmooth
    RadarRadarFilled, RadarMarkers
    RadarFilledRadar, RadarMarkers
    RadarMarkersRadar, RadarFilled

    Attempting to set the series axis to the same value as an incompatible series causes an exception to be thrown.

    See Also

  • barShape

    .barShape( );

    Determines the shape of the bar for this series. Applicable only for 3D bar charts.

    Remarks

    This property controls the shape of the bar displayed for this series only.

    To set the bar shape for all series in the chart, use the WorksheetChart.barShape property.

    See Also

  • barShape

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

    Determines the shape of the bar for this series. Applicable only for 3D bar charts.

    • value
    • Type:ig.excel.BarShape

    Remarks

    This property controls the shape of the bar displayed for this series only.

    To set the bar shape for all series in the chart, use the WorksheetChart.barShape property.

    See Also

  • barShapeResolved

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

    Returns the resolved value of the Series.barShape property.

    See Also

  • border

    .border( );
    Return Type:
    ig.excel.ChartBorder
    Return Type Description:
    Returns a ChartBorder.

    Determines the appearance of the border drawn around the Series.fill area. Applicable only for chart series which support fills, such as bar charts, area charts, and pie charts.

    Remarks

    For series which support fills, this property controls the color and size of the line drawn around the fill region.

    For line-based series, use the Series.line property.

    See Also

  • border

    .border( value:ig.excel.ChartBorder );
    Return Type:
    ig.excel.ChartBorder
    Return Type Description:
    Returns a ChartBorder.

    Determines the appearance of the border drawn around the Series.fill area. Applicable only for chart series which support fills, such as bar charts, area charts, and pie charts.

    • value
    • Type:ig.excel.ChartBorder

    Remarks

    For series which support fills, this property controls the color and size of the line drawn around the fill region.

    For line-based series, use the Series.line property.

    See Also

  • boxAndWhiskerSettings

    .boxAndWhiskerSettings( );
    Return Type:
    ig.excel.BoxAndWhiskerSettings
    Return Type Description:
    Returns a BoxAndWhiskerSettings.

    Returns a Series.boxAndWhiskerSettings instance which determines the properties for a box and whisker chart.

    Remarks

    This property is only applicable for box and whisker charts.

    See Also

  • boxAndWhiskerSettings

    .boxAndWhiskerSettings( value:ig.excel.BoxAndWhiskerSettings );
    Return Type:
    ig.excel.BoxAndWhiskerSettings
    Return Type Description:
    Returns a BoxAndWhiskerSettings.

    Sets a Series.boxAndWhiskerSettings instance which determines the properties for a box and whisker chart.

    • value
    • Type:ig.excel.BoxAndWhiskerSettings

    Remarks

    This property is only applicable for box and whisker charts.

    See Also

  • bubbleSizes

    .bubbleSizes( );
    Return Type:
    ig.excel.SeriesValues
    Return Type Description:
    Returns a SeriesValues.

    Returns a Series.values instance that determines the bubble sizes in a bubble chart.

    See Also

  • bubbleSizes

    .bubbleSizes( value:ig.excel.SeriesValues );
    Return Type:
    ig.excel.SeriesValues
    Return Type Description:
    Returns a SeriesValues.

    Sets a Series.values instance that determines the bubble sizes in a bubble chart.

    • value
    • Type:ig.excel.SeriesValues

    See Also

  • chart
    Inherited

    .chart( );
    Return Type:
    ig.excel.WorksheetChart
    Return Type Description:
    Returns a WorksheetChart.

    Returns the owning chart (read-only)

    See Also

  • chartType

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

    Specifies the type of chart for this series. Applicable only for combo charts.

    Exceptions

    Exception Description
    ig.Error The Series.axisGroup on which this series currently resides cannot share an axis with a series of this ChartType, and no adjustment could be made to avoid this.

    Remarks

    This property is only applicable for combo charts. Setting this property for any other type of chart causes an exception to be thrown.

    Not all ChartType values are supported for series which are plotted within a combo chart. For a list of the supported values, see documentation for the WorksheetChart.SetComboChartSourceData method.

    If the value assigned to this property necessitates plotting this series on a different axis than the one referenced by the Series.axisGroup property, and the other axis can accommodate this series, the AxisGroup property is changed accordingly.

    If the other axis cannot accommodate this series, and other series which are of the same series type exist on the same axis, an attempt is made to change the ChartType of those other series. For example, if a different series exists with a ChartType of BarClustered, and a value of BarStacked is assigned to this series, the ChartType of the other series is changed to BarStacked in order to accommodate the setting of the property on this series.

    If no adjustment can be made that would allow the ChartType to be changed to the specified value, an exception is thrown.

    Note that in all cases, the value of the Series.type property is automatically changed to a value which is appropriate for the assigned ChartType.

    See Also

  • chartType

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

    Specifies the type of chart for this series. Applicable only for combo charts.

    • value
    • Type:ig.excel.ChartType

    Exceptions

    Exception Description
    ig.Error The Series.axisGroup on which this series currently resides cannot share an axis with a series of this ChartType, and no adjustment could be made to avoid this.

    Remarks

    This property is only applicable for combo charts. Setting this property for any other type of chart causes an exception to be thrown.

    Not all ChartType values are supported for series which are plotted within a combo chart. For a list of the supported values, see documentation for the WorksheetChart.SetComboChartSourceData method.

    If the value assigned to this property necessitates plotting this series on a different axis than the one referenced by the Series.axisGroup property, and the other axis can accommodate this series, the AxisGroup property is changed accordingly.

    If the other axis cannot accommodate this series, and other series which are of the same series type exist on the same axis, an attempt is made to change the ChartType of those other series. For example, if a different series exists with a ChartType of BarClustered, and a value of BarStacked is assigned to this series, the ChartType of the other series is changed to BarStacked in order to accommodate the setting of the property on this series.

    If no adjustment can be made that would allow the ChartType to be changed to the specified value, an exception is thrown.

    Note that in all cases, the value of the Series.type property is automatically changed to a value which is appropriate for the assigned ChartType.

    See Also

  • dataLabels

    .dataLabels( );
    Return Type:
    ig.excel.SeriesDataLabels
    Return Type Description:
    Returns a SeriesDataLabels.

    Returns a SeriesDataLabels instance which applies to all DataLabel instances which do not have a specific setting for a given property.

    Remarks

    Use the DataPoint.dataLabel property to customize an individual data label.

    See Also

  • dataPointCollection

    .dataPointCollection( );
    Return Type:
    ig.excel.DataPointCollection
    Return Type Description:
    Returns a DataPointCollection.

    Returns a collection of DataPoint instances which represent the individual data points in this series.

    See Also

  • dataPointCollection

    .dataPointCollection( index:number );
    Return Type:
    ig.excel.DataPoint
    Return Type Description:
    A DataPoint instance.

    Returns the DataPoint instance at the specified ordinal position within this collection.

    • index
    • Type:number
    • A zero based index

    See Also

  • errorBars

    .errorBars( );
    Return Type:
    ig.excel.ErrorBars
    Return Type Description:
    Returns a ErrorBars.

    Returns an ErrorBars object.

    See Also

  • errorBars

    .errorBars( value:ig.excel.ErrorBars );
    Return Type:
    ig.excel.ErrorBars
    Return Type Description:
    Returns a ErrorBars.

    Sets an ErrorBars object.

    • value
    • Type:ig.excel.ErrorBars

    See Also

  • explosion

    .explosion( );

    Returns a value which determines the amount by which individual slices are offset from the center of the pie or doughnut, expressed as a percentage of the radius.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The value is outside the range of 0 and 400.

    Remarks

    The valid range of values is between 0 and 400, inclusive.

  • explosion

    .explosion( value:number );

    Sets a value which determines the amount by which individual slices are offset from the center of the pie or doughnut, expressed as a percentage of the radius.

    • value
    • Type:number

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException The value is outside the range of 0 and 400.

    Remarks

    The valid range of values is between 0 and 400, inclusive.

  • fill

    .fill( );
    Return Type:
    ig.excel.ChartFillBase
    Return Type Description:
    Returns a ChartFillBase.

    Returns a ChartFillBase derived object which defines the fill for this series. Not applicable for line charts.

    Remarks

    This property is not applicable to charts which depict the data series as a line. For these chart types, use the Series.line property, which controls the color and width of the line.

    See Also

  • fill

    .fill( value:ig.excel.ChartFillBase );
    Return Type:
    ig.excel.ChartFillBase
    Return Type Description:
    Returns a ChartFillBase.

    Sets a ChartFillBase derived object which defines the fill for this series. Not applicable for line charts.

    • value
    • Type:ig.excel.ChartFillBase

    Remarks

    This property is not applicable to charts which depict the data series as a line. For these chart types, use the Series.line property, which controls the color and width of the line.

    See Also

  • invertIfNegative

    .invertIfNegative( );

    Determines if negative values will be inverted.

  • invertIfNegative

    .invertIfNegative( value:boolean );

    Determines if negative values will be inverted.

    • value
    • Type:boolean

  • leaderLines

    .leaderLines( );
    Return Type:
    ig.excel.LeaderLines
    Return Type Description:
    Returns a LeaderLines.

    Returns the instance.

    Remarks

    A leader line connects a DataLabel to it's associated series.

    See Also

  • leaderLines

    .leaderLines( value:ig.excel.LeaderLines );
    Return Type:
    ig.excel.LeaderLines
    Return Type Description:
    Returns a LeaderLines.

    Sets the instance.

    • value
    • Type:ig.excel.LeaderLines

    Remarks

    A leader line connects a DataLabel to it's associated series.

    See Also

  • line

    .line( );
    Return Type:
    ig.excel.ChartLine
    Return Type Description:
    Returns a ChartLine.

    Determines the fill and width of a series line.

    Remarks

    This property is not applicable for series which support fills, such as bar, area, or pie charts.

    For chart series which supports fills, use the Series.fill property to control the fill color, and the Series.border property for the line drawn around that fill area.

    See Also

  • line

    .line( value:ig.excel.ChartLine );
    Return Type:
    ig.excel.ChartLine
    Return Type Description:
    Returns a ChartLine.

    Determines the fill and width of a series line.

    • value
    • Type:ig.excel.ChartLine

    Remarks

    This property is not applicable for series which support fills, such as bar, area, or pie charts.

    For chart series which supports fills, use the Series.fill property to control the fill color, and the Series.border property for the line drawn around that fill area.

    See Also

  • markerBorder

    .markerBorder( );
    Return Type:
    ig.excel.ChartBorder
    Return Type Description:
    Returns a ChartBorder.

    Determines the appearance of the border (a.k.a. outline) for the marker.

    See Also

  • markerBorder

    .markerBorder( value:ig.excel.ChartBorder );
    Return Type:
    ig.excel.ChartBorder
    Return Type Description:
    Returns a ChartBorder.

    Determines the appearance of the border (a.k.a. outline) for the marker.

    • value
    • Type:ig.excel.ChartBorder

    See Also

  • markerFill

    .markerFill( );
    Return Type:
    ig.excel.ChartFillBase
    Return Type Description:
    Returns a ChartFillBase.

    Defines the fill appearance for the marker.

    See Also

  • markerFill

    .markerFill( value:ig.excel.ChartFillBase );
    Return Type:
    ig.excel.ChartFillBase
    Return Type Description:
    Returns a ChartFillBase.

    Defines the fill appearance for the marker.

    • value
    • Type:ig.excel.ChartFillBase

    See Also

  • markerSize

    .markerSize( );

    Determines the size of the markers.

  • markerSize

    .markerSize( value:number );

    Determines the size of the markers.

    • value
    • Type:number

  • markerStyle

    .markerStyle( );
    Return Type:
    ig.excel.MarkerStyle
    Return Type Description:
    Returns a MarkerStyle.

    Determines the style of the markers

    See Also

  • markerStyle

    .markerStyle( value:ig.excel.MarkerStyle );
    Return Type:
    ig.excel.MarkerStyle
    Return Type Description:
    Returns a MarkerStyle.

    Determines the style of the markers

    • value
    • Type:ig.excel.MarkerStyle

    See Also

  • name

    .name( );
    Return Type:
    ig.excel.SeriesName
    Return Type Description:
    Returns a SeriesName.

    Gets the name of the series

    See Also

  • name

    .name( value:ig.excel.SeriesName );
    Return Type:
    ig.excel.SeriesName
    Return Type Description:
    Returns a SeriesName.

    Sets the name of the series

    • value
    • Type:ig.excel.SeriesName

    See Also

  • owner
    Inherited

    .owner( );
    Return Type:
    ig.excel.ChartObject
    Return Type Description:
    The owner or null if this object is owned directly by the Chart

    returns this object's owner. (read-only)

    See Also

  • owningSeries

    .owningSeries( );
    Return Type:
    ig.excel.Series
    Return Type Description:
    Returns a Series.

    Returns a reference to the owning Series. Applicable only for a line series in a Pareto chart.

    Remarks

    This property is only applicable for Series contained within a Pareto chart.

    If the Series.chartType property of this series, as well as that of the associated chart, are not both set to 'Pareto', an exception is thrown.

    If the value assigned to this property has a Series.chartType of any value other than 'ClusteredColumn', an exception is thrown.

    See Also

  • owningSeries

    .owningSeries( value:ig.excel.Series );
    Return Type:
    ig.excel.Series
    Return Type Description:
    Returns a Series.

    Sets a reference to the owning Series. Applicable only for a line series in a Pareto chart.

    • value
    • Type:ig.excel.Series

    Remarks

    This property is only applicable for Series contained within a Pareto chart.

    If the Series.chartType property of this series, as well as that of the associated chart, are not both set to 'Pareto', an exception is thrown.

    If the value assigned to this property has a Series.chartType of any value other than 'ClusteredColumn', an exception is thrown.

    See Also

  • pictureType

    .pictureType( );
    Return Type:
    ig.excel.PictureType
    Return Type Description:
    Returns a PictureType.

    Determines whether pictures are scaled, stacked, or stretched.

    See Also

  • pictureType

    .pictureType( value:ig.excel.PictureType );
    Return Type:
    ig.excel.PictureType
    Return Type Description:
    Returns a PictureType.

    Determines whether pictures are scaled, stacked, or stretched.

    • value
    • Type:ig.excel.PictureType

    See Also

  • pictureUnit

    .pictureUnit( );

    Returns a value which defines the unit of measure when Series.pictureType is set to Stack.

  • pictureUnit

    .pictureUnit( value:number );

    Sets a value which defines the unit of measure when Series.pictureType is set to Stack.

    • value
    • Type:number

  • plotOrder

    .plotOrder( );

    Gets the plotting order for the data series.

    Remarks

    Note: this is the order in which the series names will appear in the legend. When there is only one series then this is omitted. This must be a whole number between 1 and the number of series on the chart. If you enter zero then 1 is used. If you enter a number greater than the number of series then the total number of series is used.

  • plotOrder

    .plotOrder( value:number );

    Sets the plotting order for the data series.

    • value
    • Type:number

    Remarks

    Note: this is the order in which the series names will appear in the legend. When there is only one series then this is omitted. This must be a whole number between 1 and the number of series on the chart. If you enter zero then 1 is used. If you enter a number greater than the number of series then the total number of series is used.

  • sheet
    Inherited

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

    Gets the owning sheet (read-only)

    See Also

  • showDataLabels

    .showDataLabels( );

    Returns a boolean value indicating whether to display Series.dataLabels.

  • showDataLabels

    .showDataLabels( value:boolean );

    Sets a boolean value indicating whether to display Series.dataLabels.

    • value
    • Type:boolean

  • showWaterfallConnectorLines

    .showWaterfallConnectorLines( );

    Returns a boolean value indicating whether to display connecting lines between the data points in a waterfall chart.

    Remarks

    This property is only applicable for waterfall charts.

    Use the Series.border property to control the visual appearance of the connector lines.

  • showWaterfallConnectorLines

    .showWaterfallConnectorLines( value:boolean );

    Sets a boolean value indicating whether to display connecting lines between the data points in a waterfall chart.

    • value
    • Type:boolean

    Remarks

    This property is only applicable for waterfall charts.

    Use the Series.border property to control the visual appearance of the connector lines.

  • smooth

    .smooth( );

    Determines whether a smoothing effect should be applied.

  • smooth

    .smooth( value:boolean );

    Determines whether a smoothing effect should be applied.

    • value
    • Type:boolean

  • trendlineCollection

    .trendlineCollection( );
    Return Type:
    ig.excel.TrendlineCollection
    Return Type Description:
    Returns a TrendlineCollection.

    Returns a collection of Trendline instances for this series.

    Remarks

    Trendlines are supported for Area, Bar, Bubble, Line, and Scatter charts, and are not supported for other chart types.

    See Also

  • trendlineCollection

    .trendlineCollection( index:number );
    Return Type:
    ig.excel.Trendline
    Return Type Description:
    Returns a Trendline.

    Returns the Trendline instance at the specified ordinal position within the collection.

    • index
    • Type:number
    • A zero based index

    See Also

  • type

    .type( );
    Return Type:
    ig.excel.SeriesType
    Return Type Description:
    Returns a SeriesType.

    Returns a SeriesType value which determines the type of this series. Applicable only for combo charts.

    Remarks

    This property is only applicable for combo charts. Setting this property for any other type of chart causes an exception to be thrown.

    Combo charts do not support Bubble or Surface; setting this property to either of those values causes an exception to be thrown.

    The Series.chartType property must be set to a value that is compatible with assigned series type. If the current value of the ChartType property is not compatible with the value assigned to this property, a reasonable default value, which is compatible, is assigned to the ChartType property.

    See Also

  • type

    .type( value:ig.excel.SeriesType );
    Return Type:
    ig.excel.SeriesType
    Return Type Description:
    Returns a SeriesType.

    Sets a SeriesType value which determines the type of this series. Applicable only for combo charts.

    • value
    • Type:ig.excel.SeriesType

    Remarks

    This property is only applicable for combo charts. Setting this property for any other type of chart causes an exception to be thrown.

    Combo charts do not support Bubble or Surface; setting this property to either of those values causes an exception to be thrown.

    The Series.chartType property must be set to a value that is compatible with assigned series type. If the current value of the ChartType property is not compatible with the value assigned to this property, a reasonable default value, which is compatible, is assigned to the ChartType property.

    See Also

  • values

    .values( );
    Return Type:
    ig.excel.SeriesValues
    Return Type Description:
    Returns a SeriesValues.

    Returns a Series.values instance that contains a collection of all the values in the series.

    Remarks

    The value of this property can be a range on a worksheet or an array of constant values, but not a combination of both.

    See Also

  • values

    .values( value:ig.excel.SeriesValues );
    Return Type:
    ig.excel.SeriesValues
    Return Type Description:
    Returns a SeriesValues.

    Sets a Series.values instance that contains a collection of all the values in the series.

    • value
    • Type:ig.excel.SeriesValues

    Remarks

    The value of this property can be a range on a worksheet or an array of constant values, but not a combination of both.

    See Also

  • workbook
    Inherited

    .workbook( );
    Return Type:
    ig.excel.Workbook
    Return Type Description:
    Returns a Workbook.

    Gets the owning workbook (read-only)

    See Also

  • worksheet
    Inherited

    .worksheet( );
    Return Type:
    ig.excel.Worksheet
    Return Type Description:
    Returns a Worksheet.

    Gets the owning worksheet (read-only)

    See Also

  • xValues

    .xValues( );
    Return Type:
    ig.excel.XValues
    Return Type Description:
    Returns a XValues.

    Returns a Series.xValues instance that contains a collection of all the x values in the series.

    Remarks

    The value of this property can be a range on a worksheet or an array of constant values, but not a combination of both.

    See Also

  • xValues

    .xValues( value:ig.excel.XValues );
    Return Type:
    ig.excel.XValues
    Return Type Description:
    Returns a XValues.

    Sets a Series.xValues instance that contains a collection of all the x values in the series.

    • value
    • Type:ig.excel.XValues

    Remarks

    The value of this property can be a range on a worksheet or an array of constant values, but not a combination of both.

    See Also

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