Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class HiddenRowCollection

A collection of hidden [[WorksheetRow]] instances.

The rows in this collection do not necessarily have their [[RowColumnBase.hidden]] property set to True. This collection applies to a [[worksheet]], but belongs to a [[CustomView]]. When the CustomView which owns this collection is applied, the rows in this collection will have their [[RowColumnBase.hidden]] property set to True. All other rows in the associated worksheet will be made visible.

See

[[CustomView.getHiddenRows]]

Hierarchy

Hierarchy

  • Base
    • HiddenRowCollection

Implements

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 rows in the collection. The number of rows in the collection.

    Returns number

worksheet

  • get worksheet(): Worksheet

  • Gets the worksheet associated with this collection. The worksheet associated with this collection.

    Returns Worksheet

Methods

[iterator]

  • [iterator](): EnumeratorWrapper<WorksheetRow>

  • Returns EnumeratorWrapper<WorksheetRow>

add_1

  • add_1(row): void

  • Adds a row to the collection.

    This collection does not allow duplicate values. If the specified row already exists in the collection, nothing will happen. This collection also keeps itself sorted, so the row added will not necessarily be added at the end of the collection.

    Throws

    [[ArgumentNullException]] 'row' is null.

    Throws

    [[ArgumentException]] 'row' does not belong to the same worksheet this collection is associated with.

    Parameters

    • row: WorksheetRow

      The row to be added to the hidden rows collection.

    Returns void

clear

  • clear(): void

  • Clears all rows from the collection.

    Returns void

contains

  • contains(row): boolean

  • Determines whether the specified row exists in the collection.

    Parameters

    Returns boolean

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getEnumerator

  • getEnumerator(): IEnumerator$1<WorksheetRow>

  • Returns IEnumerator$1<WorksheetRow>

getHashCode

  • getHashCode(): number

  • Returns number

item

  • item(a): WorksheetRow

  • Gets the row at the specified index. The row at the specified index.

    Throws

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

    Parameters

    • a: number

    Returns WorksheetRow

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

removeAt

  • removeAt(index): void

  • Removes the row at the specified index in the collection.

    Throws

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

    Parameters

    • index: number

      The zero-based index of the row in the collection.

    Returns void

remove_1

  • remove_1(row): boolean

  • Removes the specified row from the collection if it exists.

    Parameters

    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