mirror of
https://github.com/DataTables/DataTables.git
synced 2024-12-01 13:24:10 +01:00
Dev: Tidying up documentation comments for main DataTables file
This commit is contained in:
Allan Jardine
parent
d740f0484d
commit
da2a834177
112
media/js/jquery.dataTables.js
vendored
112
media/js/jquery.dataTables.js
vendored
@ -12,16 +12,16 @@
|
||||
* BSD style license, available at:
|
||||
* http://datatables.net/license_gpl2
|
||||
* http://datatables.net/license_bsd
|
||||
*
|
||||
* This source file is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
*
|
||||
* This source file is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
* or FITNESS FOR A PARTICULAR PURPOSE. See the license files for details.
|
||||
*
|
||||
*
|
||||
* For details please refer to: http://www.datatables.net
|
||||
*/
|
||||
|
||||
/*jslint evil: true, undef: true, browser: true */
|
||||
/*globals $, jQuery,define,_fnExternApiFunc,_fnInitialise,_fnInitComplete,_fnLanguageCompat,_fnAddColumn,_fnColumnOptions,_fnAddData,_fnCreateTr,_fnGatherData,_fnBuildHead,_fnDrawHead,_fnDraw,_fnReDraw,_fnAjaxUpdate,_fnAjaxParameters,_fnAjaxUpdateDraw,_fnServerParams,_fnAddOptionsHtml,_fnFeatureHtmlTable,_fnScrollDraw,_fnAdjustColumnSizing,_fnFeatureHtmlFilter,_fnFilterComplete,_fnFilterCustom,_fnFilterColumn,_fnFilter,_fnBuildSearchArray,_fnBuildSearchRow,_fnFilterCreateSearch,_fnDataToSearch,_fnSort,_fnSortAttachListener,_fnSortingClasses,_fnFeatureHtmlPaginate,_fnPageChange,_fnFeatureHtmlInfo,_fnUpdateInfo,_fnFeatureHtmlLength,_fnFeatureHtmlProcessing,_fnProcessingDisplay,_fnVisibleToColumnIndex,_fnColumnIndexToVisible,_fnNodeToDataIndex,_fnVisbleColumns,_fnCalculateEnd,_fnConvertToWidth,_fnCalculateColumnWidths,_fnScrollingWidthAdjust,_fnGetWidestNode,_fnGetMaxLenString,_fnStringToCss,_fnDetectType,_fnSettingsFromNode,_fnGetDataMaster,_fnGetTrNodes,_fnGetTdNodes,_fnEscapeRegex,_fnDeleteIndex,_fnColumnOrdering,_fnLog,_fnClearTable,_fnSaveState,_fnLoadState,_fnDetectHeader,_fnGetUniqueThs,_fnScrollBarWidth,_fnApplyToChildren,_fnMap,_fnGetRowData,_fnGetCellData,_fnSetCellData,_fnGetObjectDataFn,_fnSetObjectDataFn,_fnApplyColumnDefs,_fnBindAction,_fnCallbackReg,_fnCallbackFire,_fnNodeToColumnIndex,_fnInfoMacros,_fnBrowserDetect,_fnGetColumns,_fnHungarianMap,_fnCamelToHungarian*/
|
||||
/*globals $,require,jQuery,define,_fnExternApiFunc,_fnInitialise,_fnInitComplete,_fnLanguageCompat,_fnAddColumn,_fnColumnOptions,_fnAddData,_fnCreateTr,_fnGatherData,_fnBuildHead,_fnDrawHead,_fnDraw,_fnReDraw,_fnAjaxUpdate,_fnAjaxParameters,_fnAjaxUpdateDraw,_fnServerParams,_fnAddOptionsHtml,_fnFeatureHtmlTable,_fnScrollDraw,_fnAdjustColumnSizing,_fnFeatureHtmlFilter,_fnFilterComplete,_fnFilterCustom,_fnFilterColumn,_fnFilter,_fnBuildSearchArray,_fnBuildSearchRow,_fnFilterCreateSearch,_fnDataToSearch,_fnSort,_fnSortAttachListener,_fnSortingClasses,_fnFeatureHtmlPaginate,_fnPageChange,_fnFeatureHtmlInfo,_fnUpdateInfo,_fnFeatureHtmlLength,_fnFeatureHtmlProcessing,_fnProcessingDisplay,_fnVisibleToColumnIndex,_fnColumnIndexToVisible,_fnNodeToDataIndex,_fnVisbleColumns,_fnCalculateEnd,_fnConvertToWidth,_fnCalculateColumnWidths,_fnScrollingWidthAdjust,_fnGetWidestNode,_fnGetMaxLenString,_fnStringToCss,_fnDetectType,_fnSettingsFromNode,_fnGetDataMaster,_fnGetTrNodes,_fnGetTdNodes,_fnEscapeRegex,_fnDeleteIndex,_fnColumnOrdering,_fnLog,_fnClearTable,_fnSaveState,_fnLoadState,_fnDetectHeader,_fnGetUniqueThs,_fnScrollBarWidth,_fnApplyToChildren,_fnMap,_fnGetRowData,_fnGetCellData,_fnSetCellData,_fnGetObjectDataFn,_fnSetObjectDataFn,_fnApplyColumnDefs,_fnBindAction,_fnCallbackReg,_fnCallbackFire,_fnNodeToColumnIndex,_fnInfoMacros,_fnBrowserDetect,_fnGetColumns,_fnHungarianMap,_fnCamelToHungarian*/
|
||||
|
||||
(/** @lends <global> */function( window, document, undefined ) {
|
||||
|
||||
@ -44,35 +44,35 @@
|
||||
(/** @lends <global> */function( $ ) {
|
||||
"use strict";
|
||||
|
||||
/**
|
||||
* DataTables is a plug-in for the jQuery Javascript library. It is a
|
||||
* highly flexible tool, based upon the foundations of progressive
|
||||
* enhancement, which will add advanced interaction controls to any
|
||||
* HTML table. For a full list of features please refer to
|
||||
* <a href="http://datatables.net">DataTables.net</a>.
|
||||
/**
|
||||
* DataTables is a plug-in for the jQuery Javascript library. It is a highly
|
||||
* flexible tool, based upon the foundations of progressive enhancement,
|
||||
* which will add advanced interaction controls to any HTML table. For a
|
||||
* full list of features please refer to
|
||||
* [DataTables.net](href="http://datatables.net).
|
||||
*
|
||||
* Note that the <i>DataTable</i> object is not a global variable but is
|
||||
* aliased to <i>jQuery.fn.DataTable</i> and <i>jQuery.fn.dataTable</i> through which
|
||||
* it may be accessed.
|
||||
* Note that the `DataTable` object is not a global variable but is aliased
|
||||
* to `jQuery.fn.DataTable` and `jQuery.fn.dataTable` through which it may
|
||||
* be accessed.
|
||||
*
|
||||
* @class
|
||||
* @param {object} [oInit={}] Configuration object for DataTables. Options
|
||||
* @param {object} [init={}] Configuration object for DataTables. Options
|
||||
* are defined by {@link DataTable.defaults}
|
||||
* @requires jQuery 1.3+
|
||||
*
|
||||
*
|
||||
* @example
|
||||
* // Basic initialisation
|
||||
* $(document).ready( function {
|
||||
* $('#example').dataTable();
|
||||
* } );
|
||||
*
|
||||
*
|
||||
* @example
|
||||
* // Initialisation with configuration options - in this case, disable
|
||||
* // pagination and sorting.
|
||||
* $(document).ready( function {
|
||||
* $('#example').dataTable( {
|
||||
* "bPaginate": false,
|
||||
* "bSort": false
|
||||
* "paginate": false,
|
||||
* "sort": false
|
||||
* } );
|
||||
* } );
|
||||
*/
|
||||
@ -6677,11 +6677,12 @@
|
||||
DataTable.version = "1.10.0-dev";
|
||||
|
||||
/**
|
||||
* Private data store, containing all of the settings objects that are created for the
|
||||
* tables on a given page.
|
||||
*
|
||||
* Note that the <i>DataTable.settings</i> object is aliased to <i>jQuery.fn.dataTableExt</i>
|
||||
* through which it may be accessed and manipulated, or <i>jQuery.fn.dataTable.settings</i>.
|
||||
* Private data store, containing all of the settings objects that are
|
||||
* created for the tables on a given page.
|
||||
*
|
||||
* Note that the `DataTable.settings` object is aliased to
|
||||
* `jQuery.fn.dataTableExt` through which it may be accessed and
|
||||
* manipulated, or `jQuery.fn.dataTable.settings`.
|
||||
* @member
|
||||
* @type array
|
||||
* @default []
|
||||
@ -6690,9 +6691,9 @@
|
||||
DataTable.settings = [];
|
||||
|
||||
/**
|
||||
* Object models container, for the various models that DataTables has available
|
||||
* to it. These models define the objects that are used to hold the active state
|
||||
* and configuration of the table.
|
||||
* Object models container, for the various models that DataTables has
|
||||
* available to it. These models define the objects that are used to hold
|
||||
* the active state and configuration of the table.
|
||||
* @namespace
|
||||
*/
|
||||
DataTable.models = {};
|
||||
@ -11358,11 +11359,12 @@
|
||||
};
|
||||
|
||||
/**
|
||||
* Extension object for DataTables that is used to provide all extension options.
|
||||
*
|
||||
* Note that the <i>DataTable.ext</i> object is available through
|
||||
* <i>jQuery.fn.dataTable.ext</i> where it may be accessed and manipulated. It is
|
||||
* also aliased to <i>jQuery.fn.dataTableExt</i> for historic reasons.
|
||||
* Extension object for DataTables that is used to provide all extension
|
||||
* options.
|
||||
*
|
||||
* Note that the `DataTable.ext` object is available through
|
||||
* `jQuery.fn.dataTable.ext` where it may be accessed and manipulated. It is
|
||||
* also aliased to `jQuery.fn.dataTableExt` for historic reasons.
|
||||
* @namespace
|
||||
* @extends DataTable.models.ext
|
||||
*/
|
||||
@ -11840,9 +11842,9 @@
|
||||
|
||||
// Information about events fired by DataTables - for documentation.
|
||||
/**
|
||||
* Draw event, fired whenever the table is redrawn on the page, at the same point as
|
||||
* fnDrawCallback. This may be useful for binding events or performing calculations when
|
||||
* the table is altered at all.
|
||||
* Draw event, fired whenever the table is redrawn on the page, at the same
|
||||
* point as fnDrawCallback. This may be useful for binding events or
|
||||
* performing calculations when the table is altered at all.
|
||||
* @name DataTable#draw
|
||||
* @event
|
||||
* @param {event} e jQuery event object
|
||||
@ -11850,8 +11852,8 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* Filter event, fired when the filtering applied to the table (using the build in global
|
||||
* global filter, or column filters) is altered.
|
||||
* Filter event, fired when the filtering applied to the table (using the
|
||||
* build in global global filter, or column filters) is altered.
|
||||
* @name DataTable#filter
|
||||
* @event
|
||||
* @param {event} e jQuery event object
|
||||
@ -11875,8 +11877,8 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* DataTables initialisation complete event, fired when the table is fully drawn,
|
||||
* including Ajax data loaded, if Ajax data is required.
|
||||
* DataTables initialisation complete event, fired when the table is fully
|
||||
* drawn, including Ajax data loaded, if Ajax data is required.
|
||||
* @name DataTable#init
|
||||
* @event
|
||||
* @param {event} e jQuery event object
|
||||
@ -11886,10 +11888,10 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* State save event, fired when the table has changed state a new state save is required.
|
||||
* This method allows modification of the state saving object prior to actually doing the
|
||||
* save, including addition or other state properties (for plug-ins) or modification
|
||||
* of a DataTables core property.
|
||||
* State save event, fired when the table has changed state a new state save
|
||||
* is required. This method allows modification of the state saving object
|
||||
* prior to actually doing the save, including addition or other state
|
||||
* properties (for plug-ins) or modification of a DataTables core property.
|
||||
* @name DataTable#stateSaveParams
|
||||
* @event
|
||||
* @param {event} e jQuery event object
|
||||
@ -11898,9 +11900,10 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* State load event, fired when the table is loading state from the stored data, but
|
||||
* prior to the settings object being modified by the saved state - allowing modification
|
||||
* of the saved state is required or loading of state for a plug-in.
|
||||
* State load event, fired when the table is loading state from the stored
|
||||
* data, but prior to the settings object being modified by the saved state
|
||||
* - allowing modification of the saved state is required or loading of
|
||||
* state for a plug-in.
|
||||
* @name DataTable#stateLoadParams
|
||||
* @event
|
||||
* @param {event} e jQuery event object
|
||||
@ -11909,8 +11912,8 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* State loaded event, fired when state has been loaded from stored data and the settings
|
||||
* object has been modified by the loaded data.
|
||||
* State loaded event, fired when state has been loaded from stored data and
|
||||
* the settings object has been modified by the loaded data.
|
||||
* @name DataTable#stateLoaded
|
||||
* @event
|
||||
* @param {event} e jQuery event object
|
||||
@ -11919,9 +11922,10 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* Processing event, fired when DataTables is doing some kind of processing (be it,
|
||||
* sort, filter or anything else). Can be used to indicate to the end user that
|
||||
* there is something happening, or that something has finished.
|
||||
* Processing event, fired when DataTables is doing some kind of processing
|
||||
* (be it, sort, filter or anything else). Can be used to indicate to the
|
||||
* end user that there is something happening, or that something has
|
||||
* finished.
|
||||
* @name DataTable#processing
|
||||
* @event
|
||||
* @param {event} e jQuery event object
|
||||
@ -11961,9 +11965,9 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* Destroy event, fired when the DataTable is destroyed by calling fnDestroy or passing
|
||||
* the bDestroy:true parameter in the initialisation object. This can be used to remove
|
||||
* bound events, added DOM nodes, etc.
|
||||
* Destroy event, fired when the DataTable is destroyed by calling fnDestroy
|
||||
* or passing the bDestroy:true parameter in the initialisation object. This
|
||||
* can be used to remove bound events, added DOM nodes, etc.
|
||||
* @name DataTable#destroy
|
||||
* @event
|
||||
* @param {event} e jQuery event object
|
||||
|
||||
@ -12,16 +12,16 @@
|
||||
* BSD style license, available at:
|
||||
* http://datatables.net/license_gpl2
|
||||
* http://datatables.net/license_bsd
|
||||
*
|
||||
* This source file is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
*
|
||||
* This source file is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
* or FITNESS FOR A PARTICULAR PURPOSE. See the license files for details.
|
||||
*
|
||||
*
|
||||
* For details please refer to: http://www.datatables.net
|
||||
*/
|
||||
|
||||
/*jslint evil: true, undef: true, browser: true */
|
||||
/*globals $, jQuery,define,_fnExternApiFunc,_fnInitialise,_fnInitComplete,_fnLanguageCompat,_fnAddColumn,_fnColumnOptions,_fnAddData,_fnCreateTr,_fnGatherData,_fnBuildHead,_fnDrawHead,_fnDraw,_fnReDraw,_fnAjaxUpdate,_fnAjaxParameters,_fnAjaxUpdateDraw,_fnServerParams,_fnAddOptionsHtml,_fnFeatureHtmlTable,_fnScrollDraw,_fnAdjustColumnSizing,_fnFeatureHtmlFilter,_fnFilterComplete,_fnFilterCustom,_fnFilterColumn,_fnFilter,_fnBuildSearchArray,_fnBuildSearchRow,_fnFilterCreateSearch,_fnDataToSearch,_fnSort,_fnSortAttachListener,_fnSortingClasses,_fnFeatureHtmlPaginate,_fnPageChange,_fnFeatureHtmlInfo,_fnUpdateInfo,_fnFeatureHtmlLength,_fnFeatureHtmlProcessing,_fnProcessingDisplay,_fnVisibleToColumnIndex,_fnColumnIndexToVisible,_fnNodeToDataIndex,_fnVisbleColumns,_fnCalculateEnd,_fnConvertToWidth,_fnCalculateColumnWidths,_fnScrollingWidthAdjust,_fnGetWidestNode,_fnGetMaxLenString,_fnStringToCss,_fnDetectType,_fnSettingsFromNode,_fnGetDataMaster,_fnGetTrNodes,_fnGetTdNodes,_fnEscapeRegex,_fnDeleteIndex,_fnColumnOrdering,_fnLog,_fnClearTable,_fnSaveState,_fnLoadState,_fnDetectHeader,_fnGetUniqueThs,_fnScrollBarWidth,_fnApplyToChildren,_fnMap,_fnGetRowData,_fnGetCellData,_fnSetCellData,_fnGetObjectDataFn,_fnSetObjectDataFn,_fnApplyColumnDefs,_fnBindAction,_fnCallbackReg,_fnCallbackFire,_fnNodeToColumnIndex,_fnInfoMacros,_fnBrowserDetect,_fnGetColumns,_fnHungarianMap,_fnCamelToHungarian*/
|
||||
/*globals $,require,jQuery,define,_fnExternApiFunc,_fnInitialise,_fnInitComplete,_fnLanguageCompat,_fnAddColumn,_fnColumnOptions,_fnAddData,_fnCreateTr,_fnGatherData,_fnBuildHead,_fnDrawHead,_fnDraw,_fnReDraw,_fnAjaxUpdate,_fnAjaxParameters,_fnAjaxUpdateDraw,_fnServerParams,_fnAddOptionsHtml,_fnFeatureHtmlTable,_fnScrollDraw,_fnAdjustColumnSizing,_fnFeatureHtmlFilter,_fnFilterComplete,_fnFilterCustom,_fnFilterColumn,_fnFilter,_fnBuildSearchArray,_fnBuildSearchRow,_fnFilterCreateSearch,_fnDataToSearch,_fnSort,_fnSortAttachListener,_fnSortingClasses,_fnFeatureHtmlPaginate,_fnPageChange,_fnFeatureHtmlInfo,_fnUpdateInfo,_fnFeatureHtmlLength,_fnFeatureHtmlProcessing,_fnProcessingDisplay,_fnVisibleToColumnIndex,_fnColumnIndexToVisible,_fnNodeToDataIndex,_fnVisbleColumns,_fnCalculateEnd,_fnConvertToWidth,_fnCalculateColumnWidths,_fnScrollingWidthAdjust,_fnGetWidestNode,_fnGetMaxLenString,_fnStringToCss,_fnDetectType,_fnSettingsFromNode,_fnGetDataMaster,_fnGetTrNodes,_fnGetTdNodes,_fnEscapeRegex,_fnDeleteIndex,_fnColumnOrdering,_fnLog,_fnClearTable,_fnSaveState,_fnLoadState,_fnDetectHeader,_fnGetUniqueThs,_fnScrollBarWidth,_fnApplyToChildren,_fnMap,_fnGetRowData,_fnGetCellData,_fnSetCellData,_fnGetObjectDataFn,_fnSetObjectDataFn,_fnApplyColumnDefs,_fnBindAction,_fnCallbackReg,_fnCallbackFire,_fnNodeToColumnIndex,_fnInfoMacros,_fnBrowserDetect,_fnGetColumns,_fnHungarianMap,_fnCamelToHungarian*/
|
||||
|
||||
(/** @lends <global> */function( window, document, undefined ) {
|
||||
|
||||
@ -44,35 +44,35 @@
|
||||
(/** @lends <global> */function( $ ) {
|
||||
"use strict";
|
||||
|
||||
/**
|
||||
* DataTables is a plug-in for the jQuery Javascript library. It is a
|
||||
* highly flexible tool, based upon the foundations of progressive
|
||||
* enhancement, which will add advanced interaction controls to any
|
||||
* HTML table. For a full list of features please refer to
|
||||
* <a href="http://datatables.net">DataTables.net</a>.
|
||||
/**
|
||||
* DataTables is a plug-in for the jQuery Javascript library. It is a highly
|
||||
* flexible tool, based upon the foundations of progressive enhancement,
|
||||
* which will add advanced interaction controls to any HTML table. For a
|
||||
* full list of features please refer to
|
||||
* [DataTables.net](href="http://datatables.net).
|
||||
*
|
||||
* Note that the <i>DataTable</i> object is not a global variable but is
|
||||
* aliased to <i>jQuery.fn.DataTable</i> and <i>jQuery.fn.dataTable</i> through which
|
||||
* it may be accessed.
|
||||
* Note that the `DataTable` object is not a global variable but is aliased
|
||||
* to `jQuery.fn.DataTable` and `jQuery.fn.dataTable` through which it may
|
||||
* be accessed.
|
||||
*
|
||||
* @class
|
||||
* @param {object} [oInit={}] Configuration object for DataTables. Options
|
||||
* @param {object} [init={}] Configuration object for DataTables. Options
|
||||
* are defined by {@link DataTable.defaults}
|
||||
* @requires jQuery 1.3+
|
||||
*
|
||||
*
|
||||
* @example
|
||||
* // Basic initialisation
|
||||
* $(document).ready( function {
|
||||
* $('#example').dataTable();
|
||||
* } );
|
||||
*
|
||||
*
|
||||
* @example
|
||||
* // Initialisation with configuration options - in this case, disable
|
||||
* // pagination and sorting.
|
||||
* $(document).ready( function {
|
||||
* $('#example').dataTable( {
|
||||
* "bPaginate": false,
|
||||
* "bSort": false
|
||||
* "paginate": false,
|
||||
* "sort": false
|
||||
* } );
|
||||
* } );
|
||||
*/
|
||||
@ -121,11 +121,12 @@
|
||||
DataTable.version = "1.10.0-dev";
|
||||
|
||||
/**
|
||||
* Private data store, containing all of the settings objects that are created for the
|
||||
* tables on a given page.
|
||||
*
|
||||
* Note that the <i>DataTable.settings</i> object is aliased to <i>jQuery.fn.dataTableExt</i>
|
||||
* through which it may be accessed and manipulated, or <i>jQuery.fn.dataTable.settings</i>.
|
||||
* Private data store, containing all of the settings objects that are
|
||||
* created for the tables on a given page.
|
||||
*
|
||||
* Note that the `DataTable.settings` object is aliased to
|
||||
* `jQuery.fn.dataTableExt` through which it may be accessed and
|
||||
* manipulated, or `jQuery.fn.dataTable.settings`.
|
||||
* @member
|
||||
* @type array
|
||||
* @default []
|
||||
@ -134,9 +135,9 @@
|
||||
DataTable.settings = [];
|
||||
|
||||
/**
|
||||
* Object models container, for the various models that DataTables has available
|
||||
* to it. These models define the objects that are used to hold the active state
|
||||
* and configuration of the table.
|
||||
* Object models container, for the various models that DataTables has
|
||||
* available to it. These models define the objects that are used to hold
|
||||
* the active state and configuration of the table.
|
||||
* @namespace
|
||||
*/
|
||||
DataTable.models = {};
|
||||
@ -149,11 +150,12 @@
|
||||
require('model.settings.js');
|
||||
|
||||
/**
|
||||
* Extension object for DataTables that is used to provide all extension options.
|
||||
*
|
||||
* Note that the <i>DataTable.ext</i> object is available through
|
||||
* <i>jQuery.fn.dataTable.ext</i> where it may be accessed and manipulated. It is
|
||||
* also aliased to <i>jQuery.fn.dataTableExt</i> for historic reasons.
|
||||
* Extension object for DataTables that is used to provide all extension
|
||||
* options.
|
||||
*
|
||||
* Note that the `DataTable.ext` object is available through
|
||||
* `jQuery.fn.dataTable.ext` where it may be accessed and manipulated. It is
|
||||
* also aliased to `jQuery.fn.dataTableExt` for historic reasons.
|
||||
* @namespace
|
||||
* @extends DataTable.models.ext
|
||||
*/
|
||||
@ -172,9 +174,9 @@
|
||||
|
||||
// Information about events fired by DataTables - for documentation.
|
||||
/**
|
||||
* Draw event, fired whenever the table is redrawn on the page, at the same point as
|
||||
* fnDrawCallback. This may be useful for binding events or performing calculations when
|
||||
* the table is altered at all.
|
||||
* Draw event, fired whenever the table is redrawn on the page, at the same
|
||||
* point as fnDrawCallback. This may be useful for binding events or
|
||||
* performing calculations when the table is altered at all.
|
||||
* @name DataTable#draw
|
||||
* @event
|
||||
* @param {event} e jQuery event object
|
||||
@ -182,8 +184,8 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* Filter event, fired when the filtering applied to the table (using the build in global
|
||||
* global filter, or column filters) is altered.
|
||||
* Filter event, fired when the filtering applied to the table (using the
|
||||
* build in global global filter, or column filters) is altered.
|
||||
* @name DataTable#filter
|
||||
* @event
|
||||
* @param {event} e jQuery event object
|
||||
@ -207,8 +209,8 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* DataTables initialisation complete event, fired when the table is fully drawn,
|
||||
* including Ajax data loaded, if Ajax data is required.
|
||||
* DataTables initialisation complete event, fired when the table is fully
|
||||
* drawn, including Ajax data loaded, if Ajax data is required.
|
||||
* @name DataTable#init
|
||||
* @event
|
||||
* @param {event} e jQuery event object
|
||||
@ -218,10 +220,10 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* State save event, fired when the table has changed state a new state save is required.
|
||||
* This method allows modification of the state saving object prior to actually doing the
|
||||
* save, including addition or other state properties (for plug-ins) or modification
|
||||
* of a DataTables core property.
|
||||
* State save event, fired when the table has changed state a new state save
|
||||
* is required. This method allows modification of the state saving object
|
||||
* prior to actually doing the save, including addition or other state
|
||||
* properties (for plug-ins) or modification of a DataTables core property.
|
||||
* @name DataTable#stateSaveParams
|
||||
* @event
|
||||
* @param {event} e jQuery event object
|
||||
@ -230,9 +232,10 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* State load event, fired when the table is loading state from the stored data, but
|
||||
* prior to the settings object being modified by the saved state - allowing modification
|
||||
* of the saved state is required or loading of state for a plug-in.
|
||||
* State load event, fired when the table is loading state from the stored
|
||||
* data, but prior to the settings object being modified by the saved state
|
||||
* - allowing modification of the saved state is required or loading of
|
||||
* state for a plug-in.
|
||||
* @name DataTable#stateLoadParams
|
||||
* @event
|
||||
* @param {event} e jQuery event object
|
||||
@ -241,8 +244,8 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* State loaded event, fired when state has been loaded from stored data and the settings
|
||||
* object has been modified by the loaded data.
|
||||
* State loaded event, fired when state has been loaded from stored data and
|
||||
* the settings object has been modified by the loaded data.
|
||||
* @name DataTable#stateLoaded
|
||||
* @event
|
||||
* @param {event} e jQuery event object
|
||||
@ -251,9 +254,10 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* Processing event, fired when DataTables is doing some kind of processing (be it,
|
||||
* sort, filter or anything else). Can be used to indicate to the end user that
|
||||
* there is something happening, or that something has finished.
|
||||
* Processing event, fired when DataTables is doing some kind of processing
|
||||
* (be it, sort, filter or anything else). Can be used to indicate to the
|
||||
* end user that there is something happening, or that something has
|
||||
* finished.
|
||||
* @name DataTable#processing
|
||||
* @event
|
||||
* @param {event} e jQuery event object
|
||||
@ -293,9 +297,9 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* Destroy event, fired when the DataTable is destroyed by calling fnDestroy or passing
|
||||
* the bDestroy:true parameter in the initialisation object. This can be used to remove
|
||||
* bound events, added DOM nodes, etc.
|
||||
* Destroy event, fired when the DataTable is destroyed by calling fnDestroy
|
||||
* or passing the bDestroy:true parameter in the initialisation object. This
|
||||
* can be used to remove bound events, added DOM nodes, etc.
|
||||
* @name DataTable#destroy
|
||||
* @event
|
||||
* @param {event} e jQuery event object
|
||||
|
||||
Loading…
Reference in New Issue
Block a user