API-方法

2017-04-11 本文已影响42人 YoungDreamer

Methods（方法）

addRecord
closeChildRow
closeChildTable
changeColumnVisibility
deleteRecord
deleteRows
destroy
getChildRow
getRowByKey
isChildRowOpen
load
openChildRow
openChildTable
reload
selectedRows
selectRows
showCreateForm
updateRecord

addRecord(options)

此方法是用编程的方式向表中添加记录。有以下参数：

record：将被添加到表格中的记录对象。这个选项是必须的。
clientOnly（boolean，default：false）：如果设置为true，jTable不会将记录添加到服务器，只是添加到本地的表格中。
animationsEnabled（boolean，default：true。表格的行为）：如果设置为false，在添加一条新纪录的时候表格不会展示动画效果。
url（string，default：在表格中设置的createAction）：你可以提供不同的URL来在服务器上创建新纪录。
success（function，default：none）：一个回调函数，当记录成功添加到表中时，可以用来通知它。
error（function：default：none）：一个回调函数，当记录添加失败时会通知它。

下面是 addRecord 的简单用法：

$('#StudentTableContainer').jtable('addRecord', {
    record: {
        Name: 'Halil ibrahim Kalkan',
        EmailAddress: 'halil@jtable.org',
        Password: '123',
        Gender: 'M',
        CityId: 4,
        BirthDate: '2002-11-18',
        Education: '2',
        About: 'adding test record',
        IsActive: true,
        RecordDate: '2011-11-12'
    }
});

closeChildRow(row)

此方法用于关闭表格行打开的子行。参阅 openChildRow 方法。（在jTable内部用此方法关闭子表）

closeChildTable(row, closed)

此方法用于关闭表格行打开的子表。row是表格内的一个jQuery行对象。closed是一个回调函数，当子表被关闭的时候调用。查看 openChildTable 方法。

changeColumnVisibility(columnName, visibility)

此方法用于改变列的可见性属性。Values可以是fixed（列一直都是可见的），visible（列默认是可见的）和hidden（列默认是隐藏的）。参阅 field visibility 选项。

deleteRecord(options)

此方法用于以编程的方式删除一条表格中存在的记录。参数如下：

key：要更新的这条记录的主键。此选项是必须的。
clientOnly（boolean，default：false）：如果设置为true，jTable不会从服务器上删除数据，只是从本地表格中删除。
animationsEnabled（boolean，default：true。表格的行为）：如果设置为false，在删除一条纪录的时候表格不会展示动画效果。
url（string，default：在表格中设置的deleteAction）：你可以提供不同的URL来在服务器上删除纪录。
success（function，default：none）：一个回调函数，当记录成功删除时，可以用来通知它。
error（function：default：none）：一个回调函数，当记录删除失败时会通知它。

下面是 deleteRecord 的简单使用：

$('#StudentTableContainer').jtable('deleteRecord', {
    key: 42
});

deleteRows(rows)

从服务器和表格中删除给定的行。rows参数必须是jQuery选择器。此方法可以和selectedRows犯法结合使用。这样，你就可以获取选中的行然后传递给deleteRows方法来删除它们。

destroy()

把表格从容器中完全删除。

getChildRow(row)

此方法用于获取表行的子行。这样，你可以向子行中添加内容。参阅 openChildRow 方法。

getRowByKey(key)

此方法用于通过一条记录的主键值来获取记录的对应行（jQuery选择器）。

isChildRowOpen(row)

如果指定行的子行被打开，此方法返回true。查阅 openChildRow 方法。

load(postData, completeCallback)

从服务器加载记录。所有的参数都是可选的。如果你想传递一些参数到服务器，在调用 load 方法时你可以把它们添加到postData参数中，像这样：

$('#PersonTable').jtable('load', { CityId: 2, Name: 'Halil' });

你可以获得居住在city=2城市，名字叫做Halil的人，如上所示。当然，你必须在服务器端处理这些参数。此外，你可以传递一个回调函数completeCallback，它会在数据加载完成的时候调用。

openChildRow(row)

此方法用于打开表行的子行。子行通常用于显示子表。如果你想展示子表，则不需要使用此方法，用 openChildTable 方法代替。如果你想打开一个自定义子行，那就用这个方法。它返回打开的子行。因此，你可以填写自定义的内容。子行与表中的特定数据行相关（作为row参数传递）。如果从表中删除数据行，那么它相关的子行也会被删除。

openChildTable(row, tableOptions, opened)

此方法用于创建和打开一个数据行的子表（参阅demo页面）。row参数是表中的数据行，tableOptions是用于初始化子表的标准jTable选项。opened是一个回调函数，当子表显示的时候有jTable调用（在打开动画结束后）。

