EasyUI - datagrid属性idField详解

EasyUI - datagrid属性idField详解

idField在treegrid中的是一个必选的属性，在datagrid中是一个可选的属性。

也许有人为了方便使用getRowIndex会在datagrid中设置idField属性，如果不注意这个属性，那么在调用getSelected或者getChecked方法时会引起更多莫名其妙的问题。

这篇博客就是讲datagrid中的idField对getSelected和getChecked方法相关方法的影响。

因为selected和checked情况类似，下面就以selected的情况来说明。

在选中一行的时候

执行的部分关键代码如下：

if (opts.idField) {
    _5cf(_6b9.selectedRows, opts.idField, row);
}
opts.finder.getTr(_6b6, _6b7).addClass("datagrid-row-selected");
opts.onSelect.apply(_6b6, _5d0(_6b6, [_6b7, row]));

这里的_6b9是datagrid的data-datagrid属性，获取方法为:

//使用jquery获取
$('#datagridId').data('datagrid');
//在easyui源码中使用下面方法获取
$.data(_6a7, "datagrid");

这个对象的一级属性如下图：

注意看这里的checkedRows和selectedRows属性。

继续看第一段代码，当if (opts.idField)存在idField属性的时候，会调用_5cf方法：

function _5cf(a, o, r) {
    for (var i = 0, len = a.length; i < len; i++) {
        if (a[i][o] == r[o]) {
            return;
        }
    }
    a.push(r);
};

这个方法就是当新选择的值和selectedRows中已有的idField值都不相同的时候，放到selectedRows中。通过idField避免重复！

当没有设置idField属性的时候，就没有selectedRows的事，只是调用下面的代码：

opts.finder.getTr(_6b6, _6b7).addClass("datagrid-row-selected");

这个代码就是给当前点击的行添加一个选中的样式，如下图：

通过上面代码我们应该已经了解选中一行的过程。

下面我们看当取消选中行时是如何处理的

关键代码如下：

opts.finder.getTr(_6bb, _6bc).removeClass("datagrid-row-selected");
if (opts.idField) {
    _5cd(_6be.selectedRows, opts.idField, row[opts.idField]);
}

看过前面的再看这里就容易很多了，首先removeClass去掉选中的样式。

然后如果有idField属性，执行_5cd方法：

function _5cd(a, o, id) {
    if (typeof o == "string") {
        for (var i = 0, len = a.length; i < len; i++) {
            if (a[i][o] == id) {
                a.splice(i, 1);
                return;
            }
        }
    } else {
        var _5ce = _5cc(a, o);
        if (_5ce != -1) {
            a.splice(_5ce, 1);
        }
    }
};

如果取消的列在selectedRows中，就会从中移除（这里的else一般不会出现，不需要重视这里）。

到这儿我们就了解了selectedRows增加和删除的情况。

注意1

这里要强调的是selectedRows中的值只能通过取消选择，或者unselectAll取消 【当前页】 的选择，即使重新加载数据，或者清空数据，都不会影响selectedRows中的值。想要取消全部选择怎么办？你可以使用clearSelections方法：

$('#id').datagrid('clearSelections');

取消全部选择，这个方法和当前显示的数据或者加载过的数据无关。这个方法如下：

clearSelections: function (jq) {
    return jq.each(function () {
        var _76d = $.data(this, "datagrid");
        var _76e = _76d.selectedRows;
        var _76f = _76d.checkedRows;
        _76e.splice(0, _76e.length);
        _6ba(this);
        if (_76d.options.checkOnSelect) {
            _76f.splice(0, _76f.length);
        }
    });
}

获取selectedRows后，通过_76e.splice(0, _76e.length);清空selectedRows，这一步已经达到我们的基本目标了，然后是调用_6ba(this);，这一步是取消当前页的选中状态（就是unselectAll方法）。如果checkOnSelect=true，在_6ba方法中也有这个判断，会取消复选框选中状态，在这里会清空checkedRows的值。

当你只想获取当前页的选择项时，最好的解决方法就是不设置idField属性。否则就要自己处理好调用clearSelections的时机。

注意2

同时你也应该了解，合理的使用idField还可以实现翻页选择（checkbox一样），这种情况下，你的datagrid能记住每一页的选中情况，而且通过getSelections(或getChecked)来获取所有页中选中的行。

下面我们看当调用getSelected方法时，是如何处理的

这个方法的定义如下：

getSelected: function (jq) {
    var rows = _6a6(jq[0]);
    return rows.length > 0 ? rows[0] : null;
}

获取rows后返回第一个或者null。在看_6a6方法：

function _6a6(_6a7) {
    var _6a8 = $.data(_6a7, "datagrid");
    var opts = _6a8.options;
    var data = _6a8.data;
    if (opts.idField) {
        return _6a8.selectedRows;
    } else {
        var rows = [];
        opts.finder.getTr(_6a7, "", "selected", 2).each(function () {
            rows.push(opts.finder.getRow(_6a7, $(this)));
        });
        return rows;
    }
};

当我们设置idField时，直接将selectedRows返回了。
如果没有设置idField，就会使用else中的方法，获取所有selected的元素，然后一个个循环，放到rows数组中返回。
从上面这两种处理方式来看，显然是有idField的时候效率更高(else效率也不低)。

其他和selected有关的方法，最终调用执行的都是上面提到的这些方法。这里不一一介绍了。

idField最有用的地方getRowIndex

getRowIndex需要一个参数，row或者id的值，使用id的前提就是设置idField。

下面是getRowIndex方法：

function _6a3(_6a4, row) {
    var _6a5 = $.data(_6a4, "datagrid");
    var opts = _6a5.options;
    var rows = _6a5.data.rows;
    if (typeof row == "object") {
        return _5cc(rows, row);
    } else {
        for (var i = 0; i < rows.length; i++) {
            if (rows[i][opts.idField] == row) {
                return i;
            }
        }
        return -1;
    }
};

当使用row参数时，满足typeof row == "object"，之后调用_5cc方法，和所有的rows一一比较返回。

另外就是使用idField方式，_6a5.data.rows包含了当前页的所有行。对所有行循环，比较idField相同的值，直接返回行号，这种方式使用也方便，因为我们业务中很容易能获取id的值，而不容易得到一行row。

最后

官方文档中对idField的介绍只有下面的这些：

idField - string - Indicate which field is an identity field.

只有通过查看源码你才能发现原来idField竟然起了这么多的作用，这个属性隐藏的含义太多，不注意就会遇到“莫名其妙”的问题。

希望通过本文能让你对datagrid中的idField有所了解。