Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class ComboChartGroupCollection

A collection of [[ComboChartGroup]] objects for a [[WorksheetChart]]

This collection is used to apply chart-specific properties to [[Series]] which appear within a combo chart.

See

  • [[ComboChartGroup]]
  • [[WorksheetChart.comboChartGroups]]

Hierarchy

Hierarchy (view full)

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

chart

  • get chart(): WorksheetChart

  • Returns the owning chart (read-only)

    See

    [[owner]]

    Returns WorksheetChart

count

  • get count(): number

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

    Returns number

isReadOnly

  • get isReadOnly(): boolean

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

    Returns boolean

owner

  • get owner(): ChartObject

  • returns this object's owner. (read-only) The owner or null if this object is owned directly by the Chart

    See

    [[chart]]

    Returns ChartObject

sheet

  • get sheet(): Sheet

  • The owning sheet (read-only)

    Returns Sheet

workbook

  • get workbook(): Workbook

  • The owning workbook (read-only)

    Returns Workbook

worksheet

  • get worksheet(): Worksheet

  • The owning worksheet (read-only)

    Returns Worksheet

Methods

[iterator]

  • [iterator](): EnumeratorWrapper<ComboChartGroup>

  • Returns EnumeratorWrapper<ComboChartGroup>

add

  • add(chartType, axisGroup): ComboChartGroup

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

    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

    • [[ComboChartGroup]]
    • [[remove]]

    Throws

    [[NotSupportedException]] The specified 'chartType' is not supported within a combo chart. See documentation for the WorksheetChart.SetComboChartSourceData method for a list of supported chart types.

    Parameters

    • chartType: ChartType

      A [[ChartType]] constant which identifies the combo chart group.

    • axisGroup: AxisGroup

      An [[AxisGroup]] constant which identifies the combo chart group.

    Returns ComboChartGroup

clear

  • clear(): void

  • Clears the collection.

    Returns void

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getEnumerator

  • getEnumerator(): any

  • Returns any

getEnumeratorObject

  • getEnumeratorObject(): any

  • Returns any

getHashCode

  • getHashCode(): number

  • Returns number

item

  • item(a, b): ComboChartGroup

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

    Parameters

    Returns ComboChartGroup

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

remove

  • remove(chartType, axisGroup): boolean

  • Removes the specified [[ComboChartGroup]] from this collection.

    Parameters

    • chartType: ChartType

      A [[ChartType]] constant which identifies the combo chart group.

    • axisGroup: AxisGroup

      An [[AxisGroup]] constant which identifies the combo chart group.

    Returns boolean

  • remove(comboChartGroup): boolean

  • Removes the specified [[ComboChartGroup]] from this collection.

    Parameters

    • comboChartGroup: ComboChartGroup

      The [[ComboChartGroup]] instance to be removed.

    Returns boolean

Static compare

  • compare(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • compareSimple(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • equalsSimple(item1, item2): boolean

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • equalsStatic(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • getArrayOfProperties(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • getArrayOfValues(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • getHashCodeStatic(obj): number

  • Parameters

    • obj: any

    Returns number

Static referenceEquals

  • referenceEquals(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static staticInit

  • staticInit(): void

  • Returns void