如果你定义了opend回调函数，你可以获取到一个打开的子表的引用。这样，你可以通过这个引用调用新的jTable实例方法。例如，如果你的opened回调函数是这样定义的：** function(data){ ... }，然后你可以通过data.childTable**来获取子表，并且你可以调用任何的jTable方法像 data.childTable.reload() 一样。
下面是使用案例：

Phones: {
    title: '',
    width: '5%',
    sorting: false,
    edit: false,
    create: false,
    listClass: 'child-opener-image-column',
    display: function (personData) {
        //Create an image that will be used to open child table
        var $img = $('![](/Content/images/Misc/phone.png)');
        //Open child table when user clicks the image
        $img.click(function () {
            $('#PersonTable').jtable('openChildTable',
                    $img.closest('tr'),
                    {
                        title: personData.record.Name + ' - Phone numbers',
                        actions: {
                            listAction: '/PagingPerson/PhoneList?PersonId=' + personData.record.PersonId,
                            deleteAction: '/PagingPerson/DeletePhone',
                            updateAction: '/PagingPerson/UpdatePhone',
                            createAction: '/PagingPerson/CreatePhone?PersonId=' + personData.record.PersonId
                        },
                        fields: {
                            PhoneId: {
                                key: true,
                                create: false,
                                edit: false,
                                list: false
                            },
                            PhoneType: {
                                title: 'Phone type',
                                width: '30%',
                                options: { '1': 'Home phone', '2': 'Office phone', '3': 'Cell phone' }
                            },
                            Number: {
                                title: 'Phone Number',
                                width: '30%'
                            },
                            RecordDate: {
                                title: 'Record date',
                                width: '20%',
                                type: 'date',
                                displayFormat: 'dd.mm.yy',
                                create: false,
                                edit: false
                            }
                        }
                    }, function (data) { //opened handler
                        data.childTable.jtable('load');
                    });
        });
        //Return image to show on the person row
        return $img;
    }

在这里，我们使用jTable的display函数创建了一个自定义列。在列中，我们创建了一个图片。当用户点击这个图片的时候，我们打开一个新的子表。我们用$img.closest('tr')来获取图片的行容器，并且将它传递给 openChildTable 方法。我们使用标准的jTable选项作为第二个参数。最后，我们传递一个function在子表完全打开后去加载表数据。

reload(completeCallback)

根据最后一个postData来重新从服务器加载数据。此方法用于从服务器重新加载表数据，因为它不会改变current page，sorting，使用最后的postData（在load调用时）。此外，你可以传递一个回调方法作为completeCallback，它会在数据加载完成的时候被调用。

原文：Re-loads records from server with last postData. This method can be used to refresh table data from server since it does not change current page, sorting and uses last postData (on load call). Also, you can pass a callback method as completeCallback, that is called when loading of data is successfully completed.

selectedRows()

获取表格中所有选中的行（jQuery选择器）。看下面案例：

var $selectedRows = $('#PersonTable').jtable('selectedRows');
$selectedRows.each(function () {
    var record = $(this).data('record');
    var personId = record.PersonId;
    var name = record.Name;
});

在这里，我们获取所有选中的行，然后遍历行并且获取此行对应的记录数据，然后获取记录的一些字段（有关详细信息请参阅演示）。

selectRows(rows)

此方法用于选择表中的一行或者多行。rows参数必须是jQuery选择器。

showCreateForm()

可用于以编程的方式来打开一个‘create new record’表单对话框。

updateRecord(options)

此方法用于以编程的方式来更新一条表中已经存在的记录。一些参数如下：

record：将要被更新的记录对象。该记录的主键值必须与表上的值匹配。否则，没有记录将会被更新。这个选项是必须的。
clientOnly（boolean，default：false）：如果设置为true，jTable不会从服务器上更新数据，只是从本地表格中更新。
animationsEnabled（boolean，default：true。表格的行为）：如果设置为false，在更新一条纪录的时候表格不会展示动画效果。
url（string，default：在表格中设置的updateAction）：你可以提供不同的URL来在服务器上更新纪录。
success（function，default：none）：一个回调函数，当记录成功更新时，可以用来通知它。
error（function：default：none）：一个回调函数，当记录更新失败时会通知它。

下面是 updateRecord 方法的简单使用：

$('#StudentTableContainer').jtable('updateRecord', {
    record: {
        StudentId: 42,
        Name: 'Halil Kalkan',
        EmailAddress: 'halil@jtable.org',
        Password: '123456',
        Gender: 'M',
        CityId: 4,
        BirthDate: '2001-11-18',
        Education: '3',
        About: 'updated this record',
        IsActive: true,
        RecordDate: '2012-01-05'
    }
});

API-方法

Methods（方法）

猜你喜欢

热点阅读