annotate DataTables-1.9.4/docs/DataTable.models.html @ 0:ac5f9272033b draft

first upload
author saskia-hiltemann
date Tue, 01 Jul 2014 11:42:23 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
2 <html>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
3 <head>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
4 <meta http-equiv="Content-type" content="text/html; charset=utf-8">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
5 <title>Namespace: models - documentation</title>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
6
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
7 <style type="text/css" media="screen">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
8 @import "media/css/doc.css";
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
9 @import "media/css/shCore.css";
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
10 @import "media/css/shThemeDataTables.css";
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
11 </style>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
12
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
13 <script type="text/javascript" src="media/js/shCore.js"></script>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
14 <script type="text/javascript" src="media/js/shBrushJScript.js"></script>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
15 <script type="text/javascript" src="media/js/jquery.js"></script>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
16 <script type="text/javascript" src="media/js/doc.js"></script>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
17 </head>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
18 <body>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
19 <div class="fw_container">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
20
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
21 <a name="top"></a>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
22 <div class="fw_header">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
23 <h1 class="page-title">Namespace: models</h1>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
24 <h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a>.</span> ยป models</h2>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
25 <div class="page-info">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
26 DataTables v1.9.4 documentation
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
27 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
28 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
29
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
30
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
31
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
32 <div class="fw_nav">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
33 <h2>Navigation</h2>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
34 <ul>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
35 <li><a href="#top">Overview</a></li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
36 <li><a href="#summary">Summary</a><div><table cellpadding="5" border="0" cellspacing="0" width="100%"><tbody><tr><td>Classes (0)</td><td><a href="#summary_namespaces">Namespaces (5)</a></td></tr><tr><td>Properties (0)</td><td>Static properties (0)</td></tr><tr><td>Methods (0)</td><td>Static methods (0)</td></tr><tr><td>Events (0)</td><td></td></tr></tbody></table></div></li><li><a href="#details">Details</a><div><table cellpadding="5" border="0" cellspacing="0" width="100%"><tbody><tr><td>Properties (0)</td><td>Static properties (0)</td></tr><tr><td>Methods (0)</td><td>Static methods (0)</td></tr><tr><td>Events (0)</td><td></td></tr></tbody></table></div></li></ul>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
37 <div style="margin-top: 10px;">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
38 <input type="hidden" name="show_private" value="0">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
39 <span id="private_label">Hiding</span> private elements
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
40 (<a id="private_toggle" href="">toggle</a>)
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
41 </span>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
42 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
43 <div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
44 <input type="hidden" name="show_extended" value="1">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
45 <span id="extended_label">Showing</span> extended elements
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
46 (<a id="extended_toggle" href="">toggle</a>)
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
47 </span>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
48 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
49 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
50
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
51 <div class="fw_content">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
52 <a name="overview"></a>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
53 <div class="doc_overview">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
54 <div class="nav_blocker"></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
55 <p>Object models container, for the various models that DataTables has available
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
56 to it. These models define the objects that are used to hold the active state
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
57 and configuration of the table.</p><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
58
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
59 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
60
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
61 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
62
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
63
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
64 <div class="doc_summary">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
65 <a name="summary"></a>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
66 <h2>Summary</h2>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
67
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
68 <div class="doc_group"><a name="summary_namespaces"></a><h3 class="subsection-title">Namespaces</h3>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
69 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
70 <dt class="even"><span class="type-name"><a href="DataTable.models.ext.html">ext</a></span></dt><dd class="even"><p>DataTables extension options and plug-ins. This namespace acts as a collection "area"
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
71 for plug-ins that can be used to extend the default DataTables behaviour - indeed many
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
72 of the build in methods use this method to provide their own capabilities (sorting methods
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
73 for example). [<a href="DataTable.models.ext.html">...</a>] </p></dd><dt class="odd"><span class="type-name"><a href="DataTable.models.oColumn.html">oColumn</a></span></dt><dd class="odd"><p>Template object for the column information object in DataTables. This object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
74 is held in the settings aoColumns array and contains all the information that
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
75 DataTables needs about each individual column. [<a href="DataTable.models.oColumn.html">...</a>] </p></dd><dt class="even"><span class="type-name"><a href="DataTable.models.oRow.html">oRow</a></span></dt><dd class="even"><p>Template object for the way in which DataTables holds information about
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
76 each individual row. This is the object format used for the settings
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
77 aoData array.</p></dd><dt class="odd"><span class="type-name"><a href="DataTable.models.oSearch.html">oSearch</a></span></dt><dd class="odd"><p>Template object for the way in which DataTables holds information about
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
78 search information for the global filter and individual column filters.</p></dd><dt class="even"><span class="type-name"><a href="DataTable.models.oSettings.html">oSettings</a></span></dt><dd class="even"><p>DataTables settings object - this holds all the information needed for a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
79 given table, including configuration, data and current application of the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
80 table options. DataTables does not have a single instance for each DataTable
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
81 with the settings attached to that instance, but rather instances of the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
82 DataTable "class" are created on-the-fly as needed (typically by a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
83 $().dataTable() call) and the settings object is then applied to that
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
84 instance. [<a href="DataTable.models.oSettings.html">...</a>] </p></dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
85 </dl></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
86 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
87
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
88
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
89
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
90
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
91 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
92
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
93 <div class="fw_footer">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
94 DataTables: Copyright 2008-2012 Allan Jardine, all rights reserved<br>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
95
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
96 Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
97 23th Sep 2012 - 14:27
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
98 with the <a href="http://datatables.net/">DataTables</a> template.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
99 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
100 </body>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
101 </html>