@mobilize/wms-components documentation
  1. Classes
  2. XamGridRowsManager

File

projects/wms-framework/src/lib/models/controls/XamGridRowsManager.ts

Description

A class representing the XamGrid RowsManager.

Extends

RowsManager

Index

Properties
Methods

Constructor

constructor(xamGrid: XamGridModel)
Defined in projects/wms-framework/src/lib/models/controls/XamGridRowsManager.ts:37

Creates a new instance of XamGridRowsManager.

Parameters :
Name Type Optional
xamGrid XamGridModel No

Properties

Private _grid
Type : XamGridModel
Defined in projects/wms-framework/src/lib/models/controls/XamGridRowsManager.ts:37

Internal XamGrid reference.
Private _addNewRowBottom
Type : any
Inherited from RowsManager
Defined in RowsManager:55

Internal reference to the newly bottom top row
Private _addNewRowTop
Type : AddNewRow
Inherited from RowsManager
Defined in RowsManager:46

Internal reference to the newly added top row
Private _cachedRows
Type : any
Inherited from RowsManager
Defined in RowsManager:216

Cached collection of rows to avoid unnecesary functions executions.
Public _items
Type : XamGridRow[]
Inherited from RowsManager
Defined in RowsManager:192

Internal items collection.
Public _itemsSource
Type : any
Inherited from RowsManager
Defined in RowsManager:168

Internal itemsSource collection
Private _rowBaseCollection
Type : RowBaseCollection
Inherited from RowsManager
Defined in RowsManager:200

Internal RowBaseCollection.
Private _rows
Type : any
Inherited from RowsManager
Defined in RowsManager:208

Internal rows collection.
DataManager
Type : any
Inherited from RowsManager
Defined in RowsManager:97

DataManager
Public Level
Type : number
Inherited from RowsManager
Defined in RowsManager:176

Level property
Public ParentRow
Type : any
Inherited from RowsManager
Defined in RowsManager:184

Reference to the parent row.
Protected _columnLayout
Type : ColumnLayout
Inherited from RowsManagerBase
Defined in RowsManagerBase:32

Internal ColumnLayout.

Methods

add
add(item: any)
Inherited from RowsManager
Defined in RowsManager:241

Creates a new item.

Parameters :
Name Type Optional
item any No
Returns : void
AddItem
AddItem(addedObject: XamGridRow)
Inherited from RowsManager
Defined in RowsManager:279

Adds new node to the collection

Parameters :
Name Type Optional
addedObject XamGridRow No
Returns : void
Clear
Clear()
Inherited from RowsManager
Defined in RowsManager:255

Clears items.

Returns : void
CreateItem
CreateItem()
Inherited from RowsManager
Defined in RowsManager:266

Creates a new item.

Returns : XamGridRow
Private fireItemsSourceChangeIfNotObservable
fireItemsSourceChangeIfNotObservable(data: Iterable<any>)
Inherited from RowsManager
Defined in RowsManager:516

Explicitly fires a ColumnLayout change

Parameters :
Name Type Optional
data Iterable<any> No
Returns : void
GetDataItem
GetDataItem(index: number, data: any)
Inherited from RowsManager
Defined in RowsManager:379

Gets the row by index and stores the row in the cache

Parameters :
Name Type Optional Default value
index number No
data any No null
Returns : XamGridRow
getInternalData
getInternalData()
Inherited from RowsManager
Defined in RowsManager:423

Gets the data to be used to populate the Rows information

Returns : any
GetRecord
GetRecord(index: number, data: any)
Inherited from RowsManager
Defined in RowsManager:412

Gets the record by index using the given data or retrieve the data from the grid

Parameters :
Name Type Optional Default value
index number No
data any No null
Returns : any
getValueFromItemsSource
getValueFromItemsSource(index: number)
Inherited from RowsManager
Defined in RowsManager:453

Gets the value from the ItemSource based on its index

Parameters :
Name Type Optional
index number No
Returns : any
hasSortOrFilter
hasSortOrFilter()
Inherited from RowsManager
Defined in RowsManager:439

Indicates if the grid has filters or sorted columns

Returns : boolean
InsertItem
InsertItem(index: number, insertedObject: XamGridRow)
Inherited from RowsManager
Defined in RowsManager:322

Inserts a new Item into the collection in the given index.

Parameters :
Name Type Optional
index number No
insertedObject XamGridRow No
Returns : void
InvalidateData
InvalidateData()
Inherited from RowsManager
Defined in RowsManager:147

Clears data

Returns : void
InvalidateRows
InvalidateRows(unregister: boolean)
Inherited from RowsManager
Defined in RowsManager:155

Clears rows

Parameters :
Name Type Optional
unregister boolean No
Returns : void
OnItemsSourceChanged
OnItemsSourceChanged(invalidateSelectionAndActivation: boolean)
Inherited from RowsManager
Defined in RowsManager:106

Callback function when the ItemsSource have changed

Parameters :
Name Type Optional
invalidateSelectionAndActivation boolean No
Returns : void
RemoveItem
RemoveItem(removedObject: XamGridRow)
Inherited from RowsManager
Defined in RowsManager:290

Remove the given node of the collection

Parameters :
Name Type Optional
removedObject XamGridRow No
Returns : boolean
RemoveRange
RemoveRange(itemsToRemove: IList<XamGridRow>)
Inherited from RowsManager
Defined in RowsManager:310

Remove the given list of items to remove

Parameters :
Name Type Optional
itemsToRemove IList<XamGridRow> No
Returns : void
toArray
toArray()
Inherited from RowsManager
Defined in RowsManager:470

Convert the XamGridRowCollection to a simple array.

Returns : any[]
UnhookDataManager
UnhookDataManager(clearChildRows: boolean, clearSelection: boolean, clearGroupBy: boolean)
Inherited from RowsManager
Defined in RowsManager:130

Refresh data manager property

Parameters :
Name Type Optional
clearChildRows boolean No
clearSelection boolean No
clearGroupBy boolean No
Returns : void 
import { RowsManager } from './RowsManager';
import { ColumnLayout } from './ColumnLayout';
import { XamGridModel } from './XamgridModel';

/**
 * A class representing the XamGrid RowsManager.
 *
 * @export
 * @class XamGridRowsManager
 * @extends {RowsManager}
 * @wType Infragistics.Controls.Grids.RowsManager
 */
export class XamGridRowsManager extends RowsManager {
  /**
   * Internal XamGrid reference.
   *
   * @private
   * @type {XamGridModel}
   * @memberof {XamGridRowsManager}
   */
  private _grid: XamGridModel;

  /**
   * Creates a new instance of XamGridRowsManager.
   *
   * @param {XamGridModel} xamGrid
   * @memberof {XamGridRowsManager}
   */
  constructor(xamGrid: XamGridModel) {
    const columnLayout = new ColumnLayout(xamGrid);
    super(0, columnLayout, null);
    this._grid = xamGrid;
  }
}

result-matching ""

    No results matching ""