构建 DataTable 类的新实例。
| 全称 | mx.datas.DataTable |
| 命名空间 | mx.datas |
| 类 | DataTable |
| 继承层次结构 | DataTableDataObject |
| 源文件 | ~\mx\scripts\datas\DataTable.js |
表示脱机内存数据中数据表的类。
示例 1
以下为 DataTable 的示例。说明了如何创建一个数据表，其行列都为空。
| JavaScript 代码 |
var table = new mx.datas.DataTable(); |
示例 2
以下为 DataTable 的示例。说明了如何传参数 DataColumn 对象集合，DataRow 对象集合创建一个数据表。
| JavaScript 代码 |
var table = new mx.datas.DataTable({
columns:[
new mx.datas.DataColumn({id:"name", label:"名字", type:"string"}),
new mx.datas.DataColumn({id:"age", label:"年龄", type:"number"}),
new mx.datas.DataColumn({id:"sex", label:"性别", type:"number"}),
new mx.datas.DataColumn({id:"birthday", label:"生日", type:"Date", pattern:"yyyy.MM.dd"})
],
rows:[
new mx.datas.DataRow({cells:[{value:"张三"}, {value:23},{value:"1", formattedValue:"男"}, {value:"1985-1-1"}]}),
new mx.datas.DataRow({cells:[{value:"李四"}, {value:24},{value:"0", formattedValue:"女"}, {value:"1984-1-1"}]}),
new mx.datas.DataRow({cells:[{value:"王五"}, {value:25},{value:"1", formattedValue:"男"}, {value:"1988-1-1"}]})
]
}); |
示例 3
以下为 DataTable 的示例。说明了如何创建一个数据表。
| JavaScript 代码 |
var table = new mx.datas.DataTable({
columns:[
{id:"name", label:"名字", type:"string"},
{id:"age", label:"年龄", type:"number"},
{id:"sex", label:"性别", type:"number"},
{id:"birthday", label:"生日", type:"Date", pattern:"yyyy.MM.dd"}
],
rows:[{
cells:[
[{value:"张三"}, {value:23},{value:"1", formattedValue:"男"}, {value:"1985-1-1"}]},
[{value:"李四"}, {value:24},{value:"0",formattedValue:"女"},{value:"1984-1-1"}],
[{value:"王五"}, {value:25},{value:"1",formattedValue:"男"}, {value:"1988-1-1"}]
]
}]
}); |
示例 4
以下为 DataTable 的示例。 说明了使用简单的参数格式创建 DataTable，方便数据传输。
| JavaScript 代码 |
var table = new mx.datas.DataTable({
cols:[
["name","名字"],
["age","年龄", "number"],
["sex","性别","number"],
["birthday","生日","Date","yyyy.MM.dd"]
],
rows:[
[{v:"张三"}, {v:23},{v:"1",f:"男"}, {v:"1985-1-1"}],
[{v:"李四"}, {v:24},{v:"0",f:"女"},{v:"1984-1-1"}],
[{v:"王五"}, {v:25},{v:"1",f:"男"}, {v:"1988-1-1"}]
]
}); |
示例 5
以下为 DataTable 的示例。 说明了使用简单的参数格式创建 DataTable，方便数据传输。
| JavaScript 代码 |
var table = new mx.datas.DataTable({
cols:[
["name","名字"],
["age","年龄", "number"],
["sex","性别","number"],
["birthday","生日","Date","yyyy.MM.dd"]
],
rows:[
["张三", 23,"男", "1985-1-1"],
["李四", 24,"女","1984-1-1"],
["王五", 25,"男", "1988-1-1"]
]
}); |
构造函数
| 名称 | 说明 |
| DataTable() | 构建 DataTable 类的新实例。 |
方法
字段
| 名称 | 说明 |
| columns | 获取该表的数据行 DataColumn 的集合。 |
| rows | 获取该表的数据行 DataRow 的集合。 |
| sortColumn | |
| sortOrder |
事件
| 名称 | 说明 |
| onchanged | |
| onchanging | |
| oncolumnCreated | |
| oncolumnCreating | |
| oncolumnDeleted | |
| oncolumnDeleting | |
| onrowCreated | |
| onrowCreating | |
| onrowDeleted | |
| onrowDeleting |
方法详细信息
addColumn(p_column, p_triggerEvent) 方法
添加一个数据列 DataColumn 作为表的最后一列，并将返回此数据列。
参数
- p_column指定的数据列。
- p_triggerEvent一个 Boolean 值，表示是否要触发 oncolumnCreated 事件。如果该值为 true，则触发事件；反之则不触发。
示例 1
以下是为向 DataColumn 追加数据列的示例。
| JavaScript 代码 |
table.addColumn(new mx.datas.DataColumn({type :"number", label :"身高", id:"height"}));
table.addColumn({id:"height", label :"身高", type :"number"});
table.addColumn(["height", "身高", "number"]);
table.addColumn("height", "身高", "number"); |
addColumn(p_id, p_label, p_type, p_triggerEvent) 方法
添加一个数据列 DataColumn 作为表的最后一列，并将返回此数据列。
参数
- p_id指定的数据列的字段名称。
- p_label指定的数据列的中文标题。
- p_type指定的数据列数据类型。
- p_triggerEvent一个 Boolean 值，表示是否要触发 oncolumnCreated 事件。如果该值为 true，则触发事件；反之则不触发。
示例 1
以下是为向 DataColumn 追加数据列的示例。
| JavaScript 代码 |
table.addColumn(new mx.datas.DataColumn({type :"number", label :"身高", id:"height"}));
table.addColumn({id:"height", label :"身高", type :"number"});
table.addColumn(["height", "身高", "number"]);
table.addColumn("height", "身高", "number"); |
addColumns(p_columns, p_triggerEvent) 方法
在指定的数据表最后一列追加 DataColumn 集合。
参数
- p_columns指定的数据列集合型。
- p_triggerEvent一个 Boolean 值，表示是否要触发 oncolumnCreated 事件。如果该值为 true，则触发事件；反之则不触发。
示例 1
以下为 DataTable 向数据表尾部添加数据列集合的示例。
| JavaScript 代码 |
// 示例 1
table.addColumns([
{id:"name", label:"名字", type:"string"},
{id:"age", label:"年龄", type:"number"},
new mx.datas.DataColumn({id:"sex", label:"性别", type:"number"}),
{id:"birthday", label:"生日", type:"Date", pattern:"yyyy.MM.dd"}
]);
// 示例 2
table.addColumns([
["name", "名字", "string"],
["age", "年龄", "number"],
["sex", "性别","number"}],
["birthday", "生日","Date", "yyyy-MM-dd"]
]); |
addRow(p_row, p_triggerEvent) 方法
向该表追加指定的数据行 DataRow ，并将返回此数据行。
参数
- p_row指定的数据行。为 null 时，追加一空行。
- p_triggerEvent一个 Boolean 值，表示是否要触发 onrowCreated 事件。如果该值为 true，则触发事件；反之则不触发。
示例 1
以下是为向 DataRow 中追加数据行的示例。
| JavaScript 代码 |
// 增加空行，本行 cells 中的 value 为空
table.addRow();
// 参数为json对象时
table.addRow(
{cells:[{value:"张三"}, {value:23},{value:"1", formattedValue:"男"}, {value:"1985-1-1"}]}
);
// 参数为DataRow对象时
table.addRow(
new mx.datas.DataRow({cells:[{value:"张三"}, {value:23},{value:"1", formattedValue:"男"}, {value:"1985-1-1"}]})
); |
getColumnProperties(p_columnIndex) 方法
获取当前数据表的指定数据列索引的自定义属性集合。
参数
- p_columnIndex列索引。
getColumnProperty(p_columnIndex, p_property) 方法
获取当前数据表的指定数据列索引的自定义属性值。
参数
- p_columnIndex列索引。
- p_property数据列自定义属性名称。
getCustomProperty(p_key) 方法
getFilteredRows(p_filters) 方法
获取指定过滤条件筛选出的数据行 DataRow 集合。
参数
- p_filters数据表过滤条件。 p_filters example: [{column: 3, value: 42}, {column: 2, minValue: 'bar', maxValue: 'foo'}]
getFormattedValue(p_rowIndex, p_columnIndex) 方法
获取指定行、列索引交叉处的数据格式化值。
参数
- p_rowIndex行索引。
- p_columnIndex列索引。
getNumberOfColumns() 方法
获取当前数据表对象的列数。
getNumberOfRows() 方法
获取当前数据表对象的行数。
getTableProperties() 方法
获取当前数据表的自定义属性集合。
getTableProperty(p_property) 方法
获取当前数据表指定属性的属性值。
参数
- p_property
getValue(p_rowIndex, p_columnIndex) 方法
获取指定行、列索引交叉处的数据值。
参数
- p_rowIndex行索引。
- p_columnIndex列索引。
insertColumn(p_atColumnIndex, p_column, p_triggerEvent) 方法
在指定的行索引前插入一列 DataColumn ，并将返回此数据列。
参数
- p_atColumnIndex指定的数据列要插入的索引位置。
- p_column指定的数据列。
- p_triggerEvent一个 Boolean 值，表示是否要触发 oncolumnCreated 事件。如果该值为 true，则触发事件；反之则不触发。
示例 1
以下是为向 DataColumn 指定位置插入数据列的示例。
| JavaScript 代码 |
// 在索引为 1 的位置插入一列的示例
table.insertColumn(1, new mx.datas.DataColumn({type :"number", label :"身高", id:"height"}));
table.insertColumn(1, {id:"height", label :"身高", type :"number"});
table.insertColumn(1, ["height", "身高", "number"]);
table.insertColumn(1, "height", "身高", "number"); |
insertColumn(p_atColumnIndex, p_id, p_label, p_type, p_triggerEvent) 方法
在指定的行索引前插入一列 DataColumn ，并将返回此数据列。
参数
- p_atColumnIndex指定的数据列要插入的索引位置。
- p_id指定的数据列的字段名称。
- p_label指定的数据列的中文标题。
- p_type指定的数据列数据类型。
- p_triggerEvent一个 Boolean 值，表示是否要触发 oncolumnCreated 事件。如果该值为 true，则触发事件；反之则不触发。
示例 1
以下是为向 DataColumn 指定位置插入数据列的示例。
| JavaScript 代码 |
// 在索引为 1 的位置插入一列的示例
table.insertColumn(1, new mx.datas.DataColumn({type :"number", label :"身高", id:"height"}));
table.insertColumn(1, {id:"height", label :"身高", type :"number"});
table.insertColumn(1, ["height", "身高", "number"]);
table.insertColumn(1, "height", "身高", "number"); |
insertColumns(p_atColumnIndex, p_columns, p_triggerEvent) 方法
在指定的列索引前插入数据列 DataColumn 集合。
参数
- p_atColumnIndex指定的数据列要插入的索引位置。
- p_columns指定的数据列集合型。
- p_triggerEvent一个 Boolean 值，表示是否要触发 oncolumnCreated 事件。如果该值为 true，则触发事件；反之则不触发。
示例 1
以下为 DataTable 向数据表中添加数据列集合的示例。
| JavaScript 代码 |
// 示例 1
table.insertColumns(1, [
{id:"name", label:"名字", type:"string"},
{id:"age", label:"年龄", type:"number"},
new mx.datas.DataColumn({id:"sex", label:"性别", type:"number"}),
{id:"birthday", label:"生日", type:"Date", pattern:"yyyy.MM.dd"}
]);
// 示例 2
table.insertColumns(1, [
["name", "名字", "string"],
["age", "年龄", "number"],
["sex", "性别","number"}],
["birthday", "生日","Date", "yyyy-MM-dd"]
]); |
insertRow(p_atRowIndex, p_row, p_triggerEvent) 方法
在指定的行索引前插入一个数据行 DataRow ，将其添加到当前表中，并将返回此数据行。
参数
- p_atRowIndex指定的数据行要插入的索引位置。
- p_row指定的数据行，如果为null，插入空行。
- p_triggerEvent一个 Boolean 值，表示是否要触发 onrowCreated 事件。如果该值为 true，则触发事件；反之则不触发。
示例 1
以下是为向 DataRow 指定位置插入数据行的示例。
| JavaScript 代码 |
// 在索引为 1 的位置插入一空行的示例
table.insertRow(1);
// 在索引为 1 的位置插入一行的示例
table.insertRow(1,
{cells:[{value:"张三"}, {value:23},{value:"1", formattedValue:"男"}, {value:"1985-1-1"}]}
);
table.insertRow(1,
new mx.datas.DataRow({cells:[{value:"张三"}, {value:23},{value:"1", formattedValue:"男"}, {value:"1985-1-1"}]})
);
table.insertRow(1, {value:"张三"}, {value:23},{value:"1",formattedValue:"男"}, {value:"1985-1-1"});
table.insertRow(1, [{v:"张三"}, {v:23},{v:"1",f:"男"}, {v:"1985-1-1"}]);
table.insertRow(1, ["张三", 23,"男", "1985-1-1"]); |
insertRows(p_atRowIndex, p_rows, p_triggerEvent) 方法
在指定的行索引前插入一个数据行 DataRow 集合，将其添加到当前表中。
参数
- p_atRowIndex指定的数据行要插入的索引位置。
- p_rows指定的数据行集合型，如果为数字则增加 p_rows 行空行。
- p_triggerEvent一个 Boolean 值，表示是否要触发 onrowCreated 事件。如果该值为 true，则触发事件；反之则不触发。
示例 1
以下为 DataTable 向数据表中添加数据集合的示例。
| JavaScript 代码 |
// 在下标为 1 的地方增加 3 空行
table.insertRows(1, 3);
// 参数为对象时的示例
table.insertRows(1, [
new mx.datas.DataRow({cells:[{value:"张三"}, {value:23},{value:"1",formattedValue:"男"}, {value:"1985-1-1"}]}),
new mx.datas.DataRow({cells:[{value:"李四"}, {value:24},{value:"0",formattedValue:"女"}, {value:"1984-1-1"}]}),
new mx.datas.DataRow({cells:[{value:"王五"}, {value:25},{value:"1",formattedValue:"男"}, {value:"1988-1-1"}]})
]);
// p_rows 为json对象时的示例
table.insertRows(1, [
{cells:[{value:"张三"}, {value:23},{value:"1", formattedValue:"男"}, {value:"1985-1-1"}]},
[{value:"李四"}, {value:24},{value:"0",formattedValue:"女"}, {value:"1984-1-1"}],
[{value:"王五"}, {value:25},{value:"1",formattedValue:"男"}, {value:"1988-1-1"}]
]);
table.insertRows(1, [
[{v:"张三"}, {v:23},{v:"1",f:"男"}, {v:"1985-1-1"}],
[{v:"李四"}, {v:24},{v:"0",f:"女"},{v:"1984-1-1"}],
[{v:"王五"}, {v:25},{v:"1",f:"男"}, {v:"1988-1-1"}]
]);
table.insertRows(1, [
["张三", 23,"男", "1985-1-1"],
["李四", 24,"女","1984-1-1"],
["王五", 25,"男", "1988-1-1"]
]); |
removeColumn(p_columnIndex, p_triggerEvent) 方法
删除指定列索引的数据列。
参数
- p_columnIndex待删除数据列 DataColumn 的索引位置。
- p_triggerEvent一个 Boolean 值，表示是否要触发 oncolumnDeleted 事件。如果该值为 true，则触发事件；反之则不触发。
示例 1
以下为从 DataTable 中从移除指定列的示例
| JavaScript 代码 |
//移除索引为 1 的列
table.removeColumn(1);
//移除 id 为 “NAME” 的列
table.removeColumn(“NAME”);
//移除列 dataColumn
table.removeColumn(dataColumn); |
removeColumns(p_startIndex, p_count, p_triggerEvent) 方法
从指定的索引开始删除指定数量的数据列 DataColumn 。
参数
- p_startIndex指定开始删除数据列 DataColumn 的索引位置。
- p_count待删除的数据列数量。
- p_triggerEvent
示例 1
以下为从 DataTable 中从移除列的示例
| JavaScript 代码 |
//从 索引 1 位置开始移除 2 列
table.removeColumns(1,2);
//从 列 id 为 “NAME”，“SEX”，的列
table.removeColumns(["NAME","SEX"]);
//从 列 column, column2, column3
table.removeColumns([column, column2, column3]);
// 移除所有列
table.removeColumns(-1); |
removeRow(p_rowIndex) 方法
删除指定行索引的数据行。
参数
- p_rowIndex待删除数据行 DataRow 的索引位置。
示例 1
以下为从 DataTable 中从移除指定行的示例
| JavaScript 代码 |
//移除索引为 1 的行
table.removeRows(1); |
removeRows(p_startIndex, p_count) 方法
从指定的索引开始删除指定数量的数据行 DataRow 。
参数
- p_startIndex指定开始删除数据行的索引位置。
- p_count待删除的数据行数量。
示例 1
以下为从 DataTable 中从移除行的示例
| JavaScript 代码 |
//从 索引 1 位置开始移除 2 行
table.removeRows(1,2);
// 移除所有行
table.removeRows(-1); |
setCell(p_rowIndex, p_columnIndex, p_opt_value, p_opt_formattedValue, p_opt_properties) 方法
在当前数据表的指定位置的设置数据单元格 DataCell 的值、格式化值以及可选属性集合。
参数
- p_rowIndex行索引。
- p_columnIndex列索引。
- p_opt_value数据单元格的值。
- p_opt_formattedValue数据单元格的格式化值。
- p_opt_properties数据单元格的自定义属性集合。
setColumnLabel(p_columnIndex, p_newLabel) 方法
setColumnProperties(p_columnIndex, p_properties) 方法
setColumnProperty(p_columnIndex, p_property, p_value) 方法
setColumns(p_columns) 方法
参数
- p_columns
setCustomeProperty(p_propertyKey, p_propertyValue) 方法
设置客户端数据对象指定属性的值。
参数
- p_propertyKey自定义属性的名称
- p_propertyValue自定义属性的值
继承自
setCustomProperties(p_properties) 方法
setRowProperties(p_rowIndex, p_properties) 方法
setRowProperty(p_rowIndex, p_property, p_value) 方法
setRows(p_rows) 方法
设置或重置当前数据表对象的数据行集合。
参数
- p_rows
setTableProperties(p_properties) 方法
设置当前数据表的自定义属性集合。
参数
- p_properties自定义属性集合。
setTableProperty(p_property, p_value) 方法
设置当前数据表的指定自定义属性的值。
参数
- p_property自定义属性名称。
- p_value自定义属性值。
sort(p_sortColumns, p_sortOrder) 方法
对指定列根据排序规则（升序、降序）进行排序。
参数
- p_sortColumns排序列，一个数组或者以逗号分隔的字符串。
- p_sortOrder排序规则（升序、降序）。