Module: nmodule/webEditors/rc/wb/table/model/TableModel


new (require("nmodule/webEditors/rc/wb/table/model/TableModel"))( [params])

API Status: Development

Table Model, for use in backing a Table widget or similar.

Parameters:
Name Type Argument Description
params Object <optional>
Properties
Name Type Argument Description
columns Array.<module:nmodule/webEditors/rc/wb/table/model/Column> <optional>
rows Array <optional>

if given, the values will be converted to
the model's initial rows by passing them through makeRow().

Mixes In:
  • tinyevents

Methods


getColumn(name)

Get the column in this model matching the given name.

Parameters:
Name Type Description
name String
Returns:

the matching
column, or null if not found

Type
module:nmodule/webEditors/rc/wb/table/model/Column

getColumnIndex(column)

Get the index of the given column.

Parameters:
Name Type Description
column module:nmodule/webEditors/rc/wb/table/model/Column
Returns:

the column's index, or -1 if not found

Type
number

getColumns( [flags])

Get the current set of columns, optionally filtered by flags.

Parameters:
Name Type Argument Description
flags Number <optional>

if given, only return columns that have these
flags.

Returns:
Type
Array.<module:nmodule/webEditors/rc/wb/table/model/Column>

getEditableColumns()

Return all columns with the EDITABLE flag set.

Returns:
Type
Array.<module:nmodule/webEditors/rc/wb/table/model/Column>

getRowIndex(row)

Get the index of the given row.

Parameters:
Name Type Description
row module:nmodule/webEditors/rc/wb/table/model/Row
Returns:

the row's index, or -1 if not found

Type
number

getRows()

Get the current set of rows.

Returns:
Type
Array.<module:nmodule/webEditors/rc/wb/table/model/Row>

getValueAt(x, y)

Ask the column at the given index for the value from the row at the
given index.

Parameters:
Name Type Description
x Number

column index

y Number

row index

Returns:

promise to be resolved with the value

Type
Promise

insertColumns(toInsert [, index])

Add new columns to the model. Will trigger a columnsAdded tinyevent.

Parameters:
Name Type Argument Description
toInsert Array.<module:nmodule/webEditors/rc/wb/table/model/Column>
index Number <optional>

index to insert the columns; will append to the
end if omitted

Returns:

promise to be resolved if the insert is
successful

Type
Promise

insertRows(toInsert [, index])

Add new rows to the model. If non-Row instances are given, they will be
converted to Rows using makeRow().

Will trigger a rowsAdded tinyevent.

Parameters:
Name Type Argument Description
toInsert Array.<(module:nmodule/webEditors/rc/wb/table/model/Row|*)>
index Number <optional>

index to insert the rows; will append to the
end if omitted

Returns:

promise to be resolved if the insert is
successful

Type
Promise

makeRow(subject)

Instantiate a new row for the given subject. insertRows will delegate
to this if values are passed in rather than Row instances. Override
as necessary.

Parameters:
Name Type Description
subject *
Returns:
Type
module:nmodule/webEditors/rc/wb/table/model/Row

removeColumns(toRemove [, end])

Remove columns from the model. Will trigger a columnsRemoved tinyevent.

Parameters:
Name Type Argument Description
toRemove Array.<module:nmodule/webEditors/rc/wb/table/model/Column> | Number

the columns to remove; or, start index

end Number <optional>

end index

Returns:

promise to be resolved if the remove is
successful

Type
Promise

removeRows(toRemove [, end])

Remove rows from the model. Will trigger a rowsRemoved tinyevent, with
parameters:

  • rowsRemoved: the rows that were removed
  • indices: the original indices of the rows that were removed

Note that rowsRemoved and indices will always be sorted by their
original index in the model's rows, regardless of the order of rows passed
to the removeRows function.

Parameters:
Name Type Argument Description
toRemove Array.<module:nmodule/webEditors/rc/wb/table/model/Row> | Number

the rows to remove; or, start index

end <optional>

end index

Returns:

promise to be resolved if the remove is
successful

Type
Promise

sort(sortFunction)

Sort the table's rows according to the given sort function. Emits a
rowsReordered event.

Remember that Array#sort is synchronous, so if the sort needs to use
any data that is asynchronously retrieved, the async work must be performed
before the sort so that the sort function can work synchronously.

Parameters:
Name Type Description
sortFunction function

standard array sort function to receive
two Row instances

Throws:

if a non-Function is given

Type
Error