[]
DEMOS DOCS API
DOWNLOAD NEED HELP? BOOK DEMO
(Showing Draft Content)

ColumnCollection Class

ColumnCollection Class

Represents a collection of Column objects in a FlexGrid control.

Heirarchy

Constructors

Properties

Methods

Events

Constructors

constructor

Properties

defaultSize

defaultSize: number

Gets or sets the default size of elements in the collection.

describedById

describedById: string

Gets or sets the ID of an element that contains a description of the column headers.

The ID is used as the value of the aria-describedby attribute for all column header elements. For column-specific descriptions, use the column's Column.describedById instead.

firstVisibleIndex

firstVisibleIndex: number

Gets the index of the first visible column (where the outline tree is displayed).

frozen

frozen: number

Gets or sets the number of frozen rows or columns in the collection.

Frozen rows and columns do not scroll, and instead remain at the top or left of the grid, next to the fixed cells. Unlike fixed cells, however, frozen cells may be selected and edited like regular cells.

frozenEnd

frozenEnd: number

Gets or sets the number of frozen rows or columns at the end in the collection.

Frozen rows and columns do not scroll, and instead remain at the top or left of the grid, next to the fixed cells. Unlike fixed cells, however, frozen cells may be selected and edited like regular cells.

grid

grid: FlexGrid

Gets the FlexGrid that owns this collection.

isUpdating

isUpdating: boolean

Gets a value that indicates whether notifications are currently suspended (see beginUpdate and endUpdate).

lastFrozen

lastFrozen: RowCol | null

get the last frozen column or row (in the case of frozen on the right/bottom, the count goes from right to left or bottom to top, respectively)

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

maxSize

maxSize: number

Gets or sets the maximum size of elements in the collection.

minSize

minSize: number

Gets or sets the minimum size of elements in the collection.

visibleLength

visibleLength: number

Gets the number of visible elements in the collection (Row.isVisible).

Methods

at

  • at(index: number): Column | undefined

  • Takes an integer value and returns the item at that index, allowing for positive and negative integers. Negative integers count back from the last item in the array.

    Parameters

    • index: number

    Returns Column | undefined

beginUpdate

  • beginUpdate(): void

canMoveElement

  • canMoveElement(src: number, dst: number, adjustFrozenCount?: boolean): boolean

  • Checks whether an element can be moved from one position to another.

    Parameters

    • src: number

      The index of the element to move.

    • dst: number

      The position to which to move the element, or specify -1 to append the element.

    • Optional adjustFrozenCount: boolean

      Whether to adjust the frozen element count when the movement is into or out of the frozen area.

    Returns boolean

    Returns true if the move is valid, false otherwise.

clear

  • clear(): void

