Mercurial > repos > saskia-hiltemann > ireport

annotate DataTables-1.9.4/docs/DataTable.models.oColumn.html @ 7:0f2b740536fb draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author saskia-hiltemann
date Mon, 21 Aug 2017 09:16:07 -0400 (2017-08-21)
parents ac5f9272033b
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: oColumn - 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: oColumn</h1>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
24 <h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.models.html">.models</a>.</span> » oColumn</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>Namespaces (0)</td></tr><tr><td>Properties (0)</td><td><a href="#summary_properties_static">Static properties (25)</a></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><a href="#summary_properties_static">Static properties (25)</a></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>Template object for the column information object in DataTables. This object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
56 is held in the settings aoColumns array and contains all the information that
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
57 DataTables needs about each individual column.</p>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
58
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
59 <p>Note that this object is related to <a href="DataTable.defaults.columns.html">DataTable.defaults.columns</a>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
60 but this one is the internal data store for DataTables's cache of columns.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
61 It should NOT be manipulated outside of DataTables. Any configuration should
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
62 be done through the initialisation options.</p><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
63
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
64 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
65
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
66 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
67
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
68
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
69 <div class="doc_summary">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
70 <a name="summary"></a>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
71 <h2>Summary</h2>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
72
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
73 <div class="doc_group"><a name="summary_properties_static"></a><h3 class="subsection-title">Properties - static</h3>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
74
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
75 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
76 <dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#aDataSort">aDataSort</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>A list of the columns that sorting should occur on when this column
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
77 is sorted. That this property is an array allows multi-column sorting
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
78 to be defined for a column (for example first name / last name columns
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
79 would benefit from this). The values are integers pointing to the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
80 columns to be sorted on (typically it will be a single integer pointing
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
81 at itself, but that doesn't need to be the case).</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#asSorting">asSorting</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Define the sorting directions that are applied to the column, in sequence
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
82 as the column is repeatedly sorted upon - i.e. the first value is used
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
83 as the sorting direction when the column if first sorted (clicked on).
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
84 Sort it again (click again) and it will move on to the next index.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
85 Repeat until loop.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#bSearchable">bSearchable</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag to indicate if the column is searchable, and thus should be included
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
86 in the filtering or not.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#bSortable">bSortable</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Flag to indicate if the column is sortable or not.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#bUseRendered">bUseRendered</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p><code>Deprecated</code> When using fnRender, you have two options for what
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
87 to do with the data, and this property serves as the switch. Firstly, you
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
88 can have the sorting and filtering use the rendered value (true - default),
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
89 or you can have the sorting and filtering us the original value (false). [<a href-"#bUseRendered">...</a>] </p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#bVisible">bVisible</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Flag to indicate if the column is currently visible in the table or not</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#fnCreatedCell">fnCreatedCell</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></dt><dd class=" even"><p>Developer definable function that is called whenever a cell is created (Ajax source,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
90 etc) or processed for input (DOM source). This can be used as a compliment to mRender
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
91 allowing you to modify the DOM element (add background colour for example) when the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
92 element is available.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#fnGetData">fnGetData</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></dt><dd class=" odd"><p>Function to get data from a cell in a column. You should <b>never</b>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
93 access data directly through _aData internally in DataTables - always use
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
94 the method attached to this property. It allows mData to function as
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
95 required. This function is automatically assigned by the column
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
96 initialisation method</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#fnRender">fnRender</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></dt><dd class=" even"><p><code>Deprecated</code> Custom display function that will be called for the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
97 display of each cell in this column. [<a href-"#fnRender">...</a>] </p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#fnSetData">fnSetData</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></dt><dd class=" odd"><p>Function to set data for a cell in the column. You should <b>never</b>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
98 set the data directly to _aData internally in DataTables - always use
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
99 this method. It allows mData to function as required. This function
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
100 is automatically assigned by the column initialisation method</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#mData">mData</a></span><span class="type-sig"><span class="type-signature"> :function|int|string|null</span></span></dt><dd class=" even"><p>Property to read the value for the cells in the column from the data
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
101 source array / object. If null, then the default content is used, if a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
102 function is given then the return from the function is used.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#mRender">mRender</a></span><span class="type-sig"><span class="type-signature"> :function|int|string|null</span></span></dt><dd class=" odd"><p>Partner property to mData which is used (only when defined) to get
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
103 the data - i.e. it is basically the same as mData, but without the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
104 'set' option, and also the data fed to it is the result from mData.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
105 This is the rendering method to match the data method of mData.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#nTf">nTf</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" even"><p>Unique footer TH/TD element for this column (if there is one). Not used
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
106 in DataTables as such, but can be used for plug-ins to reference the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
107 footer for each column.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#nTh">nTh</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" odd"><p>Unique header TH/TD element for this column - this is what the sorting
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
108 listener is attached to (if sorting is enabled.)</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sClass">sClass</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>The class to apply to all TD elements in the table's TBODY for the column</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sContentPadding">sContentPadding</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>When DataTables calculates the column widths to assign to each column,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
109 it finds the longest string in each column and then constructs a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
110 temporary table and reads the widths from that. The problem with this
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
111 is that "mmm" is much wider then "iiii", but the latter is a longer
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
112 string - thus the calculation can go wrong (doing it properly and putting
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
113 it into an DOM object and measuring that is horribly(!) slow). Thus as
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
114 a "work around" we provide this option. It will append its value to the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
115 text that is found to be the longest string for the column - i.e. padding.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sDefaultContent">sDefaultContent</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Allows a default value to be given for a column's data, and will be used
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
116 whenever a null data source is encountered (this can be because mData
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
117 is set to null, or because the data source itself is null).</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sName">sName</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Name for the column, allowing reference to the column by name as well as
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
118 by index (needs a lookup to work by name).</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sSortDataType">sSortDataType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Custom sorting data type - defines which of the available plug-ins in
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
119 afnSortData the custom sorting will use - if any is defined.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sSortingClass">sSortingClass</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Class to be applied to the header element when sorting on this column</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sSortingClassJUI">sSortingClassJUI</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Class to be applied to the header element when sorting on this column -
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
120 when jQuery UI theming is used.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sTitle">sTitle</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Title of the column - what is seen in the TH element (nTh).</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sType">sType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Column sorting and filtering type</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sWidth">sWidth</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Width of the column</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sWidthOrig">sWidthOrig</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Width of the column when it was first "encountered"</p></dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
121 </dl></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
122 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
123
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
124
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
125
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
126
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
127 <div class="doc_details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
128 <a name="details"></a>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
129 <h2>Details</h2>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
130 <div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - static</h3>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
131 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
132 <dt class=" even"><a name="aDataSort"></a><a name="aDataSort_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#aDataSort">aDataSort</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>A list of the columns that sorting should occur on when this column
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
133 is sorted. That this property is an array allows multi-column sorting
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
134 to be defined for a column (for example first name / last name columns
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
135 would benefit from this). The values are integers pointing to the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
136 columns to be sorted on (typically it will be a single integer pointing
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
137 at itself, but that doesn't need to be the case).</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
138
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
139 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
140 </div></dd><dt class=" odd"><a name="asSorting"></a><a name="asSorting_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#asSorting">asSorting</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Define the sorting directions that are applied to the column, in sequence
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
141 as the column is repeatedly sorted upon - i.e. the first value is used
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
142 as the sorting direction when the column if first sorted (clicked on).
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
143 Sort it again (click again) and it will move on to the next index.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
144 Repeat until loop.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
145
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
146 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
147 </div></dd><dt class=" even"><a name="bSearchable"></a><a name="bSearchable_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#bSearchable">bSearchable</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag to indicate if the column is searchable, and thus should be included
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
148 in the filtering or not.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
149
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
150 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
151 </div></dd><dt class=" odd"><a name="bSortable"></a><a name="bSortable_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#bSortable">bSortable</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Flag to indicate if the column is sortable or not.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
152
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
153 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
154 </div></dd><dt class=" even"><a name="bUseRendered"></a><a name="bUseRendered_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#bUseRendered">bUseRendered</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p><code>Deprecated</code> When using fnRender, you have two options for what
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
155 to do with the data, and this property serves as the switch. Firstly, you
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
156 can have the sorting and filtering use the rendered value (true - default),
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
157 or you can have the sorting and filtering us the original value (false).</p>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
158
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
159 <p>Please note that this option has now been deprecated and will be removed
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
160 in the next version of DataTables. Please use mRender / mData rather than
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
161 fnRender.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
162 <dt class="important">Deprecated</dt><dd class="yes-def">Yes</dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
163 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
164 </div></dd><dt class=" odd"><a name="bVisible"></a><a name="bVisible_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#bVisible">bVisible</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Flag to indicate if the column is currently visible in the table or not</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
165
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
166 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
167 </div></dd><dt id="DataTable.models.oColumn.fnCreatedCell" class=" even"><a name="fnCreatedCell"></a><a name="fnCreatedCell_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>fnCreatedCell</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></span></dt><dd class=" even"><p>Developer definable function that is called whenever a cell is created (Ajax source,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
168 etc) or processed for input (DOM source). This can be used as a compliment to mRender
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
169 allowing you to modify the DOM element (add background colour for example) when the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
170 element is available.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
171
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
172 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
173 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
174
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
175 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
176 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
177 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
178 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
179 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
180 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
181 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
182 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
183 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
184 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
185 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
186
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
187 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
188 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">nTd</td><td class="type type-param">element</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The TD node that has been created</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">sData</td><td class="type type-param">*</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The Data for the cell</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">oData</td><td class="type type-param">array | object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data for the whole row</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">iRow</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The row index for the aoData data store</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
189 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
190 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
191 <dt id="DataTable.models.oColumn.fnGetData" class=" odd"><a name="fnGetData"></a><a name="fnGetData_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>fnGetData</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></span></dt><dd class=" odd"><p>Function to get data from a cell in a column. You should <b>never</b>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
192 access data directly through _aData internally in DataTables - always use
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
193 the method attached to this property. It allows mData to function as
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
194 required. This function is automatically assigned by the column
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
195 initialisation method</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
196
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
197 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
198 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
199
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
200 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
201 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
202 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
203 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
204 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
205 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
206 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
207 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
208 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
209 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
210 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
211
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
212 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
213 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oData</td><td class="type type-param">array | object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data array/object for the array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
214 (i.e. aoData[]._aData)</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">sSpecific</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The specific data type you want to get -
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
215 'display', 'type' 'filter' 'sort'</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
216 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
217 </table><h5>Returns:</h5><p class="returns"><p>The data for the cell from the given row's data</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
218 <dt id="DataTable.models.oColumn.fnRender" class=" even"><a name="fnRender"></a><a name="fnRender_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>fnRender</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></span></dt><dd class=" even"><p><code>Deprecated</code> Custom display function that will be called for the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
219 display of each cell in this column.</p>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
220
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
221 <p>Please note that this option has now been deprecated and will be removed
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
222 in the next version of DataTables. Please use mRender / mData rather than
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
223 fnRender.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
224 <dt class="important">Deprecated</dt><dd class="yes-def">Yes</dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
225 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
226 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
227
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
228 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
229 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
230 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
231 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
232 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
233 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
234 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
235 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
236 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
237 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
238 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
239
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
240 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
241 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">o</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Object with the following parameters:</p></td></tr><tr><td class="number right_border"></td><td class="name">o.iDataRow</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The row in aoData</p></td></tr><tr><td class="number right_border"></td><td class="name">o.iDataColumn</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The column in question</p></td></tr><tr><td class="number right_border"></td><td class="name">o.aData</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data for the row in question</p></td></tr><tr><td class="number right_border"></td><td class="name">o.oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The settings object for this DataTables instance</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
242 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
243 </table><h5>Returns:</h5><p class="returns"><p>The string you which to use in the display</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
244 <dt id="DataTable.models.oColumn.fnSetData" class=" odd"><a name="fnSetData"></a><a name="fnSetData_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>fnSetData</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></span></dt><dd class=" odd"><p>Function to set data for a cell in the column. You should <b>never</b>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
245 set the data directly to _aData internally in DataTables - always use
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
246 this method. It allows mData to function as required. This function
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
247 is automatically assigned by the column initialisation method</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
248
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
249 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
250 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
251
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
252 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
253 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
254 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
255 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
256 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
257 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
258 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
259 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
260 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
261 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
262 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
263
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
264 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
265 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oData</td><td class="type type-param">array | object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data array/object for the array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
266 (i.e. aoData[]._aData)</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">sValue</td><td class="type type-param">*</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Value to set</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
267 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
268 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
269 <dt class=" even"><a name="mData"></a><a name="mData_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#mData">mData</a></span><span class="type-sig"><span class="type-signature"> :function|int|string|null</span></span></dt><dd class=" even"><p>Property to read the value for the cells in the column from the data
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
270 source array / object. If null, then the default content is used, if a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
271 function is given then the return from the function is used.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
272
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
273 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
274 </div></dd><dt class=" odd"><a name="mRender"></a><a name="mRender_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#mRender">mRender</a></span><span class="type-sig"><span class="type-signature"> :function|int|string|null</span></span></dt><dd class=" odd"><p>Partner property to mData which is used (only when defined) to get
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
275 the data - i.e. it is basically the same as mData, but without the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
276 'set' option, and also the data fed to it is the result from mData.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
277 This is the rendering method to match the data method of mData.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
278
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
279 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
280 </div></dd><dt class=" even"><a name="nTf"></a><a name="nTf_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#nTf">nTf</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" even"><p>Unique footer TH/TD element for this column (if there is one). Not used
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
281 in DataTables as such, but can be used for plug-ins to reference the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
282 footer for each column.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
283
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
284 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
285 </div></dd><dt class=" odd"><a name="nTh"></a><a name="nTh_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#nTh">nTh</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" odd"><p>Unique header TH/TD element for this column - this is what the sorting
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
286 listener is attached to (if sorting is enabled.)</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
287
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
288 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
289 </div></dd><dt class=" even"><a name="sClass"></a><a name="sClass_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sClass">sClass</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>The class to apply to all TD elements in the table's TBODY for the column</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
290
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
291 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
292 </div></dd><dt class=" odd"><a name="sContentPadding"></a><a name="sContentPadding_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sContentPadding">sContentPadding</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>When DataTables calculates the column widths to assign to each column,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
293 it finds the longest string in each column and then constructs a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
294 temporary table and reads the widths from that. The problem with this
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
295 is that "mmm" is much wider then "iiii", but the latter is a longer
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
296 string - thus the calculation can go wrong (doing it properly and putting
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
297 it into an DOM object and measuring that is horribly(!) slow). Thus as
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
298 a "work around" we provide this option. It will append its value to the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
299 text that is found to be the longest string for the column - i.e. padding.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
300
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
301 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
302 </div></dd><dt class=" even"><a name="sDefaultContent"></a><a name="sDefaultContent_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sDefaultContent">sDefaultContent</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Allows a default value to be given for a column's data, and will be used
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
303 whenever a null data source is encountered (this can be because mData
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
304 is set to null, or because the data source itself is null).</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
305
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
306 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
307 </div></dd><dt class=" odd"><a name="sName"></a><a name="sName_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sName">sName</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Name for the column, allowing reference to the column by name as well as
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
308 by index (needs a lookup to work by name).</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
309
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
310 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
311 </div></dd><dt class=" even"><a name="sSortDataType"></a><a name="sSortDataType_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sSortDataType">sSortDataType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Custom sorting data type - defines which of the available plug-ins in
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
312 afnSortData the custom sorting will use - if any is defined.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
313
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
314 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
315 </div></dd><dt class=" odd"><a name="sSortingClass"></a><a name="sSortingClass_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sSortingClass">sSortingClass</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Class to be applied to the header element when sorting on this column</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
316
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
317 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
318 </div></dd><dt class=" even"><a name="sSortingClassJUI"></a><a name="sSortingClassJUI_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sSortingClassJUI">sSortingClassJUI</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Class to be applied to the header element when sorting on this column -
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
319 when jQuery UI theming is used.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
320
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
321 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
322 </div></dd><dt class=" odd"><a name="sTitle"></a><a name="sTitle_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sTitle">sTitle</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Title of the column - what is seen in the TH element (nTh).</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
323
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
324 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
325 </div></dd><dt class=" even"><a name="sType"></a><a name="sType_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sType">sType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Column sorting and filtering type</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
326
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
327 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
328 </div></dd><dt class=" odd"><a name="sWidth"></a><a name="sWidth_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sWidth">sWidth</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Width of the column</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
329
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
330 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
331 </div></dd><dt class=" even"><a name="sWidthOrig"></a><a name="sWidthOrig_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sWidthOrig">sWidthOrig</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Width of the column when it was first "encountered"</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
332
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
333 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
334 </div></dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
335 </dl></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
336 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
337
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
338 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
339
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
340 <div class="fw_footer">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
341 DataTables: Copyright 2008-2012 Allan Jardine, all rights reserved<br>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
342
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
343 Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
344 23th Sep 2012 - 14:27
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
345 with the <a href="http://datatables.net/">DataTables</a> template.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
346 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
347 </body>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
348 </html>