BiDataTable

This class represents a data table inside a data set. A data table consists of columns and rows.

This class extends BiObject and therefore all methods and fields available for BiObject are also available for BiDataTable .

Constructor

new BiDataTable ( [ sName ] )

Parameters

NameTypeOptionalDefaultDescripton
sNameStringcheckedThe name of the table.

Properties

NameTypegetsetDescripton
columnsBiDataColumn[]checkedThe columns in the table
dataReadyBooleancheckedThis is true if the data is ready. This is always true for a BiDataTable but might not be true for a sub class.
dataSetBiDataSetcheckedThis is the data set that the table is part of
nameStringcheckedThe name of the table.
rowsBiDataRow[]checkedThe rows in the table

Methods

NameDescription
addColumnAdds a column to the table.
addRowAdds a row to the table.
getColumnByNameReturns the column with the given name.
removeColumnRemoves a column from the table.
removeRowRemoves a row from the table.

Events

None.

Static Methods

None.

Static Fields

None.

Remarks

None.

Method Details

addColumn

Adds a column to the table.

Syntax

object.addColumn ( oColumn [ ,oBefore ] )

Parameters

NameTypeOptionalDefaultDescripton
oColumnBiDataColumnThe column to add
oBeforeBiDataColumncheckedIf provided the new column is added before this

Return Type

void

addRow

Adds a row to the table.

Syntax

object.addRow ( oRow [ ,oBefore ] )

Parameters

NameTypeOptionalDefaultDescripton
oRowBiDataRowThe row to add
oBeforeBiDataRowcheckedIf provided the new row is added before this

Return Type

void

getColumnByName

Returns the column with the given name.

Syntax

object.getColumnByName ( s )

Parameters

NameTypeOptionalDefaultDescripton
sStringThe name of the column to get

Return Type

BiDataColumn

removeColumn

Removes a column from the table.

Syntax

object.removeColumn ( oColumn )

Parameters

NameTypeOptionalDefaultDescripton
oColumnBiDataColumnThe column to remove

Return Type

BiDataColumn

removeRow

Removes a row from the table.

Syntax

object.removeRow ( oRow )

Parameters

NameTypeOptionalDefaultDescripton
oRowBiDataRowThe row to remove

Return Type

BiDataRow