-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtemplate-12.html
242 lines (241 loc) · 281 KB
/
template-12.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
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
232
233
234
235
236
237
238
239
240
241
242
<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">(opt_initializer<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">(opt_initializer<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_initializer</div> <div class="type"> <span class="param-type">Element</span> </div> <div class="attributes"> <optional> </div> <div class="description"> this can be either element id (string) or DOM element. </div> </div> </div> <div class="details"> </div> </div> </div> <h3 class="subsection-title" id="extends">Extends</h3> <dd class="argument-list"> <ul> <li><a href="#/apis/core/elementwrapper">ElementWrapper</a></li> </ul> </dd> <h3 class="subsection-title" id="type_definitions">Type Definitions</h3>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~CellReference">CellReference</h4><div class="description"> A section in grid can be refered by the following object <br>`{Grid.MouseInfo}` : Object with valid x, y coordinates and section index <br>`<a href="#/apis/core/elementwrapper">ElementWrapper</a>` : a pointer to ElementWrapper instance <br>`Element` : cell element</div> <h5>Type:</h5> <span class="param-type">Grid.MouseInfo</span> | <span class="param-type"><a href="#/apis/core/elementwrapper">ElementWrapper</a></span> | <span class="param-type">Element</span><div class="details"> </div></div>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~ColumnOptions">ColumnOptions</h4><div class="description"> Column options that can be provided to <a href="#/apis/core/grid#insertColumn">Grid#insertColumn</a></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 class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>width</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Column width</td> </tr> <tr> <td class="name"><code>minWidth</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Minimum column width</td> </tr> <tr> <td class="name"><code>minSize</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Alias to `minWidth`</td> </tr> <tr> <td class="name"><code>size</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Alias to `width`</td> </tr> <tr> <td class="name"><code>visible</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Column visibility</td> </tr> <tr> <td class="name"><code>scalable</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Column scalability</td> </tr> <tr> <td class="name"><code>styles</code></td> <td class="type"> <span class="param-type">Object.<string, string></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Key/value pair object specifying CSS styles</td> </tr> <tr> <td class="name"><code>classes</code></td> <td class="type"> <span class="param-type">Object.<string, string></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Key/value pair object specifying CSS classes</td> </tr> <tr> <td class="name"><code>dataColumnName</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Data column for sorting</td> </tr> <tr> <td class="name"><code>renderingHandler</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Deprecated</td> </tr> <tr> <td class="name"><code>dataBindingHandler</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Column binding function</td> </tr> <tr> <td class="name"><code>columnData</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">For attaching context (user data)</td> </tr> <tr> <td class="name"><code>layout</code></td> <td class="type"> <span class="param-type"><a href="#">TrackLayout</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Deprecated</td> </tr> </tbody></table></div><div class="details"> </div></div>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~MouseInfo">MouseInfo</h4><div class="description"> Object returned from Grid#getRelativePosition method</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>hit</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last">Indicates whether the given position is on the grid</td> </tr> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">Horizontal coordinate that is relative to the top-left of the grid (Zero means left-most)</td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">Vertical coordinate that is relative to the top-left of the grid (Zero means top-most)</td> </tr> <tr> <td class="name"><code>colIndex</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>sectionIndex</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>rowIndex</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>sectionType</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>sectionSettings</code></td> <td class="type"> <span class="param-type"><a href="#/apis/core/sectionsettings">SectionSettings</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>section</code></td> <td class="type"> <span class="param-type"><a href="ILayout#/apis/core/grid">ILayoutGrid</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>cellElement</code></td> <td class="type"> <span class="param-type">Element</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>dataSource</code></td> <td class="type"> <span class="param-type"><a href="#/apis/core/dataview">DataView</a></span> </td> <td class="description last"></td> </tr> </tbody></table></div><div class="details"> </div></div>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~SectionReference">SectionReference</h4><div class="description"> A section in grid can be refered by the following object <br>`<a href="ILayout#/apis/core/grid">ILayoutGrid</a>` : A pointer to Section instance <br>`<a href="#/apis/core/sectionsettings">SectionSettings</a>` : A pointer to SectionSettings instance <br>`number` : Section index <br>`string` : Section type (e.g. "content", "title", "header", "footer"), or Section id (element id)</div> <h5>Type:</h5> <span class="param-type">number</span> | <span class="param-type">string</span> | <span class="param-type"><a href="ILayout#/apis/core/grid">ILayoutGrid</a></span> | <span class="param-type"><a href="#/apis/core/sectionsettings">SectionSettings</a></span><div class="details"> </div></div> <h3 class="subsection-title" id="methods">Methods</h3>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="addClass"><span class="type-signature"></span>addClass<span class="signature">(str)</span><span class="type-signature"></span></h4> <div class="description"> If the given CSS class is already in className, the class is not added twice </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">str</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#addClass">ElementWrapper#addClass</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="addContent"><span class="type-signature"></span>addContent<span class="signature">(content)</span><span class="type-signature"> → {Element}</span></h4> <div class="description"> Append the specified content to the existing children list. Note that string is not acceptableUse setParent() if you just want to put an element into the document. This method is specifically designed for user content, but not for element reordering </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">content</div> <div class="type"> <span class="param-type">Element</span> | <span class="param-type">Node</span> | <span class="param-type"><a href="#/apis/core/elementwrapper">ElementWrapper</a></span> </div> <div class="description"> will be appended as a child of this element </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#addContent">ElementWrapper#addContent</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Element</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="addRow"><span class="type-signature"></span>addRow<span class="signature">(opt_num<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Add specified number of rows to the last section. This method is intended for fast layout generation. <br>If column count is zero, one column will be added automatically. <br>If there is no section, a new section is created automatically. <br>No row is added to the data source. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_num</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Default is one row </div> </div> </div> <div class="details"> </div> <h5>Fires:</h5> <div class="sub-content">Grid#event:preSectionRender</div> <div class="sub-content">Grid#event:columnRender</div> <div class="sub-content">Grid#event:preSectionDataBinding</div> <div class="sub-content">Grid#event:columnDataBinding</div> <div class="sub-content"><a href="#/apis/core/grid#event:postSectionDataBinding">Grid#event:postSectionDataBinding</a></div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="addSection"><span class="type-signature"></span>addSection<span class="signature">(opt_type<span class="signature-attributes">opt</span>, opt_sectionName<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="ILayout#/apis/core/grid">ILayoutGrid</a>|null}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_type</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> </div> <div class="param"> <div class="name">opt_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"><a href="ILayout#/apis/core/grid">ILayoutGrid</a></span> | <span class="param-type">null</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="addSectionAt"><span class="type-signature"></span>addSectionAt<span class="signature">(at, opt_type<span class="signature-attributes">opt</span>, opt_sectionName<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="ILayout#/apis/core/grid">ILayoutGrid</a>|null}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">at</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">opt_type</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> </div> <div class="param"> <div class="name">opt_sectionName</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/grid#event:sectionAdded">Grid#event:sectionAdded</a></div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="ILayout#/apis/core/grid">ILayoutGrid</a></span> | <span class="param-type">null</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="autoHideScrollbars"><span class="type-signature"></span>autoHideScrollbars<span class="signature">(opt_hide<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_hide</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> True if autohide (default) or false to keep scrollbars permanently </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="deactivateRendering"><span class="type-signature"></span>deactivateRendering<span class="signature">(disabled<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> prevent bind data process </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">disabled</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="disable"><span class="type-signature"></span>disable<span class="signature">(opt_disabled<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Disable control element </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_disabled</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If false the element will be shown </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#disable">ElementWrapper#disable</a> </dd> </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="description"> <a href="#/apis/core/elementwrapper#dispose">ElementWrapper#dispose</a> </div> <div class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"> <a href="#/apis/core/elementwrapper#dispose">ElementWrapper#dispose</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="enable"><span class="type-signature"></span>enable<span class="signature">(opt_enabled<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Enable control element </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_enabled</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If false the element will be hidden </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#enable">ElementWrapper#enable</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="enableClass"><span class="type-signature"></span>enableClass<span class="signature">(str, opt_enabled<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Adds or removes CSS class by specifying "enabled" parameter </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="attributes"> </div> </div> <div class="param"> <div class="name">opt_enabled</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Default is true </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#enableClass">ElementWrapper#enableClass</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="enableColumnClass"><span class="type-signature"></span>enableColumnClass<span class="signature">(colIndex, clsName, enabled<span class="signature-attributes">opt</span>, opt_type<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">clsName</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">enabled</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> </div> <div class="param"> <div class="name">opt_type</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Apply the class only to the specified row type. Default is applying to all rows </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="enableColumnVirtualization"><span class="type-signature"></span>enableColumnVirtualization<span class="signature">(opt_enabled<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> No runtime support </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_enabled</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="enableRowHighlighting"><span class="type-signature"></span>enableRowHighlighting<span class="signature">(opt_enabled<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Rows will be highlighted when mouse is hoved over rows. This will works only with content section </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_enabled</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="enableRowVirtualization"><span class="type-signature"></span>enableRowVirtualization<span class="signature">(opt_enabled)</span><span class="type-signature"></span></h4> <div class="description"> No runtime support </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_enabled</div> <div class="type"> <span class="param-type">boolean</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="fillParentHeight"><span class="type-signature"></span>fillParentHeight<span class="signature">(opt_percent<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Sets height in percentage corresponding to the parent </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_percent</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If not defined, 100% height is used </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#fillParentHeight">ElementWrapper#fillParentHeight</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> true if there is any change, otherwise false</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="fillParentWidth"><span class="type-signature"></span>fillParentWidth<span class="signature">(opt_percent<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> <a href="#/apis/core/elementwrapper#fillParentWidth">ElementWrapper#fillParentWidth</a> </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_percent</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If not defined, 100% width is used </div> </div> </div> <div class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"> <a href="#/apis/core/elementwrapper#fillParentWidth">ElementWrapper#fillParentWidth</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> true if there is any change, otherwise false</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 bringing grid into window's view. This is useful when grid is very wide or tall, since window can be scrolled to focused element by default in some browsers. </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://developer.mozilla.org/en/docs/Web/API/HTMLElement/focus">https://developer.mozilla.org/en/docs/Web/API/HTMLElement/focus</a></li> <li><a href="http://help.dottoro.com/ljqmdirr.php">http://help.dottoro.com/ljqmdirr.php</a></li> </ul> </dd> </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">(frozenColIndex<span class="signature-attributes">opt</span>, numRightColumn<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Left columns will be frozen and horizontal scrollbar will automatically appear for the rest columns. This will happens only when the container of grid does NOT have enough space for the grid's content. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">frozenColIndex</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">null</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Last column index to be fixed/pinned on the left side. <br>Use negative value (-1) make horizontal scrollbar bar cover the first column. <br>Use null value to disable the scrollbar </div> </div> <div class="param"> <div class="name">numRightColumn</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Number of columns on the right side to be fixed/pinned on the right side </div> </div> </div> <div class="details"> </div> <h5>Example:</h5> <pre><code>grid.freezeColumn(0); // The first column is pinned to the left side
grid.freezeColumn(1); // The first two columns are pinned to the left side
grid.freezeColumn(-1); // Grid's horizontal scrollbar will cover entire are of the grid.
grid.freezeColumn(null); // Turn off grid's horizontal scrollbar
grid.freezeColumn(-1, 1); // The last column is pinned to the right side
grid.freezeColumn(-1, 2); // The last two columns are pinned to the right side
grid.freezeColumn(0, 2); // Grid's horizontal scrollbar will affect only the middle part</code></pre> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="freezeFooter"><span class="type-signature"></span>freezeFooter<span class="signature">(frozenCount)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">frozenCount</div> <div class="type"> <span class="param-type">number</span> </div> <div class="description"> the amount of sections that will be fixed in place (from bottom up). </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="freezeLayout"><span class="type-signature"></span>freezeLayout<span class="signature">(opt_bool<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Stop grid from updating layout to improve performance during multiple layout changes. Unfreeze the layout once all changes have been made. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_bool</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/core/grid#isLayoutFrozen">Grid#isLayoutFrozen</a></li> </ul> </dd> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/grid#event:widthChanged">Grid#event:widthChanged</a></div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> Previous freezing state (Used for restoring original state)</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="freezeSection"><span class="type-signature"></span>freezeSection<span class="signature">(opt_frozenSection<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Vertical scrollbar will automatically appear for the rest of the sections, when container of Grid does NOT have enough space for Grid's content. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_frozenSection</div> <div class="type"> <span class="param-type">string</span> | <span class="param-type">number</span> | <span class="param-type">null</span> </div> <div class="attributes"> <optional> </div> <div class="description"> the last section that will be fixed in place. <br>Negative value means applying the scrollbar to all sections. <br>null value means disabling the feature. </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getAllSections"><span class="type-signature"></span>getAllSections<span class="signature">(opt_type<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<<a href="ILayout#/apis/core/grid">ILayoutGrid</a>>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_type</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">Array.<<a href="ILayout#/apis/core/grid">ILayoutGrid</a>></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getAllSectionSettings"><span class="type-signature"></span>getAllSectionSettings<span class="signature">(opt_type<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<<a href="#/apis/core/sectionsettings">SectionSettings</a>>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_type</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">Array.<<a href="#/apis/core/sectionsettings">SectionSettings</a>></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getAttribute"><span class="type-signature"></span>getAttribute<span class="signature">(str)</span><span class="type-signature"> → {string}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">str</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#getAttribute">ElementWrapper#getAttribute</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getBoundingClientRect"><span class="type-signature"></span>getBoundingClientRect<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4> <div class="description"> The returned value is a TextRectangle object, which contains read-only left,top, right and bottom properties describing the border-box, in pixels, with the top-leftrelative to the top-left of the viewport. </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#getBoundingClientRect">ElementWrapper#getBoundingClientRect</a> </dd> </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="getCell"><span class="type-signature"></span>getCell<span class="signature">(sectionRef, colIndex, rowIndex, opt_includeSpan<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="#/apis/core/elementwrapper">ElementWrapper</a>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">sectionRef</div> <div class="type"> <span class="param-type">Grid.SectionReference</span> </div> <div class="attributes"> </div> </div> <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">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">opt_includeSpan</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Default is true </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/core/elementwrapper">ElementWrapper</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getCellInfo"><span class="type-signature"></span>getCellInfo<span class="signature">(cellRef)</span><span class="type-signature"> → {Grid.MouseInfo}</span></h4> <div class="description"> Get information about the cell, inclusing column index, row index, and section that the cell resides </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">cellRef</div> <div class="type"> <span class="param-type">Grid.CellReference</span> </div> <div class="description"> Reference to cell element. This can be something inside the cell as well. </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/core/grid#getRelativePosition">Grid#getRelativePosition</a></li> </ul> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Grid.MouseInfo</span> </div><div class="sub-content-desc"> Information about the given cell</div> <h5>Example:</h5> <pre><code>grid.getCellInfo({"colIndex": 0, "rowIndex": 0}); // Get cell information about the top left cell in the content section
grid.getCellInfo(document.createElement("some_element"); // Get cell information for cell that contains the element with id "some_element"
grid.getCellInfo(mouseEventArg); // Get cell information from the given MouseEvent argument (this is the same as getRelativePosition() method)
var cellInfo = grid.getCellInfo({"colIndex": 1, "rowIndex": 1});
cellInfo.colIndex = cellInfo.colIndex + 1; // Get next cell to the right
grid.getCellInfo(cellInfo);</code></pre> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getClass"><span class="type-signature"></span>getClass<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#getClass">ElementWrapper#getClass</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnAlignment"><span class="type-signature"></span>getColumnAlignment<span class="signature">(colIndex)</span><span class="type-signature"> → {string}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div><div class="sub-content-desc"> Possible returned values are "default"|"left"|"center"|"right"</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="getColumnCustomLaneSize"><span class="type-signature"></span>getColumnCustomLaneSize<span class="signature">(colIndex)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnData"><span class="type-signature"></span>getColumnData<span class="signature">(colIndex)</span><span class="type-signature"> → {Object}</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">Object</span> </div><div class="sub-content-desc"> userData</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnDataBindingEvent"><span class="type-signature"></span>getColumnDataBindingEvent<span class="signature">(c)</span><span class="type-signature"> → {Object}</span></h4> <div class="description"> Deprecated. Use setColumnDataBindingHandler instead </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">c</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/core/grid#setColumnDataBindingHandler">Grid#setColumnDataBindingHandler</a></li> </ul> </dd> </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="getColumnDataBindingHandler"><span class="type-signature"></span>getColumnDataBindingHandler<span class="signature">(c)</span><span class="type-signature"> → {function}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">c</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">function</span> </div><div class="sub-content-desc"> func</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">(str)</span><span class="type-signature"> → {number}</span></h4> <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"> data column name </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div><div class="sub-content-desc"> Return negative if the mouse is not hit</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnLeft"><span class="type-signature"></span>getColumnLeft<span class="signature">(colIndex)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnRenderEvent"><span class="type-signature"></span>getColumnRenderEvent<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Deprecated. Use setColumnRenderingHandler instead </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnRenderingHandler"><span class="type-signature"></span>getColumnRenderingHandler<span class="signature">(c)</span><span class="type-signature"> → {function}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">c</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">function</span> </div><div class="sub-content-desc"> func</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnRight"><span class="type-signature"></span>getColumnRight<span class="signature">(colIndex)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnScalability"><span class="type-signature"></span>getColumnScalability<span class="signature">(colIndex)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnVirtualizer"><span class="type-signature"></span>getColumnVirtualizer<span class="signature">()</span><span class="type-signature"> → {<a href="#">Virtualizer</a>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#">Virtualizer</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnWidth"><span class="type-signature"></span>getColumnWidth<span class="signature">(colIndex)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div> </div>
<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="getContent"><span class="type-signature"></span>getContent<span class="signature">(opt_allContent<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Element|Node|NodeList}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_allContent</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If true all children will be returned </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#getContent">ElementWrapper#getContent</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Element</span> | <span class="param-type">Node</span> | <span class="param-type">NodeList</span> </div><div class="sub-content-desc"> Returns the last child, if there are multiple children. Returns null if there is no child</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getContentWidth"><span class="type-signature"></span>getContentWidth<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="getData"><span class="type-signature"></span>getData<span class="signature">(sectionRef, colRef, rowRef)</span><span class="type-signature"> → {*}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">sectionRef</div> <div class="type"> <span class="param-type">Grid.SectionReference</span> </div> </div> <div class="param"> <div class="name">colRef</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">string</span> </div> <div class="description"> Either column index or data column name </div> </div> <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 of the display section or row id of the data table </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 undefined if not success</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getDataColumnMap"><span class="type-signature"></span>getDataColumnMap<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> <div class="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="getDataColumnName"><span class="type-signature"></span>getDataColumnName<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="getDataConflationRate"><span class="type-signature"></span>getDataConflationRate<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="getDataSource"><span class="type-signature"></span>getDataSource<span class="signature">()</span><span class="type-signature"> → {<a href="#/apis/core/dataview">DataView</a>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/core/dataview">DataView</a></span> </div><div class="sub-content-desc"> dataSource</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getDefaultRowHeight"><span class="type-signature"></span>getDefaultRowHeight<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="getElement"><span class="type-signature"></span>getElement<span class="signature">()</span><span class="type-signature"> → {Element}</span></h4> <div class="description"> Gets top element of this control </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#getElement">ElementWrapper#getElement</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Element</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getFirstPinnedRightIndex"><span class="type-signature"></span>getFirstPinnedRightIndex<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 class="sub-content-desc"> If there is no pinned right column, column count is returned</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getFitContentWidth"><span class="type-signature"></span>getFitContentWidth<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="getFooterCount"><span class="type-signature"></span>getFooterCount<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 class="sub-content-desc"> Total footer count</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getFrozenColumnCount"><span class="type-signature"></span>getFrozenColumnCount<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Returns number of pinned left columns. </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="getHeight"><span class="type-signature"></span>getHeight<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Gets offsetHeight </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#getHeight">ElementWrapper#getHeight</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div><div class="sub-content-desc"> in pixel</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getHiddenInput"><span class="type-signature"></span>getHiddenInput<span class="signature">()</span><span class="type-signature"> → {Element}</span></h4> <div class="description"> Get hidden input in grid <br>this input for make grid can copy <br>normal user should not touch it <br>but sometime grid extension will have to use this element </div> <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="getHScrollbar"><span class="type-signature"></span>getHScrollbar<span class="signature">()</span><span class="type-signature"> → {<a href="#/apis/core/elementwrapper">ElementWrapper</a>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/core/elementwrapper">ElementWrapper</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getId"><span class="type-signature"></span>getId<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#getId">ElementWrapper#getId</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getLastSection"><span class="type-signature"></span>getLastSection<span class="signature">()</span><span class="type-signature"> → {<a href="ILayout#/apis/core/grid">ILayoutGrid</a>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="ILayout#/apis/core/grid">ILayoutGrid</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getLeft"><span class="type-signature"></span>getLeft<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Gets the left position that is relative to its parent's client area </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#getLeft">ElementWrapper#getLeft</a> </dd> </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="getMinimumColumnWidth"><span class="type-signature"></span>getMinimumColumnWidth<span class="signature">(colIndex)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getNextCell"><span class="type-signature"></span>getNextCell<span class="signature">(cellRef)</span><span class="type-signature"> → {Grid.MouseInfo}</span></h4> <div class="description"> Get cell information of the next cell. If bottom right has been reached, `cell` parameter is set to null </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">cellRef</div> <div class="type"> <span class="param-type">Grid.CellReference</span> </div> <div class="description"> Reference to cell element. This can be something inside the cell as well. </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Grid.MouseInfo</span> </div><div class="sub-content-desc"> Information about the next cell from left to right and top to bottom. Returns null if the given parameter is invalid</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getNextCellInRow"><span class="type-signature"></span>getNextCellInRow<span class="signature">(cellRef, step<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Grid.MouseInfo}</span></h4> <div class="description"> Get cell information of the next cell in the same row. If there is no next cell in the row, `cell` parameter is set to null </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">cellRef</div> <div class="type"> <span class="param-type">Grid.CellReference</span> </div> <div class="attributes"> </div> <div class="default"> </div> <div class="description"> Reference to cell element. This can be something inside the cell as well. </div> </div> <div class="param"> <div class="name">step</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="default"> [default: 1] </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Grid.MouseInfo</span> </div><div class="sub-content-desc"> Information about the next cell in the row. Returns null if the given parameter is invalid</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getNextSection"><span class="type-signature"></span>getNextSection<span class="signature">(identifier<span class="signature-attributes">opt</span>, opt_type<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="ILayout#/apis/core/grid">ILayoutGrid</a>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">identifier</div> <div class="type"> <span class="param-type">MouseEvent</span> | <span class="param-type">Grid.SectionReference</span> </div> <div class="attributes"> <optional> </div> <div class="description"> This can be MouseEvent, index, or section id or pointer reference <br>If not specified, the first item is returned </div> </div> <div class="param"> <div class="name">opt_type</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> The next section with the specified type. Default is any type </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="ILayout#/apis/core/grid">ILayoutGrid</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getNextSibling"><span class="type-signature"></span>getNextSibling<span class="signature">()</span><span class="type-signature"> → {Element|Node}</span></h4> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#getNextSibling">ElementWrapper#getNextSibling</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Element</span> | <span class="param-type">Node</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getParent"><span class="type-signature"></span>getParent<span class="signature">()</span><span class="type-signature"> → {Element|Node}</span></h4> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#getParent">ElementWrapper#getParent</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Element</span> | <span class="param-type">Node</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getPinnedLeftColumnCount"><span class="type-signature"></span>getPinnedLeftColumnCount<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Returns number of pinned left columns. This is an alias to getFrozenColumnCount </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="getPinnedRightColumnCount"><span class="type-signature"></span>getPinnedRightColumnCount<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Returns number of pinned right columns. </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="getPlugin"><span class="type-signature"></span>getPlugin<span class="signature">(pluginName)</span><span class="type-signature"> → {*|null}</span></h4> <div class="description"> Return null if the specified plugin has not been loaded </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">pluginName</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">*</span> | <span class="param-type">null</span> </div><div class="sub-content-desc"> plugin Return null if the specified plugin has not been loaded</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getPluginList"><span class="type-signature"></span>getPluginList<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> <div class="description"> Get a list of existing plugin names </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="getPlugins"><span class="type-signature"></span>getPlugins<span class="signature">()</span><span class="type-signature"> → {Array}</span></h4> <div class="description"> Get a list of all plugin instances </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getPrevCell"><span class="type-signature"></span>getPrevCell<span class="signature">(cellRef)</span><span class="type-signature"> → {Grid.MouseInfo}</span></h4> <div class="description"> Get cell information of the previous cell. If top left cell has been reached, `cell` parameter is set to null </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">cellRef</div> <div class="type"> <span class="param-type">Grid.CellReference</span> </div> <div class="description"> Reference to cell element. This can be something inside the cell as well. </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Grid.MouseInfo</span> </div><div class="sub-content-desc"> Information about the previous cell in the row. Returns null if the given parameter is invalid</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getPrevCellInRow"><span class="type-signature"></span>getPrevCellInRow<span class="signature">(cellRef, step<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Grid.MouseInfo}</span></h4> <div class="description"> Get cell information of the previous cell in the same row. If there is no previous cell in the row, `cell` parameter is set to null </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">cellRef</div> <div class="type"> <span class="param-type">Grid.CellReference</span> </div> <div class="attributes"> </div> <div class="default"> </div> <div class="description"> Reference to cell element. This can be something inside the cell as well. </div> </div> <div class="param"> <div class="name">step</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="default"> [default: 1] </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Grid.MouseInfo</span> </div><div class="sub-content-desc"> Information about the previous cell in the row. Returns null if the given parameter is invalid</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getPreviousSection"><span class="type-signature"></span>getPreviousSection<span class="signature">(identifier<span class="signature-attributes">opt</span>, opt_type<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="ILayout#/apis/core/grid">ILayoutGrid</a>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">identifier</div> <div class="type"> <span class="param-type">MouseEvent</span> | <span class="param-type">Grid.SectionReference</span> </div> <div class="attributes"> <optional> </div> <div class="description"> This can be MouseEvent, index, or section id or pointer reference <br>If not specified, the last item is returned </div> </div> <div class="param"> <div class="name">opt_type</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> The previous section with the specified type. Default is any type </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="ILayout#/apis/core/grid">ILayoutGrid</a></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, context<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Grid.MouseInfo}</span></h4> <div class="description"> Return all information, from Grid and its internal components, related 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"><a href="#/apis/core/elementwrapper">ElementWrapper</a></span> | <span class="param-type">Element</span> | <span class="param-type">Event</span> | <span class="param-type">MouseEvent</span> </div> <div class="attributes"> </div> <div class="description"> Element, Browser's Event object, Browser's Mouse Event object are all valid </div> </div> <div class="param"> <div class="name">context</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> <div class="description"> An object that stores returned values </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Grid.MouseInfo</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="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="getRowIndex"><span class="type-signature"></span>getRowIndex<span class="signature">(sectionIndex, rowIndex)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">sectionIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="description"> relative to the given section </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div><div class="sub-content-desc"> rowIndex relative to the first section (index as a whole)</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getRowVirtualizer"><span class="type-signature"></span>getRowVirtualizer<span class="signature">()</span><span class="type-signature"> → {<a href="#">Virtualizer</a>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#">Virtualizer</a></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="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"> Note that if element display style is set to "none" or not in the document, scroll value will automatically reset to zero and will not be restored when it is back to visible state </div> <div class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"> <a href="#/apis/core/elementwrapper#getScrollLeft">ElementWrapper#getScrollLeft</a> </dd> </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="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"> <a href="#/apis/core/elementwrapper#getScrollTop">ElementWrapper#getScrollTop</a> </dd> </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="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="getSection"><span class="type-signature"></span>getSection<span class="signature">(sectionRef)</span><span class="type-signature"> → {<a href="ILayout#/apis/core/grid">ILayoutGrid</a>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">sectionRef</div> <div class="type"> <span class="param-type">Grid.SectionReference</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="ILayout#/apis/core/grid">ILayoutGrid</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getSectionCount"><span class="type-signature"></span>getSectionCount<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="getSectionIndex"><span class="type-signature"></span>getSectionIndex<span class="signature">(identifier<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">identifier</div> <div class="type"> <span class="param-type">MouseEvent</span> | <span class="param-type">Grid.SectionReference</span> </div> <div class="attributes"> <optional> </div> <div class="description"> This can be MouseEvent, index, or section id or pointer reference </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div><div class="sub-content-desc"> Return negative value, if the section does not exist</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getSectionSettings"><span class="type-signature"></span>getSectionSettings<span class="signature">(sectionRef)</span><span class="type-signature"> → {<a href="#/apis/core/sectionsettings">SectionSettings</a>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">sectionRef</div> <div class="type"> <span class="param-type">Grid.SectionReference</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/core/sectionsettings">SectionSettings</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getSectionTop"><span class="type-signature"></span>getSectionTop<span class="signature">(sectionRef)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">sectionRef</div> <div class="type"> <span class="param-type">Grid.SectionReference</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div><div class="sub-content-desc"> Return zero, if identifier does not exist</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getStyle"><span class="type-signature"></span>getStyle<span class="signature">(str)</span><span class="type-signature"> → {string}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">str</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#getStyle">ElementWrapper#getStyle</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getTextContent"><span class="type-signature"></span>getTextContent<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="description"> Gets textContent (IE9+) value from this element </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#getTextContent">ElementWrapper#getTextContent</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getTooltip"><span class="type-signature"></span>getTooltip<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="description"> Gets tooltip text from "title" attribute </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#getTooltip">ElementWrapper#getTooltip</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getTop"><span class="type-signature"></span>getTop<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Gets the top position that is relative to its parent's client area </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#getTop">ElementWrapper#getTop</a> </dd> </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="getVMouseWheelHandler"><span class="type-signature"></span>getVMouseWheelHandler<span class="signature">()</span><span class="type-signature"> → {function}</span></h4> <div class="description"> Allows other elements such as background to accept wheel event and scroll grid's vertical scrollbar </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">function</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getVScrollbar"><span class="type-signature"></span>getVScrollbar<span class="signature">()</span><span class="type-signature"> → {<a href="#/apis/core/elementwrapper">ElementWrapper</a>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/core/elementwrapper">ElementWrapper</a></span> </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="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Object</span> </div><div class="sub-content-desc"> Returns null if vscrollbar does not exists</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getWidth"><span class="type-signature"></span>getWidth<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Gets offsetWidth </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#getWidth">ElementWrapper#getWidth</a> </dd> </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="getYScrollVal"><span class="type-signature"></span>getYScrollVal<span class="signature">(sectionRef, rowIndex, topOfView<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {number|null}</span></h4> <div class="description"> Return the scroll value (in pixels) to make specified row visible in the view </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">sectionRef</div> <div class="type"> <span class="param-type">Grid.SectionReference</span> </div> <div class="attributes"> </div> <div class="default"> </div> <div class="description"> Specify section that the given rowIndex is related to. Use null for the first scrollable section (first non-frozen section) </div> </div> <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, Make to specified row at the top of the view. </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> | <span class="param-type">null</span> </div><div class="sub-content-desc"> The scroll value (in pixels)</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="hasClass"><span class="type-signature"></span>hasClass<span class="signature">(str)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Checks if the given CSS class is in className of the element </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">str</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#hasClass">ElementWrapper#hasClass</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="hasColumnClass"><span class="type-signature"></span>hasColumnClass<span class="signature">(colIndex, clsName, opt_type<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">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">clsName</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">opt_type</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Row type </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="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="hide"><span class="type-signature"></span>hide<span class="signature">(opt_hidden<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Sets display style as inline style to the element with value of "none" </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_hidden</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If false the element will be shown </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#hide">ElementWrapper#hide</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="hideBorders"><span class="type-signature"></span>hideBorders<span class="signature">(opt_hidden<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Deprecated </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_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/core/grid#toggleBorders">Grid#toggleBorders</a></li> </ul> </dd> </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">(colIndex, hidden<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Note that the hidden columns continue to exist and occupy the index. So there is no index shifted after this function call. </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">hidden</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If the value is true or undefined, hide the specified column. Otherwise, show the column </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/core/grid#isColumnVisible">Grid#isColumnVisible</a></li> <li><a href="#/apis/core/grid#hideColumns">Grid#hideColumns</a></li> <li><a href="#/apis/core/grid#showAllColumns">Grid#showAllColumns</a></li> </ul> </dd> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/grid#event:widthChanged">Grid#event:widthChanged</a></div> <div class="sub-content"><a href="#/apis/core/grid#event:columnVisibilityChanged">Grid#event:columnVisibilityChanged</a></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">(colIndices, hidden<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Hide multiple columns at once, improving the performance. Note that the hidden columns continue to exist and occupy the index. So there is no index shifted after this function call. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndices</div> <div class="type"> <span class="param-type">Array.<number></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 the value is true or undefined, hide the specified columns. Otherwise, show the columns </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/core/grid#hideColumn">Grid#hideColumn</a></li> <li><a href="#/apis/core/grid#showAllColumns">Grid#showAllColumns</a></li> </ul> </dd> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/grid#event:widthChanged">Grid#event:widthChanged</a></div> <div class="sub-content"><a href="#/apis/core/grid#event:columnVisibilityChanged">Grid#event:columnVisibilityChanged</a></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">(rowId)</span><span class="type-signature"></span></h4> <div class="description"> Hide row(s) in the Grid by specifying the rId </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowId</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">string</span> </div> <div class="description"> rowId of the row to 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">(rowIds)</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">rowIds</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="description"> rowId(s) of the rows to hide </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="insertAfter"><span class="type-signature"></span>insertAfter<span class="signature">(previousSibling)</span><span class="type-signature"></span></h4> <div class="description"> Inserts this element after the specified sibling. Parent of this element will be changed to sibling's parentIf sibling parent does not exist, nothing is performed.If previousSibling is null, this element will place itself at the end of its parent child list </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">previousSibling</div> <div class="type"> <span class="param-type"><a href="#/apis/core/elementwrapper">ElementWrapper</a></span> | <span class="param-type">Element</span> | <span class="param-type">Node</span> </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#insertAfter">ElementWrapper#insertAfter</a> </dd> </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">(nextSibling)</span><span class="type-signature"></span></h4> <div class="description"> <a href="#/apis/core/elementwrapper#insertBefore">ElementWrapper#insertBefore</a> </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">nextSibling</div> <div class="type"> <span class="param-type"><a href="#/apis/core/elementwrapper">ElementWrapper</a></span> | <span class="param-type">Element</span> | <span class="param-type">Node</span> </div> </div> </div> <div class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"> <a href="#/apis/core/elementwrapper#insertBefore">ElementWrapper#insertBefore</a> </dd> </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">(index, jsonObj<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">index</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">jsonObj</div> <div class="type"> <span class="param-type">Grid.ColumnOptions</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Column definition object </div> </div> </div> <div class="details"> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/grid#event:columnAdded">Grid#event:columnAdded</a></div> <div class="sub-content">Grid#event:preSectionRender</div> <div class="sub-content">Grid#event:columnRender</div> <div class="sub-content">Grid#event:preSectionDataBinding</div> <div class="sub-content">Grid#event:columnDataBinding</div> <div class="sub-content"><a href="#/apis/core/grid#event:postSectionDataBinding">Grid#event:postSectionDataBinding</a></div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="insertColumns"><span class="type-signature"></span>insertColumns<span class="signature">(at, cols<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">at</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">cols</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">Grid.ColumnOptions</span> | <span class="param-type">Array.<Grid.ColumnOptions></span> </div> <div class="attributes"> <optional> </div> <div class="description"> Column definition object or column count </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="isBinding"><span class="type-signature"></span>isBinding<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="isColumnVisible"><span class="type-signature"></span>isColumnVisible<span class="signature">(colIndex)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Use <a href="#/apis/core/grid#hideColumn">Grid#hideColumn</a> to hide the column </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"> </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="isDisposed"><span class="type-signature"></span>isDisposed<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Indicates if the object has been disposed or not </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="isEnabled"><span class="type-signature"></span>isEnabled<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Check if control element is enabled </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#isEnabled">ElementWrapper#isEnabled</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> true if element is enabled</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="isEndOfHorizontalScroll"><span class="type-signature"></span>isEndOfHorizontalScroll<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#isEndOfHorizontalScroll">ElementWrapper#isEndOfHorizontalScroll</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="isEndOfVerticalScroll"><span class="type-signature"></span>isEndOfVerticalScroll<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#isEndOfVerticalScroll">ElementWrapper#isEndOfVerticalScroll</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="isLayoutFrozen"><span class="type-signature"></span>isLayoutFrozen<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="isPinnedColumn"><span class="type-signature"></span>isPinnedColumn<span class="signature">(colIndex)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> return weather colIndex in pinned or not</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="isVisible"><span class="type-signature"></span>isVisible<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Check to see if display has "none" as a inline style. Note that any change in visibility and class name may not be reflected by the returned value. </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#isVisible">ElementWrapper#isVisible</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="listen"><span class="type-signature"></span>listen<span class="signature">(type, handler, opt_priority<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Add a event listener to either native or custom event provided from the instance. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">type</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> </div> <div class="description"> All standard HTML element event types are allowed </div> </div> <div class="param"> <div class="name">handler</div> <div class="type"> <span class="param-type">function</span> </div> <div class="attributes"> </div> <div class="description"> Callback method </div> </div> <div class="param"> <div class="name">opt_priority</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> The higher the priority, the sooner the listener get executed. Undefined priority listener will be executed last </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#listen">ElementWrapper#listen</a> </dd> </div> <h5>Example:</h5> <pre><code>var grid = new Grid();
grid.listen("click", function(e) { console.log("Grid is clicked"); });</code></pre> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="loadPlugin"><span class="type-signature"></span>loadPlugin<span class="signature">(pluginRef, opt_options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {*}</span></h4> <div class="description"> A plugin can be loaded only once </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">pluginRef</div> <div class="type"> <span class="param-type">*</span> </div> <div class="attributes"> </div> <div class="description"> Plugin name (string) or plugin instance </div> </div> <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"> Option for initialize the given plugin </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 the plugin that has been successfully loaded. Returns null if the plugin is not loaded</div> <h5>Example:</h5> <pre><code>grid.loadPlugin("CheckboxPlugin");
grid.loadPlugin("ColumnResizing");
grid.loadPlugin(new Grid.InCellEditingPlugin());</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">(fromCol, destCol)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">fromCol</div> <div class="type"> <span class="param-type">number</span> </div> <div class="description"> INCLUSIVE </div> </div> <div class="param"> <div class="name">destCol</div> <div class="type"> <span class="param-type">number</span> </div> <div class="description"> INCLUSIVE </div> </div> </div> <div class="details"> </div> <h5>Fires:</h5> <div class="sub-content">Grid#event:columnMoved</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="newColumnData"><span class="type-signature"></span>newColumnData<span class="signature">(colIndex)</span><span class="type-signature"> → {Object}</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">Object</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="preserveGridSize"><span class="type-signature"></span>preserveGridSize<span class="signature">(preserve)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">preserve</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="default"> [default: false] </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="preserveProportion"><span class="type-signature"></span>preserveProportion<span class="signature">(preserve)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">preserve</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="default"> [default: false] </div> </div> </div> <div class="details"> </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="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/core/grid#removeColumnAt">Grid#removeColumnAt</a></li> </ul> </dd> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/grid#event:widthChanged">Grid#event:widthChanged</a></div> <div class="sub-content"><a href="#/apis/core/grid#event:columnRemoved">Grid#event:columnRemoved</a></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="description"> WARNING: This only removes all rows in each section, but the sections and columns remain intact </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeAllSections"><span class="type-signature"></span>removeAllSections<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="removeAttribute"><span class="type-signature"></span>removeAttribute<span class="signature">(str)</span><span class="type-signature"></span></h4> <div class="description"> Completely removes attribute from DOM element for both key and values </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">str</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#removeAttribute">ElementWrapper#removeAttribute</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeClass"><span class="type-signature"></span>removeClass<span class="signature">(str)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">str</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#removeClass">ElementWrapper#removeClass</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeColumnAt"><span class="type-signature"></span>removeColumnAt<span class="signature">(index)</span><span class="type-signature"> → {Object}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">index</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/core/grid#removeAllColumns">Grid#removeAllColumns</a></li> </ul> </dd> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/grid#event:widthChanged">Grid#event:widthChanged</a></div> <div class="sub-content"><a href="#/apis/core/grid#event:columnRemoved">Grid#event:columnRemoved</a></div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Object</span> </div><div class="sub-content-desc"> Return column definition object</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeContent"><span class="type-signature"></span>removeContent<span class="signature">(content)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Removes the specified content from the existing children list </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">content</div> <div class="type"> <span class="param-type">Element</span> | <span class="param-type">Node</span> | <span class="param-type"><a href="#/apis/core/elementwrapper">ElementWrapper</a></span> </div> <div class="description"> If null is given, nothing is done </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#removeContent">ElementWrapper#removeContent</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> true if the content is removed</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeLastSection"><span class="type-signature"></span>removeLastSection<span class="signature">()</span><span class="type-signature"> → {<a href="ILayout#/apis/core/grid">ILayoutGrid</a>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="ILayout#/apis/core/grid">ILayoutGrid</a></span> </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">(opt_num<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Remove specified number of rows from the last section. <br>Note that this will NOT remove row in the DataTable, as well as the section. <br>Use removeRowData to remove the supporting data row from the data source </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_num</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Default is one row </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeRowData"><span class="type-signature"></span>removeRowData<span class="signature">(sectionRef, rowRef)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Do not used this method too often. This method is slow. It is always better to set data directly to the data table </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">sectionRef</div> <div class="type"> <span class="param-type">Grid.SectionReference</span> </div> </div> <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 of the display section or row id of the data table </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 for successful data setting</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeSection"><span class="type-signature"></span>removeSection<span class="signature">(sectionRef)</span><span class="type-signature"> → {<a href="ILayout#/apis/core/grid">ILayoutGrid</a>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">sectionRef</div> <div class="type"> <span class="param-type">Grid.SectionReference</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="ILayout#/apis/core/grid">ILayoutGrid</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeSectionAt"><span class="type-signature"></span>removeSectionAt<span class="signature">(at)</span><span class="type-signature"> → {<a href="ILayout#/apis/core/grid">ILayoutGrid</a>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">at</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="ILayout#/apis/core/grid">ILayoutGrid</a></span> </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"> Set a timer to call updateRowData only once to avoid performance issue due to multiple call of updateRowData() </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="rerender"><span class="type-signature"></span>rerender<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Re-render all sections (headers and contents) in grid. Layout will not be affected by this method </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="reserveRightSpace"><span class="type-signature"></span>reserveRightSpace<span class="signature">(size)</span><span class="type-signature"> → {boolean}</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> <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="resetColumnWidths"><span class="type-signature"></span>resetColumnWidths<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="scrollDown"><span class="type-signature"></span>scrollDown<span class="signature">(pixels)</span><span class="type-signature"></span></h4> <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"> </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> <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"> </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> <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, always make to specified column at the left most of the view. </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">(sectionRef, rowIndex, topOfView<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Scroll up or down to make specified row visible in the view </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">sectionRef</div> <div class="type"> <span class="param-type">Grid.SectionReference</span> </div> <div class="attributes"> </div> <div class="default"> </div> <div class="description"> Specify section that the given rowIndex is related to. Use null for the first scrollable section (first non-frozen section) </div> </div> <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, Make to specified row at the top of the view. </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setAlwaysRenderColumn"><span class="type-signature"></span>setAlwaysRenderColumn<span class="signature">(colIndex, alwaysRender<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">alwaysRender</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="setAttribute"><span class="type-signature"></span>setAttribute<span class="signature">(str, val)</span><span class="type-signature"></span></h4> <div class="description"> Sets attribute to DOM element </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">str</div> <div class="type"> <span class="param-type">string</span> </div> </div> <div class="param"> <div class="name">val</div> <div class="type"> <span class="param-type">string</span> </div> <div class="description"> Uses empty string ("") to remove the attribute value </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#setAttribute">ElementWrapper#setAttribute</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setAttributes"><span class="type-signature"></span>setAttributes<span class="signature">(json)</span><span class="type-signature"></span></h4> <div class="description"> Sets multiple attributes all at once </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">json</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="description"> Key is the attribute names and value is string value (i.e. "readonly", "50", "checkbox") </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#setAttributes">ElementWrapper#setAttributes</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setBottomPaddingSection"><span class="type-signature"></span>setBottomPaddingSection<span class="signature">(paddingSize)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">paddingSize</div> <div class="type"> <span class="param-type">boolean</span> | <span class="param-type">number</span> </div> <div class="default"> [default: 6] </div> <div class="description"> Add special section at the bottom. If falsy value is specified, the section is removed. </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setClass"><span class="type-signature"></span>setClass<span class="signature">(str)</span><span class="type-signature"></span></h4> <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"> All existing classes will be placed by this value </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#setClass">ElementWrapper#setClass</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setColumnAlignment"><span class="type-signature"></span>setColumnAlignment<span class="signature">(colIndex, alignment<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">alignment</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Available options are "center"|"right"|"left"|"c"|"r"|"l". Use empty string (falsy value) to reset back to default aliganment. </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setColumnCount"><span class="type-signature"></span>setColumnCount<span class="signature">(num)</span><span class="type-signature"></span></h4> <div class="description"> Column count can be independently set regardless of row count and section count </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">num</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/grid#event:columnAdded">Grid#event:columnAdded</a></div> <div class="sub-content">Grid#event:preSectionRender</div> <div class="sub-content">Grid#event:columnRender</div> <div class="sub-content">Grid#event:preSectionDataBinding</div> <div class="sub-content">Grid#event:columnDataBinding</div> <div class="sub-content"><a href="#/apis/core/grid#event:postSectionDataBinding">Grid#event:postSectionDataBinding</a></div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setColumnData"><span class="type-signature"></span>setColumnData<span class="signature">(colIndex, userData)</span><span class="type-signature"> → {Object}</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">userData</div> <div class="type"> <span class="param-type">Object</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="setColumnDataBindingHandler"><span class="type-signature"></span>setColumnDataBindingHandler<span class="signature">(c, func)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">c</div> <div class="type"> <span class="param-type">number</span> </div> </div> <div class="param"> <div class="name">func</div> <div class="type"> <span class="param-type">*</span> </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li>{<a href="#/apis/core/grid#setDefaultDataBindingHandler">Grid#setDefaultDataBindingHandler</a>}</li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setColumnDefaultWidth"><span class="type-signature"></span>setColumnDefaultWidth<span class="signature">(colIndex, width)</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">width</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="setColumnRenderingHandler"><span class="type-signature"></span>setColumnRenderingHandler<span class="signature">(c, func)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">c</div> <div class="type"> <span class="param-type">number</span> </div> </div> <div class="param"> <div class="name">func</div> <div class="type"> <span class="param-type">*</span> </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li>{<a href="#/apis/core/grid#setDefaultRenderingHandler">Grid#setDefaultRenderingHandler</a>}</li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setColumnScalability"><span class="type-signature"></span>setColumnScalability<span class="signature">(val, opt_scalable<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">val</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">boolean</span> </div> <div class="attributes"> </div> <div class="description"> column index or default column scalability </div> </div> <div class="param"> <div class="name">opt_scalable</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/grid#event:widthChanged">Grid#event:widthChanged</a></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="setColumnStyle"><span class="type-signature"></span>setColumnStyle<span class="signature">(colIndex, style, value, opt_type<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">style</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">value</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">opt_type</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Apply the style only to the specified row type. Default is applying to all rows </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setColumnWidth"><span class="type-signature"></span>setColumnWidth<span class="signature">(colIndex, px, opt_scalable<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">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">px</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">opt_scalable</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If not defined false value is used instead </div> </div> </div> <div class="details"> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/grid#event:widthChanged">Grid#event:widthChanged</a></div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> True if there is any changed</div> <h5>Example:</h5> <pre><code>grid.setColumnWidth(0, 100); // The first column will have a fixed width
grid.setColumnWidth(1, 100, true); // The second column will have a percentage width where 100 is the weight comparing with other percentage column</code></pre> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setColumnWidths"><span class="type-signature"></span>setColumnWidths<span class="signature">(columnWidths, opt_proportion<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Specifies multiple column widths all at once. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">columnWidths</div> <div class="type"> <span class="param-type">Array.<number></span> </div> <div class="attributes"> </div> <div class="description"> in pixel. If the specified value is undefined or null, nothing is performed on that column. </div> </div> <div class="param"> <div class="name">opt_proportion</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> This will make columns scale in proportion specified by the given width </div> </div> </div> <div class="details"> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/grid#event:widthChanged">Grid#event:widthChanged</a></div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> True if there is any changed</div> <h5>Example:</h5> <pre><code>grid.setColumnWidths([1, 2, 1, 1], true); // The first four columns have percentage width with the second column is twice as big as the others</code></pre> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setContent"><span class="type-signature"></span>setContent<span class="signature">(content, opt_tooltip<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Element}</span></h4> <div class="description"> Replaces all existing child elements with the specified content. This method automatically converts all non-element to string wrapped with <span> for proper display. </span></div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">content</div> <div class="type"> <span class="param-type">string</span> | <span class="param-type">Element</span> | <span class="param-type"><a href="#/apis/core/elementwrapper">ElementWrapper</a></span> | <span class="param-type">*</span> </div> <div class="attributes"> </div> <div class="description"> Use null to clear content. If string is given, <span> tag is automatically added to host the string. </div> </div> <div class="param"> <div class="name">opt_tooltip</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If undefined, content is added without modification. If string is given, it is added to title attribute of the content </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#setContent">ElementWrapper#setContent</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Element</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setData"><span class="type-signature"></span>setData<span class="signature">(sectionRef, colRef, rowRef, data)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Do not used this method too often. This method is slow. It is always better to set data directly to the data table </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">sectionRef</div> <div class="type"> <span class="param-type">Grid.SectionReference</span> </div> </div> <div class="param"> <div class="name">colRef</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">string</span> </div> <div class="description"> Either column index or data column name </div> </div> <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 of the display section or row id of the data table </div> </div> <div class="param"> <div class="name">data</div> <div class="type"> <span class="param-type">*</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 for successful data setting</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setDataColumnMap"><span class="type-signature"></span>setDataColumnMap<span class="signature">(opt_dataMap<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> For indirectional one to one data binding </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_dataMap</div> <div class="type"> <span class="param-type">Array.<string></span> </div> <div class="attributes"> <optional> </div> <div class="description"> index in the array will be matched with the display column </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setDataColumnName"><span class="type-signature"></span>setDataColumnName<span class="signature">(colIndex, opt_dataColumnName<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">opt_dataColumnName</div> <div class="type"> <span class="param-type">string</span> | <span class="param-type">null</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Use string for normal mapping, null to disable, and undefined for default mapping </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setDataConflationRate"><span class="type-signature"></span>setDataConflationRate<span class="signature">(milliSecond)</span><span class="type-signature"></span></h4> <div class="description"> set Data Conflation for better performance </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">milliSecond</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="setDataSource"><span class="type-signature"></span>setDataSource<span class="signature">(dataSource)</span><span class="type-signature"> → {<a href="#/apis/core/dataview">DataView</a>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">dataSource</div> <div class="type"> <span class="param-type"><a href="#/apis/core/datatable">DataTable</a></span> | <span class="param-type"><a href="#/apis/core/dataview">DataView</a></span> </div> </div> </div> <div class="details"> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/grid#event:dataSourceChanged">Grid#event:dataSourceChanged</a></div> <div class="sub-content">Grid#event:postDataSourceChanged</div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/core/dataview">DataView</a></span> </div><div class="sub-content-desc"> Returns the root data view</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setDefaultColumnScalable"><span class="type-signature"></span>setDefaultColumnScalable<span class="signature">(scalable)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">scalable</div> <div class="type"> <span class="param-type">boolean</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setDefaultDataBindingHandler"><span class="type-signature"></span>setDefaultDataBindingHandler<span class="signature">(handler)</span><span class="type-signature"></span></h4> <div class="description"> If the given column has no data binding handler, this handler will be executed instead </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">handler</div> <div class="type"> <span class="param-type">function</span> </div> <div class="description"> that takes json object as a first parameter </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li>{<a href="#/apis/core/grid#setColumnDataBindingHandler">Grid#setColumnDataBindingHandler</a>}</li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setDefaultRenderingHandler"><span class="type-signature"></span>setDefaultRenderingHandler<span class="signature">(handler)</span><span class="type-signature"></span></h4> <div class="description"> If the given column has no rendering handler, this default handler will be executed instead </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">handler</div> <div class="type"> <span class="param-type">function</span> </div> <div class="description"> that takes json object as a first parameter </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li>{<a href="#/apis/core/grid#setColumnRenderingHandler">Grid#setColumnRenderingHandler</a>}</li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setDefaultRowHeight"><span class="type-signature"></span>setDefaultRowHeight<span class="signature">(val, opt_includeTitle<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> This default row height only applies to header and content section. <br>Use the second flag to apply the change to title section too. <br>To set default row height for a specific section, please call setDefaultRowHeight directly from the section </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">val</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">opt_includeTitle</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="setFitContentWidth"><span class="type-signature"></span>setFitContentWidth<span class="signature">(bool)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">bool</div> <div class="type"> <span class="param-type">boolean</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setHeight"><span class="type-signature"></span>setHeight<span class="signature">(val)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> For complex sizing, use setStyle("height", "-webkit-calc(100% - 10px)") instead. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">val</div> <div class="type"> <span class="param-type">number</span> </div> <div class="description"> in pixel </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#setHeight">ElementWrapper#setHeight</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> true if there is any change, otherwise false</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setHidingMethod"><span class="type-signature"></span>setHidingMethod<span class="signature">(method)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">method</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="setId"><span class="type-signature"></span>setId<span class="signature">(val)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">val</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#setId">ElementWrapper#setId</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setLeft"><span class="type-signature"></span>setLeft<span class="signature">(val)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">val</div> <div class="type"> <span class="param-type">number</span> </div> <div class="description"> in pixel </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#setLeft">ElementWrapper#setLeft</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> true if there is any change, otherwise false</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setMinimumColumnWidth"><span class="type-signature"></span>setMinimumColumnWidth<span class="signature">(colIndex, width)</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">width</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/grid#event:widthChanged">Grid#event:widthChanged</a></div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setMinimumColumnWidths"><span class="type-signature"></span>setMinimumColumnWidths<span class="signature">(minWidths, proportion<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">minWidths</div> <div class="type"> <span class="param-type">Array.<(number|null)></span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">proportion</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> This will make the column expand in proportion of its minimum width when there is enough space. </div> </div> </div> <div class="details"> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/grid#event:widthChanged">Grid#event:widthChanged</a></div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> True if there is any change</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">(parent, opt_prepend<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> <a href="#/apis/core/elementwrapper#setParent">ElementWrapper#setParent</a> </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">parent</div> <div class="type"> <span class="param-type"><a href="#/apis/core/elementwrapper">ElementWrapper</a></span> | <span class="param-type">Element</span> | <span class="param-type">Node</span> </div> <div class="attributes"> </div> <div class="description"> Uses null to clear parent </div> </div> <div class="param"> <div class="name">opt_prepend</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If false (default), this element is appended to child list of the parent </div> </div> </div> <div class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"> <a href="#/apis/core/elementwrapper#setParent">ElementWrapper#setParent</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setRowScrollingStep"><span class="type-signature"></span>setRowScrollingStep<span class="signature">(rowCount)</span><span class="type-signature"></span></h4> <div class="description"> Scrolling step will be multiple of the default row height in pixels. For example, if default row height is 32 pixel and row scrolling step is 2, <br>then the actual scrolling step for vertical scrollbar will be (32 * 2) = 64 pixels </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowCount</div> <div class="type"> <span class="param-type">number</span> </div> <div class="description"> Number of rows for a single scrolling step. Use zero to disable this feature. </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> <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"> </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> <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"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setSectionRowCount"><span class="type-signature"></span>setSectionRowCount<span class="signature">(sectionRef, num)</span><span class="type-signature"></span></h4> <div class="description"> The specified section and columns must exist prior to calling this method </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">sectionRef</div> <div class="type"> <span class="param-type">Grid.SectionReference</span> </div> </div> <div class="param"> <div class="name">num</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="setStyle"><span class="type-signature"></span>setStyle<span class="signature">(str, val)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">str</div> <div class="type"> <span class="param-type">string</span> </div> </div> <div class="param"> <div class="name">val</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#setStyle">ElementWrapper#setStyle</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setStyles"><span class="type-signature"></span>setStyles<span class="signature">(json)</span><span class="type-signature"></span></h4> <div class="description"> Sets multiple css properties all at once </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">json</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="description"> Key is the property names and value is style value (i.e. "center", "#FF00FF", "10px") </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#setStyles">ElementWrapper#setStyles</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setTextContent"><span class="type-signature"></span>setTextContent<span class="signature">(str)</span><span class="type-signature"></span></h4> <div class="description"> Sets textContent (IE9+) value this will replace all childNodes with a single TextNode </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">str</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#setTextContent">ElementWrapper#setTextContent</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setTooltip"><span class="type-signature"></span>setTooltip<span class="signature">(str)</span><span class="type-signature"></span></h4> <div class="description"> Sets tooltip text to "title" attribute </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">str</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#setTooltip">ElementWrapper#setTooltip</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setTop"><span class="type-signature"></span>setTop<span class="signature">(val)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">val</div> <div class="type"> <span class="param-type">number</span> </div> <div class="description"> in pixel </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#setTop">ElementWrapper#setTop</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> ture if there is any change, otherwise false</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setWidth"><span class="type-signature"></span>setWidth<span class="signature">(val)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> For complex sizing, use setStyle("width", "-webkit-calc(100% - 10px)") instead. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">val</div> <div class="type"> <span class="param-type">number</span> </div> <div class="description"> in pixel </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#setWidth">ElementWrapper#setWidth</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> true if there is any change, otherwise false</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="show"><span class="type-signature"></span>show<span class="signature">(opt_shown<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> <a href="#/apis/core/elementwrapper#show">ElementWrapper#show</a> </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_shown</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If false the element will be hidden </div> </div> </div> <div class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"> <a href="#/apis/core/elementwrapper#show">ElementWrapper#show</a> </dd> </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/core/grid#hideColumn">Grid#hideColumn</a></li> <li><a href="#/apis/core/grid#hideColumns">Grid#hideColumns</a></li> </ul> </dd> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/grid#event:widthChanged">Grid#event:widthChanged</a></div> <div class="sub-content"><a href="#/apis/core/grid#event:columnVisibilityChanged">Grid#event:columnVisibilityChanged</a></div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="showBorders"><span class="type-signature"></span>showBorders<span class="signature">(opt_shown<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Deprecated </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_shown</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/core/grid#toggleBorders">Grid#toggleBorders</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">(rowIds, opt_show<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">rowIds</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"> rowId(s) of the rows to show </div> </div> <div class="param"> <div class="name">opt_show</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="synchronizeVScrollbar"><span class="type-signature"></span>synchronizeVScrollbar<span class="signature">(subGrid)</span><span class="type-signature"></span></h4> <div class="description"> Synchronize two vertical scrollbars of two grid, by hiding its scrollbar and using the one from the given grid </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">subGrid</div> <div class="type"> <span class="param-type"><a href="#/apis/core/grid">Grid</a></span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="toggleBorders"><span class="type-signature"></span>toggleBorders<span class="signature">(forcedVal<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Toggle borders around grid element. WARNING: You will need to manually call updateLayout() method, if you call this method at run-time </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">forcedVal</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If value is true, show border lines, otherwise hide them </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="toggleClass"><span class="type-signature"></span>toggleClass<span class="signature">(cls, forcedVal<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Toggles the specified class </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">cls</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">forcedVal</div> <div class="type"> <span class="param-type">boolean</span> | <span class="param-type">null</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If specified, force CSS class state as the specified value </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#toggleClass">ElementWrapper#toggleClass</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="toggleGridlines"><span class="type-signature"></span>toggleGridlines<span class="signature">(forcedVal<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Toggle both horizontal and vertical gridlines. This applies to ONLY content sections. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">forcedVal</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If value is true, show gridlines, otherwise hide them </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="toggleHorizontalLines"><span class="type-signature"></span>toggleHorizontalLines<span class="signature">(forcedVal<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Toggle horizontal gridlines. This applies to all sections. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">forcedVal</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If value is true, show horizontal lines, otherwise hide them </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="toggleVerticalLines"><span class="type-signature"></span>toggleVerticalLines<span class="signature">(forcedVal<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Toggle vertical gridlines. This applies to all sections. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">forcedVal</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If value is true, show vertical lines, otherwise hide them </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="description"> Return a string that represents the object mainly for debugging </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#toString">ElementWrapper#toString</a> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="unfreezeLayout"><span class="type-signature"></span>unfreezeLayout<span class="signature">(opt_bool<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Deprecated. Please use freezeLayout instead </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_bool</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/core/grid#freezeLayout">Grid#freezeLayout</a></li> </ul> </dd> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/grid#event:widthChanged">Grid#event:widthChanged</a></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="unlisten"><span class="type-signature"></span>unlisten<span class="signature">(type, handler)</span><span class="type-signature"></span></h4> <div class="description"> Removes an event listener which was added with listen(). The same function handler must be sent in, or else it will not be removed </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">type</div> <div class="type"> <span class="param-type">string</span> </div> <div class="description"> The name of the event without the 'on' prefix. </div> </div> <div class="param"> <div class="name">handler</div> <div class="type"> <span class="param-type">function</span> </div> <div class="description"> The listener function to remove. </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#unlisten">ElementWrapper#unlisten</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="unlistenAll"><span class="type-signature"></span>unlistenAll<span class="signature">(opt_type<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Removes all listeners from an object. If no type is specified, it will remove all listeners that have been registered.You can also optionally remove listeners of a particular type. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_type</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Type of event to, default is all types. </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/elementwrapper#unlistenAll">ElementWrapper#unlistenAll</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="unloadPlugin"><span class="type-signature"></span>unloadPlugin<span class="signature">(pluginRef)</span><span class="type-signature"> → {*|null}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">pluginRef</div> <div class="type"> <span class="param-type">*</span> </div> <div class="description"> Plugin name (string) or instance </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">*</span> | <span class="param-type">null</span> </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"> Sometimes there is a change in layout without Grid noticing it (e.g tab pane is switched, or parent is hidden from view). <br>Hence, the layout must be manually and explicitly update by calling this method. </div> <div class="details"> </div> <h5>Fires:</h5> <div class="sub-content"><a href="#/apis/core/grid#event:widthChanged">Grid#event:widthChanged</a></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">(sectionRef<span class="signature-attributes">opt</span>, fromRowIndex<span class="signature-attributes">opt</span>, lastRowIndex<span class="signature-attributes">opt</span>, userParam<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Fires data binding event without actual change in the data source. <br>This will force visual elements to be re-rendered with the latest data in the data source. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">sectionRef</div> <div class="type"> <span class="param-type">Grid.SectionReference</span> </div> <div class="attributes"> <optional> </div> <div class="description"> If not defined, "content" is used </div> </div> <div class="param"> <div class="name">fromRowIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> INCLUSIVE If the value is undefined, the first row index will be used </div> </div> <div class="param"> <div class="name">lastRowIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> INCLUSIVE If the value is undefined, the last row index will be used </div> </div> <div class="param"> <div class="name">userParam</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Addtional parameters to be fired with the event </div> </div> </div> <div class="details"> </div> <h5>Fires:</h5> <div class="sub-content">Grid#event:preSectionDataBinding</div> <div class="sub-content">Grid#event:columnDataBinding</div> <div class="sub-content"><a href="#/apis/core/grid#event:postSectionDataBinding">Grid#event:postSectionDataBinding</a></div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="updateScrollbars"><span class="type-signature"></span>updateScrollbars<span class="signature">(updateHeight, updateWidth)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">updateHeight</div> <div class="type"> <span class="param-type">boolean</span> </div> </div> <div class="param"> <div class="name">updateWidth</div> <div class="type"> <span class="param-type">boolean</span> </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:columnAdded">columnAdded</h4> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:columnRemoved">columnRemoved</h4> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:columnVisibilityChanged">columnVisibilityChanged</h4> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:dataSourceChanged">dataSourceChanged</h4> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:postSectionDataBinding">postSectionDataBinding</h4> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:rowExpansionBinding">rowExpansionBinding</h4> <div class="description"> Trigger after column data binding. Fires for all rows within the view. </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>originalRowData</code></td> <td class="type"> <span class="param-type">Object.<string, *></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>originalRowId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The row that rowExpansion belongs to</td> </tr> <tr> <td class="name"><code>rowExpansion</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>rowId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>rowIndex</code></td> <td class="type"> <span class="param-type">number</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:rowHighlighted">rowHighlighted</h4> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:sectionAdded">sectionAdded</h4> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">event</div> <h4 class="name" id="event:widthChanged">widthChanged</h4> <div class="details"> </div> </div> </article></section></div></div>