Class SparklineCollection

A collection of [[Sparkline]]s exposed from a [[SparklineGroup]]

Hierarchy

Base
- SparklineCollection

Implements

IEnumerable$1<Sparkline>

Constructors

constructor

new SparklineCollection(a, b): SparklineCollection
Overrides Base.constructor
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:38747
Parameters
- a: number
- b: SparklineGroup
Returns SparklineCollection
new SparklineCollection(a, b, c): SparklineCollection
Overrides Base.constructor
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:38748
Parameters
- a: number
- b: SparklineGroup
- c: Sparkline[]
Returns SparklineCollection
new SparklineCollection(a, ..._rest): SparklineCollection
Overrides Base.constructor
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:38749
Parameters
- a: number
- Rest ..._rest: any[]
Returns SparklineCollection

Properties

$type

$type: Type

`Static` $t

$t: Type

`Static` nextHashCode

nextHashCode: number

Accessors

count

get count(): number
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:38753
Returns the total number of items in the collection.

Returns number

Methods

[iterator]

[iterator](): EnumeratorWrapper<Sparkline>
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:38791
Returns EnumeratorWrapper<Sparkline>

add

add(row, column, dataRegion, cellReferenceMode?): Sparkline
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:38777
Adds a new [[SparklineGroup]] with no sparklines

Parameters
- row: number
  The zero-based row of the sparkline cell.
- column: number
  The zero-based column of the sparkline cell.
- dataRegion: string
  A string describing the data region.
- Optional cellReferenceMode: CellReferenceMode
  An optional [[CellReferenceMode]] to use to parse the dataRegion. If null it defaults to the workbook's mode.
Returns Sparkline

clear

clear(): void
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:38785
Clears all items from the collection

Returns void

contains

contains(sparkline): boolean
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:38790
Returns true if the collection contains the item

Parameters
- sparkline: Sparkline
  The sparkline to check
Returns boolean

equals

equals(other): boolean
Inherited from Base.equals
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:10
Parameters
- other: any
Returns boolean

getEnumerator

getEnumerator(): any
Implementation of IEnumerable$1.getEnumerator
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:38792
Returns any

getEnumeratorObject

getEnumeratorObject(): any
Implementation of IEnumerable$1.getEnumeratorObject
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:38797
Returns any

getHashCode

getHashCode(): number
Inherited from Base.getHashCode
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:17
Returns number

indexOf

indexOf(sparkline): number
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:38807
Gets the index of the item in the collection

Parameters
- sparkline: Sparkline
Returns number

item

item(a, b?): Sparkline
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:38760
Indexer

Throws
[[IndexOutOfRangeException]] If the index is negative or greater than or equal to [[count]]

Parameters
- a: number
- Optional b: Sparkline
Returns Sparkline

memberwiseClone

memberwiseClone(): Base
Inherited from Base.memberwiseClone
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:19
Returns Base

remove

remove(sparkline): boolean
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:38813
Removes a sparkline from the collection

Parameters
- sparkline: Sparkline
  The sparkline to remove.
Returns boolean

removeAt

removeAt(index): void
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:38819
Removes a sparkline from the collection

Throws
[[IndexOutOfRangeException]] if the index is less than 0 or not less than the count.

Parameters
- index: number
  The zero-based index of the sparkline to remove.
Returns void

`Static` compare

compare(item1, item2): number
Inherited from Base.compare
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:14
Parameters
- item1: any
- item2: any
Returns number

`Static` compareSimple

compareSimple(item1, item2): number
Inherited from Base.compareSimple
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:13
Parameters
- item1: any
- item2: any
Returns number

`Static` equalsSimple

equalsSimple(item1, item2): boolean
Inherited from Base.equalsSimple
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:12
Parameters
- item1: any
- item2: any
Returns boolean

`Static` equalsStatic

equalsStatic(a, b): boolean
Inherited from Base.equalsStatic
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:11
Parameters
- a: any
- b: any
Returns boolean

`Static` getArrayOfProperties

getArrayOfProperties(obj): any[]
Inherited from Base.getArrayOfProperties
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:22
Parameters
- obj: any
Returns any[]

`Static` getArrayOfValues

getArrayOfValues(obj): any[]
Inherited from Base.getArrayOfValues
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:21
Parameters
- obj: any
Returns any[]

`Static` getHashCodeStatic

getHashCodeStatic(obj): number
Inherited from Base.getHashCodeStatic
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:18
Parameters
- obj: any
Returns number

`Static` referenceEquals

referenceEquals(a, b): boolean
Inherited from Base.referenceEquals
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:20
Parameters
- a: any
- b: any
Returns boolean

`Static` staticInit

staticInit(): void
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:38746
Returns void

Class SparklineCollection

Hierarchy

Hierarchy

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

a: number

b: SparklineGroup

Returns SparklineCollection

Parameters

a: number

b: SparklineGroup

c: Sparkline[]

Returns SparklineCollection

Parameters

a: number

Rest ..._rest: any[]

Returns SparklineCollection

Properties

$type

Static $t

Static nextHashCode

Accessors

count

Returns number

Methods

[iterator]

Returns EnumeratorWrapper<Sparkline>

add

Parameters

row: number

column: number

dataRegion: string

Optional cellReferenceMode: CellReferenceMode

Returns Sparkline

clear

Returns void

contains

Parameters

sparkline: Sparkline

Returns boolean

equals

Parameters

other: any

Returns boolean

getEnumerator

Returns any

getEnumeratorObject

Returns any

getHashCode

Returns number

indexOf

Parameters

sparkline: Sparkline

Returns number

item

Throws

Parameters

a: number

Optional b: Sparkline

Returns Sparkline

memberwiseClone

Returns Base

remove

Parameters

sparkline: Sparkline

Returns boolean

removeAt

Throws

Parameters

index: number

Returns void

Static compare

Parameters

item1: any

`Static` $t

`Static` nextHashCode

`Static` compare

`Static` compareSimple

`Static` equalsSimple

`Static` equalsStatic

`Static` getArrayOfProperties

`Static` getArrayOfValues

`Static` getHashCodeStatic

`Static` referenceEquals

`Static` staticInit