import Grid from 'kqwebmap-project/src/ui/Grid.js'

public class | source

Grid

网格控件

See:

./manual/Grid.html

Constructor Summary

Public Constructor
public	constructor(id: String, options: Object) 构造函数

Method Summary

Public Methods
public	clearSelection(): Null 清除选定的行（或者单元格）
public	dataItem(row: Object): Object 返回指定的行（或者单元格）绑定的数据项
public	items(): Array 返回所有的数据项
public	select(rows: Object): Object 获取或设置选定的行（或者单元格）
public	setDataSource(dataSource: Array): Null 设置网格控件的数据源
public	setOptions(options: Object): Null 设置网格控件的配置参数

Public Constructors

public constructor(id: String, options: Object) source

构造函数

Params:

Name	Type	Attribute	Description
id	String		控件的id
options	Object		配置参数
options.allowCopy	Boolean		是否允许复制。如果允许复制，那么复制的值将存放到剪贴板中
options.columns	Array		列的配置信息
options.columns.attributes	Object		列的样式
options.columns.field	String		列绑定的字段。绑定以后，字段的值将显示在单元格中
options.columns.headerAttributes	Object		表头的样式
options.columns.minResizableWidth	Number		列的最小的宽度（像素）
options.columns.selectable	Boolean		网格控件中的记录是否可以选中
options.columns.title	String		列的标题
options.columns.width	Number		列的宽度（像素）
options.dataSource	Array		网格控件绑定的数据源
options.height	Number		网格控件的高度（像素）
options.pageable	Boolean \| Object		网格控件是否分页显示
options.pageable.pageSize	Number		每页显示的记录数
options.pageable.pageSizes	Array		一个下拉列表，允许用户改变每页显示的记录数
options.pageable.refresh	Boolean		是否显示刷新按钮
options.pageable.info	Boolean		是否显示分页信息。如果设置为真，那么将显示当前页和记录总数。
options.pageable.messages	Object		分页控件显示的文本信息，用户可以定制文本信息
options.pageable.messages.display	String		显示的文本信息包含三个占位符: {0} - 第一个数据项索引 {1} - 最后一个数据项索引 {2} - 数据项的总数
options.pageable.messages.empty	String		网格记录数为空时的提示信息
options.pageable.messages.first	String		首页按钮的提示信息
options.pageable.messages.last	String		末页按钮的提示信息
options.pageable.messages.next	String		下一页按钮的提示信息
options.pageable.messages.previous	String		上一页按钮的提示信息
options.pageable.messages.refresh	String		刷新按钮的提示信息
options.resizable	Boolean		网格控件的大小是否可以调整
options.scrollable	Boolean		网格控件是否显示滚动条
options.selectable	Boolean \| String		如果设置为true，用户将能够选择网格控件的行（默认值：false）可以设置为以下字符串值： "row" - 选择一行 "cell" - 选择一个单元格 "multiple, row" - 选择多行 "multiple, cell" - 选择多个单元格
options.change	function(e: Object): null		选择网格控件中的行或者单元格时触发

Public Methods

public clearSelection(): Null source

清除选定的行（或者单元格）

Return:

Null

public dataItem(row: Object): Object source

返回指定的行（或者单元格）绑定的数据项

Params:

Name	Type	Attribute	Description
row	Object		jQuery选择器

Return:

Object

绑定的数据项

public items(): Array source

返回所有的数据项

Return:

Array

数据项的数组

public select(rows: Object): Object source

获取或设置选定的行（或者单元格）

Params:

Name	Type	Attribute	Description
rows	Object		jQuery选择器

Return:

Object

选定的行（或者单元格）的jQuery对象

public setDataSource(dataSource: Array): Null source

设置网格控件的数据源

Params:

Name	Type	Attribute	Description
dataSource	Array		网格控件绑定的数据源

Return:

Null

public setOptions(options: Object): Null source

设置网格控件的配置参数

Params:

Name	Type	Attribute	Description
options	Object		网格控件的配置参数

Return:

Null