ColumnCollection Class

File
wijmo.grid.js
Module
wijmo.grid
Base Class
RowColCollection
Show
   

Represents a collection of Column objects in a FlexGrid control.

Constructor

Properties

Methods

Events

Constructor

constructor

constructor(g: FlexGrid, defaultSize: number): RowColCollection

Initializes a new instance of the RowColCollection class.

Parameters
Inherited From
RowColCollection
Returns
RowColCollection

Properties

defaultSize

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

Inherited From
RowColCollection
Type
number

describedById

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 describedById instead.

Type
string

firstVisibleIndex

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

Type

frozen

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.

Inherited From
RowColCollection
Type
number

grid

Gets the FlexGrid that owns this collection.

Inherited From
RowColCollection
Type
FlexGrid

isUpdating

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

Inherited From
ObservableArray
Type

maxSize

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

Inherited From
RowColCollection
Type
number

minSize

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

Inherited From
RowColCollection
Type
number

visibleLength

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

Inherited From
RowColCollection
Type
number

Methods

beginUpdate

beginUpdate(): void

Suspends notifications until the next call to endUpdate.

Inherited From
RowColCollection
Returns
void

canMoveElement

canMoveElement(src: number, dst: number): boolean

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

Parameters
Inherited From
RowColCollection
Returns
boolean

clear

clear(): void

Removes all items from the array.

Inherited From
ObservableArray
Returns
void

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
Inherited From
ObservableArray
Returns
void

endUpdate

endUpdate(): void

Resumes notifications suspended by a call to beginUpdate.

Inherited From
ObservableArray
Returns
void

getColumn

getColumn(name: string): Column

Gets a column by name or by 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
Returns
Column

getItemAt

getItemAt(position: number): number

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

Parameters
Inherited From
RowColCollection
Returns
number

getNextCell

getNextCell(index: number, move: SelMove, pageSize: number): void

Finds the next visible cell for a selection change.

Parameters
Inherited From
RowColCollection
Returns
void

getTotalSize

getTotalSize(): number

Gets the total size of the elements in the collection.

Inherited From
RowColCollection
Returns
number

implementsInterface

implementsInterface(interfaceName: string): boolean

Returns true if the caller queries for a supported interface.

Parameters
Inherited From
ObservableArray
Returns
boolean

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
Returns
number

insert

insert(index: number, item: any): void

Inserts an item at a specific position in the array.

Parameters
Inherited From
ObservableArray
Returns
void

isFrozen

isFrozen(index: number): boolean

Checks whether a column or row is frozen.

Parameters
Inherited From
RowColCollection
Returns
boolean

moveElement

moveElement(src: number, dst: number): void

Moves an element from one position to another.

Parameters
Inherited From
RowColCollection
Returns
void

onCollectionChanged

onCollectionChanged(e?: NotifyCollectionChangedEventArgs): void

Keeps track of dirty state and invalidate grid on changes.

Parameters
Inherited From
RowColCollection
Returns
void

push

push(item: any): number

Appends an item to the array.

Parameters
Inherited From
RowColCollection
Returns
number

remove

remove(item: any): boolean

Removes an item from the array.

Parameters
Inherited From
ObservableArray
Returns
boolean

removeAt

removeAt(index: number): void

Removes an item at a specific position in the array.

Parameters
Inherited From
ObservableArray
Returns
void

setAt

setAt(index: number, item: any): void

Assigns an item at a specific position in the array.

Parameters
Inherited From
ObservableArray
Returns
void

slice

slice(begin?: number, end?: number): any[]

Creates a shallow copy of a portion of an array.

Parameters
Inherited From
ObservableArray
Returns
any[]

sort

sort(compareFn?: Function): this

Sorts the elements of the array in place.

Parameters
Inherited From
ObservableArray
Returns
this

splice

splice(index: number, count: number, item?: any): any[]

Removes or adds items to the array.

Parameters
Inherited From
RowColCollection
Returns
any[]

Events

collectionChanged

Occurs when the collection changes.

Inherited From
ObservableArray
Arguments
NotifyCollectionChangedEventArgs