-
Notifications
You must be signed in to change notification settings - Fork 0
/
template-19.html
28 lines (27 loc) · 24.9 KB
/
template-19.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
<link rel="stylesheet" href="./resources/styles/elf-template.css">
<h1 id="segmentcollection">SegmentCollection</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>SegmentCollection<span class="signature">()</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="SegmentCollection"><span class="type-signature"></span>new SegmentCollection<span class="signature">()</span><span class="type-signature"></span></h4> <div class="details"> </div> </div> </div> <h3 class="subsection-title" id="methods">Methods</h3>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="addSegment"><span class="type-signature"></span>addSegment<span class="signature">(rid)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rid</div> <div class="type"> <span class="param-type">string</span> </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. Otherwise, returns false</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="addSegmentChild"><span class="type-signature"></span>addSegmentChild<span class="signature">(segmentId, rid)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">segmentId</div> <div class="type"> <span class="param-type">string</span> </div> </div> <div class="param"> <div class="name">rid</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">boolean</span> </div><div class="sub-content-desc"> Returns true if there is any change. Otherwise, returns false</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="addSegmentChildren"><span class="type-signature"></span>addSegmentChildren<span class="signature">(segmentId, rids)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">segmentId</div> <div class="type"> <span class="param-type">string</span> </div> </div> <div class="param"> <div class="name">rids</div> <div class="type"> <span class="param-type">Array.<string></span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> Returns true if there is any change. Otherwise, returns false</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="addSegments"><span class="type-signature"></span>addSegments<span class="signature">(rids)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rids</div> <div class="type"> <span class="param-type">Array.<string></span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> Returns true if there is any change. Otherwise, returns false</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="collapseSegment"><span class="type-signature"></span>collapseSegment<span class="signature">(segmentId, bool<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">segmentId</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">bool</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 class="sub-content-desc"> Returns true if there is any change. Otherwise, returns false</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="containsSegment"><span class="type-signature"></span>containsSegment<span class="signature">(rid)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rid</div> <div class="type"> <span class="param-type">string</span> </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="containsSegmentChild"><span class="type-signature"></span>containsSegmentChild<span class="signature">(segmentId, rid)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">segmentId</div> <div class="type"> <span class="param-type">string</span> </div> </div> <div class="param"> <div class="name">rid</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">boolean</span> </div><div class="sub-content-desc"> Returns true if there is any change. Otherwise, returns false</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="expandAllSegments"><span class="type-signature"></span>expandAllSegments<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 any change. Otherwise, returns false</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="expandSegment"><span class="type-signature"></span>expandSegment<span class="signature">(segmentId, bool<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">segmentId</div> <div class="type"> <span class="param-type">string</span> </div> <div class="attributes"> </div> </div> <div class="param"> <div class="name">bool</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="fillSegment"><span class="type-signature"></span>fillSegment<span class="signature">(segmentId, rids)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">segmentId</div> <div class="type"> <span class="param-type">string</span> </div> </div> <div class="param"> <div class="name">rids</div> <div class="type"> <span class="param-type">Array.<string></span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="fillSegments"><span class="type-signature"></span>fillSegments<span class="signature">(rids)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rids</div> <div class="type"> <span class="param-type">Array.<string></span> </div> </div> </div> <div class="details"> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getCollapsedRows"><span class="type-signature"></span>getCollapsedRows<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="getSegment"><span class="type-signature"></span>getSegment<span class="signature">(rid)</span><span class="type-signature"> → {<a href="#/apis/core/segment">Segment</a>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rid</div> <div class="type"> <span class="param-type">string</span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type"><a href="#/apis/core/segment">Segment</a></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getSegmentCount"><span class="type-signature"></span>getSegmentCount<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="getSegmentIds"><span class="type-signature"></span>getSegmentIds<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<string></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getSegments"><span class="type-signature"></span>getSegments<span class="signature">()</span><span class="type-signature"> → {Object.<string, <a href="#/apis/core/segment">Segment</a>>}</span></h4> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Object.<string, <a href="#/apis/core/segment">Segment</a>></span> </div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="getSegmentValues"><span class="type-signature"></span>getSegmentValues<span class="signature">(rids<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {Array.<number>}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rids</div> <div class="type"> <span class="param-type">Array.<string></span> </div> <div class="description"> Array of row ids </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">Array.<number></span> </div><div class="sub-content-desc"> Returns Array of segment values, if there are at least two segments, otherwise returns null</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="isCollapsedSegment"><span class="type-signature"></span>isCollapsedSegment<span class="signature">(segmentId)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">segmentId</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">boolean</span> </div><div class="sub-content-desc"> Returns true if there is any change. Otherwise, returns false</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeAllSegmentChildren"><span class="type-signature"></span>removeAllSegmentChildren<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 any change. Otherwise, returns false</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeAllSegments"><span class="type-signature"></span>removeAllSegments<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 any change. Otherwise, returns false</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeSegment"><span class="type-signature"></span>removeSegment<span class="signature">(rid)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">rid</div> <div class="type"> <span class="param-type">string</span> </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. Otherwise, returns false</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeSegmentChild"><span class="type-signature"></span>removeSegmentChild<span class="signature">(segmentId, rid)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">segmentId</div> <div class="type"> <span class="param-type">string</span> </div> </div> <div class="param"> <div class="name">rid</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">boolean</span> </div><div class="sub-content-desc"> Returns true if there is any change. Otherwise, returns false</div> </div>
<div class="item"> <div class="item-type">function</div> <h4 class="name" id="removeSegmentChildren"><span class="type-signature"></span>removeSegmentChildren<span class="signature">(segmentId, rids)</span><span class="type-signature"> → {boolean}</span></h4> <h5>Parameters:</h5> <div class="params"> <div class="param"> <div class="name">segmentId</div> <div class="type"> <span class="param-type">string</span> </div> </div> <div class="param"> <div class="name">rids</div> <div class="type"> <span class="param-type">Array.<string></span> </div> </div> </div> <div class="details"> </div> <h5>Returns:</h5> <div class="sub-content"> <span class="param-type">boolean</span> </div><div class="sub-content-desc"> Returns true if there is any change. Otherwise, returns false</div> </div> </article></section></div></div>