-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtemplate-24.html
63 lines (62 loc) · 60.6 KB
/
template-24.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<link rel="stylesheet" href="./resources/styles/elf-template.css">
<h1 id="rowdefinition">RowDefinition</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>RowDefinition<span class="signature">(rowOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h1> </header><article> <div class="container-overview">
<div class="item"> <div class="item-type">class</div> <h4 class="name" id="RowDefinition"><span class="type-signature"></span>new RowDefinition<span class="signature">(rowOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowOptions</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition#~Options">RowDefinition~Options</a></span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div> </div> <h3 class="subsection-title" id="type_definitions">Type Definitions</h3>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~Options">Options</h4><div class="description"> RowDefinition options</div> <h5>Type:</h5> <span class="param-type">Object</span> <h5>Properties:</h5> <div class="props"><table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>ric</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> "" </td> <td class="description last">RIC for real-time fields. Prefixing 0# to the ric is equivalent to specifying asChain property.</td> </tr> <tr> <td class="name"><code>permId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> "" </td> <td class="description last">Organization PermId to be used instead of ric for private company.</td> </tr> <tr> <td class="name"><code>values</code></td> <td class="type"> <span class="param-type">Array</span> | <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Values for static data</td> </tr> <tr> <td class="name"><code>fields</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">Field that corresponds to the given static values</td> </tr> <tr> <td class="name"><code>asChain</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last">The given ric will be treated as a chain</td> </tr> <tr> <td class="name"><code>chainRic</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> "" </td> <td class="description last">RIC to be used for chain request (overiding ric property)</td> </tr> <tr> <td class="name"><code>collapsed</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Chain is collapsed by default. Segment is expanded by default.</td> </tr> <tr> <td class="name"><code>label</code></td> <td class="type"> <span class="param-type">string</span> | <span class="param-type">null</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>hidden</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last">When this row is hidden</td> </tr> <tr> <td class="name"><code>realTime</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last">Realtime row, able to request for JET/RTK</td> </tr> <tr> <td class="name"><code>info</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last">For storing any additional information to the row</td> </tr> <tr> <td class="name"><code>rowId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Row identifier used for referencing the row. The value cannot be in "_x_" format.</td> </tr> </tbody></table></div><div class="details"> </div></div>
<div class="item"> <div class="item-type">typedef</div> <h4 class="name" id="~RowTypes">RowTypes</h4> <h5>Type:</h5> <span class="param-type">Object</span> <h5>Properties:</h5> <div class="props"><table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>CONTENT</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> "CONTENT" </td> <td class="description last">Regular row</td> </tr> <tr> <td class="name"><code>CHAIN</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> "CHAIN" </td> <td class="description last">Chain RIC row</td> </tr> <tr> <td class="name"><code>CONSTITUENT</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> "CONSTITUENT" </td> <td class="description last">Constituent row</td> </tr> <tr> <td class="name"><code>GROUP_HEADER</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> "GROUP_HEADER" </td> <td class="description last">Row of segment separator at the very top</td> </tr> <tr> <td class="name"><code>SUBGROUP_HEADER</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> "SUBGROUP_HEADER" </td> <td class="description last">Row of nested segment separator</td> </tr> <tr> <td class="name"><code>GROUP_MEMBER</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> "GROUP_MEMBER" </td> <td class="description last">Child row displayed under segment separator</td> </tr> </tbody></table></div><div class="details"> </div></div> <h3 class="subsection-title" id="methods">Methods</h3>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id=".dispose"><span class="type-signature"></span>dispose<span class="signature">(rowDef)</span><span class="type-signature"></span></h4> <div class="description"> For mapping row Id by Array.map() </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowDef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition">RowDefinition</a></span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id=".hasChain"><span class="type-signature"></span>hasChain<span class="signature">(rowDef)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowDef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition">RowDefinition</a></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=".toRowId"><span class="type-signature"></span>toRowId<span class="signature">(rowDef)</span><span class="type-signature"> → {string}</span></h4> <div class="description"> For mapping row Id by Array.map() </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowDef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition">RowDefinition</a></span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div><div class="sub-content-desc"> Row Id will never be empty string unless the row has been removed</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="addUpdate"><span class="type-signature"></span>addUpdate<span class="signature">(changes)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Take event argument from streaming update with "changes" array property </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">changes</div> <div class="type"> <span class="param-type">Object</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> Returns true if there is any change</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="cloneRowData"><span class="type-signature"></span>cloneRowData<span class="signature">(obj<span class="signature-attributes">opt</span>, exceptionObj<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">obj</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> </div> <div class="param"> <div class="name">exceptionObj</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="collapseChain"><span class="type-signature"></span>collapseChain<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 class="sub-content-desc"> Returns true if there is a change in view</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="copyRowData"><span class="type-signature"></span>copyRowData<span class="signature">(srcRowDef)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">srcRowDef</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition">RowDefinition</a></span> </div> <div class="description"> Original source of row data to be copied from </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="countChildInView"><span class="type-signature"></span>countChildInView<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="dispose"><span class="type-signature"></span>dispose<span class="signature">()</span><span class="type-signature"></span></h4> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="expandChain"><span class="type-signature"></span>expandChain<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 class="sub-content-desc"> Returns true if there is a change in view</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getAllDescendantIds"><span class="type-signature"></span>getAllDescendantIds<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> <div class="description"> Get rowIds of all descendants (i.e. children and nested children). </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<string></span> </div><div class="sub-content-desc"> Null if there is no row Id</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getChildCount"><span class="type-signature"></span>getChildCount<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="getChildren"><span class="type-signature"></span>getChildren<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getConfigObject"><span class="type-signature"></span>getConfigObject<span class="signature">(rowOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="#/apis/rt-grid/rowdefinition#~Options">RowDefinition~Options</a>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowOptions</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition#~Options">RowDefinition~Options</a></span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition#~Options">RowDefinition~Options</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">(field)</span><span class="type-signature"> → {*}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">field</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">*</span> </div><div class="sub-content-desc"> data</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getDataId"><span class="type-signature"></span>getDataId<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="description"> Data id is deprecated </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div><div class="sub-content-desc"> Always return empty string</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"> → {DataCache}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">DataCache</span> </div><div class="sub-content-desc"> dataSource</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getDepthLevel"><span class="type-signature"></span>getDepthLevel<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="getDescendants"><span class="type-signature"></span>getDescendants<span class="signature">(ary<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>>}</span></h4> <div class="description"> Get all descendants (i.e. children and nested children). </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">ary</div> <div class="type"> <span class="param-type">Array.<<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>></span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>></span> </div><div class="sub-content-desc"> Flat list of row definitions. The order is corresponded to the order of the rows in the view</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getDisplayText"><span class="type-signature"></span>getDisplayText<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="getLabel"><span class="type-signature"></span>getLabel<span class="signature">()</span><span class="type-signature"> → {string|null}</span></h4> <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>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getParent"><span class="type-signature"></span>getParent<span class="signature">()</span><span class="type-signature"> → {<a href="#/apis/rt-grid/rowdefinition">RowDefinition</a>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition">RowDefinition</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getPermId"><span class="type-signature"></span>getPermId<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="getRic"><span class="type-signature"></span>getRic<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="getRowData"><span class="type-signature"></span>getRowData<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Object</span> </div><div class="sub-content-desc"> rowData</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getRowId"><span class="type-signature"></span>getRowId<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">string</span> </div><div class="sub-content-desc"> Row Id will never be empty string unless the row has been removed</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getRowInfo"><span class="type-signature"></span>getRowInfo<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Object</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getSubId"><span class="type-signature"></span>getSubId<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="getSymbol"><span class="type-signature"></span>getSymbol<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="getUpdates"><span class="type-signature"></span>getUpdates<span class="signature">()</span><span class="type-signature"> → {Object.<string, number>}</span></h4> <div class="description"> If there is no update, this method returns null </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Object.<string, number></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getUserInput"><span class="type-signature"></span>getUserInput<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="initialize"><span class="type-signature"></span>initialize<span class="signature">(rowOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rowOptions</div> <div class="type"> <span class="param-type"><a href="#/apis/rt-grid/rowdefinition#~Options">RowDefinition~Options</a></span> </div> <div class="attributes"> <optional> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="isAutoGenerated"><span class="type-signature"></span>isAutoGenerated<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="isChain"><span class="type-signature"></span>isChain<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="isChainCollapsed"><span class="type-signature"></span>isChainCollapsed<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="isChainExpanded"><span class="type-signature"></span>isChainExpanded<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="isConstituent"><span class="type-signature"></span>isConstituent<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="isDisposed"><span class="type-signature"></span>isDisposed<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="isRealTimeRow"><span class="type-signature"></span>isRealTimeRow<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="isRowHeader"><span class="type-signature"></span>isRowHeader<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="isSubscribing"><span class="type-signature"></span>isSubscribing<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="registerToView"><span class="type-signature"></span>registerToView<span class="signature">(view, destRowId<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">view</div> <div class="type"> <span class="param-type">DataView</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">destRowId</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Destination position where the row will be placed BEFORE the specified position </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 registration</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="resetRowData"><span class="type-signature"></span>resetRowData<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="resetUpdates"><span class="type-signature"></span>resetUpdates<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="setData"><span class="type-signature"></span>setData<span class="signature">(field, value)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">field</div> <div class="type"> <span class="param-type">string</span> </div> </div> <div class="param"> <div class="name">value</div> <div class="type"> <span class="param-type">*</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setDataSource"><span class="type-signature"></span>setDataSource<span class="signature">(dataSource, subs<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> This method should always be called right after the initialization </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">dataSource</div> <div class="type"> <span class="param-type">DataCache</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">subs</div> <div class="type"> <span class="param-type">Object</span> </div> <div class="attributes"> <optional> </div> <div class="description"> Quotes2 subscription object </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 if there is an data update</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setRowData"><span class="type-signature"></span>setRowData<span class="signature">(data)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">data</div> <div class="type"> <span class="param-type">Object.<string, *></span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setRowInfo"><span class="type-signature"></span>setRowInfo<span class="signature">(obj)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">obj</div> <div class="type"> <span class="param-type">Object</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setStaticData"><span class="type-signature"></span>setStaticData<span class="signature">(field, value)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">field</div> <div class="type"> <span class="param-type">string</span> </div> </div> <div class="param"> <div class="name">value</div> <div class="type"> <span class="param-type">*</span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="setStaticRowData"><span class="type-signature"></span>setStaticRowData<span class="signature">(data, indexToFieldMap<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> This method replaces all existing static data by the given data -- all existing static data are removed. </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">data</div> <div class="type"> <span class="param-type">Object.<string, *></span> | <span class="param-type">Array</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">indexToFieldMap</div> <div class="type"> <span class="param-type">Array.<string></span> </div> <div class="attributes"> <optional> </div> <div class="description"> In case of the given data is an array, this param will be used for mapping index to field </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="subscribeForUpdates"><span class="type-signature"></span>subscribeForUpdates<span class="signature">(subs<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">subs</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">boolean</span> </div><div class="sub-content-desc"> If a subscription is made, return true.</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="toggleChain"><span class="type-signature"></span>toggleChain<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Toggle between chain expanding and collapsing </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 if there is a change in view</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="unlinkChain"><span class="type-signature"></span>unlinkChain<span class="signature">()</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="unsubscribeForUpdates"><span class="type-signature"></span>unsubscribeForUpdates<span class="signature">(keepData<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {null}</span></h4> <div class="description"> Unsubscribe existing real-time data service. Static data is maintained </div> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">keepData</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">null</span> </div><div class="sub-content-desc"> Always return null</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">(data, indexToFieldMap<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">data</div> <div class="type"> <span class="param-type">Object.<string, *></span> | <span class="param-type">Array</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">indexToFieldMap</div> <div class="type"> <span class="param-type">Array.<string></span> </div> <div class="attributes"> <optional> </div> <div class="description"> In case of the given data is an array, this param will be used for mapping index to field </div> </div> </div> <div class="details"> </div> </div> </article></section></div></div>