Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class AxisCollection

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

Hierarchy

Hierarchy (view full)

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static$t

$t: Type

StaticnextHashCode

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

  • Returns EnumeratorWrapper<Axis>

add

  • add(type, group?): Axis

  • Adds a new [[Axis]] into the collection with the specified type and groupo. Note: If there is an axis already in the collection of the type and group specified it will be replaced with the newly added one.

    Parameters

    • type: AxisType

      The type of the axis.

    • group: AxisGroup

      The axis group, defaults to primary.

    Returns Axis

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?): Axis

  • Indexer

    Parameters

    Returns Axis

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

remove

  • remove(type, group): boolean

  • Removes an axis from the collection.

    Parameters

    • type: AxisType

      The type of the axis.

    • group: AxisGroup

      The axis group, defaults to primary.

    Returns boolean

Staticcompare

  • compare(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

StaticcompareSimple

  • compareSimple(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

StaticequalsSimple

  • equalsSimple(item1, item2): boolean

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

StaticequalsStatic

  • equalsStatic(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

StaticgetArrayOfProperties

  • getArrayOfProperties(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

StaticgetArrayOfValues

  • getArrayOfValues(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

StaticgetHashCodeStatic

  • getHashCodeStatic(obj): number

  • Parameters

    • obj: any

    Returns number

StaticreferenceEquals

  • referenceEquals(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

StaticstaticInit

  • staticInit(): void

  • Returns void