-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtemplate-14.html
More file actions
156 lines (155 loc) · 172 KB
/
template-14.html
File metadata and controls
156 lines (155 loc) · 172 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
<link rel="stylesheet" href="./resources/styles/elf-template.css">
<h1 id="ilayoutgrid">ILayoutGrid</h1>
<div id="elf-api-container"><div id="main-template" class="elf-template"> <section><header> <h1 class="subsection-title">ILayoutGrid</h1> </header><article> <div class="container-overview"> <div class="details"> </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="methods">Methods</h3>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="activateRows"><span class="type-signature"></span>activateRows<span class="signature">(from<span class="signature-attributes">opt</span>, to<span class="signature-attributes">opt</span>, opt_updateRange<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">from</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> INCLUSIVE </div> </div> <div class="param"> <div class="name">to</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> EXCLUSIVE </div> </div> <div class="param"> <div class="name">opt_updateRange</div> <div class="type"> <span class="param-type">Array.<number></span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="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">(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">number</span> </div> <div class="description"> Number of row to be added from the last row </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="clearCellSpans"><span class="type-signature"></span>clearCellSpans<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="clearColumnCustomizations"><span class="type-signature"></span>clearColumnCustomizations<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="clearColumnSpans"><span class="type-signature"></span>clearColumnSpans<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="clearRowCustomizations"><span class="type-signature"></span>clearRowCustomizations<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="clearSelectedRows"><span class="type-signature"></span>clearSelectedRows<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"> Number of selection removed</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="disableHorizontalGridLine"><span class="type-signature"></span>disableHorizontalGridLine<span class="signature">(opt_bool<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_bool</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="disableVerticalGridLine"><span class="type-signature"></span>disableVerticalGridLine<span class="signature">(opt_bool<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_bool</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="dispose"><span class="type-signature"></span>dispose<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Calls this method, if it is NO LONGER needed and we want to free up memory.Any usage after disposition will cause exception error </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <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, className, enabled<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">className</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> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="enableRowClass"><span class="type-signature"></span>enableRowClass<span class="signature">(rowIndex, className, enabled)</span><span class="type-signature"></span></h4> <div class="description"> Apply CSS class to each cell in the row </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> <div class="param"> <div class="name">className</div> <div class="type"> <span class="param-type">string</span> </div> </div> <div class="param"> <div class="name">enabled</div> <div class="type"> <span class="param-type">boolean</span> </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li>ILayoutGrid.#setRowStyle</li> </ul> </dd> </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_bool<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> When mouse hovering over a row, it will be highlighted </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"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="enableShading"><span class="type-signature"></span>enableShading<span class="signature">(enabled)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">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"> Sets width 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% width is used </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <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="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">(colIndex, rowIndex, opt_includeSpan<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="#/apis/core/elementwrapper">ElementWrapper</a>}</span></h4> <div class="description"> WARNING: Any modification to individual cell outside this class will not reflect the change as a whole. Please use with great care. </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">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 false (cells are retrieved by their index) </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="getCellColSpan"><span class="type-signature"></span>getCellColSpan<span class="signature">(colIndex, rowIndex)</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Returns zero or negative value, if the cell is spanned over (i.e. occupied by the spanning cell). <br>Negative value is distance from the spanning cell (i.e. -1 means one cell from the spanning cell and -2 means two cells from the spanning cell) <br>Return one, if the cell has no span (normal cell). <br>Return value greater than one, if the cell is spanning (getting expanded) </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 class="param"> <div class="name">rowIndex</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="getCellContent"><span class="type-signature"></span>getCellContent<span class="signature">(colIndex, rowIndex)</span><span class="type-signature"> → {Element|Node|NodeList}</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">rowIndex</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">Element</span> | <span class="param-type">Node</span> | <span class="param-type">NodeList</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getCellHeight"><span class="type-signature"></span>getCellHeight<span class="signature">(colIndex, rowIndex)</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 class="param"> <div class="name">rowIndex</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="getCellIndex"><span class="type-signature"></span>getCellIndex<span class="signature">(colIndex, cellElem)</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 class="param"> <div class="name">cellElem</div> <div class="type"> <span class="param-type">Element</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getCellLeft"><span class="type-signature"></span>getCellLeft<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="getCellRowSpan"><span class="type-signature"></span>getCellRowSpan<span class="signature">(colIndex, rowIndex)</span><span class="type-signature"> → {number}</span></h4> <div class="description"> Returns zero or negative value, if the cell is spanned over (i.e. occupied by the spanning cell). <br>Negative value is distance from the spanning cell (i.e. -1 means one cell from the spanning cell and -2 means two cells from the spanning cell) <br>Return one, if the cell has no span (normal cell). <br>Return value greater than one, if the cell is spanning (getting expanded) </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 class="param"> <div class="name">rowIndex</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="getCellsByRowIndex"><span class="type-signature"></span>getCellsByRowIndex<span class="signature">(rowIndex)</span><span class="type-signature"> → {Array.<<a href="#/apis/core/elementwrapper">ElementWrapper</a>>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li>ILayoutGrid.#setRowStyle</li> <li>ILayoutGrid.#enableRowClass</li> </ul> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<<a href="#/apis/core/elementwrapper">ElementWrapper</a>></span> </div><div class="sub-content-desc"> Return null for non existing row</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getCellTop"><span class="type-signature"></span>getCellTop<span class="signature">(rowIndex)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </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="getCellWidth"><span class="type-signature"></span>getCellWidth<span class="signature">(colIndex, rowIndex)</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 class="param"> <div class="name">rowIndex</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="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="getColumn"><span class="type-signature"></span>getColumn<span class="signature">(index)</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">index</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/core/elementwrapper">ElementWrapper</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnCount"><span class="type-signature"></span>getColumnCount<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getColumnHost"><span class="type-signature"></span>getColumnHost<span class="signature">()</span><span class="type-signature"> → {Element}</span></h4> <div class="description"> Get immediate parent of all child columns (i.e. base grid 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="getColumnIndex"><span class="type-signature"></span>getColumnIndex<span class="signature">(colElem)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colElem</div> <div class="type"> <span class="param-type">Element</span> | <span class="param-type">Node</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="getColumnStyle"><span class="type-signature"></span>getColumnStyle<span class="signature">(colIndex, styleName)</span><span class="type-signature"> → {string|null}</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">styleName</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> | <span class="param-type">null</span> </div><div class="sub-content-desc"> value</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="getComputedStyle"><span class="type-signature"></span>getComputedStyle<span class="signature">()</span><span class="type-signature"> → {CSSStyleDeclaration}</span></h4> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/getComputedStyle">https://developer.mozilla.org/en-US/docs/Web/API/Window/getComputedStyle</a></li> </ul> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">CSSStyleDeclaration</span> </div><div class="sub-content-desc"> CSS live style object</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="getContentHeight"><span class="type-signature"></span>getContentHeight<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="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="getDefaultColumnWidth"><span class="type-signature"></span>getDefaultColumnWidth<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="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="getFirstIndexInView"><span class="type-signature"></span>getFirstIndexInView<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="getFirstSelectedRow"><span class="type-signature"></span>getFirstSelectedRow<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="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="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="getIndex"><span class="type-signature"></span>getIndex<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="getLastIndexInView"><span class="type-signature"></span>getLastIndexInView<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="getLastSelectedRow"><span class="type-signature"></span>getLastSelectedRow<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="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="getMinimumRowHeight"><span class="type-signature"></span>getMinimumRowHeight<span class="signature">(rowIndex)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </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="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="getRelativePosition"><span class="type-signature"></span>getRelativePosition<span class="signature">(obj)</span><span class="type-signature"> → {Object}</span></h4> <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="description"> ElementWrapper, element or mouse event whose position we're calculating. </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="getReservedSpace"><span class="type-signature"></span>getReservedSpace<span class="signature">()</span><span class="type-signature"> → {Element}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Element</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getRowAnchor"><span class="type-signature"></span>getRowAnchor<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="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="getRowHeight"><span class="type-signature"></span>getRowHeight<span class="signature">(rowIndex)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </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="getRowHighlight"><span class="type-signature"></span>getRowHighlight<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"> rowIndex Negative number means no row is highlighted</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getRowOffset"><span class="type-signature"></span>getRowOffset<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="getRowScalability"><span class="type-signature"></span>getRowScalability<span class="signature">(rowIndex)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </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="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="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <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>
<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="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <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>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getSelectedRowCount"><span class="type-signature"></span>getSelectedRowCount<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="getSelectedRows"><span class="type-signature"></span>getSelectedRows<span class="signature">()</span><span class="type-signature"> → {Array.<number>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<number></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getStretchedCells"><span class="type-signature"></span>getStretchedCells<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="#/apis/core/cell">Cell</a>>}</span></h4> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/core/ilayoutgrid#stretchCell">ILayoutGrid#stretchCell</a></li> </ul> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<<a href="#/apis/core/cell">Cell</a>></span> </div><div class="sub-content-desc"> The cells that are stretched</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="getVisibleRowCount"><span class="type-signature"></span>getVisibleRowCount<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="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="hasCellSpan"><span class="type-signature"></span>hasCellSpan<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="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">()</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="hideColumn"><span class="type-signature"></span>hideColumn<span class="signature">(colIndex, val<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">val</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="hideRow"><span class="type-signature"></span>hideRow<span class="signature">(rowIndex, val<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">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">val</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="hitTest"><span class="type-signature"></span>hitTest<span class="signature">(x, y, opt_omitSpan<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object|null}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">x</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">y</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">opt_omitSpan</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="description"> if true cell spans will be omitted from calculation </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Object</span> | <span class="param-type">null</span> </div><div class="sub-content-desc"> Return object with "colIndex" and "rowIndex" property</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="hitTestX"><span class="type-signature"></span>hitTestX<span class="signature">(x)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">x</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div><div class="sub-content-desc"> Positive index if hit, otherwise negative</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="hitTestY"><span class="type-signature"></span>hitTestY<span class="signature">(y)</span><span class="type-signature"> → {number}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">y</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">number</span> </div><div class="sub-content-desc"> Positive index if hit, otherwise negative</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"> Inserts this element before the specified sibling. Parent of this element will be changed to sibling's parentIf sibling parent does not exist, nothing is performed.If nextSibling 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">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="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <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="isColumnActive"><span class="type-signature"></span>isColumnActive<span class="signature">(colIndex)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Column can be virtualized. Column that is in view will be active, while the one that is not in view will be inactive </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="isColumnVisible"><span class="type-signature"></span>isColumnVisible<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="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="isInCurrentView"><span class="type-signature"></span>isInCurrentView<span class="signature">(index)</span><span class="type-signature"> → {boolean}</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"> </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="isRowVisible"><span class="type-signature"></span>isRowVisible<span class="signature">(rowIndex)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </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="isSelectedRow"><span class="type-signature"></span>isSelectedRow<span class="signature">(at)</span><span class="type-signature"> → {boolean}</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">boolean</span> </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="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="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="removeRow"><span class="type-signature"></span>removeRow<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">number</span> </div> <div class="description"> Number of row to be removed from the last row </div> </div> </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"> → {Element}</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">Element</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="selectRowRange"><span class="type-signature"></span>selectRowRange<span class="signature">(rowIndex)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="description"> * @param {number} length can be negative to select upward </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="selectSingleRow"><span class="type-signature"></span>selectSingleRow<span class="signature">(rowIndex)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> </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="setBorders"><span class="type-signature"></span>setBorders<span class="signature">(lft, top, rgt, btm)</span><span class="type-signature"></span></h4> <div class="description"> Deprecated. Shorthand method to set border visibility. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">lft</div> <div class="type"> <span class="param-type">boolean</span> </div> </div> <div class="param"> <div class="name">top</div> <div class="type"> <span class="param-type">boolean</span> </div> </div> <div class="param"> <div class="name">rgt</div> <div class="type"> <span class="param-type">boolean</span> </div> </div> <div class="param"> <div class="name">btm</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="setCellColSpan"><span class="type-signature"></span>setCellColSpan<span class="signature">(colIndex, rowIndex, colSpan)</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 class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> <div class="param"> <div class="name">colSpan</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="setCellContent"><span class="type-signature"></span>setCellContent<span class="signature">(colIndex, rowIndex, data)</span><span class="type-signature"> → {Element}</span></h4> <div class="description"> Set data to the specified cell </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 class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> <div class="param"> <div class="name">data</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="description"> this can be HTML element, string, number, date, image </div> </div> </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="setCellRowSpan"><span class="type-signature"></span>setCellRowSpan<span class="signature">(colIndex, rowIndex, rowSpan)</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 class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> <div class="param"> <div class="name">rowSpan</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="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="setColumnCount"><span class="type-signature"></span>setColumnCount<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">number</span> </div> </div> </div> <div class="details"> </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">(colIndex, val)</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 class="param"> <div class="name">val</div> <div class="type"> <span class="param-type">boolean</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="setColumnStyle"><span class="type-signature"></span>setColumnStyle<span class="signature">(colIndex, styleName, value)</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">styleName</div> <div class="type"> <span class="param-type">string</span> </div> </div> <div class="param"> <div class="name">value</div> <div class="type"> <span class="param-type">string</span> </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, val)</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 class="param"> <div class="name">val</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="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="setDefaultColumnWidth"><span class="type-signature"></span>setDefaultColumnWidth<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">number</span> </div> </div> </div> <div class="details"> </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)</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">number</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="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, val)</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 class="param"> <div class="name">val</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="setMinimumRowHeight"><span class="type-signature"></span>setMinimumRowHeight<span class="signature">(rowIndex, val)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> <div class="param"> <div class="name">val</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="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> <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="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <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="setRowAnchor"><span class="type-signature"></span>setRowAnchor<span class="signature">(at)</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> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setRowAttributes"><span class="type-signature"></span>setRowAttributes<span class="signature">(rowIndex, func)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> <div class="param"> <div class="name">func</div> <div class="type"> <span class="param-type">function</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setRowCount"><span class="type-signature"></span>setRowCount<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">number</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setRowHeight"><span class="type-signature"></span>setRowHeight<span class="signature">(rowIndex, val)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> <div class="param"> <div class="name">val</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="setRowHighlight"><span class="type-signature"></span>setRowHighlight<span class="signature">(rowIndex)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="description"> Negative number will cause deselection </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setRowScalability"><span class="type-signature"></span>setRowScalability<span class="signature">(rowIndex, val)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> <div class="param"> <div class="name">val</div> <div class="type"> <span class="param-type">boolean</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="setRowStyle"><span class="type-signature"></span>setRowStyle<span class="signature">(rowIndex, styleName, value, enabled<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Set CSS style to each cell in the row </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">styleName</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> | <span class="param-type">null</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 class="description"> If set to false, the specified style will be removed instead </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li>ILayoutGrid.#enableRowClass</li> </ul> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setSelectedRow"><span class="type-signature"></span>setSelectedRow<span class="signature">(rowIndex, opt_selected<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">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">opt_selected</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="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="setTransposedShading"><span class="type-signature"></span>setTransposedShading<span class="signature">(enabled)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">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="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"> Sets display style as inline style to the element with value of empty string </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="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <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="stretchCell"><span class="type-signature"></span>stretchCell<span class="signature">(cellRef, rowIndex<span class="signature-attributes">opt</span>, opt_stretching<span class="signature-attributes">opt</span>, onlyToTheRight<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="#/apis/core/cell">Cell</a>}</span></h4> <div class="description"> This will make the specified cell horizontally span to fit entire row regardless of position of the cell -- cell will shift to the left most of the section.<br>If opt_noLeftStretching is true, the cell will not extend to the left most position<br>This is different from cell colSpan, which the cell remain in the same position. tr-stretched class will also be added to the cell </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">cellRef</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type"><a href="#/apis/core/cell">Cell</a></span> </div> <div class="attributes"> </div> <div class="default"> </div> <div class="description"> Either column index or cell reference is acceptable </div> </div> <div class="param"> <div class="name">rowIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="default"> </div> <div class="description"> If the cell instance is given as the first parameter, this parameter will be ignored. </div> </div> <div class="param"> <div class="name">opt_stretching</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> <div class="default"> </div> <div class="description"> Default is true </div> </div> <div class="param"> <div class="name">onlyToTheRight</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"> By default, cell will be stretched to both left and right directions, covering entire row. Set to true to expand only to the right </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/core/cell">Cell</a></span> </div><div class="sub-content-desc"> The cell being stretched</div> <h5>Example:</h5> <pre><code>grid.stretchCell(1, 0); // The second cell on the first row will be stretched covering the entire row
grid.stretchCell(cellInstance, 0, true); // The given cell will be stretched covering the entire row</code></pre> </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="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="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="unstretchCell"><span class="type-signature"></span>unstretchCell<span class="signature">(cellRef, rowIndex<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="#/apis/core/cell">Cell</a>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">cellRef</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type"><a href="#/apis/core/cell">Cell</a></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"> <optional> </div> </div> </div> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/core/ilayoutgrid#stretchCell">ILayoutGrid#stretchCell</a></li> </ul> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/core/cell">Cell</a></span> </div><div class="sub-content-desc"> The cell being un-stretched</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="updateStretchedCells"><span class="type-signature"></span>updateStretchedCells<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <div class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="#/apis/core/ilayoutgrid#stretchCell">ILayoutGrid#stretchCell</a></li> </ul> </dd> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> Return true if there is any change</div> </div> </article></section></div></div>