{hero}

stateSaveParams

始於:DataTables 1.10

狀態儲存事件 - 在儲存表格狀態資訊時觸發。

描述

stateSaveParams 事件是 stateSaveParams 初始化選項的事件對應。與回呼函式一樣,當表格狀態變更且需要新的狀態儲存時,會觸發該事件。關於儲存資料的格式,請參考 stateSaveCallback 文件。

此事件允許在實際儲存之前修改狀態儲存物件,包括新增其他狀態屬性(針對外掛程式)或修改 DataTables 核心屬性。

stateSaveParams 事件與 stateSaveCallback 在相同時間點觸發(技術上回呼函式會在事件之前觸發,但它們是依序發生,因此兩者都可以用來達到相同的效果)。

請注意,與所有 DataTables 發出的事件一樣,事件物件上會有一個可用的 DataTables API 實例(第一個參數)。此外,事件會以 dt 命名空間觸發。因此,要監聽此事件,您還必須使用 dt 命名空間,只需將 .dt 附加到您的事件名稱,如下面的範例所示。

注意:從 1.11.0 版本開始,無論 stateSave 選項為何,都會觸發此事件。這允許始終追蹤並提供使用者最新的狀態。

類型

function function( e, settings, data )

參數

範例

移除已儲存的篩選器,這樣永遠不會儲存篩選。

$('#example')
	.on('stateSaveParams.dt', function (e, settings, data) {
		data.search.search = '';
	})
	.DataTable();

相關

以下選項直接相關,也可能在您的應用程式開發中很有用。