jQuery LigerUI API ligerGrid Methos

jQuery ligerUI V1.1.6

previous page next page
组件方法列表
方法 参数 描述
addEditRow (rowdata)
  • 增加一个编辑行
addRow (rowdata, rowParm, isBefore, parentRow)
  • 增加新行
addRows (rowdataArr)
  • 一次性增加多行
append (rowData, targetRow, nearRow, isBefore) appendRow同名方法
appendRange (rows, targetRow, nearRow, isBefore) 一次性附加多行
appendRow (rowData, targetRow, nearRow, isBefore)
  • 附加新行(树模式)
beginEdit (rowParm)
  • 进入编辑状态
cancelEdit (rowParm)
  • 取消编辑
changeCol (from, to, isAfter)
  • 改变列的位置
changeHeaderText (columnparm, headerText)
  • 改变表头文本
changePage (ctype)
  • 改变分页
changeSort (columnName, sortOrder)
  • 改变排序
collapse (targetRow)
  • 收缩(树模式)
collapseDetail (rowParm)
  • 收缩明细
deleteRange (rows) 一次性删除多行
deleteRow (rowParm)
  • 选择行
deleteSelectedRow ()
  • 删除选择的行
demotion (targetRow)
  • 降级(树模式)
down (targetRow)
  • 下移
enabledTotal () isTotalSummary同名方法
endEdit (rowParm)
  • 结束编辑
existRecord (rowdata) 是否存在某记录
expand (targetRow)
  • 展开(树模式)
extendDetail (rowParm)
  • 展开明细
formatRecord (record)
  • 格式化数据,删除系统字段
getAdded ()
  • 获取新增的数据
getCheckedRowObjs ()
  • 获取选中的行 DOM对象集合
getCheckedRows ()
  • 获取选中的行数据(复选框)
getChidren (rowParm)
  • 获取子节点数据(树模式)
getColumn (columnpam)
  • 获取列信息
getColumns (columnLevel)
  • 获取指定层级的Columns
getColumnType (columnname)
  • 根据列名获取列类型
getData (status, removeStatus)
  • 获取数据
getDeleted ()
  • 获取删除过的数据
getParent (rowParm)
  • 获取父节点数据(树模式)
getRowObj (rowParm)
  • 行DOM转换为行数据
getSelected ()
  • 获取选中的行数据(同getSelectedRow)
getSelectedRow ()
  • 获取选中的行数据
getSelectedRowObj ()
  • 获取选中的行 DOM对象
getSelectedRowObjs ()
  • 获取选中的行 DOM对象集合
getSelectedRows ()
  • 获取选中的行数据集合(支持Ctrl多选)
getSelecteds ()
  • 获取选中的行数据集合(支持Ctrl多选)(同getSelectedRows)
getUpdated ()
  • 获取修改过的数据
hasChildren (rowParm)
  • 是否包括子节点(树模式)
isLeaf (rowParm)
  • 是否叶节点(树模式)
isSelected (rowdata)
  • 判断是否选中
isTotalSummary ()
  • 是否包含汇总
loadData (loadDataParm)
  • 刷新数据
loadServerData (param, clause)
  • 加载数据(服务器)
move (from, to, isAfter)
  • 移动行
moveRange (rows)
  • 移动多行
remove (targetRow)
  • 移除行
removeRange (rows)
  • 移除多行
reRender (e)
  • 重新加载html
setColumnWidth (columnparm, value)
  • 调整列宽
setOptions (parms)
  • 重新设置参数(同名方法set)
SubmitEdit (rowParm)
  • 提交编辑
toggle (targetRow)
  • 伸展/收缩节点(树模式)
toggleCol (columnparm, visible)
  • 显示/隐藏列
up (targetRow)
  • 上移
update (rowDom, newRowData)
updateCell (cell, value, rowParm)
  • 更新单元格
updateRow (newRowData, rowDom)
  • 更新行
upgrade (targetRow)
  • 升级(树模式)
