Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class WorksheetDataTableCollection

A collection of [[WorksheetDataTable]] instances on a worksheet.

Hierarchy

Hierarchy

  • Base
    • WorksheetDataTableCollection

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

    Returns number

Methods

[iterator]

  • [iterator](): EnumeratorWrapper<WorksheetDataTable>

  • Returns EnumeratorWrapper<WorksheetDataTable>

add

  • add(cellsInTable, columnInputCell, rowInputCell): WorksheetDataTable

  • Creates a new data table and adds it to the collection.

    The input cells specified must be different cell references and at least one must be non-null. See the [[WorksheetDataTable]] overview for more information on data tables.

    Throws

    [[ArgumentNullException]] 'cellsInTable' is null.

    Throws

    [[ArgumentException]] 'cellsInTable' is a region which does not belongs to the worksheet which owns this collection.

    Throws

    [[ArgumentException]] 'columnInputCell' is not null but does not belong to the worksheet which owns this collection.

    Throws

    [[ArgumentException]] 'rowInputCell' is not null but does not belong to the worksheet which owns this collection.

    Throws

    [[InvalidOperationException]] Both 'columnInputCell' and 'rowInputCell' are null.

    Throws

    [[InvalidOperationException]] 'columnInputCell' and 'rowInputCell' are the same cell.

    Throws

    [[InvalidOperationException]] 'columnInputCell' or 'rowInputCell' are contained in the 'cellsInTable' region.

    Throws

    [[InvalidOperationException]] One or more of the interior cells of the 'cellsInTable' region (all cells except the left-most column and top row) is an interior cell of another data table or is a cell in an array formula, and the entire range of that other entity extends outside the interior cells of 'cellsInTable'.

    Parameters

    • cellsInTable: WorksheetRegion

      The region of cells in the data table.

    • columnInputCell: WorksheetCell

      The cell used as the column-input cell in the data table.

    • rowInputCell: WorksheetCell

      The cell used as the row-input cell in the data table.

    Returns WorksheetDataTable

clear

  • clear(): void

  • Clears all data tables from the collection.

    Once a data table is removed from the collection, it can no longer be used.

    Returns void

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getHashCode

  • getHashCode(): number

  • Returns number

item

  • item(a): WorksheetDataTable

  • Gets the data table at the specified index in the collection. The data table at the specified index.

    Parameters

    • a: number

    Returns WorksheetDataTable

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

removeAt

  • removeAt(index): void

  • Removes the data table at the specified index from the collection.

    Once a data table is removed from the collection, it can no longer be used.

    Parameters

    • index: number

      The zero-based index of the data table to remove from the collection.

    Returns void

remove_1

  • remove_1(dataTable): boolean

  • Removes the specified data table from the collection.

    Once a data table is removed from the collection, it can no longer be used.

    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

Static staticInit

  • staticInit(): void

  • Returns void