Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class DisplayValueCollection

A collection of display text values.

See

  • [[WorksheetCell.getText]]
  • [[WorksheetRow.getCellText]]
  • [[FixedValuesFilter.displayValues]]

Hierarchy

Hierarchy

  • Base
    • DisplayValueCollection

Implements

  • IList$1<string>

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

count

  • get count(): number

  • Gets the number of display text values in the collection.

    Returns number

Methods

[iterator]

  • [iterator](): EnumeratorWrapper<string>

  • Returns EnumeratorWrapper<string>

add

  • add(item): void

  • Adds a display text value to the collection.

    Throws

    [[ArgumentNullException]] 'item' is null or empty.

    Throws

    [[ArgumentException]] 'item' matches another value in the collection. Values are compared case-insensitively.

    Parameters

    • item: string

      The display text value to add to the collection.

    Returns void

clear

  • clear(): void

  • Clears the collection.

    Throws

    [[InvalidOperationException]] The collection is owned by a [[FixedValuesFilter]] which only allowed the values in the collection. Clearing the collection would prevent the filter from including any values, which is not allowed for a FixedValuesFilter.

    Returns void

contains

  • contains(item): boolean

  • Determines whether the specified value is in the collection.

    Display text values are compared case-insensitively.

    Parameters

    • item: string

      The display text value to find in the collection.

    Returns boolean

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getHashCode

  • getHashCode(): number

  • Returns number

indexOf

  • indexOf(item): number

  • Gets the index of the specified display text value in the collection.

    Parameters

    • item: string

      The display text value to find in the collection.

    Returns number

insert

  • insert(index, item): void

  • Inserts a display text value into the collection.

    Throws

    [[ArgumentNullException]] 'item' is null or empty.

    Throws

    [[ArgumentException]] 'item' matches another value in the collection. Values are compared case-insensitively.

    Throws

    [[ArgumentOutOfRangeException]] 'index' is less than 0 or greater than [[count]].

    Parameters

    • index: number

      The 0-based index where the value should be inserted.

    • item: string

      The display text value to insert into the collection.

    Returns void

item

  • item(a, b?): string

  • Gets or sets the display text value at the specified index.

    Throws

    [[ArgumentOutOfRangeException]] 'index' is less than 0 or greater than or equal to [[count]].

    Throws

    [[ArgumentNullException]] The value assigned is null.

    Throws

    [[ArgumentException]] The value assigned matches another value in the collection. Values are compared case-insensitively.

    Parameters

    • a: number
    • Optional b: string

    Returns string

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

remove

  • remove(item): boolean

  • Removes a display text value from the collection.

    Display text values are compared case-insensitively.

    Parameters

    • item: string

      The display text value to remove from the collection.

    Returns boolean

removeAt

  • removeAt(index): void

  • Removes the display text value at the specified index.

    Throws

    [[ArgumentOutOfRangeException]] 'index' is less than 0 or greater than or equal to [[count]].

    Throws

    [[InvalidOperationException]] This operation removes the last item in the collection and it is owned by a [[FixedValuesFilter]] which only allowed the values in the collection. Clearing the collection would prevent the filter from including any values, which is not allowed for a FixedValuesFilter.

    Parameters

    • index: number

      The 0-based index of the value to remove.

    Returns void

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