1
0
mirror of https://github.com/DataTables/DataTables.git synced 2025-02-18 16:54:14 +01:00

Documentation - note that DataTable is not a global object, but give variables for how it can be accessed

This commit is contained in:
Allan Jardine 2011-12-14 15:08:42 +00:00
parent 473fc847b2
commit 356579f311
2 changed files with 20 additions and 0 deletions

View File

@ -35,6 +35,10 @@
* HTML table. For a full list of features please refer to
* <a href="http://datatables.net">DataTables.net</a>.
*
* 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.
*
* @class
* @param {object} [oInit={}] Configuration object for DataTables. Options
* are defined by {@link DataTable.models.oInit}
@ -6392,6 +6396,9 @@
/**
* 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 is may be accessed and manipulated, or <i>jQuery.fn.dataTable.settings</i>.
* @member
* @type array
* @default []
@ -9827,6 +9834,9 @@
/**
* Extension object for DataTables that is used to provide all extension options.
* See {@link DataTable.models.ext} for full information about the extension object.
*
* Note that the <i>DataTable.ext</i> object is aliased to <i>jQuery.fn.dataTableExt</i>
* through which is may be accessed and manipulated, or <i>jQuery.fn.dataTable.ext</i>.
* @namespace
*/
DataTable.ext = $.extend( true, {}, DataTable.models.ext );

View File

@ -35,6 +35,10 @@
* HTML table. For a full list of features please refer to
* <a href="http://datatables.net">DataTables.net</a>.
*
* 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.
*
* @class
* @param {object} [oInit={}] Configuration object for DataTables. Options
* are defined by {@link DataTable.models.oInit}
@ -96,6 +100,9 @@
/**
* 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 is may be accessed and manipulated, or <i>jQuery.fn.dataTable.settings</i>.
* @member
* @type array
* @default []
@ -119,6 +126,9 @@
/**
* Extension object for DataTables that is used to provide all extension options.
* See {@link DataTable.models.ext} for full information about the extension object.
*
* Note that the <i>DataTable.ext</i> object is aliased to <i>jQuery.fn.dataTableExt</i>
* through which is may be accessed and manipulated, or <i>jQuery.fn.dataTable.ext</i>.
* @namespace
*/
DataTable.ext = $.extend( true, {}, DataTable.models.ext );