Class YAHOO.ext.grid.DefaultDataModel

Object
   |
   +--YAHOO.ext.grid.AbstractDataModel
         |
         +--YAHOO.ext.grid.DefaultDataModel

Direct Known Subclasses:

YAHOO.ext.grid.LoadableDataModel

class YAHOO.ext.grid.DefaultDataModel

extends YAHOO.ext.grid.AbstractDataModel

This is the default implementation of a DataModel used by the Grid. It works with multi-dimensional array based data. Using the event system in the base class YAHOO.ext.grid.AbstractDataModel, all updates to this DataModel are automatically reflected in the user interface.
Usage:

 var myData = [
	["MSFT","Microsoft Corporation", "314,571.156", "32,187.000", "55000"],
	["ORCL", "Oracle Corporation", "62,615.266", "9,519.000", "40650"]
 ];
 var dataModel = new YAHOO.ext.grid.DefaultDataModel(myData);
 

Constructor Detail

YAHOO.ext.grid.DefaultDataModel

YAHOO.ext.grid.DefaultDataModel(data)

addRow

Number addRow(<Array> cellValues)

Adds a row to the dataset.

Parameters:
cellValues - The array of values for the new row

Returns:
The index of the added row

applySort

void applySort(suppressEvent)

Applies the last used sort to the current data.

filter

Number filter(<Object> query)

Filter the DataModel rows by the query defined in spec, see query() for more details on the query spec.

Parameters:
query - The query spec query()

Returns:
The number of rows removed

getRow

Array getRow(rowIndex)

Returns the column data for the specified row.

getRowCount

Number getRowCount()

Returns the number of rows in the dataset

getRowId

Number getRowId(rowIndex)

Returns the ID of the specified row. By default it return the value of the first column. Override to provide more advanced ID handling.

getRows

Array getRows(<Array> indexes)

Returns the column data for the specified rows as a multi-dimensional array: rows[3][0] would give you the value of row 4, column 0.

Parameters:
indexes - The row indexes to fetch

getValueAt

Object getValueAt(<Number> rowIndex, <Number> colIndex)

Returns the value at the specified data position

Parameters:
rowIndex -
colIndex -

insertRow

Number insertRow(<Number> index, <Array> cellValues)

Inserts a row a the specified location in the dataset.

Parameters:
index - The index where the row should be inserted
cellValues - The array of values for the new row

Returns:
The index the row was inserted in

query

Array query(<Object> spec, <Boolean> returnUnmatched)

Query the DataModel rows by the filters defined in spec, for example...

 // column 1 starts with Jack, column 2 filtered by myFcn, column 3 equals 'Fred'
 dataModel.filter({1: /^Jack.+/i}, 2: myFcn, 3: 'Fred'});
 

Parameters:
spec - The spec is generally an object literal consisting of column index and filter type. The filter type can be a string/number (exact match), a regular expression to test using String.search() or a function to call. If it's a function, it will be called with the value for the specified column and an array of the all column values for that row: yourFcn(value, columnData). If it returns anything other than true, the row is not a match.
returnUnmatched - True to return rows which don't match the query instead of rows that do match

Returns:
An array of row indexes that match

removeRow

void removeRow(<Number> index)

Remove a row.

Parameters:
index -

setDefaultSort

void setDefaultSort(columnModel, columnIndex, direction)

setValueAt

void setValueAt(<Object> value, <Number> rowIndex, <Number> colIndex)

Sets the specified value at the specified data position

Parameters:
value - The new value
rowIndex -
colIndex -

sort

void sort(<YAHOO.ext.grid.DefaultColumnModel> columnModel, <Number> columnIndex, <String> direction, suppressEvent)

Sorts the data by the specified column - Uses the sortType specified for the column in the passed columnModel.

Parameters:
columnModel - The ColumnModel for this dataset
columnIndex - The column index to sort by
direction - The direction of the sort ('DESC' or 'ASC')