From e1d860205b27e99a255ff07ab1e42daa7a0d4eac Mon Sep 17 00:00:00 2001 From: Allan Jardine Date: Wed, 14 Dec 2011 16:22:58 +0000 Subject: [PATCH] Change the defaults object from attaching to DataTable.models to just the top level DataTable as DataTable.defaults - makes it much easier to access it when trying to set a default. --- media/js/jquery.dataTables.js | 96 +- media/src/DataTables.js | 4 +- media/src/core/core.constructor.js | 4 +- media/src/model/model.init.js | 1748 ---------------------------- media/src/model/model.settings.js | 88 +- 5 files changed, 96 insertions(+), 1844 deletions(-) delete mode 100644 media/src/model/model.init.js diff --git a/media/js/jquery.dataTables.js b/media/js/jquery.dataTables.js index 39262074..ab8651ae 100644 --- a/media/js/jquery.dataTables.js +++ b/media/js/jquery.dataTables.js @@ -41,7 +41,7 @@ * * @class * @param {object} [oInit={}] Configuration object for DataTables. Options - * are defined by {@link DataTable.models.oInit} + * are defined by {@link DataTable.defaults} * @requires jQuery 1.3+ * * @example @@ -6036,7 +6036,7 @@ _fnLanguageCompat( oInit.oLanguage ); } - oInit = _fnExtend( $.extend(true, {}, DataTable.models.oInit), oInit ); + oInit = _fnExtend( $.extend(true, {}, DataTable.defaults), oInit ); // Map the initialisation options onto the settings object _fnMap( oSettings.oFeatures, oInit, "bPaginate" ); @@ -6144,7 +6144,7 @@ */ $.extend( oSettings.oClasses, DataTable.ext.oJUIClasses ); - if ( oInit.sDom == DataTable.models.oInit.sDom ) + if ( oInit.sDom == DataTable.defaults.sDom ) { /* Set the DOM to use a layout suitable for jQuery UI's theming */ oSettings.sDom = '<"H"lfr>t<"F"ip>'; @@ -7349,7 +7349,7 @@ * time. * @namespace */ - DataTable.models.oInit = { + DataTable.defaults = { /** * An array of data to use for the table, passed in at initialisation which * will be used in preference to any data which is already in the DOM. This is @@ -9101,7 +9101,7 @@ * $().dataTable() call) and the settings object is then applied to that * instance. * - * Note that this object is related to {@link DataTable.models.oInit} but this + * Note that this object is related to {@link DataTable.defaults} but this * one is the internal data store for DataTables's cache of columns. It should * NOT be manipulated outside of DataTables. Any configuration should be done * through the initialisation options. @@ -9125,7 +9125,7 @@ * Flag to say if DataTables should automatically try to calculate the * optimum table and columns widths (true) or not (false). * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bAutoWidth": null, @@ -9136,7 +9136,7 @@ * increase for Ajax source and Javascript source data, but makes no * difference at all fro DOM and server-side processing tables. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bDeferRender": null, @@ -9146,7 +9146,7 @@ * then there is no filtering at all on the table, including fnFilter. * To just remove the filtering input use sDom and remove the 'f' option. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bFilter": null, @@ -9155,7 +9155,7 @@ * Table information element (the 'Showing x of y records' div) enable * flag. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bInfo": null, @@ -9164,7 +9164,7 @@ * Present a user control allowing the end user to change the page size * when pagination is enabled. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bLengthChange": null, @@ -9173,7 +9173,7 @@ * Pagination enabled or not. Note that if this is disabled then length * changing must also be disabled. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bPaginate": null, @@ -9182,7 +9182,7 @@ * Processing indicator enable flag whenever DataTables is enacting a * user request - typically an Ajax request for server-side processing. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bProcessing": null, @@ -9192,7 +9192,7 @@ * get all data from the server for every draw - there is no filtering, * sorting or paging done on the client-side. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bServerSide": null, @@ -9200,7 +9200,7 @@ /** * Sorting enablement flag. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bSort": null, @@ -9210,7 +9210,7 @@ * visual highlight or not. This can slow things down when enabled since * there is a lot of DOM interaction. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bSortClasses": null, @@ -9218,7 +9218,7 @@ /** * State saving enablement flag. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bStateSave": null @@ -9235,7 +9235,7 @@ * etc for the scrolling header elements or not. Typically you will want * this. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bAutoCss": null, @@ -9244,7 +9244,7 @@ * When the table is shorter in height than sScrollY, collapse the * table container down to the height of the table (when true). * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bCollapse": null, @@ -9253,7 +9253,7 @@ * Infinite scrolling enablement flag. Now deprecated in favour of * using the Scroller plug-in. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bInfinite": null, @@ -9271,7 +9271,7 @@ * the bottom of the scrolling viewport before the next page is loaded * when using infinite scrolling. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type int */ "iLoadGap": null, @@ -9280,7 +9280,7 @@ * Viewport width for horizontal scrolling. Horizontal scrolling is * disabled if an empty string. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string */ "sX": null, @@ -9289,7 +9289,7 @@ * Width to expand the table to when using x-scrolling. Typically you * should not need to use this. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string * @deprecated */ @@ -9299,7 +9299,7 @@ * Viewport height for vertical scrolling. Vertical scrolling is disabled * if an empty string. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string */ "sY": null @@ -9308,12 +9308,12 @@ /** * Language information for the table. * @namespace - * @extends DataTable.models.oInit.oLanguage + * @extends DataTable.defaults.oLanguage */ "oLanguage": { /** * Information callback function. See - * {@link DataTable.models.oInit.fnInfoCallback} + * {@link DataTable.defaults.fnInfoCallback} * @type function * @default */ @@ -9390,7 +9390,7 @@ * Store the applied global search information in case we want to force a * research or compare the old search to a new one. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @namespace * @extends DataTable.models.oSearch */ @@ -9414,7 +9414,7 @@ *
  • Index 2 - index of asSorting for this column
    • * * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type array * @todo These inner arrays should really be objects */ @@ -9424,7 +9424,7 @@ * Sorting that is always applied to the table (i.e. prefixed in front of * aaSorting). * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type array|null * @default null */ @@ -9433,7 +9433,7 @@ /** * Classes to use for the striping of a table. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type array * @default [] */ @@ -9456,7 +9456,7 @@ /** * Call this function every time a row is inserted (draw). * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type function * @default null * @todo Make into an array so plug-ins can hook in @@ -9466,7 +9466,7 @@ /** * Callback function for the header on each draw. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type function * @default null * @todo Make into an array so plug-ins can hook in @@ -9476,7 +9476,7 @@ /** * Callback function for the footer on each draw. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type function * @default null * @todo Make into an array so plug-ins can hook in @@ -9494,7 +9494,7 @@ * Callback function for just before the table is redrawn. A return of * false will be used to cancel the draw. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type function * @default null * @todo Make into an array so plug-ins can hook in @@ -9504,7 +9504,7 @@ /** * Callback function for when the table has been initialised. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type function * @default null * @todo Make into an array so plug-ins can hook in @@ -9557,7 +9557,7 @@ * Indicate if when using server-side processing the loading of data * should be deferred until the second draw. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean * @default false */ @@ -9582,7 +9582,7 @@ * Dictate the positioning of DataTables' control elements - see * {@link DataTable.model.oInit.sDom}. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string * @default null */ @@ -9591,7 +9591,7 @@ /** * Which type of pagination should be used. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string * @default two_button */ @@ -9600,7 +9600,7 @@ /** * The cookie duration (for bStateSave) in seconds. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type int * @default 0 */ @@ -9609,7 +9609,7 @@ /** * The cookie name prefix. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string * @default Empty string */ @@ -9618,7 +9618,7 @@ /** * Callback function for cookie creation. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type function * @default null */ @@ -9662,7 +9662,7 @@ /** * Source url for AJAX data for the table. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string * @default null */ @@ -9673,7 +9673,7 @@ * can be an empty string (when not server-side processing), in which case * it is assumed an an array is given directly. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string */ "sAjaxDataProp": null, @@ -9697,7 +9697,7 @@ /** * Function to get the server-side data. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type function */ "fnServerData": null, @@ -9714,7 +9714,7 @@ * Send the XHR HTTP method - GET or POST (could be PUT or DELETE if * required). * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string */ "sServerMethod": null, @@ -9722,7 +9722,7 @@ /** * Format numbers for display. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type function */ "fnFormatNumber": null, @@ -9730,7 +9730,7 @@ /** * List of options that can be used for the user selectable length menu. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type array * @default [] */ @@ -9806,7 +9806,7 @@ /** * Flag to indicate if jQuery UI marking and classes should be used. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bJUI": null, @@ -9843,7 +9843,7 @@ * one unique cell per column, if the top one (true) or bottom one (false) * should be used for sorting / title by DataTables. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bSortCellsTop": null, diff --git a/media/src/DataTables.js b/media/src/DataTables.js index c0427b91..63dce0fa 100644 --- a/media/src/DataTables.js +++ b/media/src/DataTables.js @@ -41,7 +41,7 @@ * * @class * @param {object} [oInit={}] Configuration object for DataTables. Options - * are defined by {@link DataTable.models.oInit} + * are defined by {@link DataTable.defaults} * @requires jQuery 1.3+ * * @example @@ -120,7 +120,7 @@ require('model.search.js'); require('model.row.js'); require('model.column.js'); - require('model.init.js'); + require('model.defaults.js'); require('model.settings.js'); /** diff --git a/media/src/core/core.constructor.js b/media/src/core/core.constructor.js index e19aae85..18961e6e 100644 --- a/media/src/core/core.constructor.js +++ b/media/src/core/core.constructor.js @@ -83,7 +83,7 @@ if ( oInit.oLanguage ) _fnLanguageCompat( oInit.oLanguage ); } -oInit = _fnExtend( $.extend(true, {}, DataTable.models.oInit), oInit ); +oInit = _fnExtend( $.extend(true, {}, DataTable.defaults), oInit ); // Map the initialisation options onto the settings object _fnMap( oSettings.oFeatures, oInit, "bPaginate" ); @@ -191,7 +191,7 @@ if ( oInit.bJQueryUI ) */ $.extend( oSettings.oClasses, DataTable.ext.oJUIClasses ); - if ( oInit.sDom == DataTable.models.oInit.sDom ) + if ( oInit.sDom == DataTable.defaults.sDom ) { /* Set the DOM to use a layout suitable for jQuery UI's theming */ oSettings.sDom = '<"H"lfr>t<"F"ip>'; diff --git a/media/src/model/model.init.js b/media/src/model/model.init.js deleted file mode 100644 index 884a9cdd..00000000 --- a/media/src/model/model.init.js +++ /dev/null @@ -1,1748 +0,0 @@ - - -/** - * Initialisation options that can be given to DataTables at initialisation - * time. - * @namespace - */ -DataTable.models.oInit = { - /** - * An array of data to use for the table, passed in at initialisation which - * will be used in preference to any data which is already in the DOM. This is - * particularly useful for constructing tables purely in Javascript, for - * example with a custom Ajax call. - * @type array - * @default null - * - * @example - * // Using a 2D array data source - * $(document).ready( function () { - * $('#example').dataTable( { - * "aaData": [ - * ['Trident', 'Internet Explorer 4.0', 'Win 95+', 4, 'X'], - * ['Trident', 'Internet Explorer 5.0', 'Win 95+', 5, 'C'], - * ], - * "aoColumns": [ - * { "sTitle": "Engine" }, - * { "sTitle": "Browser" }, - * { "sTitle": "Platform" }, - * { "sTitle": "Version" }, - * { "sTitle": "Grade" } - * ] - * } ); - * } ); - * - * @example - * // Using an array of objects as a data source (mDataProp) - * $(document).ready( function () { - * $('#example').dataTable( { - * "aaData": [ - * { - * "engine": "Trident", - * "browser": "Internet Explorer 4.0", - * "platform": "Win 95+", - * "version": 4, - * "grade": "X" - * }, - * { - * "engine": "Trident", - * "browser": "Internet Explorer 5.0", - * "platform": "Win 95+", - * "version": 5, - * "grade": "C" - * } - * ], - * "aoColumns": [ - * { "sTitle": "Engine", "mDataProp": "engine" }, - * { "sTitle": "Browser", "mDataProp": "browser" }, - * { "sTitle": "Platform", "mDataProp": "platform" }, - * { "sTitle": "Version", "mDataProp": "version" }, - * { "sTitle": "Grade", "mDataProp": "grade" } - * ] - * } ); - * } ); - */ - "aaData": null, - - - /** - * If sorting is enabled, then DataTables will perform a first pass sort on - * initialisation. You can define which column(s) the sort is performed upon, - * and the sorting direction, with this variable. The aaSorting array should - * contain an array for each column to be sorted initially containing the - * column's index and a direction string ('asc' or 'desc'). - * @type array - * @default [[0,'asc']] - * - * @example - * // Sort by 3rd column first, and then 4th column - * $(document).ready( function() { - * $('#example').dataTable( { - * "aaSorting": [[2,'asc'], [3,'desc']] - * } ); - * } ); - * - * // No initial sorting - * $(document).ready( function() { - * $('#example').dataTable( { - * "aaSorting": [] - * } ); - * } ); - */ - "aaSorting": [[0,'asc']], - - - /** - * This parameter is basically identical to the aaSorting parameter, but - * cannot be overridden by user interaction with the table. What this means - * is that you could have a column (visible or hidden) which the sorting will - * always be forced on first - any sorting after that (from the user) will - * then be performed as required. This can be useful for grouping rows - * together. - * @type array - * @default null - * - * @example - * $(document).ready( function() { - * $('#example').dataTable( { - * "aaSortingFixed": [[0,'asc']] - * } ); - * } ) - */ - "aaSortingFixed": null, - - - /** - * This parameter allows you to readily specify the entries in the length drop - * down menu that DataTables shows when pagination is enabled. It can be - * either a 1D array of options which will be used for both the displayed - * option and the value, or a 2D array which will use the array in the first - * position as the value, and the array in the second position as the - * displayed options (useful for language strings such as 'All'). - * @type array - * @default [ 10, 25, 50, 100 ] - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "aLengthMenu": [[10, 25, 50, -1], [10, 25, 50, "All"]] - * } ); - * } ); - * - * @example - * // Setting the default display length as well as length menu - * // This is likely to be wanted if you remove the '10' option which - * // is the iDisplayLength default. - * $(document).ready(function() { - * $('#example').dataTable( { - * "iDisplayLength": 25, - * "aLengthMenu": [[25, 50, 100, -1], [25, 50, 100, "All"]] - * } ); - * } ); - */ - "aLengthMenu": [ 10, 25, 50, 100 ], - - - /** - * The aoColumns option in the initialisation parameter allows you to define - * details about the way individual columns behave. For a full list of - * column options that can be set, please see - * {@link DataTable.models.oInitColumns}. Note that if you use aoColumns to - * define your columns, you must have an entry in the array for every single - * column that you have in your table (these can be null if you don't which - * to specify any options). - * @namespace - */ - "aoColumns": null, - - /** - * Very similar to aoColumns, aoColumnDefs allows you to target a specific - * column, multiple columns, or all columns, using the aTargets property of - * each object in the array. This allows great flexibility when creating - * tables, as the aoColumnDefs arrays can be of any length, targeting the - * columns you specifically want. aoColumnDefs may use any of the column - * options available: {@link DataTable.models.oInitColumns}, but it _must_ - * have aTargets defined in each object in the array. Values in the aTargets - * array may be: - * - * @namespace - */ - "aoColumnDefs": null, - - - /** - * Basically the same as oSearch, this parameter defines the individual column - * filtering state at initialisation time. The array must be of the same size - * as the number of columns, and each element be an object with the parameters - * "sSearch" and "bEscapeRegex" (the latter is optional). 'null' is also - * accepted and the default will be used. - * @type array - * @default [] - * - * @example - * $(document).ready( function() { - * $('#example').dataTable( { - * "aoSearchCols": [ - * null, - * { "sSearch": "My filter" }, - * null, - * { "sSearch": "^[0-9]", "bEscapeRegex": false } - * ] - * } ); - * } ) - */ - "aoSearchCols": [], - - - /** - * An array of CSS classes that should be applied to displayed rows. This - * array may be of any length, and DataTables will apply each class - * sequentially, looping when required. - * @type array - * @default [ 'odd', 'even' ] - * - * @example - * $(document).ready( function() { - * $('#example').dataTable( { - * "asStripeClasses": [ 'strip1', 'strip2', 'strip3' ] - * } ); - * } ) - */ - "asStripeClasses": [ 'odd', 'even' ], - - - /** - * Enable or disable automatic column width calculation. This can be disabled - * as an optimisation (it takes some time to calculate the widths) if the - * tables widths are passed in using aoColumns. - * @type boolean - * @default true - * - * @example - * $(document).ready( function () { - * $('#example').dataTable( { - * "bAutoWidth": false - * } ); - * } ); - */ - "bAutoWidth": true, - - - /** - * Deferred rendering can provide DataTables with a huge speed boost when you - * are using an Ajax or JS data source for the table. This option, when set to - * true, will cause DataTables to defer the creation of the table elements for - * each row until they are needed for a draw - saving a significant amount of - * time. - * @type boolean - * @default false - * - * @example - * $(document).ready(function() { - * var oTable = $('#example').dataTable( { - * "sAjaxSource": "sources/arrays.txt", - * "bDeferRender": true - * } ); - * } ); - */ - "bDeferRender": false, - - - /** - * Replace a DataTable which matches the given selector and replace it with - * one which has the properties of the new initialisation object passed. If no - * table matches the selector, then the new DataTable will be constructed as - * per normal. - * @type boolean - * @default false - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "sScrollY": "200px", - * "bPaginate": false - * } ); - * - * // Some time later.... - * $('#example').dataTable( { - * "bFilter": false, - * "bDestroy": true - * } ); - * } ); - */ - "bDestroy": false, - - - /** - * Enable or disable filtering of data. Filtering in DataTables is "smart" in - * that it allows the end user to input multiple words (space separated) and - * will match a row containing those words, even if not in the order that was - * specified (this allow matching across multiple columns). Note that if you - * wish to use filtering in DataTables this must remain 'true' - to remove the - * default filtering input box and retain filtering abilities, please use - * @ref{sDom}. - * @type boolean - * @default true - * - * @example - * $(document).ready( function () { - * $('#example').dataTable( { - * "bFilter": false - * } ); - * } ); - */ - "bFilter": true, - - - /** - * Enable or disable the table information display. This shows information - * about the data that is currently visible on the page, including information - * about filtered data if that action is being performed. - * @type boolean - * @default true - * - * @example - * $(document).ready( function () { - * $('#example').dataTable( { - * "bInfo": false - * } ); - * } ); - */ - "bInfo": true, - - - /** - * Enable jQuery UI ThemeRoller support (required as ThemeRoller requires some - * slightly different and additional mark-up from what DataTables has - * traditionally used). - * @type boolean - * @default false - * - * @example - * $(document).ready( function() { - * $('#example').dataTable( { - * "bJQueryUI": true - * } ); - * } ); - */ - "bJQueryUI": false, - - - /** - * Allows the end user to select the size of a formatted page from a select - * menu (sizes are 10, 25, 50 and 100). Requires pagination (bPaginate). - * @type boolean - * @default true - * - * @example - * $(document).ready( function () { - * $('#example').dataTable( { - * "bLengthChange": false - * } ); - * } ); - */ - "bLengthChange": true, - - - /** - * Enable or disable pagination. - * @type boolean - * @default true - * - * @example - * $(document).ready( function () { - * $('#example').dataTable( { - * "bPaginate": false - * } ); - * } ); - */ - "bPaginate": true, - - - /** - * Enable or disable the display of a 'processing' indicator when the table is - * being processed (e.g. a sort). This is particularly useful for tables with - * large amounts of data where it can take a noticeable amount of time to sort - * the entries. - * @type boolean - * @default false - * - * @example - * $(document).ready( function () { - * $('#example').dataTable( { - * "bProcessing": true - * } ); - * } ); - */ - "bProcessing": false, - - - /** - * Retrieve the DataTables object for the given selector. Note that if the - * table has already been initialised, this parameter will cause DataTables - * to simply return the object that has already been set up - it will not take - * account of any changes you might have made to the initialisation object - * passed to DataTables (setting this parameter to true is an acknowledgement - * that you understand this). bDestroy can be used to reinitialise a table if - * you need. - * @type boolean - * @default false - * - * @example - * $(document).ready(function() { - * initTable(); - * tableActions(); - * } ); - * - * function initTable () - * { - * return $('#example').dataTable( { - * "sScrollY": "200px", - * "bPaginate": false, - * "bRetrieve": true - * } ); - * } - * - * function tableActions () - * { - * var oTable = initTable(); - * // perform API operations with oTable - * } - */ - "bRetrieve": false, - - - /** - * Indicate if DataTables should be allowed to set the padding / margin - * etc for the scrolling header elements or not. Typically you will want - * this. - * @type boolean - * @default true - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "bScrollAutoCss": false, - * "sScrollY": "200px" - * } ); - * } ); - */ - "bScrollAutoCss": true, - - - /** - * When vertical (y) scrolling is enabled, DataTables will force the height of - * the table's viewport to the given height at all times (useful for layout). - * However, this can look odd when filtering data down to a small data set, - * and the footer is left "floating" further down. This parameter (when - * enabled) will cause DataTables to collapse the table's viewport down when - * the result set will fit within the given Y height. - * @type boolean - * @default false - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "sScrollY": "200", - * "bScrollCollapse": true - * } ); - * } ); - */ - "bScrollCollapse": false, - - - /** - * Enable infinite scrolling for DataTables (to be used in combination with - * sScrollY). Infinite scrolling means that DataTables will continually load - * data as a user scrolls through a table, which is very useful for large - * dataset. This cannot be used with pagination, which is automatically - * disabled. - * @type boolean - * @default false - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "bScrollInfinite": true, - * "bScrollCollapse": true, - * "sScrollY": "200px" - * } ); - * } ); - */ - "bScrollInfinite": false, - - - /** - * Configure DataTables to use server-side processing. Note that the - * sAjaxSource parameter must also be given in order to give DataTables a - * source to obtain the required data for each draw. - * @type boolean - * @default false - * - * @example - * $(document).ready( function () { - * $('#example').dataTable( { - * "bServerSide": true, - * "sAjaxSource": "xhr.php" - * } ); - * } ); - */ - "bServerSide": false, - - - /** - * Enable or disable sorting of columns. Sorting of individual columns can be - * disabled by the "bSortable" option for each column. - * @type boolean - * @default true - * - * @example - * $(document).ready( function () { - * $('#example').dataTable( { - * "bSort": false - * } ); - * } ); - */ - "bSort": true, - - - /** - * Allows control over whether DataTables should use the top (true) unique - * cell that is found for a single column, or the bottom (false - default). - * This is useful when using complex headers. - * @type boolean - * @default false - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "bSortCellsTop": true - * } ); - * } ); - */ - "bSortCellsTop": false, - - - /** - * Enable or disable the addition of the classes 'sorting_1', 'sorting_2' and - * 'sorting_3' to the columns which are currently being sorted on. This is - * presented as a feature switch as it can increase processing time (while - * classes are removed and added) so for large data sets you might want to - * turn this off. - * @type boolean - * @default true - * - * @example - * $(document).ready( function () { - * $('#example').dataTable( { - * "bSortClasses": false - * } ); - * } ); - */ - "bSortClasses": true, - - - /** - * Enable or disable state saving. When enabled a cookie will be used to save - * table display information such as pagination information, display length, - * filtering and sorting. As such when the end user reloads the page the - * display display will match what thy had previously set up. - * @type boolean - * @default false - * - * @example - * $(document).ready( function () { - * $('#example').dataTable( { - * "bStateSave": true - * } ); - * } ); - */ - "bStateSave": false, - - - /** - * Customise the cookie and / or the parameters being stored when using - * DataTables with state saving enabled. This function is called whenever - * the cookie is modified, and it expects a fully formed cookie string to be - * returned. Note that the data object passed in is a Javascript object which - * must be converted to a string (JSON.stringify for example). - * @type function - * @param {string} sName Name of the cookie defined by DataTables - * @param {object} oData Data to be stored in the cookie - * @param {string} sExpires Cookie expires string - * @param {string} sPath Path of the cookie to set - * @returns {string} Cookie formatted string (which should be encoded by - * using encodeURIComponent()) - * - * @example - * $(document).ready( function () { - * $('#example').dataTable( { - * "fnCookieCallback": function (sName, oData, sExpires, sPath) { - * // Customise oData or sName or whatever else here - * return sName + "="+JSON.stringify(oData)+"; expires=" + sExpires +"; path=" + sPath; - * } - * } ); - * } ); - */ - "fnCookieCallback": null, - - - /** - * This function is called on every 'draw' event, and allows you to - * dynamically modify any aspect you want about the created DOM. - * @type function - * @param {object} oSettings DataTables settings object - * - * @example - * $(document).ready( function() { - * $('#example').dataTable( { - * "fnDrawCallback": function() { - * alert( 'DataTables has redrawn the table' ); - * } - * } ); - * } ); - */ - "fnDrawCallback": null, - - - /** - * Identical to fnHeaderCallback() but for the table footer this function - * allows you to modify the table footer on every 'draw' even. - * @type function - * @param {node} nFoot "TR" element for the footer - * @param {array} aData Full table data (as derived from the original HTML) - * @param {int} iStart Index for the current display starting point in the - * display array - * @param {int} iEnd Index for the current display ending point in the - * display array - * @param {array int} aiDisplay Index array to translate the visual position - * to the full data array - * - * @example - * $(document).ready( function() { - * $('#example').dataTable( { - * "fnFooterCallback": function( nFoot, aData, iStart, iEnd, aiDisplay ) { - * nFoot.getElementsByTagName('th')[0].innerHTML = "Starting index is "+iStart; - * } - * } ); - * } ) - */ - "fnFooterCallback": null, - - - /** - * When rendering large numbers in the information element for the table - * (i.e. "Showing 1 to 10 of 57 entries") DataTables will render large numbers - * to have a comma separator for the 'thousands' units (e.g. 1 million is - * rendered as "1,000,000") to help readability for the end user. This - * function will override the default method DataTables uses. - * @type function - * @param {int} iIn number to be formatted - * @returns {string} formatted string for DataTables to show the number - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "fnFormatNumber": function ( iIn ) { - * if ( iIn < 1000 ) { - * return iIn; - * } else { - * var - * s=(iIn+""), - * a=s.split(""), out="", - * iLen=s.length; - * - * for ( var i=0 ; i<iLen ; i++ ) { - * if ( i%3 === 0 && i !== 0 ) { - * out = "'"+out; - * } - * out = a[iLen-i-1]+out; - * } - * } - * return out; - * }; - * } ); - * } ); - */ - "fnFormatNumber": function ( iIn ) { - if ( iIn < 1000 ) - { - // A small optimisation for what is likely to be the majority of use cases - return iIn; - } - - var s=(iIn+""), a=s.split(""), out="", iLen=s.length; - - for ( var i=0 ; i - * - * @example - * $(document).ready( function() { - * $('#example').dataTable( { - * "fnInitComplete": function(oSettings, json) { - * alert( 'DataTables has finished its initialisation.' ); - * } - * } ); - * } ) - */ - "fnInitComplete": null, - - - /** - * Called at the very start of each table draw and can be used to cancel the - * draw by returning false, any other return (including undefined) results in - * the full draw occurring). - * @type function - * @param {object} oSettings DataTables settings object - * @returns {boolean} False will cancel the draw, anything else (including no - * return) will allow it to complete. - * - * @example - * $(document).ready( function() { - * $('#example').dataTable( { - * "fnPreDrawCallback": function( oSettings ) { - * if ( $('#test').val() == 1 ) { - * return false; - * } - * } - * } ); - * } ); - */ - "fnPreDrawCallback": null, - - - /** - * This function allows you to 'post process' each row after it have been - * generated for each table draw, but before it is rendered on screen. This - * function might be used for setting the row class name etc. - * @type function - * @param {node} nRow "TR" element for the current row - * @param {array} aData Raw data array for this row - * @param {int} iDisplayIndex The display index for the current table draw - * @param {int} iDisplayIndexFull The index of the data in the full list of - * rows (after filtering) - * @returns {node} "TR" element for the current row - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "fnRowCallback": function( nRow, aData, iDisplayIndex, iDisplayIndexFull ) { - * // Bold the grade for all 'A' grade browsers - * if ( aData[4] == "A" ) - * { - * $('td:eq(4)', nRow).html( 'A' ); - * } - * return nRow; - * } - * } ); - * } ); - */ - "fnRowCallback": null, - - - /** - * This parameter allows you to override the default function which obtains - * the data from the server ($.getJSON) so something more suitable for your - * application. For example you could use POST data, or pull information from - * a Gears or AIR database. - * @type function - * @param {string} sSource HTTP source to obtain the data from (sAjaxSource) - * @param {array} aoData A key/value pair object containing the data to send - * to the server - * @param {function} fnCallback to be called on completion of the data get - * process that will draw the data on the page. - * @param {object} oSettings DataTables settings object - * - * @example - * // POST data to server - * $(document).ready(function() { - * $('#example').dataTable( { - * "bProcessing": true, - * "bServerSide": true, - * "sAjaxSource": "xhr.php", - * "fnServerData": function ( sSource, aoData, fnCallback ) { - * $.ajax( { - * "dataType": 'json', - * "type": "POST", - * "url": sSource, - * "data": aoData, - * "success": fnCallback - * } ); - * } - * } ); - * } ); - */ - "fnServerData": function ( sUrl, aoData, fnCallback, oSettings ) { - oSettings.jqXHR = $.ajax( { - "url": sUrl, - "data": aoData, - "success": function (json) { - $(oSettings.oInstance).trigger('xhr', oSettings); - fnCallback( json ); - }, - "dataType": "json", - "cache": false, - "type": oSettings.sServerMethod, - "error": function (xhr, error, thrown) { - if ( error == "parsererror" ) { - alert( "DataTables warning: JSON data from server could not be parsed. "+ - "This is caused by a JSON formatting error." ); - } - } - } ); - }, - - - /** - * It is often useful to send extra data to the server when making an Ajax - * request - for example custom filtering information, and this callback - * function makes it trivial to send extra information to the server. The - * passed in parameter is the data set that has been constructed by - * DataTables, and you can add to this or modify it as you require. - * @type function - * @param {array} aoData Data array (array of objects which are name/value - * pairs) that has been constructed by DataTables and will be sent to the - * server. In the case of Ajax sourced data with server-side processing - * this will be an empty array, for server-side processing there will be a - * significant number of parameters! - * @returns {undefined} Ensure that you modify the aoData array passed in, - * as this is passed by reference. - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "bProcessing": true, - * "bServerSide": true, - * "sAjaxSource": "scripts/server_processing.php", - * "fnServerParams": function ( aoData ) { - * aoData.push( { "name": "more_data", "value": "my_value" } ); - * } - * } ); - * } ); - */ - "fnServerParams": null, - - - /** - * State saving in DataTables is very useful, but it does a blanket save on - * all properties that the user can modify, so the table is restored. This - * callback method can be used to modify the saved properties as you require, - * just prior to them being loaded. This method can also be used to override - * the state loading altogether by returning false. - * @type function - * @param {object} oSettings DataTables settings object - * @param {object} oData Object containing information retrieved from the - * state saving cookie which should be restored. For the exact properties - * please refer to the DataTables code. - * @returns {boolean} false if the state should not be loaded, true otherwise - * - * @example - * // Remove a previously saved filter - * $(document).ready( function () { - * $('#example').dataTable( { - * "bStateSave": true, - * "fnStateLoadCallback": function ( oSettings, oData ) { - * oData.sFilter = ""; - * return true; - * } - * } ); - * } ); - * - * @example - * // Override state loading - * $(document).ready( function () { - * $('#example').dataTable( { - * "bStateSave": true, - * "fnStateLoadCallback": function ( oSettings, oData ) { - * return false; - * } - * } ); - * } ); - */ - "fnStateLoadCallback": null, - - - /** - * When using state saving it can be useful to store your own custom - * parameters in the state saving cookie that DataTables uses, or to modify - * the settings that DataTables uses. Note that this function can be quite - * involved to use since it uses JSON notation in a string, given that jQuery - * does not provide a "stringify" option for JSON objects. - * @type function - * @param {object} oSettings DataTables settings object - * @param {string} sValue a JSON string (without the final closing brace) - * which should be stored in the state saving cookie. - * @returns {string} The full string that should be used to save the state - * - * @example - * // Add a custom parameter - * $(document).ready( function () { - * $('#example').dataTable( { - * "bStateSave": true, - * "fnStateSaveCallback": function ( oSettings, sValue ) { - * sValue += ',"myCustomParameter": "myValue"'; - * return sValue; - * } - * } ); - * } ); - * - * @example - * // Modify saved filter to be blank - * $(document).ready( function () { - * $('#example').dataTable( { - * "bStateSave": true, - * "fnStateSaveCallback": function ( oSettings, sValue ) { - * sValue = sValue.replace( /"sFilter":".*?"/, '"sFilter":""' ); - * return sValue; - * } - * } ); - * } ); - * - * @example - * // Modify saved filter to be blank - using JSON2.js - * $(document).ready( function () { - * $('#example').dataTable( { - * "bStateSave": true, - * "fnStateSaveCallback": function ( oSettings, sValue ) { - * var oData = JSON.parse( sValue+"}" ); - * oData.sFilter = ""; - * return JSON.stringify( oData ).slice( 0, -1 ); - * } - * } ); - * } ); - */ - "fnStateSaveCallback": null, - - - /** - * Duration of the cookie which is used for storing session information. This - * value is given in seconds. - * @type int - * @default 7200 (2 hours) - * - * @example - * $(document).ready( function() { - * $('#example').dataTable( { - * "iCookieDuration": 60*60*24 // 1 day - * } ); - * } ) - */ - "iCookieDuration": 7200, - - - /** - * When enabled DataTables will not make a request to the server for the first - * page draw - rather it will use the data already on the page (no sorting etc - * will be applied to it), thus saving on an XHR at load time. iDeferLoading - * is used to indicate that deferred loading is required, but it is also used - * to tell DataTables how many records there are in the full table (allowing - * the information element and pagination to be displayed correctly). - * @type int - * @default null - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "bServerSide": true, - * "sAjaxSource": "scripts/server_processing.php", - * "iDeferLoading": 57 - * } ); - * } ); - */ - "iDeferLoading": null, - - - /** - * Number of rows to display on a single page when using pagination. If - * feature enabled (bLengthChange) then the end user will be able to override - * this to a custom setting using a pop-up menu. - * @type int - * @default 10 - * - * @example - * $(document).ready( function() { - * $('#example').dataTable( { - * "iDisplayLength": 50 - * } ); - * } ) - */ - "iDisplayLength": 10, - - - /** - * Define the starting point for data display when using DataTables with - * pagination. Note that this parameter is the number of records, rather than - * the page number, so if you have 10 records per page and want to start on - * the third page, it should be "20". - * @type int - * @default 0 - * - * @example - * $(document).ready( function() { - * $('#example').dataTable( { - * "iDisplayStart": 20 - * } ); - * } ) - */ - "iDisplayStart": 0, - - - /** - * The scroll gap is the amount of scrolling that is left to go before - * DataTables will load the next 'page' of data automatically. You typically - * want a gap which is big enough that the scrolling will be smooth for the - * user, while not so large that it will load more data than need. - * @type int - * @default 100 - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "bScrollInfinite": true, - * "bScrollCollapse": true, - * "sScrollY": "200px", - * "iScrollLoadGap": 50 - * } ); - * } ); - */ - "iScrollLoadGap": 100, - - - /** - * By default DataTables allows keyboard navigation of the table (sorting, paging, - * and filtering) by adding a tabindex attribute to the required elements. This - * allows you to tab through the controls and press the enter key to activate them. - * The tabindex is default 0, meaning that the tab follows the flow of the document. - * You can overrule this using this parameter if you wish. Use a value of -1 to - * disable built-in keyboard navigation. - * @type int - * @default 0 - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "iTabIndex": 1 - * } ); - * } ); - */ - "iTabIndex": 0, - - - /** - * All strings that DataTables uses in the user interface that it creates - * are defined in this object, allowing you to modified them individually or - * completely replace them all as required. - * @namespace - */ - "oLanguage": { - /** - * Strings that are used for WAI-ARIA labels and controls only (these are not - * actually visible on the page, but will be read by screenreaders, and thus - * must be internationalised as well). - * @namespace - */ - "oAria": { - /** - * ARIA label that is added to the table headers when the column may be - * sorted ascending by activing the column (click or return when focused). - * Note that the column header is prefixed to this string. - * @type string - * @default : activate to sort column ascending - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "oAria": { - * "sSortAscending": " - click/return to sort ascending" - * } - * } - * } ); - * } ); - */ - "sSortAscending": ": activate to sort column ascending", - - /** - * ARIA label that is added to the table headers when the column may be - * sorted descending by activing the column (click or return when focused). - * Note that the column header is prefixed to this string. - * @type string - * @default : activate to sort column ascending - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "oAria": { - * "sSortDescending": " - click/return to sort descending" - * } - * } - * } ); - * } ); - */ - "sSortDescending": ": activate to sort column descending" - }, - - /** - * Pagination string used by DataTables for the two built-in pagination - * control types ("two_button" and "full_numbers") - * @namespace - */ - "oPaginate": { - /** - * Text to use when using the 'full_numbers' type of pagination for the - * button to take the user to the first page. - * @type string - * @default First - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "oPaginate": { - * "sFirst": "First page" - * } - * } - * } ); - * } ); - */ - "sFirst": "First", - - - /** - * Text to use when using the 'full_numbers' type of pagination for the - * button to take the user to the last page. - * @type string - * @default Last - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "oPaginate": { - * "sLast": "Last page" - * } - * } - * } ); - * } ); - */ - "sLast": "Last", - - - /** - * Text to use when using the 'full_numbers' type of pagination for the - * button to take the user to the next page. - * @type string - * @default Next - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "oPaginate": { - * "sNext": "Next page" - * } - * } - * } ); - * } ); - */ - "sNext": "Next", - - - /** - * Text to use when using the 'full_numbers' type of pagination for the - * button to take the user to the previous page. - * @type string - * @default Previous - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "oPaginate": { - * "sPrevious": "Previous page" - * } - * } - * } ); - * } ); - */ - "sPrevious": "Previous" - }, - - /** - * This string is shown in preference to sZeroRecords when the table is - * empty of data (regardless of filtering). Note that this is an optional - * parameter - if it is not given, the value of sZeroRecords will be used - * instead (either the default or given value). - * @type string - * @default No data available in table - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "sEmptyTable": "No data available in table" - * } - * } ); - * } ); - */ - "sEmptyTable": "No data available in table", - - - /** - * This string gives information to the end user about the information that - * is current on display on the page. The _START_, _END_ and _TOTAL_ - * variables are all dynamically replaced as the table display updates, and - * can be freely moved or removed as the language requirements change. - * @type string - * @default Showing _START_ to _END_ of _TOTAL_ entries - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "sInfo": "Got a total of _TOTAL_ entries to show (_START_ to _END_)" - * } - * } ); - * } ); - */ - "sInfo": "Showing _START_ to _END_ of _TOTAL_ entries", - - - /** - * Display information string for when the table is empty. Typically the - * format of this string should match sInfo. - * @type string - * @default Showing 0 to 0 of 0 entries - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "sInfoEmpty": "No entries to show" - * } - * } ); - * } ); - */ - "sInfoEmpty": "Showing 0 to 0 of 0 entries", - - - /** - * When a user filters the information in a table, this string is appended - * to the information (sInfo) to give an idea of how strong the filtering - * is. The variable _MAX_ is dynamically updated. - * @type string - * @default (filtered from _MAX_ total entries) - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "sInfoFiltered": " - filtering from _MAX_ records" - * } - * } ); - * } ); - */ - "sInfoFiltered": "(filtered from _MAX_ total entries)", - - - /** - * If can be useful to append extra information to the info string at times, - * and this variable does exactly that. This information will be appended to - * the sInfo (sInfoEmpty and sInfoFiltered in whatever combination they are - * being used) at all times. - * @type string - * @default Empty string - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "sInfoPostFix": "All records shown are derived from real information." - * } - * } ); - * } ); - */ - "sInfoPostFix": "", - - - /** - * DataTables has a build in number formatter (fnFormatNumber) which is used - * to format large numbers that are used in the table information. By - * default a comma is used, but this can be trivially changed to any - * character you wish with this parameter. - * @type string - * @default , - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "sInfoThousands": "'" - * } - * } ); - * } ); - */ - "sInfoThousands": ",", - - - /** - * Detail the action that will be taken when the drop down menu for the - * pagination length option is changed. The '_MENU_' variable is replaced - * with a default select list of 10, 25, 50 and 100, and can be replaced - * with a custom select box if required. - * @type string - * @default Show _MENU_ entries - * - * @example - * // Language change only - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "sLengthMenu": "Display _MENU_ records" - * } - * } ); - * } ); - * - * @example - * // Language and options change - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "sLengthMenu": 'Display records' - * } - * } ); - * } ); - */ - "sLengthMenu": "Show _MENU_ entries", - - - /** - * When using Ajax sourced data and during the first draw when DataTables is - * gathering the data, this message is shown in an empty row in the table to - * indicate to the end user the the data is being loaded. Note that this - * parameter is not used when loading data by server-side processing, just - * Ajax sourced data with client-side processing. - * @type string - * @default Loading... - * - * @example - * $(document).ready( function() { - * $('#example').dataTable( { - * "oLanguage": { - * "sLoadingRecords": "Please wait - loading..." - * } - * } ); - * } ); - */ - "sLoadingRecords": "Loading...", - - - /** - * Text which is displayed when the table is processing a user action - * (usually a sort command or similar). - * @type string - * @default Processing... - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "sProcessing": "DataTables is currently busy" - * } - * } ); - * } ); - */ - "sProcessing": "Processing...", - - - /** - * Details the actions that will be taken when the user types into the - * filtering input text box. The variable "_INPUT_", if used in the string, - * is replaced with the HTML text box for the filtering input allowing - * control over where it appears in the string. If "_INPUT_" is not given - * then the input box is appended to the string automatically. - * @type string - * @default Search: - * - * @example - * // Input text box will be appended at the end automatically - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "sSearch": "Filter records:" - * } - * } ); - * } ); - * - * @example - * // Specify where the filter should appear - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "sSearch": "Apply filter _INPUT_ to table" - * } - * } ); - * } ); - */ - "sSearch": "Search:", - - - /** - * All of the language information can be stored in a file on the - * server-side, which DataTables will look up if this parameter is passed. - * It must store the URL of the language file, which is in a JSON format, - * and the object has the same properties as the oLanguage object in the - * initialiser object (i.e. the above parameters). Please refer to one of - * the example language files to see how this works in action. - * @type string - * @default Empty string - i.e. disabled - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "sUrl": "http://www.sprymedia.co.uk/dataTables/lang.txt" - * } - * } ); - * } ); - */ - "sUrl": "", - - - /** - * Text shown inside the table records when the is no information to be - * displayed after filtering. sEmptyTable is shown when there is simply no - * information in the table at all (regardless of filtering). - * @type string - * @default No matching records found - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "oLanguage": { - * "sZeroRecords": "No records to display" - * } - * } ); - * } ); - */ - "sZeroRecords": "No matching records found" - }, - - - /** - * This parameter allows you to have define the global filtering state at - * initialisation time. As an object the "sSearch" parameter must be - * defined, but all other parameters are optional. When "bRegex" is true, - * the search string will be treated as a regular expression, when false - * (default) it will be treated as a straight string. When "bSmart" - * DataTables will use it's smart filtering methods (to word match at - * any point in the data), when false this will not be done. - * @type object - * @extends DataTable.models.oSearch - * - * @example - * $(document).ready( function() { - * $('#example').dataTable( { - * "oSearch": {"sSearch": "Initial search"} - * } ); - * } ) - */ - "oSearch": $.extend( {}, DataTable.models.oSearch ), - - - /** - * By default DataTables will look for the property 'aaData' when obtaining - * data from an Ajax source or for server-side processing - this parameter - * allows that property to be changed. You can use Javascript dotted object - * notation to get a data source for multiple levels of nesting. - * @type string - * @default aaData - * - * @example - * // Get data from { "data": [...] } - * $(document).ready(function() { - * var oTable = $('#example').dataTable( { - * "sAjaxSource": "sources/data.txt", - * "sAjaxDataProp": "data" - * } ); - * } ); - * - * @example - * // Get data from { "data": { "inner": [...] } } - * $(document).ready(function() { - * var oTable = $('#example').dataTable( { - * "sAjaxSource": "sources/data.txt", - * "sAjaxDataProp": "data.inner" - * } ); - * } ); - */ - "sAjaxDataProp": "aaData", - - - /** - * You can instruct DataTables to load data from an external source using this - * parameter (use aData if you want to pass data in you already have). Simply - * provide a url a JSON object can be obtained from. This object must include - * the parameter 'aaData' which is the data source for the table. - * @type string - * @default null - * - * @example - * $(document).ready( function() { - * $('#example').dataTable( { - * "sAjaxSource": "http://www.sprymedia.co.uk/dataTables/json.php" - * } ); - * } ) - */ - "sAjaxSource": null, - - - /** - * This parameter can be used to override the default prefix that DataTables - * assigns to a cookie when state saving is enabled. - * @type string - * @default SpryMedia_DataTables_ - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "sCookiePrefix": "my_datatable_", - * } ); - * } ); - */ - "sCookiePrefix": "SpryMedia_DataTables_", - - - /** - * This initialisation variable allows you to specify exactly where in the - * DOM you want DataTables to inject the various controls it adds to the page - * (for example you might want the pagination controls at the top of the - * table). DIV elements (with or without a custom class) can also be added to - * aid styling. The follow syntax is used: - * - * @type string - * @default lfrtip (when bJQueryUI is false) or - * <"H"lfr>t<"F"ip> (when bJQueryUI is true) - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "sDom": '<"top"i>rt<"bottom"flp><"clear"&lgt;' - * } ); - * } ); - */ - "sDom": "lfrtip", - - - /** - * DataTables features two different built-in pagination interaction methods - * ('two_button' or 'full_numbers') which present different page controls to - * the end user. Further methods can be added using the API (see below). - * @type string - * @default two_button - * - * @example - * $(document).ready( function() { - * $('#example').dataTable( { - * "sPaginationType": "full_numbers" - * } ); - * } ) - */ - "sPaginationType": "two_button", - - - /** - * Enable horizontal scrolling. When a table is too wide to fit into a certain - * layout, or you have a large number of columns in the table, you can enable - * x-scrolling to show the table in a viewport, which can be scrolled. This - * property can by any CSS unit, or a number (in which case it will be treated - * as a pixel measurement). - * @type string - * @default blank string - i.e. disabled - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "sScrollX": "100%", - * "bScrollCollapse": true - * } ); - * } ); - */ - "sScrollX": "", - - - /** - * This property can be used to force a DataTable to use more width than it - * might otherwise do when x-scrolling is enabled. For example if you have a - * table which requires to be well spaced, this parameter is useful for - * "over-sizing" the table, and thus forcing scrolling. This property can by - * any CSS unit, or a number (in which case it will be treated as a pixel - * measurement). - * @type string - * @default blank string - i.e. disabled - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "sScrollX": "100%", - * "sScrollXInner": "110%" - * } ); - * } ); - */ - "sScrollXInner": "", - - - /** - * Enable vertical scrolling. Vertical scrolling will constrain the DataTable - * to the given height, an enable scrolling for any data which overflows the - * current viewport. This can be used as an alternative to paging to display - * a lot of data in a small area (although paging and scrolling can both be - * enabled at the same time). This property can by any CSS unit, or a number - * (in which case it will be treated as a pixel measurement). - * @type string - * @default blank string - i.e. disabled - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "sScrollY": "200px", - * "bPaginate": false - * } ); - * } ); - */ - "sScrollY": "", - - - /** - * Set the HTTP method that is used to make the Ajax call for server-side - * processing or Ajax sourced data. - * @type string - * @default GET - * - * @example - * $(document).ready(function() { - * $('#example').dataTable( { - * "bServerSide": true, - * "sAjaxSource": "scripts/post.php", - * "sServerMethod": "POST" - * } ); - * } ); - */ - "sServerMethod": "GET" -}; - diff --git a/media/src/model/model.settings.js b/media/src/model/model.settings.js index e026c458..4c0c941a 100644 --- a/media/src/model/model.settings.js +++ b/media/src/model/model.settings.js @@ -9,7 +9,7 @@ * $().dataTable() call) and the settings object is then applied to that * instance. * - * Note that this object is related to {@link DataTable.models.oInit} but this + * Note that this object is related to {@link DataTable.defaults} but this * one is the internal data store for DataTables's cache of columns. It should * NOT be manipulated outside of DataTables. Any configuration should be done * through the initialisation options. @@ -33,7 +33,7 @@ DataTable.models.oSettings = { * Flag to say if DataTables should automatically try to calculate the * optimum table and columns widths (true) or not (false). * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bAutoWidth": null, @@ -44,7 +44,7 @@ DataTable.models.oSettings = { * increase for Ajax source and Javascript source data, but makes no * difference at all fro DOM and server-side processing tables. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bDeferRender": null, @@ -54,7 +54,7 @@ DataTable.models.oSettings = { * then there is no filtering at all on the table, including fnFilter. * To just remove the filtering input use sDom and remove the 'f' option. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bFilter": null, @@ -63,7 +63,7 @@ DataTable.models.oSettings = { * Table information element (the 'Showing x of y records' div) enable * flag. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bInfo": null, @@ -72,7 +72,7 @@ DataTable.models.oSettings = { * Present a user control allowing the end user to change the page size * when pagination is enabled. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bLengthChange": null, @@ -81,7 +81,7 @@ DataTable.models.oSettings = { * Pagination enabled or not. Note that if this is disabled then length * changing must also be disabled. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bPaginate": null, @@ -90,7 +90,7 @@ DataTable.models.oSettings = { * Processing indicator enable flag whenever DataTables is enacting a * user request - typically an Ajax request for server-side processing. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bProcessing": null, @@ -100,7 +100,7 @@ DataTable.models.oSettings = { * get all data from the server for every draw - there is no filtering, * sorting or paging done on the client-side. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bServerSide": null, @@ -108,7 +108,7 @@ DataTable.models.oSettings = { /** * Sorting enablement flag. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bSort": null, @@ -118,7 +118,7 @@ DataTable.models.oSettings = { * visual highlight or not. This can slow things down when enabled since * there is a lot of DOM interaction. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bSortClasses": null, @@ -126,7 +126,7 @@ DataTable.models.oSettings = { /** * State saving enablement flag. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bStateSave": null @@ -143,7 +143,7 @@ DataTable.models.oSettings = { * etc for the scrolling header elements or not. Typically you will want * this. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bAutoCss": null, @@ -152,7 +152,7 @@ DataTable.models.oSettings = { * When the table is shorter in height than sScrollY, collapse the * table container down to the height of the table (when true). * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bCollapse": null, @@ -161,7 +161,7 @@ DataTable.models.oSettings = { * Infinite scrolling enablement flag. Now deprecated in favour of * using the Scroller plug-in. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bInfinite": null, @@ -179,7 +179,7 @@ DataTable.models.oSettings = { * the bottom of the scrolling viewport before the next page is loaded * when using infinite scrolling. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type int */ "iLoadGap": null, @@ -188,7 +188,7 @@ DataTable.models.oSettings = { * Viewport width for horizontal scrolling. Horizontal scrolling is * disabled if an empty string. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string */ "sX": null, @@ -197,7 +197,7 @@ DataTable.models.oSettings = { * Width to expand the table to when using x-scrolling. Typically you * should not need to use this. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string * @deprecated */ @@ -207,7 +207,7 @@ DataTable.models.oSettings = { * Viewport height for vertical scrolling. Vertical scrolling is disabled * if an empty string. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string */ "sY": null @@ -216,12 +216,12 @@ DataTable.models.oSettings = { /** * Language information for the table. * @namespace - * @extends DataTable.models.oInit.oLanguage + * @extends DataTable.defaults.oLanguage */ "oLanguage": { /** * Information callback function. See - * {@link DataTable.models.oInit.fnInfoCallback} + * {@link DataTable.defaults.fnInfoCallback} * @type function * @default */ @@ -298,7 +298,7 @@ DataTable.models.oSettings = { * Store the applied global search information in case we want to force a * research or compare the old search to a new one. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @namespace * @extends DataTable.models.oSearch */ @@ -322,7 +322,7 @@ DataTable.models.oSettings = { *
  • Index 2 - index of asSorting for this column
    • * * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type array * @todo These inner arrays should really be objects */ @@ -332,7 +332,7 @@ DataTable.models.oSettings = { * Sorting that is always applied to the table (i.e. prefixed in front of * aaSorting). * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type array|null * @default null */ @@ -341,7 +341,7 @@ DataTable.models.oSettings = { /** * Classes to use for the striping of a table. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type array * @default [] */ @@ -364,7 +364,7 @@ DataTable.models.oSettings = { /** * Call this function every time a row is inserted (draw). * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type function * @default null * @todo Make into an array so plug-ins can hook in @@ -374,7 +374,7 @@ DataTable.models.oSettings = { /** * Callback function for the header on each draw. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type function * @default null * @todo Make into an array so plug-ins can hook in @@ -384,7 +384,7 @@ DataTable.models.oSettings = { /** * Callback function for the footer on each draw. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type function * @default null * @todo Make into an array so plug-ins can hook in @@ -402,7 +402,7 @@ DataTable.models.oSettings = { * Callback function for just before the table is redrawn. A return of * false will be used to cancel the draw. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type function * @default null * @todo Make into an array so plug-ins can hook in @@ -412,7 +412,7 @@ DataTable.models.oSettings = { /** * Callback function for when the table has been initialised. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type function * @default null * @todo Make into an array so plug-ins can hook in @@ -465,7 +465,7 @@ DataTable.models.oSettings = { * Indicate if when using server-side processing the loading of data * should be deferred until the second draw. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean * @default false */ @@ -490,7 +490,7 @@ DataTable.models.oSettings = { * Dictate the positioning of DataTables' control elements - see * {@link DataTable.model.oInit.sDom}. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string * @default null */ @@ -499,7 +499,7 @@ DataTable.models.oSettings = { /** * Which type of pagination should be used. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string * @default two_button */ @@ -508,7 +508,7 @@ DataTable.models.oSettings = { /** * The cookie duration (for bStateSave) in seconds. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type int * @default 0 */ @@ -517,7 +517,7 @@ DataTable.models.oSettings = { /** * The cookie name prefix. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string * @default Empty string */ @@ -526,7 +526,7 @@ DataTable.models.oSettings = { /** * Callback function for cookie creation. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type function * @default null */ @@ -570,7 +570,7 @@ DataTable.models.oSettings = { /** * Source url for AJAX data for the table. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string * @default null */ @@ -581,7 +581,7 @@ DataTable.models.oSettings = { * can be an empty string (when not server-side processing), in which case * it is assumed an an array is given directly. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string */ "sAjaxDataProp": null, @@ -605,7 +605,7 @@ DataTable.models.oSettings = { /** * Function to get the server-side data. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type function */ "fnServerData": null, @@ -622,7 +622,7 @@ DataTable.models.oSettings = { * Send the XHR HTTP method - GET or POST (could be PUT or DELETE if * required). * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type string */ "sServerMethod": null, @@ -630,7 +630,7 @@ DataTable.models.oSettings = { /** * Format numbers for display. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type function */ "fnFormatNumber": null, @@ -638,7 +638,7 @@ DataTable.models.oSettings = { /** * List of options that can be used for the user selectable length menu. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type array * @default [] */ @@ -714,7 +714,7 @@ DataTable.models.oSettings = { /** * Flag to indicate if jQuery UI marking and classes should be used. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bJUI": null, @@ -751,7 +751,7 @@ DataTable.models.oSettings = { * one unique cell per column, if the top one (true) or bottom one (false) * should be used for sorting / title by DataTables. * Note that this parameter will be set by the initialisation routine. To - * set a default use {@link DataTable.models.oInit}. + * set a default use {@link DataTable.defaults}. * @type boolean */ "bSortCellsTop": null,