preXhr
自:DataTables 1.10
Ajax 事件——在发起 Ajax 请求之前触发。
描述
此事件在 DataTables 对服务器发出 ajax 请求获取数据之前触发,它是xhr
事件的对名词事件,后者在 Ajax 请求成功从服务器返回数据之后触发。
preXhr
事件设计供插件作者使用,他们可以在其扩展中侦听此事件并发送任何所需的附加数据。它的功能非常类似于ajax.data
,但是该选项通常是由为其表格编写初始化代码的人使用,而不是插件作者使用。
请注意,与所有 DataTables 发出的事件一样,事件对象会提供一个 DataTables API 实例(第一个参数)。此外,这些事件还会在 dt
命名空间中触发。因此,若要侦听此事件,你必须使用 dt
命名空间,方法是在事件名称后面附加 .dt
,如下面的示例所示。
类型
函数 function( e, settings, json, xhr )
- 参数
名称 类型 可选 1 e
否 jQuery 事件对象
2 settings
否 DataTables 设置对象
3 data
否 将以对象形式发送到服务器的数据
4 xhr
否 自 2.0.0 起:为 jQuery 构造的 XHR 对象
示例
在 Ajax 请求中使用事件向服务器发送附加数据
$('#example')
.on('preXhr.dt', function (e, settings, data) {
data.sessionId = $('#sessionId').val();
})
.DataTable({
ajax: 'data.json'
});
// Note that `ajax.data` could also be used to perform this action in this case
相关
以下选项直接相关,在你的应用程序开发中也可能很有用。