-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtemplate-23.html
More file actions
231 lines (229 loc) · 223 KB
/
template-23.html
File metadata and controls
231 lines (229 loc) · 223 KB
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
<link rel="stylesheet" href="./resources/styles/elf-template.css">
<h1 id="grid">Grid</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>Grid<span class="signature">(placeholder<span class="signature-attributes">opt</span>, config<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="Grid"><span class="type-signature"></span>new Grid<span class="signature">(placeholder<span class="signature-attributes">opt</span>, config<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">placeholder</div> <div class="type"> <span class="param-type">Element</span> | <span class="param-type">null</span> </div> <div class="attributes"> <optional> </div> </div> <div class="param"> <div class="name">config</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~GridOptions">Grid~GridOptions</a></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>EventDispatcher</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="~ADCOptions">ADCOptions</h4><div class="description"> ADC requesting level config from adc team</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>productId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 001 </td> <td class="description last">required parameter, it specifies the product for which you request data. Contact the adc staff to create one.</td> </tr> </tbody></table></div><div class="details"> </div></div>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~ColumnReference">ColumnReference</h4><div class="description"> A column in Grid can be referred by the following values:<br><b>number</b> : Column index including all invisible (hidden) columns<br><b>string</b> : Field name or column id of the column<br><b>ColumnDefinition</b> : Column definition object<br></div> <h5>Type:</h5> <span class="param-type">number</span> | <span class="param-type">string</span> | <span class="param-type"><a href="#/apis/rt-grid/columndefinition">ColumnDefinition</a></span><div class="details"> </div></div>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~GridOptions">GridOptions</h4><div class="description"> Configuration object that can be provided directly at the initialization phase</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>columns</code></td> <td class="type"> <span class="param-type">Array.<(<a href="#/apis/rt-grid/columndefinition#~Options">ColumnDefinition~Options</a>|string)></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Collection of the column definitions</td> </tr> <tr> <td class="name"><code>defaultColumnOptions</code></td> <td class="type"> <span class="param-type"><a href="#/apis/rt-grid/columndefinition#~Options">ColumnDefinition~Options</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">All Columns will inherit from this default object</td> </tr> <tr> <td class="name"><code>rows</code></td> <td class="type"> <span class="param-type">Array.<<a href="#/apis/rt-grid/rowdefinition#~Options">RowDefinition~Options</a>></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Collection of the row definitions</td> </tr> <tr> <td class="name"><code>fields</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Shorthand for setting fields</td> </tr> <tr> <td class="name"><code>rics</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Shorthand for creating row definition</td> </tr> <tr> <td class="name"><code>plugins</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Additional plugins for core grid (from getBlotter()/getCoreGrid())</td> </tr> <tr> <td class="name"><code>extensions</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Alias to `plugins`</td> </tr> <tr> <td class="name"><code>scrollbar</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">Enable both vertical and horizontal scrollbar in grid</td> </tr> <tr> <td class="name"><code>linearWheelScrolling</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, wheel scrolling will move the content linearly regardless of how long the content is (i.e. no skipping).</td> </tr> <tr> <td class="name"><code>stepScroll</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, a full row will be scrolled at a time instead of actual scroll value.</td> </tr> <tr> <td class="name"><code>autoHideScrollbar</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">Fading in/out Scrollbar on hover.</td> </tr> <tr> <td class="name"><code>pageSize</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last">Make grid show specified number of row</td> </tr> <tr> <td class="name"><code>rowHeight</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 32 </td> <td class="description last">Set default row height for body (content) section</td> </tr> <tr> <td class="name"><code>headerRowHeight</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 32 </td> <td class="description last">Set default row height for header section</td> </tr> <tr> <td class="name"><code>noColumnDragging</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">All columns can be moved by dragging. If this option is true, the feature is disabled</td> </tr> <tr> <td class="name"><code>columnReorder</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">Alias with noColumnDragging but in opposite value. This property deprecated in favor of noColumnDragging.</td> </tr> <tr> <td class="name"><code>rowHighlighting</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">Highlight a row when hovering mouse over grid</td> </tr> <tr> <td class="name"><code>autoLayoutUpdate</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">Grid will check for layout change periodically.</td> </tr> <tr> <td class="name"><code>columnFreezing</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Deprecated in favor of column's leftPinned property. Enable horizontal scrollbar after `columnFreezing` index</td> </tr> <tr> <td class="name"><code>freezeColumn</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Deprecated in favor of column's leftPinned property. An alias to columnFreezing</td> </tr> <tr> <td class="name"><code>pinnedRightColumns</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last">Deprecated in favor of column's rightPinned property. Number of columns to be frozen/pinned on the right side.</td> </tr> <tr> <td class="name"><code>staticDataRows</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Shorthand for calling <a href="#/apis/rt-grid/grid#addStaticDataRows">Grid#addStaticDataRows</a></td> </tr> <tr> <td class="name"><code>dataFields</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Shorthand for calling <a href="#/apis/rt-grid/grid#addDataFields">Grid#addDataFields</a></td> </tr> <tr> <td class="name"><code>rowVirtualization</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, all data rows will be rendered. This will greatly impact grid's performance if the data set is huge.</td> </tr> <tr> <td class="name"><code>columnVirtualization</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, columns that are out of grid's view will NOT be rendered. This could greatly improve grid's performance when there are a lot of columns.</td> </tr> <tr> <td class="name"><code>topFreezingCount</code></td> <td class="type"> <span class="param-type">number</span> | <span class="param-type">null</span> | <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">If number >= 0 will fix number of frozen title section, If false = disabled scrollbar, if null then title section will freeze auto when new section added, this option will not work with scrollbar option.</td> </tr> <tr> <td class="name"><code>bottomFreezingCount</code></td> <td class="type"> <span class="param-type">number</span> | <span class="param-type">null</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">If number >= 0 will fix nuber of frozen footer section, if null then footer section will freeze auto when new section added, this option will not work with scrollbar option.</td> </tr> <tr> <td class="name"><code>borders</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">Lines around grid element</td> </tr> <tr> <td class="name"><code>gridlines</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">Horizontal and Vertical lines for ONLY content sections</td> </tr> <tr> <td class="name"><code>verticalLines</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">Vertical lines for all sections</td> </tr> <tr> <td class="name"><code>contentVerticalLines</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">Vertical lines for all content section</td> </tr> <tr> <td class="name"><code>horizontalLines</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">Horizontal lines for all sections</td> </tr> <tr> <td class="name"><code>RTK</code></td> <td class="type"> <span class="param-type">*</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">rtk toolkit instance</td> </tr> <tr> <td class="name"><code>ADC</code></td> <td class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~ADCOptions">Grid~ADCOptions</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">ADC requesting level config object from adc team</td> </tr> <tr> <td class="name"><code>synapse</code></td> <td class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~SynapseConfig">Grid~SynapseConfig</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">synapse config object</td> </tr> <tr> <td class="name"><code>contentRightPadding</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last">Padding that is added next to the right most column. The padding is still a part of scrollable content.</td> </tr> <tr> <td class="name"><code>contentBottomPadding</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last">Padding that is added below the last section. The padding is still a part of scrollable content.</td> </tr> <tr> <td class="name"><code>dataConflationRate</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last">set delay for data to avoid to much sorting operation when data changed</td> </tr> <tr> <td class="name"><code>autoDateConversion</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, date-time field with numeric value will be automatically converted to native date object.</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 content text by using mouse drag.</td> </tr> <tr> <td class="name"><code>lang</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">laguage for config localization date time, if null the default language is "en"</td> </tr> <tr> <td class="name"><code>scrollbarParent</code></td> <td class="type"> <span class="param-type">Element</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Element to be attached by grid's scrollbars, allowing them to move outside and avoid overlapping with the content.</td> </tr> <tr> <td class="name"><code>formulaEngine</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, field with leading equal sign will be treated as a formula and rows will be filled with the calculated values.</td> </tr> <tr> <td class="name"><code>adcPollingInterval</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last">Length of polling interval for refreshing ADC data in milliseconds. The default value (0) means no polling.</td> </tr> <tr> <td class="name"><code>fieldCaching</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, field definition will be caching internal mechanism</td> </tr> <tr> <td class="name"><code>timeSeriesExpansion</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 time series field will be treated as a normal field and not expanded.</td> </tr> <tr> <td class="name"><code>childDataField</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> CHILD_VALUES </td> <td class="description last">The given field will be used to store children's static data, such as row color assignment.</td> </tr> <tr> <td class="name"><code>topSection</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, title section will not be rendered</td> </tr> <tr> <td class="name"><code>sorting</code></td> <td class="type"> <span class="param-type">SortableTitlePlugin~Options</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Options for sorting</td> </tr> <tr> <td class="name"><code>dataComposed</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">Handler for dataComposed event</td> </tr> <tr> <td class="name"><code>beforeContentBinding</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">Handler for beforeContentBinding event</td> </tr> <tr> <td class="name"><code>firstRendered</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">Handler for firstRendered event</td> </tr> <tr> <td class="name"><code>afterContentBinding</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">Handler for afterContentBinding event</td> </tr> </tbody></table></div><div class="details"> </div></div>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~RowReference">RowReference</h4><div class="description"> A row in Grid can be referred by the following values: <br><b>number</b> : Row index of a visible rows, excluding invisible (hidden) rows<br><b>RowDefinition</b> : Row definition object<br><b>string</b> : Unique row Id existing in current data table, including invisible rows<br></div> <h5>Type:</h5> <span class="param-type">number</span> | <span class="param-type">string</span> | <span class="param-type"><a href="#/apis/rt-grid/rowdefinition">RowDefinition</a></span><div class="details"> </div></div>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~SynapseConfig">SynapseConfig</h4><div class="description"> Configuration object that can be provided directly at the initialization phase</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>apiKey</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last">Synapse api key</td> </tr> <tr> <td class="name"><code>contextApp</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last">Synapse context app name</td> </tr> <tr> <td class="name"><code>auth</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">Synapse authen token</td> </tr> <tr> <td class="name"><code>debug</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 true, Synapse response will be mock</td> </tr> </tbody></table></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="activateADCPolling"><span class="type-signature"></span>activateADCPolling<span class="signature">(activated<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">activated</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="default"> [default: true] </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="activateColumnRenderer"><span class="type-signature"></span>activateColumnRenderer<span class="signature">(colRef, id<span class="signature-attributes">opt</span>, 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">colRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a></span> </div> <div class="attributes"> </div> <div class="description"> Column index or id </div> </div> <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 </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="addDataFields"><span class="type-signature"></span>addDataFields<span class="signature">(fieldRef, referrer<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Add fields for real-time data without adding column nor UIs. No duplication is allowed </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">fieldRef</div> <div class="type"> <span class="param-type">string</span> | <span class="param-type">Array.<string></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">referrer</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </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="addFooterSection"><span class="type-signature"></span>addFooterSection<span class="signature">(sectionName<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">sectionName</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">*</span> </div><div class="sub-content-desc"> Return Section instance</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="addHeaderSection"><span class="type-signature"></span>addHeaderSection<span class="signature">(sectionName<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">sectionName</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">*</span> </div><div class="sub-content-desc"> Return Section instance</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="addStaticDataRows"><span class="type-signature"></span>addStaticDataRows<span class="signature">(dataRows, fields<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Add multiple rows without `ric` property in <a href="#/apis/rt-grid/rowdefinition">RowDefinition</a> </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">dataRows</div> <div class="type"> <span class="param-type">Array</span> </div> <div class="attributes"> </div> <div class="description"> 2D Array of data or Array of Field/Value pair object </div> </div> <div class="param"> <div class="name">fields</div> <div class="type"> <span class="param-type">Array.<string></span> </div> <div class="attributes"> <optional> </div> <div class="description"> If no field is given, field defined in column definition will be used instead </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/rt-grid/grid#logDV">Grid#logDV</a></li> <li><a href="#/apis/rt-grid/grid#logDT">Grid#logDT</a></li> </ul> </dd> </div> <h5>Example:</h5> <pre><code>let grid = new rt.Grid(grid_div, options);
grid.addStaticDataRows([
[10, "a", true],
[20, "b", false],
[30, "c", true]
], ["field1", "field2", "field3"]); // 3 rows are appended
<p>grid.addStaticDataRows([ // Object format can also be used
{"field1": 40, "field2": "a", "field3": true},
{"field1": 50, "field2": "b"}, // each row doesn't have to be the same
{"field1": 60, "field4": "some thing"}
]); // 3 more rows are appended
grid.logDV({"colNames": ["field1", "field2", "field3", "field4"]}); // See results in console</code></pre> </div> </p>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="clearColumnData"><span class="type-signature"></span>clearColumnData<span class="signature">(colRefs)</span><span class="type-signature"></span></h4> <div class="description"> Clear all existing data from the specified column(s). </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colRefs</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a></span> | <span class="param-type">Array.<<a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a>></span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="clearSort"><span class="type-signature"></span>clearSort<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="contains"><span class="type-signature"></span>contains<span class="signature">(elem)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Check element in the grid element </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">elem</div> <div class="type"> <span class="param-type">Element</span> </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"> =true if an element from the parameter is inside a grid element</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="focus"><span class="type-signature"></span>focus<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Focus grid element without moving window scrollbar </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="freezeColumn"><span class="type-signature"></span>freezeColumn<span class="signature">(colIndex<span class="signature-attributes">opt</span>, pinnedRightColumns<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Freeze the column at the left side of the table starting from index 0 to the specified colIndexIf no index is specified (null or undefined index), unfreeze all columns. </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="attributes"> <optional> </div> <div class="description"> Negative index is equivalent to null value </div> </div> <div class="param"> <div class="name">pinnedRightColumns</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Number of columns to be pinned/snapped on the right side </div> </div> </div> <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="description"> Get all fields, including required fields and data fields, with no duplicate </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<string></span> </div><div class="sub-content-desc"> New array is created</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getAllRics"><span class="type-signature"></span>getAllRics<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> <div class="description"> Retrieve all RIC subscriptions. This method is not dependent on the number of rows, the RIC can vary from the current row in the grid. </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="getAllRowDefinitions"><span class="type-signature"></span>getAllRowDefinitions<span class="signature">(inclAutoGenerated<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>>}</span></h4> <div class="description"> Get all row definitions, including filtered and hidden rows, but without auto generated rows (i.e., group header and chain constituent). </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">inclAutoGenerated</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="default"> [default: false] </div> <div class="description"> Set to true to include auto generated rows. Default value is false (exclude auto generated rows) </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnBackgroundColor"><span class="type-signature"></span>getColumnBackgroundColor<span class="signature">(colRef)</span><span class="type-signature"> → {string}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a></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="getColumnCount"><span class="type-signature"></span>getColumnCount<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="getColumnDataType"><span class="type-signature"></span>getColumnDataType<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>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnDefinition"><span class="type-signature"></span>getColumnDefinition<span class="signature">(colIndex)</span><span class="type-signature"> → {<a href="#/apis/rt-grid/columndefinition">ColumnDefinition</a>}</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"><a href="#/apis/rt-grid/columndefinition">ColumnDefinition</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnDefinitionById"><span class="type-signature"></span>getColumnDefinitionById<span class="signature">(colId)</span><span class="type-signature"> → {<a href="#/apis/rt-grid/columndefinition">ColumnDefinition</a>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colId</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"><a href="#/apis/rt-grid/columndefinition">ColumnDefinition</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnDefinitions"><span class="type-signature"></span>getColumnDefinitions<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="getColumnDefinitionsById"><span class="type-signature"></span>getColumnDefinitionsById<span class="signature">(colIds)</span><span class="type-signature"> → {<a href="#/apis/rt-grid/columndefinition">ColumnDefinition</a>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIds</div> <div class="type"> <span class="param-type">Array.<string></span> </div> </div> </div> <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="getColumnField"><span class="type-signature"></span>getColumnField<span class="signature">(colIndex)</span><span class="type-signature"> → {string}</span></h4> <div class="description"> Return field defined in the column definition </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> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/rt-grid/grid#getColumnDefinition">Grid#getColumnDefinition</a></li> </ul> </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="getColumnFields"><span class="type-signature"></span>getColumnFields<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> <div class="description"> Get fields from each column definition. Note that this does not include any required field or data fields. Duplicates may exist. </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<string></span> </div><div class="sub-content-desc"> New array is created</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnId"><span class="type-signature"></span>getColumnId<span class="signature">(colIndex)</span><span class="type-signature"> → {string}</span></h4> <div class="description"> Return column id that is set through configuration object </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> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/rt-grid/grid#getColumnDefinition">Grid#getColumnDefinition</a></li> </ul> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div><div class="sub-content-desc"> Return empty string if no existing id or column</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnIds"><span class="type-signature"></span>getColumnIds<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> <div class="description"> Get ids from each column definition. </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<string></span> </div><div class="sub-content-desc"> New array is created</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnIndex"><span class="type-signature"></span>getColumnIndex<span class="signature">(colRef)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a></span> </div> </div> </div> <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="getColumnIndices"><span class="type-signature"></span>getColumnIndices<span class="signature">(colRefs)</span><span class="type-signature"> → {Array.<number>}</span></h4> <div class="description"> Any invalid column reference will be excluded from the output array </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colRefs</div> <div class="type"> <span class="param-type">Array.<<a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a>></span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<number></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnNames"><span class="type-signature"></span>getColumnNames<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> <div class="description"> Get column name from each column definition. Note that this does not include any required field or data fields. Duplicates may exist. </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<string></span> </div><div class="sub-content-desc"> New array is created</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="getCoreGrid"><span class="type-signature"></span>getCoreGrid<span class="signature">()</span><span class="type-signature"> → {Core}</span></h4> <div class="description"> The returned core grid </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Core</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getDataRowCount"><span class="type-signature"></span>getDataRowCount<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="description"> WARNING: This represents number of rows in the DataTable which includes all invisible rows and rows in multiple wrapped grids </div> <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="getDataView"><span class="type-signature"></span>getDataView<span class="signature">()</span><span class="type-signature"> → {DataView}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">DataView</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getElement"><span class="type-signature"></span>getElement<span class="signature">()</span><span class="type-signature"> → {Element}</span></h4> <div class="details"> </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="getExtension"><span class="type-signature"></span>getExtension<span class="signature">(str)</span><span class="type-signature"> → {*}</span></h4> <div class="description"> Get extension instance </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 class="description"> Extension name </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">*</span> </div><div class="sub-content-desc"> Returns null, if the specified extension does not exist</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getFieldInfo"><span class="type-signature"></span>getFieldInfo<span class="signature">(field)</span><span class="type-signature"> → {Object}</span></h4> <div class="description"> Get stored field information. If field information has not been requested or no data has been received yet, null value is returned. </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">Object</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getMultipleRowData"><span class="type-signature"></span>getMultipleRowData<span class="signature">(obj<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<Object>}</span></h4> <div class="description"> Get data from multiple rows. If null or undefined value is given, data from all rows are returned. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">obj</div> <div class="type"> <span class="param-type">*</span> </div> <div class="attributes"> <optional> </div> <div class="description"> The value can be rowIndex, array of row indices, array of row definitions, DataView instance, null or undefined </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<Object></span> </div> <h5>Example:</h5> <pre><code>grid.getMultipleRowData(); // All row data are returned
grid.getMultipleRowData([0, 2, 4]); // Three row data are returned
grid.getMultipleRowData(1); // One row data from the specified row index is returned
grid.getMultipleRowData(DataView); // All row data from the specified DataView instance are returned</code></pre> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getPageCount"><span class="type-signature"></span>getPageCount<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="getPageIndex"><span class="type-signature"></span>getPageIndex<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="getPageItemCount"><span class="type-signature"></span>getPageItemCount<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Get all rows without paging </div> <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="getPageSize"><span class="type-signature"></span>getPageSize<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="getRelativePosition"><span class="type-signature"></span>getRelativePosition<span class="signature">(obj)</span><span class="type-signature"> → {Object}</span></h4> <div class="description"> The returned object contains <br>`boolean` hit : Indicates whether the given position is on the grid <br>`number` x : Horizontal coordinate that is relative to the top-left of the grid (Zero means left-most) <br>`number` y : Vertical coordinate that is relative to the top-left of the grid (Zero means top-most) <br>`number` colIndex <br>`number` sectionIndex <br>`number` rowIndex <br>and other related property to the given position. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">obj</div> <div class="type"> <span class="param-type">ElementWrapper</span> | <span class="param-type">Element</span> | <span class="param-type">Event</span> | <span class="param-type">MouseEvent</span> </div> <div class="description"> Element, Browser's Event object, Browser's Mouse Event object are all valid </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="getRic"><span class="type-signature"></span>getRic<span class="signature">(rowRef<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h4> <div class="description"> Returns RIC of given row reference. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type">string</span> | <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">string</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getRowCount"><span class="type-signature"></span>getRowCount<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="description"> WARNING: This represents number of visible rows in a single grid </div> <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="getRowData"><span class="type-signature"></span>getRowData<span class="signature">(rowIndex)</span><span class="type-signature"> → {Object}</span></h4> <div class="description"> A shorthand to retrieve row data based on index of the specified row. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="description"> Row index as shown in the view </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Object</span> </div><div class="sub-content-desc"> "FIELD1": value1, "FIELD2": value2, ...</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getRowDefinition"><span class="type-signature"></span>getRowDefinition<span class="signature">(rowRef)</span><span class="type-signature"> → {<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>}</span></h4> <div class="description"> Get RowDefinition object by either number or row id </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">string</span> </div> <div class="description"> Row index as shown in the view or row id (string) </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition">RowDefinition</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getRowDefinitions"><span class="type-signature"></span>getRowDefinitions<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>>}</span></h4> <div class="description"> Get all row definitions shown in the view, excluding rows that are hidden by filtering or pagination. <br>A new array object is created every time. Do not call this method repeatedly.<br>Group header row will return null for its rowDefinition since the row is auto generated and has no data nor definition. </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getRowType"><span class="type-signature"></span>getRowType<span class="signature">(rowRef)</span><span class="type-signature"> → {string}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">string</span> </div> <div class="description"> Row index as shown in the view or row id (string) </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="getScrollHeight"><span class="type-signature"></span>getScrollHeight<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Get height of scrollable area from the vertical scrollbar. This is useful for determining the end of scrollbar </div> <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="getScrollLeft"><span class="type-signature"></span>getScrollLeft<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Get scroll value in pixel from the horizontal scrollbar </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div><div class="sub-content-desc"> pixels</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getScrollTop"><span class="type-signature"></span>getScrollTop<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Get scroll value in pixel from the vertical scrollbar </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div><div class="sub-content-desc"> pixels</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getScrollWidth"><span class="type-signature"></span>getScrollWidth<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Get width of scrollable area from the horizontal scrollbar. This is useful for determining the end of scrollbar </div> <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="getSortedColumnIndex"><span class="type-signature"></span>getSortedColumnIndex<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="getSortingStates"><span class="type-signature"></span>getSortingStates<span class="signature">()</span><span class="type-signature"> → {Array.<Object>}</span></h4> <div class="description"> Get sorting states from sorting columns </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<Object></span> </div><div class="sub-content-desc"> Array of sorting states ordered by priority. If there is no sorting column, an empty array is returned</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">()</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 class="sub-content-desc"> "a" for "ascending, "d" for descending, and "n" for none/noOrder</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getVScrollView"><span class="type-signature"></span>getVScrollView<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4> <div class="description"> Get information about current grid's view and the vertical scrollbar </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Object</span> </div><div class="sub-content-desc"> Returns null, if vertical scrollbar does not exists</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="hasHiddenRow"><span class="type-signature"></span>hasHiddenRow<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="hasRic"><span class="type-signature"></span>hasRic<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Returns true if there is at least 1 RIC in the grid. This method includes RICs not in the row. </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="hideColumn"><span class="type-signature"></span>hideColumn<span class="signature">(colRef, hidden<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> The hidden column still occupies the same index. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">hidden</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/rt-grid/grid#hideColumns">Grid#hideColumns</a></li> <li><a href="#/apis/rt-grid/grid#showAllColumns">Grid#showAllColumns</a></li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="hideColumns"><span class="type-signature"></span>hideColumns<span class="signature">(colRefs, hidden<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Hide multiple columns at once. The hidden columns still occupy the same index. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colRefs</div> <div class="type"> <span class="param-type">Array.<<a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a>></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">hidden</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/rt-grid/grid#hideColumn">Grid#hideColumn</a></li> <li><a href="#/apis/rt-grid/grid#showAllColumns">Grid#showAllColumns</a></li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="hideRow"><span class="type-signature"></span>hideRow<span class="signature">(rowRef, hidden<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">rowRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">hidden</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> if false, show instead of hide </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="hideRows"><span class="type-signature"></span>hideRows<span class="signature">(rowRefs, hidden<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Hide row(s) in the Grid by specifying the rIds </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRefs</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a></span> | <span class="param-type">Array.<<a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a>></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">hidden</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> if false, show instead of hide </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">(gridOption<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">gridOption</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~GridOptions">Grid~GridOptions</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="initSubscription"><span class="type-signature"></span>initSubscription<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="insertBefore"><span class="type-signature"></span>insertBefore<span class="signature">(elem)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">elem</div> <div class="type"> <span class="param-type">Element</span> </div> <div class="description"> Sibling element </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="insertColumn"><span class="type-signature"></span>insertColumn<span class="signature">(columnOption, idx<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> | <span class="param-type">string</span> </div> <div class="attributes"> </div> <div class="description"> String will be treated as field, while object is treated as the column options </div> </div> <div class="param"> <div class="name">idx</div> <div class="type"> <span class="param-type">number</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="insertRow"><span class="type-signature"></span>insertRow<span class="signature">(rowOption<span class="signature-attributes">opt</span>, rowRef<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowOption</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition#~Options">RowDefinition~Options</a></span> | <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> </div> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a></span> </div> <div class="attributes"> <optional> </div> <div class="description"> Reference (i.e. row index, row id, or row definition) of the insert position </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition">RowDefinition</a></span> </div> <h5>Example:</h5> <pre><code>let grid = new rt.Grid(grid_div, options);
grid.insertRow({"ric": "RIC"}, 0); // A new row is added at the top</code></pre> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="insertRows"><span class="type-signature"></span>insertRows<span class="signature">(rowOptions, rowRef<span class="signature-attributes">opt</span>, opt_fields<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">rowOptions</div> <div class="type"> <span class="param-type">Array.<(<a href="#/apis/rt-grid/rowdefinition#~Options">RowDefinition~Options</a>|string)></span> </div> <div class="attributes"> </div> <div class="description"> Array of row option object </div> </div> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a></span> </div> <div class="attributes"> <optional> </div> <div class="description"> Reference (i.e. row index, row id, or row definition) of the insert position </div> </div> <div class="param"> <div class="name">opt_fields</div> <div class="type"> <span class="param-type">Array.<string></span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Example:</h5> <pre><code>let grid = new rt.Grid(grid_div, options);
grid.insertRows([
{ric: "RIC"},
{values: {"field1": 0, "field2": 1}},
{ric: "RIC2", values: [1, 2, 3, 4]},
null
]); // 4 rows are appended</code></pre> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="insertSegmentSeparator"><span class="type-signature"></span>insertSegmentSeparator<span class="signature">(rowOption<span class="signature-attributes">opt</span>, rowRef<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>}</span></h4> <div class="description"> Insert a row as a segment separator </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowOption</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition#~Options">RowDefinition~Options</a></span> </div> <div class="attributes"> <optional> </div> </div> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a></span> </div> <div class="attributes"> <optional> </div> <div class="description"> Reference (i.e. row index, row id, or row definition) of the insert position </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition">RowDefinition</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="isFocused"><span class="type-signature"></span>isFocused<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Check grid element is focused </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="isSorting"><span class="type-signature"></span>isSorting<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="listen"><span class="type-signature"></span>listen<span class="signature">(type, handler)</span><span class="type-signature"></span></h4> <div class="description"> Alias to EventDispatcher#addEventListener </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"> Event name </div> </div> <div class="param"> <div class="name">handler</div> <div class="type"> <span class="param-type">function</span> </div> <div class="description"> Event handler </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="loadFieldInfo"><span class="type-signature"></span>loadFieldInfo<span class="signature">(field)</span><span class="type-signature"> → {Promise}</span></h4> <div class="description"> Request field information from Synapse service. If field information already exists, a resolved promise is returned. Synapse config must be supplied before the request can be made. </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">Promise</span> </div> <h5>Example:</h5> <pre><code>let gridConfig = {
synapse: { // define synapse configuration
apiKey: "xxx",
contextApp: "xxx",
auth: "xxx" (optional)
}
};
let promise = grid.loadFieldInfo("CF_LAST");</code></pre> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="logDT"><span class="type-signature"></span>logDT<span class="signature">(opt_options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Log DataTable to console. By default, this will log only fields specified in the column definition. To see other column data use "colNames" options </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_options</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> <div class="description"> { "colNames": Array.<string>, "rowCount": number, "startIndex": number, "getter": function(Object, string):* } </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="logDV"><span class="type-signature"></span>logDV<span class="signature">(opt_options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Log DataView to console. By default, this will log only fields specified in the column definition. To see other column data use "colNames" options </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_options</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> <div class="description"> { "colNames": Array.<string>, "rowCount": number, "startIndex": number, "getter": function(Object, string):* } </div> </div> </div> <div class="details"> </div> <h5>Example:</h5> <pre><code>// Options have the following format:
// {
// "colNames": Array.<string>,
// "rowCount": number,
// "startIndex": number,
// "getter": function(rowData:Object, colName:string):*,
// "withRowIds": boolean
// }
grid.logDV({"rowCount": 10}); // Showing 10 records</code></pre> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="moveColumn"><span class="type-signature"></span>moveColumn<span class="signature">(fromColIndex, toColIndex)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Move the column at the specified index to the target index. When moving multiple columns, the original order of the source columns will be sorted by their index and the position of the columns will not be guaranteed to be exactly at the destination index. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">fromColIndex</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">Array.<number></span> </div> <div class="description"> index or array of indices of the column(s) to be moved. </div> </div> <div class="param"> <div class="name">toColIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="description"> target column index </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/rt-grid/grid#moveColumnById">Grid#moveColumnById</a></li> </ul> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> Return true if there is any change, and false otherwise</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="moveColumnById"><span class="type-signature"></span>moveColumnById<span class="signature">(srcCol, destCol<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> If source column is not found, no operation is performed. If destination column is not found, the source column will be moved to the last position.<br>Note: this method behaves slightly different from moveColumn method in that it always put source column at the position before the specified destination column, while moveColumn method will put column at exactly at the destination index. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">srcCol</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">string</span> </div> <div class="attributes"> </div> <div class="description"> Column Id or index </div> </div> <div class="param"> <div class="name">destCol</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Column Id or index of the destination </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/rt-grid/grid#moveColumn">Grid#moveColumn</a></li> </ul> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> Return true if there is any change, and false otherwise</div> <h5>Example:</h5> <pre><code>grid.moveColumnById(3, 1); // Move column 3 to position before column 1
grid.moveColumnById(0, 2); // Move column 0 to position before column 2 (column index 1)
grid.moveColumnById(0, 1); // Nothing is moved
grid.moveColumnById("sourceColumnId", "anotherId");
grid.moveColumnById("sourceColumnId", ""); // move to the last position</code></pre> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="pinColumn"><span class="type-signature"></span>pinColumn<span class="signature">(colRef, side<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Pin column to the left side by moving the specified column to the rightmost of the frozen columns. <br>The method will do nothing if the specified column is already pinned to the left side </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a></span> | <span class="param-type">Array.<<a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a>></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">side</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Available values are: left|right. If no value is supplied, the column will be pinned to the left. </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="refreshADCData"><span class="type-signature"></span>refreshADCData<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Force re-requesting ADC data to immediately update the data </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> Return true, if a request has been made</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeAllColumns"><span class="type-signature"></span>removeAllColumns<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Sorting is also cleared. </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/rt-grid/grid#removeColumn">Grid#removeColumn</a></li> <li><a href="#/apis/rt-grid/grid#removeColumns">Grid#removeColumns</a></li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeAllRows"><span class="type-signature"></span>removeAllRows<span class="signature">()</span><span class="type-signature"></span></h4> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/rt-grid/grid#removeRow">Grid#removeRow</a></li> <li><a href="#/apis/rt-grid/grid#removeRows">Grid#removeRows</a></li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeColumn"><span class="type-signature"></span>removeColumn<span class="signature">(colRef)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a></span> </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/rt-grid/grid#removeColumns">Grid#removeColumns</a></li> <li><a href="#/apis/rt-grid/grid#removeAllColumns">Grid#removeAllColumns</a></li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeColumns"><span class="type-signature"></span>removeColumns<span class="signature">(colRefs)</span><span class="type-signature"></span></h4> <div class="description"> Remove multiple columns through array. To remove all columns, use removeAllColumns() instead of this method </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colRefs</div> <div class="type"> <span class="param-type">Array.<<a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a>></span> </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/rt-grid/grid#removeColumn">Grid#removeColumn</a></li> <li><a href="#/apis/rt-grid/grid#removeAllColumns">Grid#removeAllColumns</a></li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeDataFields"><span class="type-signature"></span>removeDataFields<span class="signature">(fieldRef, referrer<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Add fields for real-time data without adding column nor UIs. No duplication is allowed </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">fieldRef</div> <div class="type"> <span class="param-type">string</span> | <span class="param-type">Array.<string></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">referrer</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </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="removeEventListeners"><span class="type-signature"></span>removeEventListeners<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Alias to EventDispatcher#removeAllEventListeners </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeFieldReferrer"><span class="type-signature"></span>removeFieldReferrer<span class="signature">(referrer)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">referrer</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="removeRow"><span class="type-signature"></span>removeRow<span class="signature">(rowRef)</span><span class="type-signature"> → {<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a></span> </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/rt-grid/grid#removeRows">Grid#removeRows</a></li> <li><a href="#/apis/rt-grid/grid#removeAllRows">Grid#removeAllRows</a></li> </ul> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition">RowDefinition</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeRows"><span class="type-signature"></span>removeRows<span class="signature">(rowRefs)</span><span class="type-signature"> → {Array.<<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>>}</span></h4> <div class="description"> Remove multiple rows at once. This prevents duplicate operation and improve performance. To remove all rows, use removeAllRows() method instead of this method. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRefs</div> <div class="type"> <span class="param-type">Array.<<a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a>></span> </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/rt-grid/grid#removeRow">Grid#removeRow</a></li> <li><a href="#/apis/rt-grid/grid#removeAllRows">Grid#removeAllRows</a></li> </ul> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>></span> </div><div class="sub-content-desc"> Array of removed row definitions</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="reorderColumns"><span class="type-signature"></span>reorderColumns<span class="signature">(colRefs, destCol<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colRefs</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">string</span> | <span class="param-type">Array.<(number|string)></span> </div> <div class="attributes"> </div> <div class="description"> List of column index or column id to be moved </div> </div> <div class="param"> <div class="name">destCol</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Destination position where the moved columns will be placed BEFORE the specified position. This can be column id or index </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"> Return true if there is any change, and false otherwise</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="replaceColumn"><span class="type-signature"></span>replaceColumn<span class="signature">(columnOption, colRef)</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> | <span class="param-type">string</span> </div> <div class="description"> String will be treated as field, while object is treated as the column options </div> </div> <div class="param"> <div class="name">colRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a></span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="replaceRow"><span class="type-signature"></span>replaceRow<span class="signature">(rowRef, rowOption<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>}</span></h4> <div class="description"> Replace existing row by a new row. Row Id is always changed, after the row is replaced.If the rowId of the new row is identical to that of the replacing row. Grid will do nothing becausesimilar rowIds indicate that they are the same row. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a></span> </div> <div class="attributes"> </div> <div class="description"> Reference (i.e. row index, row id, or row definition) of the insert position </div> </div> <div class="param"> <div class="name">rowOption</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition#~Options">RowDefinition~Options</a></span> | <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition">RowDefinition</a></span> </div><div class="sub-content-desc"> Returns null, if the row is not replaced. Otherwise, a newly created row is returned</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="requestRowRefresh"><span class="type-signature"></span>requestRowRefresh<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Request re-rendering of content row by triggering data binding event without any change in data model </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="restoreColumns"><span class="type-signature"></span>restoreColumns<span class="signature">(columns, byId<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Remove, add and keep column based on the given column data </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">columns</div> <div class="type"> <span class="param-type">Array.<Object></span> </div> <div class="attributes"> </div> <div class="default"> </div> <div class="description"> Array of column options </div> </div> <div class="param"> <div class="name">byId</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="default"> [default: false,] </div> <div class="description"> if enable it, this method will only check for differences in the 'id' property </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="scrollDown"><span class="type-signature"></span>scrollDown<span class="signature">(pixels)</span><span class="type-signature"></span></h4> <div class="description"> Scroll the view down by the specified value. Use negative value to scroll the view to the top </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">pixels</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li>Grid.setScrollTop</li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="scrollRight"><span class="type-signature"></span>scrollRight<span class="signature">(pixels)</span><span class="type-signature"></span></h4> <div class="description"> Scroll the view to the right by the specified value. Use negative value to scroll the view to the left </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">pixels</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li>Grid.setScrollLeft</li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="scrollToColumn"><span class="type-signature"></span>scrollToColumn<span class="signature">(colIndex, leftOfView<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Scroll the view to the specified column. If the column is already in the view, nothing happens. If the column is outside of the view, the view will be moved to the column with some additional offsets </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="attributes"> </div> </div> <div class="param"> <div class="name">leftOfView</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Default is false. If true, the specified column will be put at the leftmost of the view (no offset) </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"> Return true, if there is any change</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="scrollToRow"><span class="type-signature"></span>scrollToRow<span class="signature">(rowIndex, topOfView<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Scroll the view to the specified row. If the row is already in the view, nothing happens. If the row is outside of the view, the view will be moved to the row with some additional offsets </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> <div class="default"> </div> </div> <div class="param"> <div class="name">topOfView</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="default"> [default: false] </div> <div class="description"> If true, the specified row will be put at the top of the view (no offset) </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setClassification"><span class="type-signature"></span>setClassification<span class="signature">(rowRef, fields)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a></span> </div> </div> <div class="param"> <div class="name">fields</div> <div class="type"> <span class="param-type">Array.<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="setColumnBackgroundColor"><span class="type-signature"></span>setColumnBackgroundColor<span class="signature">(colRef, color)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a></span> </div> </div> <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="setColumnFormatter"><span class="type-signature"></span>setColumnFormatter<span class="signature">(colIndex, formatter)</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="description"> Column index of the position of the column to be updated </div> </div> <div class="param"> <div class="name">formatter</div> <div class="type"> <span class="param-type">Object</span> | <span class="param-type">function</span> </div> <div class="description"> Formatter object or bind function </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setColumnName"><span class="type-signature"></span>setColumnName<span class="signature">(colIndex, str)</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> <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="setColumnRenderer"><span class="type-signature"></span>setColumnRenderer<span class="signature">(colRef, 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">colRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a></span> </div> <div class="attributes"> </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> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setColumns"><span class="type-signature"></span>setColumns<span class="signature">(columns)</span><span class="type-signature"></span></h4> <div class="description"> Remove all existing columns and add new columns based on the given objects </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">columns</div> <div class="type"> <span class="param-type">Array.<Object></span> </div> <div class="description"> Array of column options </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setColumnSorter"><span class="type-signature"></span>setColumnSorter<span class="signature">(colRef, 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">colRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a></span> </div> <div class="attributes"> </div> </div> <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>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setFields"><span class="type-signature"></span>setFields<span class="signature">(ary)</span><span class="type-signature"></span></h4> <div class="description"> Remove all existing columns and add new columns based on the given texts/fields </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">ary</div> <div class="type"> <span class="param-type">Array.<string></span> </div> <div class="description"> Array of fields (string) </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/rt-grid/grid#setColumns">Grid#setColumns</a></li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setLocale"><span class="type-signature"></span>setLocale<span class="signature">(lang)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">lang</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="setPage"><span class="type-signature"></span>setPage<span class="signature">(pageIndex)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">pageIndex</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="setPageSize"><span class="type-signature"></span>setPageSize<span class="signature">(size)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">size</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="setParent"><span class="type-signature"></span>setParent<span class="signature">(elem)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">elem</div> <div class="type"> <span class="param-type">Element</span> </div> <div class="description"> Parent element </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setRic"><span class="type-signature"></span>setRic<span class="signature">(rowRef, str, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>}</span></h4> <div class="description"> Set RIC to the specified row </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">str</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> </div> <div class="description"> RIC to be set to a row </div> </div> <div class="param"> <div class="name">options</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition#~Options">RowDefinition~Options</a></span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition">RowDefinition</a></span> </div><div class="sub-content-desc"> Returns modified Row Definition instance</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setRicData"><span class="type-signature"></span>setRicData<span class="signature">(ric, values)</span><span class="type-signature"></span></h4> <div class="description"> Set row data base on RIC. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">ric</div> <div class="type"> <span class="param-type">string</span> </div> </div> <div class="param"> <div class="name">values</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="description"> {"FIELD1": value1, "FIELD2": value2, ...} Use null to remove current row data (not row in the view). </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setRics"><span class="type-signature"></span>setRics<span class="signature">(ary)</span><span class="type-signature"></span></h4> <div class="description"> Reset existing rows. It is a combination of insertRows and removeAllRows. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">ary</div> <div class="type"> <span class="param-type">Array.<string></span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setRowContent"><span class="type-signature"></span>setRowContent<span class="signature">(rowRef, str)</span><span class="type-signature"></span></h4> <div class="description"> Alias to setRic </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a></span> </div> </div> <div class="param"> <div class="name">str</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li>Grid.setRic</li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setRowData"><span class="type-signature"></span>setRowData<span class="signature">(rowRef, values)</span><span class="type-signature"></span></h4> <div class="description"> A shorthand to set row data based on index of the specified row. It is better to keep rowDefinition object for updating data directly as row index can be changed by sorting and filtering. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a></span> </div> </div> <div class="param"> <div class="name">values</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="description"> {"FIELD1": value1, "FIELD2": value2, ...} Use null to remove current row data (not row in the view). </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setScrollLeft"><span class="type-signature"></span>setScrollLeft<span class="signature">(pixels)</span><span class="type-signature"></span></h4> <div class="description"> Set scroll value to the horizontal scrollbar. This will move the scrollbar to specific position </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">pixels</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li>Grid.scrollRight</li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setScrollTop"><span class="type-signature"></span>setScrollTop<span class="signature">(pixels)</span><span class="type-signature"></span></h4> <div class="description"> Set scroll value to the vertical scrollbar. This will move the scrollbar to specific position </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">pixels</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li>Grid.scrollDown</li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setStaticData"><span class="type-signature"></span>setStaticData<span class="signature">(rowRef, field, value)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a></span> </div> </div> <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">value</div> <div class="type"> <span class="param-type">*</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setStaticRowData"><span class="type-signature"></span>setStaticRowData<span class="signature">(rowRef, values)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a></span> </div> </div> <div class="param"> <div class="name">values</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="showAllColumns"><span class="type-signature"></span>showAllColumns<span class="signature">()</span><span class="type-signature"></span></h4> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/rt-grid/grid#hideColumn">Grid#hideColumn</a></li> <li><a href="#/apis/rt-grid/grid#hideColumns">Grid#hideColumns</a></li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="showRows"><span class="type-signature"></span>showRows<span class="signature">(rowRefs, shown<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Show row(s) in the Grid by specifying the rIds </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRefs</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a></span> | <span class="param-type">Array.<<a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a>></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">shown</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> if false, hide instead of show </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">(colRef, opt_order<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">colRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">opt_order</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> This can be "ascending", "descending", "none", "noOrder", or "originalOrder" </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="toggleChain"><span class="type-signature"></span>toggleChain<span class="signature">(rowRef)</span><span class="type-signature"></span></h4> <div class="description"> Toggle between expanded and collapsed chain index </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a></span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="toggleRowExpansion"><span class="type-signature"></span>toggleRowExpansion<span class="signature">(rid, force<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">rid</div> <div class="type"> <span class="param-type">string</span> | <span class="param-type">number</span> </div> <div class="attributes"> </div> <div class="description"> Row Id or index </div> </div> <div class="param"> <div class="name">force</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="unhideAllRows"><span class="type-signature"></span>unhideAllRows<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Unhide all hidden rows in the Grid </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="unlinkChain"><span class="type-signature"></span>unlinkChain<span class="signature">(rowRef)</span><span class="type-signature"></span></h4> <div class="description"> Unlink the chain and its constituents. When the chain is expanded,the chain row and its members are converted from autogenerated toregular real-time rows. Only the chain row will be transformed toa conventional real-time row if the chain is collapsed.All converted rows will continue to have their data updated. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~RowReference">Grid~RowReference</a></span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="unpinAllColumns"><span class="type-signature"></span>unpinAllColumns<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> A shorthand to unpin all columns from the left hand side </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="unpinColumn"><span class="type-signature"></span>unpinColumn<span class="signature">(colRef, dest<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Unpin column from the left side by moving the specified column to the end of the frozen columns. <br>The method will do nothing if the specified column is not pinned on the left side. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colRef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a></span> | <span class="param-type">Array.<<a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a>></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">dest</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid#~ColumnReference">Grid~ColumnReference</a></span> </div> <div class="attributes"> <optional> </div> <div class="description"> The unpinned column will be placed before the destination position after the operation </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="updateColumnTitle"><span class="type-signature"></span>updateColumnTitle<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="updateDataSet"><span class="type-signature"></span>updateDataSet<span class="signature">(records, rowIdentifier<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Insert, update, remove and reorder data based on the given array of records </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">records</div> <div class="type"> <span class="param-type">Array.<Object></span> </div> <div class="attributes"> </div> <div class="description"> Array of records for insert, remove, update, reorder in one operation </div> </div> <div class="param"> <div class="name">rowIdentifier</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Check difference data with the row identifier map property for operate record. </div> </div> </div> <div class="details"> </div> <h5>Example:</h5> <pre><code>// Grid data set will be updated to 3 records. All rows in the grid will be cleared and new rows will be inserted
grid.updateDataSet([
{ id: "A", field2: 1, field3: 2, field4: "Something A" },
{ id: "B", field2: 1, field3: 2, field4: "Something B" },
{ id: "C", field2: 1, field3: 2, field4: "Something C" },
], "id");
// Update record id "B" in "field2", "field3" value 100, 200
grid.updateDataSet([
{ id: "A", field2: 1, field3: 2, field4: "Something A" },
{ id: "B", field2: 100, field3: 200, field4: "Something B" },
{ id: "C", field2: 1, field3: 2, field4: "Something C" },
], "id");
// Delete record id "B"
grid.updateDataSet([
{ id: "A", field2: 1, field3: 2, field4: "Something A" },
{ id: "C", field2: 1, field3: 2, field4: "Something C" },
], "id");
// Insert record id "D"
grid.updateDataSet([
{ id: "A", field2: 1, field3: 2, field4: "Something A" },
{ id: "C", field2: 1, field3: 2, field4: "Something C" },
{ id: "D", field2: 1, field3: 2, field4: "Something D" },
], "id");
// Reorder to "D", "C", "A"
grid.updateDataSet([
{ id: "D", field2: 1, field3: 2, field4: "Something D" },
{ id: "C", field2: 1, field3: 2, field4: "Something C" },
{ id: "A", field2: 1, field3: 2, field4: "Something A" },
], "id");
// Insert, Update, Delete And Reorder
grid.updateDataSet([
{ id: "F", field2: 1, field3: 2, field4: "Something F" },
{ id: "D", field2: 1, field3: 2, field4: "Something D" },
{ id: "C", field2: 1, field3: 2, field4: "Something C" },
{ id: "E", field2: 1, field3: 2, field4: "Something E" },
], "id");</code></pre> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="updateLayout"><span class="type-signature"></span>updateLayout<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="updateLayout"><span class="type-signature"></span>updateLayout<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Force recalculation of grid's layout </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="updateRowData"><span class="type-signature"></span>updateRowData<span class="signature">(opt_rowIndex<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_rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> </div> </div> <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:adcDataReceived">adcDataReceived</h4> <div class="description"> Fired after ADC data or response received from the server </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>data</code></td> <td class="type"> <span class="param-type">Array.<Array></span> </td> <td class="description last">Data part of the server response</td> </tr> </tbody></table></div><div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:afterContentBinding">afterContentBinding</h4> <div class="description"> Trigger after content binding. </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>e</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">Event of afterContentBinding</td> </tr> </tbody></table></div><div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:beforeContentBinding">beforeContentBinding</h4> <div class="description"> Trigger before content binding. </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>e</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">Event of beforeContentBinding, we can use e.actualUpdate to check the actual data update, otherwise It will be empty when it is rendered by row virtualization or only the UI changes.</td> </tr> </tbody></table></div><div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:beforeRowRemoved">beforeRowRemoved</h4> <div class="description"> Fired only when a row will be removed through Grid's API and before occurring of the actual removal </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:beforeUnlinked">beforeUnlinked</h4> <div class="description"> Trigger before unlinking a chain row. </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 class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>chain</code></td> <td class="type"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition">RowDefinition</a></span> </td> <td class="description last">An row definition object of a chain row.</td> </tr> <tr> <td class="name"><code>collapsed</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last">Collapsing state of a chain row.</td> </tr> <tr> <td class="name"><code>ridMap</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">A map of constituent rics and row ids used to customize row ids.</td> </tr> </tbody></table></div><div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:dataComposed">dataComposed</h4> <div class="description"> Trigger before dataChanged. Perform any data update during the event will NOT cause more dataChanged events </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>grid</code></td> <td class="type"> <span class="param-type"><a href="#/apis/rt-grid/grid">Grid</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>rowDef</code></td> <td class="type"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition">RowDefinition</a></span> </td> <td class="description last"></td> </tr> </tbody></table></div><div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:fieldAdded">fieldAdded</h4> <div class="description"> Fired after the field has been added to the data table. </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>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">"fieldAdded"</td> </tr> <tr> <td class="name"><code>addedFields</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="description last">An array of newly added fields</td> </tr> <tr> <td class="name"><code>fields</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="description last">All fields</td> </tr> <tr> <td class="name"><code>rics</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="description last">All rics</td> </tr> <tr> <td class="name"><code>rowDefs</code></td> <td class="type"> <span class="param-type">Array.<<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>></span> </td> <td class="description last">All row definitions</td> </tr> </tbody></table></div><div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:fieldRemoved">fieldRemoved</h4> <div class="description"> Fired after the field has been removed from the data table. </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>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">"fieldRemoved"</td> </tr> <tr> <td class="name"><code>removedFields</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="description last">An array of recently removed fields</td> </tr> <tr> <td class="name"><code>fields</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="description last">All fields</td> </tr> <tr> <td class="name"><code>rics</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="description last">All rics</td> </tr> <tr> <td class="name"><code>rowDefs</code></td> <td class="type"> <span class="param-type">Array.<<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>></span> </td> <td class="description last">All row definitions</td> </tr> </tbody></table></div><div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:firstRendered">firstRendered</h4> <div class="description"> This event is triggered when the content is rendered for the first time. </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>e</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">Event of firstRendered</td> </tr> </tbody></table></div><div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:pageCountChanged">pageCountChanged</h4> <div class="description"> Fired after page count in the data view is changed during the active pagination mode </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:pageIndexChanged">pageIndexChanged</h4> <div class="description"> Fired after page index in the data view is changed during the active pagination mode </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:ricAdded">ricAdded</h4> <div class="description"> Fired after the ric has been added to the data table. </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>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">"ricAdded"</td> </tr> <tr> <td class="name"><code>addedRics</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="description last">An array of newly added rics</td> </tr> <tr> <td class="name"><code>fields</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="description last">All fields</td> </tr> <tr> <td class="name"><code>rics</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="description last">All rics</td> </tr> <tr> <td class="name"><code>rowDefs</code></td> <td class="type"> <span class="param-type">Array.<<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>></span> </td> <td class="description last">All row definitions</td> </tr> </tbody></table></div><div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:ricRemoved">ricRemoved</h4> <div class="description"> Fired after the ric has been removed from the data table. </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>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">"ricRemoved"</td> </tr> <tr> <td class="name"><code>removedRics</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="description last">An array of recently removed rics</td> </tr> <tr> <td class="name"><code>fields</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="description last">All fields</td> </tr> <tr> <td class="name"><code>rics</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="description last">All rics</td> </tr> <tr> <td class="name"><code>rowDefs</code></td> <td class="type"> <span class="param-type">Array.<<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>></span> </td> <td class="description last">All row definitions</td> </tr> </tbody></table></div><div class="details"> </div> </div> </article></section></div></div>