-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtemplate-17.html
39 lines (38 loc) · 38.6 KB
/
template-17.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<link rel="stylesheet" href="./resources/styles/elf-template.css">
<h1 id="sectionsettings">SectionSettings</h1>
<div id="elf-api-container"><div id="main-template" class="elf-template"> <section><header> <h1 class="subsection-title"><span class="attribs"><span class="type-signature"></span></span>SectionSettings<span class="signature">(grid<span class="signature-attributes">non-null</span>)</span><span class="type-signature"></span></h1> </header><article> <div class="container-overview">
<div class="item"> <div class="item-type">class</div> <h4 class="name" id="SectionSettings"><span class="type-signature"></span>new SectionSettings<span class="signature">(grid<span class="signature-attributes">non-null</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">grid</div> <div class="type"> <span class="param-type"><a href="#/apis/core/ilayoutgrid">ILayoutGrid</a></span> </div> </div> </div> <div class="details"> </div> </div> </div> <h3 class="subsection-title" id="extends">Extends</h3> <dd class="argument-list"> <ul> <li><a href="#/apis/core/eventdispatcher">EventDispatcher</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="activateColumns"><span class="type-signature"></span>activateColumns<span class="signature">(activations, firstIndex, lastIndex)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">activations</div> <div class="type"> <span class="param-type">Array.<(boolean|undefined)></span> </div> </div> <div class="param"> <div class="name">firstIndex</div> <div class="type"> <span class="param-type">number</span> </div> </div> <div class="param"> <div class="name">lastIndex</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="disableConflation"><span class="type-signature"></span>disableConflation<span class="signature">(opt_disabled)</span><span class="type-signature"></span></h4> <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> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="disableDataBinding"><span class="type-signature"></span>disableDataBinding<span class="signature">(opt_disabled<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_disabled</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="enableColumnVirtualization"><span class="type-signature"></span>enableColumnVirtualization<span class="signature">(opt_enabled<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">opt_enabled</div> <div class="type"> <span class="param-type">boolean</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="extendDataEventArg"><span class="type-signature"></span>extendDataEventArg<span class="signature">(e<span class="signature-attributes">opt</span>, begin<span class="signature-attributes">opt</span>, end<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">e</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> </div> <div class="param"> <div class="name">begin</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> INCLUSIVE. The value can be undefined or NaN </div> </div> <div class="param"> <div class="name">end</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> INCLUSIVE. The value can be undefined or NaN </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="extendEventArg"><span class="type-signature"></span>extendEventArg<span class="signature">(e<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">e</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Object</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="extendRenderEventArg"><span class="type-signature"></span>extendRenderEventArg<span class="signature">(e, fromR, toR)</span><span class="type-signature"> → {Object}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">e</div> <div class="type"> <span class="param-type">Object</span> </div> </div> <div class="param"> <div class="name">fromR</div> <div class="type"> <span class="param-type">number</span> </div> </div> <div class="param"> <div class="name">toR</div> <div class="type"> <span class="param-type">number</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Object</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getAutoSyncRowCount"><span class="type-signature"></span>getAutoSyncRowCount<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> When the parameter is not specifically set by user, The mode will be switched automatically based on SectionSettings type </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="getChildren"><span class="type-signature"></span>getChildren<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="#/apis/core/sectionsettings">SectionSettings</a>>}</span></h4> <div class="description"> Clone a copy of the list of SectionSettingss. If there is no tree relationship, return null </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<<a href="#/apis/core/sectionsettings">SectionSettings</a>></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getData"><span class="type-signature"></span>getData<span class="signature">(colName, rowRef)</span><span class="type-signature"> → {*}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colName</div> <div class="type"> <span class="param-type">string</span> </div> </div> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">string</span> </div> <div class="description"> Number is treated as row index relative to this section data view. String is data view row id </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">*</span> </div><div class="sub-content-desc"> Returns undefined if not success</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getDataChangedConflator"><span class="type-signature"></span>getDataChangedConflator<span class="signature">()</span><span class="type-signature"> → {<a href="#">Conflator</a>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#">Conflator</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getDataSource"><span class="type-signature"></span>getDataSource<span class="signature">()</span><span class="type-signature"> → {<a href="#/apis/core/dataview">DataView</a>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/core/dataview">DataView</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getId"><span class="type-signature"></span>getId<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="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="getParent"><span class="type-signature"></span>getParent<span class="signature">()</span><span class="type-signature"> → {<a href="#/apis/core/sectionsettings">SectionSettings</a>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/core/sectionsettings">SectionSettings</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getRootDataSource"><span class="type-signature"></span>getRootDataSource<span class="signature">()</span><span class="type-signature"> → {<a href="#/apis/core/datatable">DataTable</a>|<a href="#/apis/core/dataview">DataView</a>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/core/datatable">DataTable</a></span> | <span class="param-type"><a href="#/apis/core/dataview">DataView</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getRowData"><span class="type-signature"></span>getRowData<span class="signature">(rowRef)</span><span class="type-signature"> → {Object.<string, *>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">string</span> </div> <div class="description"> Row Index of the display section or row id of the data table </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Object.<string, *></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getSection"><span class="type-signature"></span>getSection<span class="signature">()</span><span class="type-signature"> → {<a href="#/apis/core/ilayoutgrid">ILayoutGrid</a>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/core/ilayoutgrid">ILayoutGrid</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getSectionName"><span class="type-signature"></span>getSectionName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getType"><span class="type-signature"></span>getType<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="isBinding"><span class="type-signature"></span>isBinding<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="listen"><span class="type-signature"></span>listen<span class="signature">(type, handler, opt_priority<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">type</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> </div> <div class="description"> Any event provided by derived class </div> </div> <div class="param"> <div class="name">handler</div> <div class="type"> <span class="param-type">function</span> </div> <div class="attributes"> </div> <div class="description"> Callback method </div> </div> <div class="param"> <div class="name">opt_priority</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> The higher the priority, the sooner the listener get executed. Undefined priority listener will be executed last </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/eventdispatcher#listen">EventDispatcher#listen</a> </dd> </div> <h5>Example:</h5> <pre><code>var grid = new Grid();
grid.listen("click", function(e) { console.log("Grid is clicked"); });</code></pre> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeRowData"><span class="type-signature"></span>removeRowData<span class="signature">(rowRef)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">string</span> </div> <div class="description"> Row Index of the display section or row id of the data table </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> Returns true for successful data removing</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="rerender"><span class="type-signature"></span>rerender<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Rerender section content. If the section is bound with the data source, dataChanged event is fired. Otherwise, rowAvailable event is fired instead. </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setAutoSyncRowCount"><span class="type-signature"></span>setAutoSyncRowCount<span class="signature">(bool)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">bool</div> <div class="type"> <span class="param-type">boolean</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setData"><span class="type-signature"></span>setData<span class="signature">(colName, rowRef, data)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">colName</div> <div class="type"> <span class="param-type">string</span> </div> </div> <div class="param"> <div class="name">rowRef</div> <div class="type"> <span class="param-type">number</span> | <span class="param-type">string</span> </div> <div class="description"> Number is treated as row index relative to this section data view. String is data view row id </div> </div> <div class="param"> <div class="name">data</div> <div class="type"> <span class="param-type">*</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> Returns true for successful data setting</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setDataSource"><span class="type-signature"></span>setDataSource<span class="signature">(dataView)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">dataView</div> <div class="type"> <span class="param-type"><a href="#/apis/core/dataview">DataView</a></span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setId"><span class="type-signature"></span>setId<span class="signature">(str<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">str</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setType"><span class="type-signature"></span>setType<span class="signature">(type)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">type</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="snapshot"><span class="type-signature"></span>snapshot<span class="signature">(clone)</span><span class="type-signature"></span></h4> <div class="description"> Regenerate the section (UI part) on a different object </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">clone</div> <div class="type"> <span class="param-type"><a href="#/apis/core/ilayoutgrid">ILayoutGrid</a></span> </div> <div class="description"> A LayoutGrid that will be rendered </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="unlisten"><span class="type-signature"></span>unlisten<span class="signature">(type, handler)</span><span class="type-signature"></span></h4> <div class="description"> Removes an event listener which was added with listen(). The same function handler must be sent in, or else it will not be removed </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">type</div> <div class="type"> <span class="param-type">string</span> </div> <div class="description"> The name of the event without the 'on' prefix. </div> </div> <div class="param"> <div class="name">handler</div> <div class="type"> <span class="param-type">function</span> </div> <div class="description"> The listener function to remove. </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/eventdispatcher#unlisten">EventDispatcher#unlisten</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="unlistenAll"><span class="type-signature"></span>unlistenAll<span class="signature">(type<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Removes all listeners from an object. If no type is specified, it will remove all listeners that have been registered. <br>You can also optionally remove listeners of a particular type. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">type</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Type of event to, default is all types. </div> </div> </div> <div class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"> <a href="#/apis/core/eventdispatcher#unlistenAll">EventDispatcher#unlistenAll</a> </dd> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="updateRowData"><span class="type-signature"></span>updateRowData<span class="signature">(fromRowIndex<span class="signature-attributes">opt</span>, lastRowIndex<span class="signature-attributes">opt</span>, e<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Fires data binding event without actual change in the data source.This will force visual elements to be re-rendered with the latest data in the data source. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">fromRowIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> INCLUSIVE If the value is undefined, the first row index will be used </div> </div> <div class="param"> <div class="name">lastRowIndex</div> <div class="type"> <span class="param-type">number</span> </div> <div class="attributes"> <optional> </div> <div class="description"> INCLUSIVE If the value is undefined, the last row index will be used </div> </div> <div class="param"> <div class="name">e</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Additional parameters to be fired with the event </div> </div> </div> <div class="details"> </div> </div> </article></section></div></div>