组件方法详细
{Object} addEditRow (rowdata)
描述:
  • 增加一个编辑行
参数列表:
参数名 类型 描述 默认值
rowdata {Object}    
返回值:
{Object}
{Void} addRow (rowdata, rowParm, isBefore, parentRow)
描述:
  • 增加新行
例子:
function addRow()
{
    var manager = $("#maingrid").ligerGetGridManager();
    manager.addRow();
} 
function addRowWithData()
{
    var manager = $("#maingrid").ligerGetGridManager();
    var row = manager.getSelectedRow(); 
    manager.addRow({ 
        DepartmentID: 3,
        DepartmentName: '销售部',
        RealName: "分为" + newrowid,
        ID: newrowid++,
        Sex : 1,
        Age : 25,
        IncomeDay: new Date(1306108800000),
        Phone : "2343434",
        Address: "wwrere4"
    }, row, true);
}
参数列表:
参数名 类型 描述 默认值
rowdata {Object} 要附加的数据(非必填)  
rowParm {Object} 插入的位置 可以是DOM对象，也可以是Row Data(非必填)  
isBefore {Object} 是否在指定Dom对象的前方插入行(非必填)  
parentRow {Object} 作为子节点加入到这个行(树模式可用)(非必填)  
返回值:
{Void}
{Void} addRows (rowdataArr)
描述:
  • 一次性增加多行
参数列表:
参数名 类型 描述 默认值
rowdataArr {Array} 要附加的数据  
返回值:
{Void}
append (rowData, targetRow, nearRow, isBefore)
描述:
appendRow同名方法
参数列表:
参数名 类型 描述 默认值
rowData    
targetRow    
nearRow    
isBefore    
appendRange (rows, targetRow, nearRow, isBefore)
描述:
一次性附加多行
参数列表:
参数名 类型 描述 默认值
rows {Array} 要附加的数据  
targetRow {Object} 父节点  
nearRow {Object} 插入的位置 rowid或者rowdata  
isBefore {Object} 是否在之前附加(非必填)  
{Void} appendRow (rowData, targetRow, nearRow, isBefore)
描述:
  • 附加新行(树模式)
例子:
function addRow(parent)
{ 
    var dept = $("#txtDept").val();
    var parentRow;
    var selectRow = manager.getSelectedRow();
    if (parent) parentRow = selectRow;
    else parentRow = manager.getParent(selectRow);

    if (manager.isLeaf(parentRow))
    {
        alert('叶节点不能增加子节点');
        return;
    }
    var data = {
        name: dept,
        id: dept,
        remark: dept
    };
    if (parent)
    { 
        manager.appendRow(data, parentRow);
    }
    else
    {   
        manager.appendRow(data, parentRow,selectRow,false);
    }
}
参数列表:
参数名 类型 描述 默认值
rowData {Object} 要附加的数据  
targetRow {Object} 父节点  
nearRow {Object} 插入的位置 rowid或者rowdata  
isBefore {Object} 是否在之前附加(非必填)  
返回值:
{Void}
{Object} beginEdit (rowParm)
描述:
  • 进入编辑状态
参数列表:
参数名 类型 描述 默认值
rowParm {Object} rowindex或者rowdata  
返回值:
{Object}
{Object} cancelEdit (rowParm)
描述:
  • 取消编辑
参数列表:
参数名 类型 描述 默认值
rowParm {Object} rowindex或者rowdata  
返回值:
{Object}
changeCol (from, to, isAfter)
描述:
  • 改变列的位置
参数列表:
参数名 类型 描述 默认值
from {Object} 来源表头  
to {Object} 目标位置表头  
isAfter {Bool} 是否附加到后面  
{Void} changeHeaderText (columnparm, headerText)
描述:
  • 改变表头文本
参数列表:
参数名 类型 描述 默认值
columnparm {Int|String} 列参数,可以是列索引、列ID,也可以是列名  
headerText {String} 表头文本  
返回值:
{Void}
{Void} changePage (ctype)
描述:
  • 改变分页
