ig.excel.ComboChartGroupCollection

A collection of ComboChartGroup objects for a WorksheetChart

Remarks

This collection is used to apply chart-specific properties to Series which appear within a combo 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.

  • add

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

    Creates a new ComboChartGroup, or returns an existing one, which matches the specified chartType and axisGroup.

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

    Exceptions

    Exception Description
    ig.Error The specified chartType is not supported within a combo chart. See documentation for the WorksheetChart.SetComboChartSourceData method for a list of supported chart types.

    Remarks

    This method returns an object which provides a way to set chart-specific properties for a Series that is displayed within a combo chart.

    For example, to change the WorksheetChart.gapWidth property for each series associated with a bar chart contained within a combo chart, set the ComboChartGroup.gapWidth property of the instance returned from this method.

    If a ComboChartGroup instance corresponding to the specified chartType and axisGroup already exists, that instance is returned; otherwise a new instance is created and that instance is returned.

    See Also

  • chart
    Inherited

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

    Returns the owning chart (read-only)

    See Also

  • clear

    .clear( );

    Clears the collection.

  • count

    .count( );

    Returns the number of items in the collection (read-only)

  • getEnumerator

    .getEnumerator( );

    Gets an enumerator for the items in the collection

  • isReadOnly

    .isReadOnly( );

    Determines if the collecion can be modified (read-only)

  • item

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

    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

  • remove

    .remove( chartType:ig.excel.ChartType, axisGroup:ig.excel.AxisGroup );
    Return Type:
    boolean
    Return Type Description:
    True if the item was removed, otherwise false.

    Removes the specified ComboChartGroup from this collection.

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

    See Also

  • remove

    .remove( comboChartGroup:ig.excel.ComboChartGroup );
    Return Type:
    boolean
    Return Type Description:
    True if the item was removed, otherwise false.

    Removes the specified ComboChartGroup from this collection.

    • comboChartGroup
    • Type:ig.excel.ComboChartGroup
    • The ComboChartGroup instance to be removed.

    See Also

  • sheet
    Inherited

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

    Gets the owning sheet (read-only)

    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

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