concat

  • concat(...items: ConcatArray<Column>[]): Column[]
  • concat(...items: (T | ConcatArray<T>)[]): Column[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Column>[]

      Additional items to add to the end of array1.

    Returns Column[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Column[]

deferUpdate

  • deferUpdate(fn: Function): void

  • Executes a function within a beginUpdate/endUpdate block.

    The collection will not be refreshed until the function finishes. This method ensures endUpdate is called even if the function throws an exception.

    Parameters

    • fn: Function

      Function to be executed without updates.

    Returns void

endUpdate

  • endUpdate(isSilent?: boolean): void

  • Resumes notifications suspended by a call to beginUpdate.

    Parameters

    • Optional isSilent: boolean

      whether to end update silently i.e without raising collectionChanged event

    Returns void

entries

  • entries(): IterableIterator<[number, Column]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Column]>

every

  • every(callbackfn: Object, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: Object

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

filter

  • filter<S>(callbackfn: Object, thisArg?: any): S[]
  • filter(callbackfn: Object, thisArg?: any): Column[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: Object

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: Object

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Column[]

forEach

  • forEach(callbackfn: Object, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: Object

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

getColumn

  • getColumn(name: string | number): Column

  • Gets a column by name, binding, or index.

    The method searches the column by name. If a column with the given name is not found, it searches by binding. The searches are case-sensitive.

    Parameters

    • name: string | number

      The name, binding, or index to find.

    Returns Column

    The column with the specified name or binding, or null if not found.

getFrozenSize

  • getFrozenSize(): number

getItemAt

  • getItemAt(position: number): number

  • Gets the index of the element at a given physical position.

    Parameters

    • position: number

      Position of the item in the collection, in pixels.

    Returns number

getNextCell

  • getNextCell(index: number, move: SelMove, pageSize?: number): any

  • Finds the next visible cell for a selection change.

    Parameters

    • index: number

      Starting index for the search.

    • move: SelMove

      Type of move (size and direction).

    • Optional pageSize: number

      Size of a page (in case the move is a page up/down).

    Returns any

getTotalSize

  • getTotalSize(): number

implementsInterface

  • implementsInterface(interfaceName: string): boolean

  • Returns true if the caller queries for a supported interface.

    Parameters

    • interfaceName: string

      Name of the interface to look for.

    Returns boolean

    True if the caller queries for a supported interface.

indexOf

  • indexOf(name: any): number

  • Gets the index of a column by name or binding.

    The method searches the column by name. If a column with the given name is not found, it searches by binding. The searches are case-sensitive.

    Parameters

    • name: any

      The name or binding to find.

    Returns number

    The index of column with the specified name or binding, or -1 if not found.

insert

  • insert(index: number, item: Column): void

  • Inserts an item at a specific position in the array.

    Parameters

    • index: number

      Position where the item will be added.

    • item: Column

      Item to add to the array.

    Returns void

isFrozen

  • isFrozen(index: number): boolean

  • Checks whether a column or row is frozen. we take into account the case this.frozen < 0.

    Parameters

    • index: number

      The index of the column or row to check.

    Returns boolean

join

  • join(separator?: string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Column, fromIndex?: number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Column

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: Object, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: Object

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

moveElement

  • moveElement(src: number, dst: number, adjustFrozenCount?: boolean): boolean

  • Moves an element from one position to another.

    Parameters

    • src: number

      Index of the element to move.

    • dst: number

      Position where the element should be moved to (-1 to append).

    • Optional adjustFrozenCount: boolean

      Whether to adjust the frozen element count when the movement is into or out of the frozen area.

    Returns boolean

    Returns true if the element was moved, false otherwise.

onCollectionChanged

push

remove

  • remove(item: Column): boolean

  • Removes an item from the array.

    Parameters

    • item: Column

      Item to remove.

    Returns boolean

    True if the item was removed, false if it wasn't found in the array.

removeAt

  • removeAt(index: number): void

  • Removes an item at a specific position in the array.

    Parameters

    • index: number

      Position of the item to remove.

    Returns void

reverse

  • Reverses the elements in an Array.

    Returns Column[]

setAt

  • setAt(index: number, item: Column): void

  • Assigns an item at a specific position in the array.

    Parameters

    • index: number

      Position where the item will be assigned.

    • item: Column

      Item to assign to the array.

    Returns void

shift

  • Removes the first element from the array and returns that element.

    This method changes the length of the array.

    Returns Column

slice

  • slice(begin?: number, end?: number): Column[]

  • Creates a shallow copy of a portion of an array.

    Parameters

    • Optional begin: number

      Position where the copy starts.

    • Optional end: number

      Position where the copy ends.

    Returns Column[]

    A shallow copy of a portion of an array.

some

  • some(callbackfn: Object, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: Object

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: Function): this

  • Sorts the elements of the array in place.

    Parameters

    • Optional compareFn: Function

      Specifies a function that defines the sort order. If specified, the function should take two arguments and should return -1, +1, or 0 to indicate the first argument is smaller, greater than, or equal to the second argument. If omitted, the array is sorted in dictionary order according to the string conversion of each element.

    Returns this

    A copy of the sorted array.

splice

  • splice(index: number, count: number, ...item: Column[]): Column[]

  • Removes or adds items to the array.

    Parameters

    • index: number

      Position where items are to be added or removed.

    • count: number

      Number of items to remove from the array.

    • Rest ...item: Column[]

    Returns Column[]

    An array containing the removed elements.

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Column[]): number

  • Adds one or more elements to the beginning of the array and returns the new length of the array.

    Parameters

    Returns number

    The new length of the array.

values

  • values(): IterableIterator<Column>

  • Returns an iterable of values in the array

    Returns IterableIterator<Column>

Events

collectionChanged

collectionChanged: Event<ObservableArray<Column>, NotifyCollectionChangedEventArgs<Column>>

Occurs when the collection changes.