例子:
function changePage(ctype)
        {
            var manager = $("#maingrid").ligerGetGridManager();
            manager.changePage(ctype);
        }
参数列表:
参数名 类型 描述 默认值
ctype {String} 类型：first/prev/next/last/input  
返回值:
{Void}
{Void} changeSort (columnName, sortOrder)
描述:
  • 改变排序
例子:
function changeSort(columnName, sortOrder)
        {
            var manager = $("#maingrid").ligerGetGridManager();
            manager.changeSort(columnName, sortOrder);
        }
参数列表:
参数名 类型 描述 默认值
columnName {String} 列名  
sortOrder {String} 排序方向,asc或者desc  
返回值:
{Void}
{Bool} collapse (targetRow)
描述:
  • 收缩(树模式)
参数列表:
参数名 类型 描述 默认值
targetRow {Object} rowindex或者rowdata  
返回值:
{Bool}
{Object} collapseDetail (rowParm)
描述:
  • 收缩明细
参数列表:
参数名 类型 描述 默认值
rowParm {Object} rowindex或者rowdata  
返回值:
{Object}
deleteRange (rows)
描述:
一次性删除多行
参数列表:
参数名 类型 描述 默认值
rows    
{Void} deleteRow (rowParm)
描述:
  • 选择行
例子:
function deleteRow()
        {
            var manager = $("#maingrid").ligerGetGridManager();
            manager.deleteRow($("tr.l-grid-row",manager.gridbody)[0]);
        }
参数列表:
参数名 类型 描述 默认值
rowParm {Object} 行Dom对象或者行对应的row data  
返回值:
{Void}
{Void} deleteSelectedRow ()
描述:
  • 删除选择的行
例子:
function deleteSelectedRow()
        {
            var manager = $("#maingrid").ligerGetGridManager();
            manager.deleteSelectedRow();
        }
返回值:
{Void}
{Bool} demotion (targetRow)
描述:
  • 降级(树模式)
参数列表:
参数名 类型 描述 默认值
targetRow {Object} rowindex或者rowdata  
返回值:
{Bool}
{Bool} down (targetRow)
描述:
  • 下移
参数列表:
参数名 类型 描述 默认值
targetRow {Object} rowindex或者rowdata  
返回值:
{Bool}
enabledTotal ()
描述:
isTotalSummary同名方法
endEdit (rowParm)
描述:
  • 结束编辑
参数列表:
参数名 类型 描述 默认值
rowParm {Object} rowindex或者rowdata(行编辑模式)(单元格编辑模式为空)  
existRecord (rowdata)
描述:
是否存在某记录
参数列表:
参数名 类型 描述 默认值
rowdata {Object} 节点 数据  
{Bool} expand (targetRow)
描述:
  • 展开(树模式)
参数列表:
参数名 类型 描述 默认值
targetRow {Object} rowindex或者rowdata  
返回值:
{Bool}
{Object} extendDetail (rowParm)
描述:
  • 展开明细
参数列表:
参数名 类型 描述 默认值
rowParm {Object} rowindex或者rowdata  
返回值:
{Object}
{Object} formatRecord (record)
描述:
  • 格式化数据,删除系统字段
参数列表:
参数名 类型 描述 默认值
record {Object}    
返回值:
{Object} record
getAdded ()
描述:
  • 获取新增的数据
{Array} getCheckedRowObjs ()
描述:
  • 获取选中的行 DOM对象集合
返回值:
{Array} Row Dom Object
{Array} getCheckedRows ()
描述:
  • 获取选中的行数据(复选框)
返回值:
{Array} Row Array Data
{Array} getChidren (rowParm)
描述:
  • 获取子节点数据(树模式)
参数列表:
参数名 类型 描述 默认值
rowParm {Object} rowindex或者rowdata  
返回值:
{Array}
{Object} getColumn (columnpam)
描述:
  • 获取列信息
