Represents a collection of sort elements that are applied to a data source or provider.

Constructors

Section titled "Constructors"

IgxChartSortDescriptionCollection 

new IgxChartSortDescriptionCollection(): IgxChartSortDescriptionCollection

Returns IgxChartSortDescriptionCollection

Properties

Section titled "Properties"

ngAcceptInputType_shouldDetachOnTargetChange

Section titled "ngAcceptInputType_shouldDetachOnTargetChange" 
ngAcceptInputType_shouldDetachOnTargetChange: string | boolean

Accessors

Section titled "Accessors"

count

Section titled "count" 
get count(): number

Returns number

i

Section titled "i" 
get i(): ChartSortDescriptionCollection

Returns ChartSortDescriptionCollection

shouldDetachOnTargetChange

Section titled "shouldDetachOnTargetChange"

Gets or sets whether this collection should detach the sync when the target collection changes.

 
get shouldDetachOnTargetChange(): boolean

Returns boolean 

set shouldDetachOnTargetChange(v: boolean): void

Parameters

  • v: boolean

Returns void

Methods

Section titled "Methods"

[iterator]

Section titled "[iterator]" 
[iterator](): Generator<any, void, unknown>

Returns Generator<any, void, unknown>

add

Section titled "add" 
add(item: IgxChartSortDescription): boolean

Parameters

Returns boolean

clear

Section titled "clear" 
clear(): void

Returns void

findByName

Section titled "findByName" 
findByName(name: string): any

Parameters

  • name: string

Returns any

indexOf

Section titled "indexOf" 
indexOf(item: IgxChartSortDescription): number

Parameters

Returns number

insert

Section titled "insert" 
insert(index: number, item: IgxChartSortDescription): void

Parameters

Returns void

item

Section titled "item" 
item(index: number, value: IgxChartSortDescription): IgxChartSortDescription

Parameters

Returns IgxChartSortDescription

remove

Section titled "remove" 
remove(item: IgxChartSortDescription): boolean

Parameters

Returns boolean

removeAt

Section titled "removeAt" 
removeAt(index: number): IgxChartSortDescription

Parameters

  • index: number

Returns IgxChartSortDescription

toArray

Section titled "toArray" 
toArray(): IgxChartSortDescription[]

Returns IgxChartSortDescription[]