-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtemplate-20.html
57 lines (56 loc) · 76.8 KB
/
template-20.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
<link rel="stylesheet" href="./resources/styles/elf-template.css">
<h1 id="sortabletitleplugin">SortableTitlePlugin</h1>
<div id="elf-api-container"><div id="main-template" class="elf-template"> <section><header> <h1 class="subsection-title"><span class="attribs"><span class="type-signature"></span></span>SortableTitlePlugin<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h1> </header><article> <div class="container-overview">
<div class="item"> <div class="item-type">class</div> <h4 class="name" id="SortableTitlePlugin"><span class="type-signature"></span>new SortableTitlePlugin<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">options</div> <div class="type"> <span class="param-type">SortableTitlePlugin.Options</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div> </div> <h3 class="subsection-title" id="extends">Extends</h3> <dd class="argument-list"> <ul> <li><a href="#">Plugin</a></li> </ul> </dd> <h3 class="subsection-title" id="type_definitions">Type Definitions</h3>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~ColumnOptions">ColumnOptions</h4><div class="description"> The sorting properties for column option.</div> <h5>Type:</h5> <span class="param-type">Object</span> <h5>Properties:</h5> <div class="props"><table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>sortable</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last">If enable, the column can be sorted by user click</td> </tr> <tr> <td class="name"><code>sortBy</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Field to be used for sorting. If defined, user can click at the header section to sort the column</td> </tr> <tr> <td class="name"><code>sortLogic</code></td> <td class="type"> <span class="param-type">DataTable.SortLogic</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Custom compare function for sorting</td> </tr> <tr> <td class="name"><code>sortingLogic</code></td> <td class="type"> <span class="param-type">DataTable.SortLogic</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Alias to `sortLogic`</td> </tr> <tr> <td class="name"><code>sorter</code></td> <td class="type"> <span class="param-type">DataTable.SortLogic</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Alias to `sortLogic`</td> </tr> <tr> <td class="name"><code>defaultSort</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Set to "d" for descending order and "a" for ascending order</td> </tr> </tbody></table></div><div class="details"> </div></div>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~InitialSort">InitialSort</h4><div class="description"> The sorting object which will be used for initialSort config.</div> <h5>Type:</h5> <span class="param-type">Object</span> <h5>Properties:</h5> <div class="props"><table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>colIndex</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last">Index of the column</td> </tr> <tr> <td class="name"><code>sortOrder</code></td> <td class="type"> <span class="param-type"><a href="#/apis/core/sortabletitleplugin#~SortOrder">SortableTitlePlugin~SortOrder</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Set to "d" for descending order and "a" for ascending order</td> </tr> <tr> <td class="name"><code>order</code></td> <td class="type"> <span class="param-type"><a href="#/apis/core/sortabletitleplugin#~SortOrder">SortableTitlePlugin~SortOrder</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Alias of sortOrder</td> </tr> </tbody></table></div><div class="details"> </div></div>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~Options">Options</h4><div class="description"> The configuration object for sorting options. This can be defined by `sorting` property in CompositeGrid configuration object.</div> <h5>Type:</h5> <span class="param-type">Object</span> <h5>Properties:</h5> <div class="props"><table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>initialSort</code></td> <td class="type"> <span class="param-type"><a href="#/apis/core/sortabletitleplugin#~InitialSort">SortableTitlePlugin~InitialSort</a></span> | <span class="param-type">Array.<SortableTitlePlugin.InitialSort></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Set this config to initiate sorting after grid is created.</td> </tr> <tr> <td class="name"><code>multicolumn</code></td> <td class="type"> <span class="param-type">boolean</span> | <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last">Allow mulitple columns to be sorted at the same time. If number is defined, it is treated as maximum number of column to be sorted.</td> </tr> <tr> <td class="name"><code>multiColumn</code></td> <td class="type"> <span class="param-type">boolean</span> | <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last">Alias to `multicolumn`</td> </tr> <tr> <td class="name"><code>threeStatesSorting</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last">If enabled, sorting will cycle through ascending, descending and original order states.</td> </tr> <tr> <td class="name"><code>sortLogic</code></td> <td class="type"> <span class="param-type">Object.<string, DataTable.SortLogic></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Custom logic for sorting based on the specified field. The key is field name and the value pair is a function.</td> </tr> <tr> <td class="name"><code>disableDoubleClickToSort</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last">If enabled, double click on column title to sort</td> </tr> <tr> <td class="name"><code>sortableColumns</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last">If enabled, all columns will be sortable by field automatically</td> </tr> <tr> <td class="name"><code>sortableIndicator</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last">If enabled, sort indicator (diamond) icon will always show regardless of sorting states. In Halo theme, this option will be enabled by default.</td> </tr> <tr> <td class="name"><code>indicatorOnly</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last">If enabled, data will not be sorted, but the UI is rendered normally. This is useful for server side sorting.</td> </tr> <tr> <td class="name"><code>mode</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Set to "manual" to disable data sorting. Deprecated in favor of `indicatorOnly`</td> </tr> <tr> <td class="name"><code>disabled</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last">If enabled, header section cannot be clicked and no sort UI is rendered. Sorting can still be triggered only through `sortColumn` method.</td> </tr> <tr> <td class="name"><code>columnSorted</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">A shortcut to define the columnSorted event handler</td> </tr> <tr> <td class="name"><code>preClicked</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">A shortcut to define the preClicked event handler</td> </tr> <tr> <td class="name"><code>clicked</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">A shortcut to define the clicked event handler</td> </tr> <tr> <td class="name"><code>preDataSorting</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">A shortcut to define the preDataSorting event handler</td> </tr> </tbody></table></div><div class="details"> </div></div>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~SortOrder">SortOrder</h4> <h5>Type:</h5> <span class="param-type">"a"</span> | <span class="param-type">"ascending"</span> | <span class="param-type">"d"</span> | <span class="param-type">"descending"</span> | <span class="param-type">"n"</span> | <span class="param-type">null</span><div class="details"> </div></div> <h3 class="subsection-title" id="methods">Methods</h3>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="afterInit"><span class="type-signature"></span>afterInit<span class="signature">()</span><span class="type-signature"></span></h4> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="clearSortState"><span class="type-signature"></span>clearSortState<span class="signature">(opt_arg<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Clear all sorting states </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_arg</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Event argument to be sent with preDataSorting event </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="config"><span class="type-signature"></span>config<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">options</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Grid model object </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="disableCellClick"><span class="type-signature"></span>disableCellClick<span class="signature">(cell, disabled<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> This api is deprecated. Use SortableTitlePlugin.prototype.disableColumnSorting instead </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">cell</div> <div class="type"> <span class="param-type"><a href="#/apis/core/elementwrapper">ElementWrapper</a></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">disabled</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="disableColumnSorting"><span class="type-signature"></span>disableColumnSorting<span class="signature">(columns, disabled<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">columns</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">Array.<number></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">disabled</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="disableDataSorting"><span class="type-signature"></span>disableDataSorting<span class="signature">(disabled<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">disabled</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="disableDoubleClickToSort"><span class="type-signature"></span>disableDoubleClickToSort<span class="signature">(disabled<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> To allow double click action to sort. Default value is false. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">disabled</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="disableSortSymbols"><span class="type-signature"></span>disableSortSymbols<span class="signature">(disabled<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">disabled</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="disableTwoStateSorting"><span class="type-signature"></span>disableTwoStateSorting<span class="signature">(disabled<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">disabled</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnMenu"><span class="type-signature"></span>getColumnMenu<span class="signature">(colIndex, config)</span><span class="type-signature"> → {Object}</span></h4> <div class="description"> Function for ColumnMenuExtension to collect config of column menu </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="description"> Column index </div> </div> <div class="param"> <div class="name">config</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="description"> Column Menu configuration </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Object</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnSortingField"><span class="type-signature"></span>getColumnSortingField<span class="signature">(colIndex)</span><span class="type-signature"> → {string}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div><div class="sub-content-desc"> field A field used for sorting</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnSortingFields"><span class="type-signature"></span>getColumnSortingFields<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<string></span> </div><div class="sub-content-desc"> fields of each sorting states</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getConfigObject"><span class="type-signature"></span>getConfigObject<span class="signature">(gridOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">gridOptions</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Object</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getDataColumnMap"><span class="type-signature"></span>getDataColumnMap<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> <div class="description"> Get Array of fields used for sorting </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<string></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getGridElementFromPoint"><span class="type-signature"></span>getGridElementFromPoint<span class="signature">(x, y)</span><span class="type-signature"> → {Element}</span></h4> <div class="description"> Use in case of there is an overlay over the top of the grid (target element cannot be used). </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">x</div> <div class="type"> <span class="param-type">number</span> </div> </div> <div class="param"> <div class="name">y</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="##getGridElementFromPoint">Plugin#getGridElementFromPoint</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Element</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getIcons"><span class="type-signature"></span>getIcons<span class="signature">()</span><span class="type-signature"> → {Object.<string, string>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Object.<string, string></span> </div><div class="sub-content-desc"> "a" for ascending, "d" for descending, and "n" for no sorting</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getName"><span class="type-signature"></span>getName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="description"> The name must be readonly and unique among all other plugins </div> <div class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"> <a href="##getName">Plugin#getName</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getRelativeGrid"><span class="type-signature"></span>getRelativeGrid<span class="signature">(e)</span><span class="type-signature"> → {<a href="#/apis/core/grid">Grid</a>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">e</div> <div class="type"> <span class="param-type">Event</span> | <span class="param-type">Element</span> | <span class="param-type"><a href="#/apis/core/elementwrapper">ElementWrapper</a></span> </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="##getRelativeGrid">Plugin#getRelativeGrid</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/core/grid">Grid</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getSortedColumnIndex"><span class="type-signature"></span>getSortedColumnIndex<span class="signature">(priority<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Return the first (highest priority) sorted column's index </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">priority</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div><div class="sub-content-desc"> Return negative value if there is no sorted column</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getSortedColumns"><span class="type-signature"></span>getSortedColumns<span class="signature">()</span><span class="type-signature"> → {Array.<Object>|null}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<Object></span> | <span class="param-type">null</span> </div><div class="sub-content-desc"> Array of object with "colIndex" and "sortOrder"</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getSortingStates"><span class="type-signature"></span>getSortingStates<span class="signature">()</span><span class="type-signature"> → {Array.<Object>}</span></h4> <div class="description"> Deprecated. Use getSortedColumns instead of this </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/core/sortabletitleplugin#getSortedColumns">SortableTitlePlugin#getSortedColumns</a></li> </ul> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<Object></span> </div><div class="sub-content-desc"> Array of sorted column states ordered by priority</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getSortOrder"><span class="type-signature"></span>getSortOrder<span class="signature">(colIndex<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If colIndex is undefined or null the first sorted column is used instead </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div><div class="sub-content-desc"> "a" for ascending, "d" for descending, and "n" for no sorting</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getSortPriority"><span class="type-signature"></span>getSortPriority<span class="signature">(colIndex)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div><div class="sub-content-desc"> Start with 0 (first column to be sorted) and end in the highest number. Negative means the specified column is not sorted</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="initialize"><span class="type-signature"></span>initialize<span class="signature">(owner<span class="signature-attributes">non-null</span>)</span><span class="type-signature"></span></h4> <div class="description"> Suppress google compiler for argument options because Internal Plugin doesn't support. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">owner</div> <div class="type"> <span class="param-type"><a href="#/apis/core/grid">Grid</a></span> </div> </div> </div> <div class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"> <a href="##initialize">Plugin#initialize</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="isColumnSorted"><span class="type-signature"></span>isColumnSorted<span class="signature">(colIndex)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="listen"><span class="type-signature"></span>listen<span class="signature">(type, handler, opt_priority<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">type</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> </div> <div class="description"> Any event provided by derived class </div> </div> <div class="param"> <div class="name">handler</div> <div class="type"> <span class="param-type">function</span> </div> <div class="attributes"> </div> <div class="description"> Callback method </div> </div> <div class="param"> <div class="name">opt_priority</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> The higher the priority, the sooner the listener get executed. Undefined priority listener will be executed last </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/eventdispatcher#listen">EventDispatcher#listen</a> </dd> </div> <h5>Example:</h5> <pre><code>var grid = new Grid();
grid.listen("click", function(e) { console.log("Grid is clicked"); });</code></pre> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="refresh"><span class="type-signature"></span>refresh<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Perform sorting with the same parameter. </div> <div class="details"> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/sortabletitleplugin#event:preDataSorting">SortableTitlePlugin#event:preDataSorting</a></div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="restoreUserActions"><span class="type-signature"></span>restoreUserActions<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Perform sorting with the same parameter. Alias to <a href="#/apis/core/sortabletitleplugin#refresh">SortableTitlePlugin#refresh</a> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setClickDelayInterval"><span class="type-signature"></span>setClickDelayInterval<span class="signature">(opt_ms<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_ms</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Delay before actual sorting in milliseconds. Setting undefined value will be 500ms. Setting 0 to instantly perform sorting </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setColumnSortingField"><span class="type-signature"></span>setColumnSortingField<span class="signature">(colIndex, field, sortLogic<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">field</div> <div class="type"> <span class="param-type">string</span> | <span class="param-type">null</span> </div> <div class="attributes"> </div> <div class="description"> A field used for sorting </div> </div> <div class="param"> <div class="name">sortLogic</div> <div class="type"> <span class="param-type">function</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setDataColumnMap"><span class="type-signature"></span>setDataColumnMap<span class="signature">(dataMap)</span><span class="type-signature"></span></h4> <div class="description"> Set sorting field for multiple columns at once </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">dataMap</div> <div class="type"> <span class="param-type">Array.<(string|null)></span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setFirstSortOrder"><span class="type-signature"></span>setFirstSortOrder<span class="signature">(colIdentifier, sortOrder<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIdentifier</div> <div class="type"> <span class="param-type">string</span> | <span class="param-type">number</span> | <span class="param-type">Array.<(string|number)></span> | <span class="param-type">null</span> </div> <div class="attributes"> </div> <div class="description"> string is data column name, while number is display column index. If null, all data column names are removed </div> </div> <div class="param"> <div class="name">sortOrder</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> "ascending", "descending", "none" </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setSortableColumnCount"><span class="type-signature"></span>setSortableColumnCount<span class="signature">(count)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">count</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setSortLogic"><span class="type-signature"></span>setSortLogic<span class="signature">(field, func)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">field</div> <div class="type"> <span class="param-type">string</span> </div> </div> <div class="param"> <div class="name">func</div> <div class="type"> <span class="param-type">function</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setSortLogics"><span class="type-signature"></span>setSortLogics<span class="signature">(sortLogic)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">sortLogic</div> <div class="type"> <span class="param-type">Object.<string, function()></span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="sortColumn"><span class="type-signature"></span>sortColumn<span class="signature">(colIndex, sortOrder<span class="signature-attributes">opt</span>, opt_arg<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">sortOrder</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> "a" for ascending, "d" for descending, and "n" for no sorting </div> </div> <div class="param"> <div class="name">opt_arg</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Event argument to be sent with preDataSorting event </div> </div> </div> <div class="details"> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/sortabletitleplugin#event:preDataSorting">SortableTitlePlugin#event:preDataSorting</a></div> <div class="sub-content"><a href="#/apis/core/sortabletitleplugin#event:columnSorted">SortableTitlePlugin#event:columnSorted</a></div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="sortColumns"><span class="type-signature"></span>sortColumns<span class="signature">(sortOptions, opt_arg<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">sortOptions</div> <div class="type"> <span class="param-type">Array.<SortableTitlePlugin.InitialSort></span> </div> <div class="attributes"> </div> <div class="description"> Input an array to specify the multiple column sort order </div> </div> <div class="param"> <div class="name">opt_arg</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Event argument to be sent with preDataSorting event </div> </div> </div> <div class="details"> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/sortabletitleplugin#event:preDataSorting">SortableTitlePlugin#event:preDataSorting</a></div> <div class="sub-content"><a href="#/apis/core/sortabletitleplugin#event:columnSorted">SortableTitlePlugin#event:columnSorted</a></div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="unlisten"><span class="type-signature"></span>unlisten<span class="signature">(type, handler)</span><span class="type-signature"></span></h4> <div class="description"> Removes an event listener which was added with listen(). The same function handler must be sent in, or else it will not be removed </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">type</div> <div class="type"> <span class="param-type">string</span> </div> <div class="description"> The name of the event without the 'on' prefix. </div> </div> <div class="param"> <div class="name">handler</div> <div class="type"> <span class="param-type">function</span> </div> <div class="description"> The listener function to remove. </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/eventdispatcher#unlisten">EventDispatcher#unlisten</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="unlistenAll"><span class="type-signature"></span>unlistenAll<span class="signature">(type<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Removes all listeners from an object. If no type is specified, it will remove all listeners that have been registered. <br>You can also optionally remove listeners of a particular type. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">type</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Type of event to, default is all types. </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/eventdispatcher#unlistenAll">EventDispatcher#unlistenAll</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="unload"><span class="type-signature"></span>unload<span class="signature">(owner<span class="signature-attributes">non-null</span>)</span><span class="type-signature"></span></h4> <div class="description"> For disposing any resource </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">owner</div> <div class="type"> <span class="param-type"><a href="#/apis/core/grid">Grid</a></span> </div> </div> </div> <div class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"> <a href="##unload">Plugin#unload</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="updateSortSymbols"><span class="type-signature"></span>updateSortSymbols<span class="signature">()</span><span class="type-signature"></span></h4> <div class="details"> </div> </div> <h3 class="subsection-title" id="events">Events</h3>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:clicked">clicked</h4> <div class="description"> Fired when user click and after the sorting operation </div> <h5>Properties:</h5> <div class="props"><table> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>colIndex</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>sortOrder</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">"a" for "ascending, "d" for descending, and "n" for none</td> </tr> <tr> <td class="name"><code>dataColumnName</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Field that is used for sorting</td> </tr> </tbody></table></div><div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:columnSorted">columnSorted</h4> <div class="description"> Fired once column is sorted and before SortableTitlePlugin#clicked </div> <h5>Properties:</h5> <div class="props"><table> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>colIndex</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>sortOrder</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">"a" for "ascending, "d" for descending, and "n" for none</td> </tr> <tr> <td class="name"><code>sortedField</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Field that is used for sorting</td> </tr> <tr> <td class="name"><code>colIndices</code></td> <td class="type"> <span class="param-type">Array.<number></span> </td> <td class="description last">An array of colIndex</td> </tr> <tr> <td class="name"><code>sortOrders</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="description last">An array of sortOrder</td> </tr> <tr> <td class="name"><code>sortedFields</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="description last">An array of sortedField</td> </tr> </tbody></table></div><div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:preClicked">preClicked</h4> <div class="description"> Fired when user click and before the sorting operation. </div> <h5>Properties:</h5> <div class="props"><table> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>colIndex</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>target</code></td> <td class="type"> <span class="param-type">Element</span> </td> <td class="description last">Element being clicked</td> </tr> </tbody></table></div><div class="details"> </div> <h5>Example:</h5> <pre><code>function onPreClicked(e) {
e.cancel = true; // Cancel sorting operation
}</code></pre> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:preDataSorting">preDataSorting</h4> <div class="description"> Fired just before sorting data. This allows additional modification before the actual sorting </div> <h5>Properties:</h5> <div class="props"><table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>isUserAction</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">This has true value, if event initiate from clicking title/header section</td> </tr> </tbody></table></div><div class="details"> </div> </div> </article></section></div></div>