参数列表:
参数名 类型 描述 默认值
columnpam {String} 列ID、列索引  
返回值:
{Object} Column，对应于g.columns[columnindex]
{Array} getColumns (columnLevel)
描述:
  • 获取指定层级的Columns
参数列表:
参数名 类型 描述 默认值
columnLevel    
返回值:
{Array} 返回指定层级的Columns
{String} getColumnType (columnname)
描述:
  • 根据列名获取列类型
例子:
function getColumnType(columnname)
        {
            var manager = $("#maingrid").ligerGetGridManager();
            return manager.getColumnType(columnname);
        }
参数列表:
参数名 类型 描述 默认值
columnname {String} 列名  
返回值:
{String} Column Type
{Array} getData (status, removeStatus)
描述:
  • 获取数据
例子:
function getData()
{
var manager = $("#maingrid").liger();
return manager.getData();
} 
function getData()
{ 
return $("#maingrid").liger('getData')
}
参数列表:
参数名 类型 描述 默认值
status {Object} 状态名,可以为空  
removeStatus {Object} 是否移除状态字段,可以为空  
返回值:
{Array} 返回的是一个数组
getDeleted ()
描述:
  • 获取删除过的数据
{Object} getParent (rowParm)
描述:
  • 获取父节点数据(树模式)
参数列表:
参数名 类型 描述 默认值
rowParm {Object} rowindex或者rowdata  
返回值:
{Object}
{Object} getRowObj (rowParm)
描述:
  • 行DOM转换为行数据
参数列表:
参数名 类型 描述 默认值
rowParm {Object} rowindex或者rowdata  
返回值:
{Object} Row Object
{Object} getSelected ()
描述:
  • 获取选中的行数据(同getSelectedRow)
返回值:
{Object} Row Data
{Object} getSelectedRow ()
描述:
  • 获取选中的行数据
例子:
function getSelectedRow()
        {
            var manager = $("#maingrid").ligerGetGridManager();
            return manager.getSelectedRow();
        }
返回值:
{Object} Row Data
{Array} getSelectedRowObj ()
描述:
  • 获取选中的行 DOM对象
返回值:
{Array} Row Dom Object
{Array} getSelectedRowObjs ()
描述:
  • 获取选中的行 DOM对象集合
返回值:
{Array} Row Dom Object
{Object} getSelectedRows ()
描述:
  • 获取选中的行数据集合(支持Ctrl多选)
返回值:
{Object} Row Data
{Object} getSelecteds ()
描述:
  • 获取选中的行数据集合(支持Ctrl多选)(同getSelectedRows)
返回值:
{Object} Row Data
getUpdated ()
描述:
  • 获取修改过的数据
{Bool} hasChildren (rowParm)
描述:
  • 是否包括子节点(树模式)
参数列表:
参数名 类型 描述 默认值
rowParm {Object} rowindex或者rowdata  
返回值:
{Bool}
{Bool} isLeaf (rowParm)
描述:
  • 是否叶节点(树模式)
参数列表:
参数名 类型 描述 默认值
rowParm {Object} rowindex或者rowdata  
返回值:
{Bool}
{Object} isSelected (rowdata)
描述:
  • 判断是否选中
参数列表:
参数名 类型 描述 默认值
rowdata {Object} 行数据  
返回值:
{Object} Row Data
{Bool} isTotalSummary ()
描述:
  • 是否包含汇总
例子:
function isTotalSummary()
        {
            var manager = $("#maingrid").ligerGetGridManager();
            return manager.isTotalSummary();
        }
返回值:
{Bool} 是否包含汇总
{Void} loadData (loadDataParm)
描述:
  • 刷新数据
例子:
function f_reload()
        {
            var manager = $("#maingrid").ligerGetGridManager();
            manager.loadData();
        }
