jQWidgets jqxGrid iscolumngroupable() 方法

介绍

iscolumngroupable() 方法是 jQWidgets jqxGrid 组件中的一种方法，用于判断某一列是否可以被列分组。

语法

iscolumngroupable(column: string | number): boolean

参数

• column(string|number)：列的数据字段（column datafield）或索引（index）。

返回值

• 返回一个布尔值，表示指定列是否可以被列分组。

示例

$(document).ready(function () {
    // 初始化数据源和列信息
    let source = {
        datatype: "json",
        datafields: [
            { name: 'id', type: 'number' },
            { name: 'name', type: 'string' },
            { name: 'age', type: 'number' },
            { name: 'gender', type: 'string' }
        ],
        id: 'id',
        localdata: [
            { id: 1, name: 'Jack', age: 29, gender: 'Male' },
            { id: 2, name: 'Mary', age: 22, gender: 'Female' },
            { id: 3, name: 'Tom', age: 33, gender: 'Male' },
            { id: 4, name: 'Lucy', age: 25, gender: 'Female' },
            { id: 5, name: 'Linda', age: 28, gender: 'Female' },
            { id: 6, name: 'Nick', age: 24, gender: 'Male' }
        ]
    };
    let dataAdapter = new $.jqx.dataAdapter(source);

    let columns = [
        { text: 'ID', datafield: 'id' },
        { text: 'Name', datafield: 'name' },
        { text: 'Age', datafield: 'age' },
        {
            text: 'Gender', datafield: 'gender',
            cellsrenderer: function (row, column, value) {
                if (value == 'Male') {
                    return '<img src="male.png"/>';
                }
                else {
                    return '<img src="female.png"/>';
                }
            },
            width: 100,
            columngroup: 'Personal Information' // 指定列分组
        }
    ];

    // 初始化 jqxGrid 组件
    $('#jqxgrid').jqxGrid({
        width: '100%',
        source: dataAdapter,
        columns: columns
    });

    // 判断某一列是否可以被列分组
    let isGroupable = $('#jqxgrid').jqxGrid('iscolumngroupable', 'gender');
    console.log(isGroupable); // true
});

在上面的示例中所指定的 iscolumngroupable() 方法会判断 gender 列是否可以被列分组，由于该列为字符串类型，因此是可以被列分组的，所以方法返回值为 true。

参考资料

• jQWidgets jqxGrid 官方文档 Grid API Methods。