-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtemplate-22.html
63 lines (62 loc) · 71.2 KB
/
template-22.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
58
59
60
61
62
63
<link rel="stylesheet" href="./resources/styles/elf-template.css">
<h1 id="columndefinition">ColumnDefinition</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>ColumnDefinition<span class="signature">(columnOption<span class="signature-attributes">opt</span>, hostGrid<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="ColumnDefinition"><span class="type-signature"></span>new ColumnDefinition<span class="signature">(columnOption<span class="signature-attributes">opt</span>, hostGrid<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">columnOption</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/columndefinition#~Options">ColumnDefinition~Options</a></span> </div> <div class="attributes"> <optional> </div> </div> <div class="param"> <div class="name">hostGrid</div> <div class="type"> <span class="param-type">*</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div> </div> <h3 class="subsection-title" id="type_definitions">Type Definitions</h3>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~Options">Options</h4><div class="description"> ColumnDefinition options</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>field</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 for real-time, ADC, formula sources</td> </tr> <tr> <td class="name"><code>dataType</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">data type eg. string, datetime, number</td> </tr> <tr> <td class="name"><code>formulaReference</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"></td> </tr> <tr> <td class="name"><code>require</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Extra fields required by this column will be requested for real-time data.</td> </tr> <tr> <td class="name"><code>name</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">Label of the column</td> </tr> <tr> <td class="name"><code>notRealTimeField</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, the `field` will not be requested for real-time data. By enabling this, `rowSorting` will also be disabled, if not specified.</td> </tr> <tr> <td class="name"><code>tooltip</code></td> <td class="type"> <span class="param-type">boolean</span> | <span class="param-type">string</span> | <span class="param-type">null</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Show tooltip in header section</td> </tr> <tr> <td class="name"><code>headerBinding</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Method for custom header rendering.</td> </tr> <tr> <td class="name"><code>headerRenderer</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Alias to `headerBinding`</td> </tr> <tr> <td class="name"><code>binding</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Method for custom rendering. It will be executed on each data update and scrolling</td> </tr> <tr> <td class="name"><code>renderer</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Alias to `binding`</td> </tr> <tr> <td class="name"><code>sortLogic</code></td> <td class="type"> <span class="param-type"><a href="#/apis/rt-grid/columndefinition#~SortLogic">ColumnDefinition~SortLogic</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>sortingLogic</code></td> <td class="type"> <span class="param-type"><a href="#/apis/rt-grid/columndefinition#~SortLogic">ColumnDefinition~SortLogic</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </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"><a href="#/apis/rt-grid/columndefinition#~SortLogic">ColumnDefinition~SortLogic</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Alias to `sortLogic`</td> </tr> <tr> <td class="name"><code>rowSorting</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">If set to true, RowDefinition object will be used for sorting comparison. If set to false, data from the given `field` will be used for sorting comparison.</td> </tr> <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"> true </td> <td class="description last">If disabled, the column cannot be sorted by user click</td> </tr> <tr> <td class="name"><code>sort</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">Deprecated Alias to `sortOrder`</td> </tr> <tr> <td class="name"><code>sortOrder</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">The column can be sorted in ascending and descending order by specifying the order "a", "d". This option will sort the column when it is initialized or inserted at runtime.</td> </tr> <tr> <td class="name"><code>styles</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Key/value pair Object specifying CSS styles</td> </tr> <tr> <td class="name"><code>width</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> NaN </td> <td class="description last">If specified, column will have a fixed width in pixel</td> </tr> <tr> <td class="name"><code>minWidth</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> NaN </td> <td class="description last">If specified, column will have a minimum width in pixel</td> </tr> <tr> <td class="name"><code>scalable</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last">Column scalability forces column to be scaled and filled the grid. `width` property will be used as a weight/ratio</td> </tr> <tr> <td class="name"><code>className</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"></td> </tr> <tr> <td class="name"><code>class</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">Alias to `className`</td> </tr> <tr> <td class="name"><code>textAlign</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">Text alignment for content and column header. Available values are: left|center|right</td> </tr> <tr> <td class="name"><code>alignment</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">Alias to `textAlign`</td> </tr> <tr> <td class="name"><code>headerAlignment</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">Text alignment for column header. This will override `textAlign` option for column header.</td> </tr> <tr> <td class="name"><code>titleAlignment</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">Alias to `headerAlignment`</td> </tr> <tr> <td class="name"><code>hidden</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"></td> </tr> <tr> <td class="name"><code>id</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">A unique identifier for the column</td> </tr> <tr> <td class="name"><code>textSelect</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, user can select text in this column</td> </tr> <tr> <td class="name"><code>keepModel</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">If enabled, initial column's options will be kept</td> </tr> <tr> <td class="name"><code>stationary</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, the column order cannot be changed (i.e., this column and any column to its left cannot be moved)</td> </tr> <tr> <td class="name"><code>leftPinned</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, the column will not be part of the scrollable area and is pinned to the left side</td> </tr> <tr> <td class="name"><code>rightPinned</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, the column will not be part of the scrollable area and is pinned to the right side</td> </tr> <tr> <td class="name"><code>info</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">For storing any additional information to the column</td> </tr> <tr> <td class="name"><code>focusable</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, the column will be used to find focusable element when pressing tab key</td> </tr> <tr> <td class="name"><code>backgroundColor</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">CSS color value</td> </tr> </tbody></table></div><div class="details"> </div></div>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~SortLogic"><span class="type-signature"></span>SortLogic<span class="signature">(valA, valB, order, ctx)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">valA</div> <div class="type"> <span class="param-type">*</span> </div> <div class="description"> Data or RowDefinition object, depending on rowSorting flag, used for comparison </div> </div> <div class="param"> <div class="name">valB</div> <div class="type"> <span class="param-type">*</span> </div> <div class="description"> Data or RowDefinition object, depending on rowSorting flag, used for comparison </div> </div> <div class="param"> <div class="name">order</div> <div class="type"> <span class="param-type">number</span> </div> <div class="description"> Order code. 1 means ascending order and -1 means descending order </div> </div> <div class="param"> <div class="name">ctx</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="description"> Context Object of the current sorting operation </div> </div> </div> <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=".getDataType"><span class="type-signature"></span>getDataType<span class="signature">(field)</span><span class="type-signature"> → {string}</span></h4> <div class="description"> get data type </div> <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> <div class="details"> </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=".getRealTimeFields"><span class="type-signature"></span>getRealTimeFields<span class="signature">(fields, colDef)</span><span class="type-signature"> → {Array.<string>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">fields</div> <div class="type"> <span class="param-type">Array.<string></span> </div> <div class="description"> To be used by Array.reduce method </div> </div> <div class="param"> <div class="name">colDef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/columndefinition">ColumnDefinition</a></span> </div> </div> </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=".isAdcField"><span class="type-signature"></span>isAdcField<span class="signature">(field)</span><span class="type-signature"> → {boolean}</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> <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=".isFormulaField"><span class="type-signature"></span>isFormulaField<span class="signature">(field)</span><span class="type-signature"> → {boolean}</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> <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=".isRealTimeField"><span class="type-signature"></span>isRealTimeField<span class="signature">(field)</span><span class="type-signature"> → {boolean}</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> <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="activateRenderer"><span class="type-signature"></span>activateRenderer<span class="signature">(id<span class="signature-attributes">opt</span>, func<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Make the given renderer the first priority, overriding any existing renderer. The method still maintain existing renderers for restoring back to original state. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">id</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> ID for renderer mapping. If not specified the default renderer will be picked up </div> </div> <div class="param"> <div class="name">func</div> <div class="type"> <span class="param-type">function</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If not specified the renderer which corresponded id from mapping will be picked up. If false is given, the corresponding id will be cleared. </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> Current activation state after the call</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="addRenderer"><span class="type-signature"></span>addRenderer<span class="signature">(func)</span><span class="type-signature"></span></h4> <div class="description"> Add more renderer to the existing list </div> <h5>Parameters:</h5> <div class="params"> <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="clearUserModel"><span class="type-signature"></span>clearUserModel<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="dispose"><span class="type-signature"></span>dispose<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="getAllFields"><span class="type-signature"></span>getAllFields<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>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getBackgroundColor"><span class="type-signature"></span>getBackgroundColor<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="details"> </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="getChildren"><span class="type-signature"></span>getChildren<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="#/apis/rt-grid/columndefinition">ColumnDefinition</a>>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<<a href="#/apis/rt-grid/columndefinition">ColumnDefinition</a>></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getClasses"><span class="type-signature"></span>getClasses<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>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnInfo"><span class="type-signature"></span>getColumnInfo<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4> <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="getConfigObject"><span class="type-signature"></span>getConfigObject<span class="signature">(colOptions<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">colOptions</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="getDataType"><span class="type-signature"></span>getDataType<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="description"> get data type </div> <div class="details"> </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="getField"><span class="type-signature"></span>getField<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="details"> </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="getFieldDataType"><span class="type-signature"></span>getFieldDataType<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="description"> get realtime field data type </div> <div class="details"> </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="getFieldDefinition"><span class="type-signature"></span>getFieldDefinition<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="details"> </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="getHeaderAlignment"><span class="type-signature"></span>getHeaderAlignment<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="details"> </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="getHeaderRenderer"><span class="type-signature"></span>getHeaderRenderer<span class="signature">()</span><span class="type-signature"> → {function}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">function</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getId"><span class="type-signature"></span>getId<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="details"> </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="getInitialSortOrder"><span class="type-signature"></span>getInitialSortOrder<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="description"> Deprecated, this function will be return initial sort order of this column, The current sort state may be different from initial sort state. </div> <div class="details"> <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated">Yes</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="getMinWidth"><span class="type-signature"></span>getMinWidth<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </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="details"> </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="getParent"><span class="type-signature"></span>getParent<span class="signature">()</span><span class="type-signature"> → {<a href="#/apis/rt-grid/columndefinition">ColumnDefinition</a>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/rt-grid/columndefinition">ColumnDefinition</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getRenderer"><span class="type-signature"></span>getRenderer<span class="signature">()</span><span class="type-signature"> → {function}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">function</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getRequiredFields"><span class="type-signature"></span>getRequiredFields<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>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getRequireFields"><span class="type-signature"></span>getRequireFields<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>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getSorter"><span class="type-signature"></span>getSorter<span class="signature">()</span><span class="type-signature"> → {function}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">function</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getTextAlign"><span class="type-signature"></span>getTextAlign<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="details"> </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="getTooltip"><span class="type-signature"></span>getTooltip<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="details"> </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="getUserModel"><span class="type-signature"></span>getUserModel<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4> <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="getWidth"><span class="type-signature"></span>getWidth<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="hide"><span class="type-signature"></span>hide<span class="signature">(bool<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">bool</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="initialize"><span class="type-signature"></span>initialize<span class="signature">(columnOption<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">columnOption</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/columndefinition#~Options">ColumnDefinition~Options</a></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="isAutoGenerated"><span class="type-signature"></span>isAutoGenerated<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <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="isDefaultName"><span class="type-signature"></span>isDefaultName<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <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="isFieldEmpty"><span class="type-signature"></span>isFieldEmpty<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <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="isFocusable"><span class="type-signature"></span>isFocusable<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <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="isFormulaField"><span class="type-signature"></span>isFormulaField<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <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="isHidden"><span class="type-signature"></span>isHidden<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <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="isRealTimeField"><span class="type-signature"></span>isRealTimeField<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <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="isRowSorting"><span class="type-signature"></span>isRowSorting<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <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="isScalable"><span class="type-signature"></span>isScalable<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <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="isSortable"><span class="type-signature"></span>isSortable<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <div class="details"> <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated">Yes</dd> </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="isTextSelect"><span class="type-signature"></span>isTextSelect<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <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="isTimeSeries"><span class="type-signature"></span>isTimeSeries<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <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="isTimeSeriesChild"><span class="type-signature"></span>isTimeSeriesChild<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <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="setBackgroundColor"><span class="type-signature"></span>setBackgroundColor<span class="signature">(color)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">color</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setColumnInfo"><span class="type-signature"></span>setColumnInfo<span class="signature">(obj)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">obj</div> <div class="type"> <span class="param-type">Object</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setDataType"><span class="type-signature"></span>setDataType<span class="signature">(dataType)</span><span class="type-signature"></span></h4> <div class="description"> set data type </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">dataType</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setHeaderRenderer"><span class="type-signature"></span>setHeaderRenderer<span class="signature">(func)</span><span class="type-signature"></span></h4> <div class="description"> This will clear all previously stored renderers and set a new one. </div> <h5>Parameters:</h5> <div class="params"> <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="setName"><span class="type-signature"></span>setName<span class="signature">(str)</span><span class="type-signature"></span></h4> <div class="description"> To allow user change column name in run-time (language change or localization) </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">str</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setRenderer"><span class="type-signature"></span>setRenderer<span class="signature">(func)</span><span class="type-signature"></span></h4> <div class="description"> This will clear all previously stored renderers and set a new one. </div> <h5>Parameters:</h5> <div class="params"> <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="setSorter"><span class="type-signature"></span>setSorter<span class="signature">(func<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">func</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/columndefinition#~SortLogic">ColumnDefinition~SortLogic</a></span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div> </article></section></div></div>