参数列表:
参数名 类型 描述 默认值
loadDataParm {Function|Boolean|Object} 是否重新提交服务器,或者是筛选的函数,也可以指定data  
返回值:
{Void}
{Void} loadServerData (param, clause)
描述:
  • 加载数据(服务器)
参数列表:
参数名 类型 描述 默认值
param {Object} 加载参数  
clause {Function} 是筛选的函数  
返回值:
{Void}
move (from, to, isAfter)
描述:
  • 移动行
参数列表:
参数名 类型 描述 默认值
from {Object} 来源表头  
to {Object} 目标位置表头  
isAfter {Bool} 是否附加到后面  
{Bool} moveRange (rows)
描述:
  • 移动多行
参数列表:
参数名 类型 描述 默认值
rows {Array}    
返回值:
{Bool}
{Bool} remove (targetRow)
描述:
  • 移除行
参数列表:
参数名 类型 描述 默认值
targetRow {Object} rowindex或者rowdata  
返回值:
{Bool}
{Bool} removeRange (rows)
描述:
  • 移除多行
参数列表:
参数名 类型 描述 默认值
rows {Array}    
返回值:
{Bool}
{Object} reRender (e)
描述:
  • 重新加载html
参数列表:
参数名 类型 描述 默认值
e {Object} e(rowdata、column)  
返回值:
{Object}
{Void} setColumnWidth (columnparm, value)
描述:
  • 调整列宽
参数列表:
参数名 类型 描述 默认值
columnparm {Int|String} 列参数,可以是列索引、列ID,也可以是列名  
value {Int} 宽度  
返回值:
{Void}
{Void} setOptions (parms)
描述:
  • 重新设置参数(同名方法set)
例子:

    

        国家：
    

    

        
    

    

        
搜索

    



    
$("#searchbtn").ligerButton({ click: function ()
            {
                var gridManager = $("#maingrid").ligerGetGridManager();
                var Country = $("#ddlCountry").val(); 
                gridManager.setOptions(
                    { parms: [{ name: 'Country', value: Country}] }
                );
                gridManager.loadData(true);
            }
参数列表:
参数名 类型 描述 默认值
parms {Object} 参数列表  
返回值:
{Void}
{Object} SubmitEdit (rowParm)
描述:
  • 提交编辑
参数列表:
参数名 类型 描述 默认值
rowParm {Object} rowindex或者rowdata  
返回值:
{Object}
{Bool} toggle (targetRow)
描述:
  • 伸展/收缩节点(树模式)
参数列表:
参数名 类型 描述 默认值
targetRow {Object} rowindex或者rowdata  
返回值:
{Bool}
{Void} toggleCol (columnparm, visible)
描述:
  • 显示/隐藏列
参数列表:
参数名 类型 描述 默认值
columnparm {Int|String} 列参数,可以是列索引、列ID,也可以是列名  
visible {Boolean} 是否可见  
返回值:
{Void}
{Bool} up (targetRow)
描述:
  • 上移
参数列表:
参数名 类型 描述 默认值
targetRow {Object} rowindex或者rowdata  
返回值:
{Bool}
update (rowDom, newRowData)
描述:
参数列表:
参数名 类型 描述 默认值
rowDom    
newRowData    
{Void} updateCell (cell, value, rowParm)
描述:
  • 更新单元格
参数列表:
参数名 类型 描述 默认值
cell {String|Object} 单元格Dom对象或者列名  
value {String|Int|Float|Date} 新值  
rowParm {Object} 行Dom对象或者行对应的row data  
返回值:
{Void}
{Void} updateRow (newRowData, rowDom)
描述:
  • 更新行
参数列表:
参数名 类型 描述 默认值
newRowData {Object} 要附加的数据(非必填)  
rowDom {Object} DOM对象  
返回值:
{Void}
{Bool} upgrade (targetRow)
描述:
  • 升级(树模式)
参数列表:
参数名 类型 描述 默认值
targetRow {Object} rowindex或者rowdata  
返回值:
{Bool}
previous page start next page