fork/livesplit-core

git clone https://git.julia.blue/fork/livesplit-core

Christopher SerrAdd docsee16b86

v0.11.0
35.3 KiB677 linesraw
1<!doctype html>
2<html class="default no-js">
3<head>
4	<meta charset="utf-8">
5	<meta http-equiv="X-UA-Compatible" content="IE=edge">
6	<title>SplitsComponent | livesplit</title>
7	<meta name="description" content="">
8	<meta name="viewport" content="width=device-width, initial-scale=1">
9	<link rel="stylesheet" href="../assets/css/main.css">
10</head>
11<body>
12<header>
13	<div class="tsd-page-toolbar">
14		<div class="container">
15			<div class="table-wrap">
16				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17					<div class="field">
18						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19						<input id="tsd-search-field" type="text" />
20					</div>
21					<ul class="results">
22						<li class="state loading">Preparing search index...</li>
23						<li class="state failure">The search index is not available</li>
24					</ul>
25					<a href="../index.html" class="title">livesplit</a>
26				</div>
27				<div class="table-cell" id="tsd-widgets">
28					<div id="tsd-filter">
29						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30						<div class="tsd-filter-group">
31							<div class="tsd-select" id="tsd-filter-visibility">
32								<span class="tsd-select-label">All</span>
33								<ul class="tsd-select-list">
34									<li data-value="public">Public</li>
35									<li data-value="protected">Public/Protected</li>
36									<li data-value="private" class="selected">All</li>
37								</ul>
38							</div>
39							<input type="checkbox" id="tsd-filter-inherited" checked />
40							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41							<input type="checkbox" id="tsd-filter-externals" checked />
42							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43							<input type="checkbox" id="tsd-filter-only-exported" />
44							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45						</div>
46					</div>
47					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48				</div>
49			</div>
50		</div>
51	</div>
52	<div class="tsd-page-title">
53		<div class="container">
54			<ul class="tsd-breadcrumb">
55				<li>
56					<a href="../globals.html">Globals</a>
57				</li>
58				<li>
59					<a href="splitscomponent.html">SplitsComponent</a>
60				</li>
61			</ul>
62			<h1>Class SplitsComponent</h1>
63		</div>
64	</div>
65</header>
66<div class="container container-main">
67	<div class="row">
68		<div class="col-8 col-content">
69			<section class="tsd-panel tsd-comment">
70				<div class="tsd-comment tsd-typography">
71					<div class="lead">
72						<p>The Splits Component is the main component for visualizing all the split
73							times. Each segment is shown in a tabular fashion showing the segment icon,
74							segment name, the delta compared to the chosen comparison, and the split
75							time. The list provides scrolling functionality, so not every segment needs
76						to be shown all the time.</p>
77					</div>
78				</div>
79			</section>
80			<section class="tsd-panel tsd-hierarchy">
81				<h3>Hierarchy</h3>
82				<ul class="tsd-hierarchy">
83					<li>
84						<a href="splitscomponentrefmut.html" class="tsd-signature-type">SplitsComponentRefMut</a>
85						<ul class="tsd-hierarchy">
86							<li>
87								<span class="target">SplitsComponent</span>
88							</li>
89						</ul>
90					</li>
91				</ul>
92			</section>
93			<section class="tsd-panel-group tsd-index-group">
94				<h2>Index</h2>
95				<section class="tsd-panel tsd-index-panel">
96					<div class="tsd-index-content">
97						<section class="tsd-index-section tsd-is-inherited">
98							<h3>Constructors</h3>
99							<ul class="tsd-index-list">
100								<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponent.html#constructor" class="tsd-kind-icon">constructor</a></li>
101							</ul>
102						</section>
103						<section class="tsd-index-section tsd-is-inherited">
104							<h3>Properties</h3>
105							<ul class="tsd-index-list">
106								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponent.html#ptr" class="tsd-kind-icon">ptr</a></li>
107							</ul>
108						</section>
109						<section class="tsd-index-section ">
110							<h3>Methods</h3>
111							<ul class="tsd-index-list">
112								<li class="tsd-kind-method tsd-parent-kind-class"><a href="splitscomponent.html#dispose" class="tsd-kind-icon">dispose</a></li>
113								<li class="tsd-kind-method tsd-parent-kind-class"><a href="splitscomponent.html#intogeneric" class="tsd-kind-icon">into<wbr>Generic</a></li>
114								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponent.html#scrolldown" class="tsd-kind-icon">scroll<wbr>Down</a></li>
115								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponent.html#scrollup" class="tsd-kind-icon">scroll<wbr>Up</a></li>
116								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponent.html#setalwaysshowlastsplit" class="tsd-kind-icon">set<wbr>Always<wbr>Show<wbr>Last<wbr>Split</a></li>
117								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponent.html#setseparatorlastsplit" class="tsd-kind-icon">set<wbr>Separator<wbr>Last<wbr>Split</a></li>
118								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponent.html#setsplitpreviewcount" class="tsd-kind-icon">set<wbr>Split<wbr>Preview<wbr>Count</a></li>
119								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponent.html#setvisualsplitcount" class="tsd-kind-icon">set<wbr>Visual<wbr>Split<wbr>Count</a></li>
120								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponent.html#state" class="tsd-kind-icon">state</a></li>
121								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="splitscomponent.html#stateasjson" class="tsd-kind-icon">state<wbr>AsJson</a></li>
122								<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="splitscomponent.html#with" class="tsd-kind-icon">with</a></li>
123								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="splitscomponent.html#new" class="tsd-kind-icon">new</a></li>
124							</ul>
125						</section>
126					</div>
127				</section>
128			</section>
129			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
130				<h2>Constructors</h2>
131				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
132					<a name="constructor" class="tsd-anchor"></a>
133					<h3>constructor</h3>
134					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
135						<li class="tsd-signature tsd-kind-icon">new <wbr>Splits<wbr>Component<span class="tsd-signature-symbol">(</span>ptr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="splitscomponent.html" class="tsd-signature-type">SplitsComponent</a></li>
136					</ul>
137					<ul class="tsd-descriptions">
138						<li class="tsd-description">
139							<aside class="tsd-sources">
140								<p>Inherited from <a href="splitscomponentref.html">SplitsComponentRef</a>.<a href="splitscomponentref.html#constructor">constructor</a></p>
141								<ul>
142									<li>Defined in livesplit_core.ts:5749</li>
143								</ul>
144							</aside>
145							<div class="tsd-comment tsd-typography">
146								<div class="lead">
147									<p>This constructor is an implementation detail. Do not use this.</p>
148								</div>
149							</div>
150							<h4 class="tsd-parameters-title">Parameters</h4>
151							<ul class="tsd-parameters">
152								<li>
153									<h5>ptr: <span class="tsd-signature-type">number</span></h5>
154								</li>
155							</ul>
156							<h4 class="tsd-returns-title">Returns <a href="splitscomponent.html" class="tsd-signature-type">SplitsComponent</a></h4>
157						</li>
158					</ul>
159				</section>
160			</section>
161			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
162				<h2>Properties</h2>
163				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
164					<a name="ptr" class="tsd-anchor"></a>
165					<h3>ptr</h3>
166					<div class="tsd-signature tsd-kind-icon">ptr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
167					<aside class="tsd-sources">
168						<p>Inherited from <a href="splitscomponentref.html">SplitsComponentRef</a>.<a href="splitscomponentref.html#ptr">ptr</a></p>
169						<ul>
170							<li>Defined in livesplit_core.ts:5749</li>
171						</ul>
172					</aside>
173				</section>
174			</section>
175			<section class="tsd-panel-group tsd-member-group ">
176				<h2>Methods</h2>
177				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
178					<a name="dispose" class="tsd-anchor"></a>
179					<h3>dispose</h3>
180					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
181						<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
182					</ul>
183					<ul class="tsd-descriptions">
184						<li class="tsd-description">
185							<aside class="tsd-sources">
186								<ul>
187									<li>Defined in livesplit_core.ts:5896</li>
188								</ul>
189							</aside>
190							<div class="tsd-comment tsd-typography">
191								<div class="lead">
192									<p>Disposes the object, allowing it to clean up all of its memory. You need
193										to call this for every object that you don&#39;t use anymore and hasn&#39;t
194									already been disposed.</p>
195								</div>
196							</div>
197							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
198						</li>
199					</ul>
200				</section>
201				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
202					<a name="intogeneric" class="tsd-anchor"></a>
203					<h3>into<wbr>Generic</h3>
204					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
205						<li class="tsd-signature tsd-kind-icon">into<wbr>Generic<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="component.html" class="tsd-signature-type">Component</a></li>
206					</ul>
207					<ul class="tsd-descriptions">
208						<li class="tsd-description">
209							<aside class="tsd-sources">
210								<ul>
211									<li>Defined in livesplit_core.ts:5913</li>
212								</ul>
213							</aside>
214							<div class="tsd-comment tsd-typography">
215								<div class="lead">
216									<p>Converts the component into a generic component suitable for using with a
217									layout.</p>
218								</div>
219							</div>
220							<h4 class="tsd-returns-title">Returns <a href="component.html" class="tsd-signature-type">Component</a></h4>
221						</li>
222					</ul>
223				</section>
224				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
225					<a name="scrolldown" class="tsd-anchor"></a>
226					<h3>scroll<wbr>Down</h3>
227					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
228						<li class="tsd-signature tsd-kind-icon">scroll<wbr>Down<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
229					</ul>
230					<ul class="tsd-descriptions">
231						<li class="tsd-description">
232							<aside class="tsd-sources">
233								<p>Inherited from <a href="splitscomponentrefmut.html">SplitsComponentRefMut</a>.<a href="splitscomponentrefmut.html#scrolldown">scrollDown</a></p>
234								<ul>
235									<li>Defined in livesplit_core.ts:5813</li>
236								</ul>
237							</aside>
238							<div class="tsd-comment tsd-typography">
239								<div class="lead">
240									<p>Scrolls down the window of the segments that are shown. Doesn&#39;t move the
241									scroll window if it reaches the bottom of the segments.</p>
242								</div>
243							</div>
244							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
245						</li>
246					</ul>
247				</section>
248				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
249					<a name="scrollup" class="tsd-anchor"></a>
250					<h3>scroll<wbr>Up</h3>
251					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
252						<li class="tsd-signature tsd-kind-icon">scroll<wbr>Up<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
253					</ul>
254					<ul class="tsd-descriptions">
255						<li class="tsd-description">
256							<aside class="tsd-sources">
257								<p>Inherited from <a href="splitscomponentrefmut.html">SplitsComponentRefMut</a>.<a href="splitscomponentrefmut.html#scrollup">scrollUp</a></p>
258								<ul>
259									<li>Defined in livesplit_core.ts:5803</li>
260								</ul>
261							</aside>
262							<div class="tsd-comment tsd-typography">
263								<div class="lead">
264									<p>Scrolls up the window of the segments that are shown. Doesn&#39;t move the
265									scroll window if it reaches the top of the segments.</p>
266								</div>
267							</div>
268							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
269						</li>
270					</ul>
271				</section>
272				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
273					<a name="setalwaysshowlastsplit" class="tsd-anchor"></a>
274					<h3>set<wbr>Always<wbr>Show<wbr>Last<wbr>Split</h3>
275					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
276						<li class="tsd-signature tsd-kind-icon">set<wbr>Always<wbr>Show<wbr>Last<wbr>Split<span class="tsd-signature-symbol">(</span>alwaysShowLastSplit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
277					</ul>
278					<ul class="tsd-descriptions">
279						<li class="tsd-description">
280							<aside class="tsd-sources">
281								<p>Inherited from <a href="splitscomponentrefmut.html">SplitsComponentRefMut</a>.<a href="splitscomponentrefmut.html#setalwaysshowlastsplit">setAlwaysShowLastSplit</a></p>
282								<ul>
283									<li>Defined in livesplit_core.ts:5850</li>
284								</ul>
285							</aside>
286							<div class="tsd-comment tsd-typography">
287								<div class="lead">
288									<p>If not every segment is shown in the scrolling window of segments, then
289										this determines whether the final segment is always to be shown, as it
290										contains valuable information about the total duration of the chosen
291									comparison, which is often the runner&#39;s Personal Best.</p>
292								</div>
293							</div>
294							<h4 class="tsd-parameters-title">Parameters</h4>
295							<ul class="tsd-parameters">
296								<li>
297									<h5>alwaysShowLastSplit: <span class="tsd-signature-type">boolean</span></h5>
298								</li>
299							</ul>
300							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
301						</li>
302					</ul>
303				</section>
304				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
305					<a name="setseparatorlastsplit" class="tsd-anchor"></a>
306					<h3>set<wbr>Separator<wbr>Last<wbr>Split</h3>
307					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
308						<li class="tsd-signature tsd-kind-icon">set<wbr>Separator<wbr>Last<wbr>Split<span class="tsd-signature-symbol">(</span>separatorLastSplit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
309					</ul>
310					<ul class="tsd-descriptions">
311						<li class="tsd-description">
312							<aside class="tsd-sources">
313								<p>Inherited from <a href="splitscomponentrefmut.html">SplitsComponentRefMut</a>.<a href="splitscomponentrefmut.html#setseparatorlastsplit">setSeparatorLastSplit</a></p>
314								<ul>
315									<li>Defined in livesplit_core.ts:5862</li>
316								</ul>
317							</aside>
318							<div class="tsd-comment tsd-typography">
319								<div class="lead">
320									<p>If the last segment is to always be shown, this determines whether to
321										show a more pronounced separator in front of the last segment, if it is
322										not directly adjacent to the segment shown right before it in the
323									scrolling window.</p>
324								</div>
325							</div>
326							<h4 class="tsd-parameters-title">Parameters</h4>
327							<ul class="tsd-parameters">
328								<li>
329									<h5>separatorLastSplit: <span class="tsd-signature-type">boolean</span></h5>
330								</li>
331							</ul>
332							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
333						</li>
334					</ul>
335				</section>
336				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
337					<a name="setsplitpreviewcount" class="tsd-anchor"></a>
338					<h3>set<wbr>Split<wbr>Preview<wbr>Count</h3>
339					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
340						<li class="tsd-signature tsd-kind-icon">set<wbr>Split<wbr>Preview<wbr>Count<span class="tsd-signature-symbol">(</span>count<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
341					</ul>
342					<ul class="tsd-descriptions">
343						<li class="tsd-description">
344							<aside class="tsd-sources">
345								<p>Inherited from <a href="splitscomponentrefmut.html">SplitsComponentRefMut</a>.<a href="splitscomponentrefmut.html#setsplitpreviewcount">setSplitPreviewCount</a></p>
346								<ul>
347									<li>Defined in livesplit_core.ts:5838</li>
348								</ul>
349							</aside>
350							<div class="tsd-comment tsd-typography">
351								<div class="lead">
352									<p>If there&#39;s more segments than segments that are shown, the window
353										showing the segments automatically scrolls up and down when the current
354										segment changes. This count determines the minimum number of future
355										segments to be shown in this scrolling window when it automatically
356									scrolls.</p>
357								</div>
358							</div>
359							<h4 class="tsd-parameters-title">Parameters</h4>
360							<ul class="tsd-parameters">
361								<li>
362									<h5>count: <span class="tsd-signature-type">number</span></h5>
363								</li>
364							</ul>
365							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
366						</li>
367					</ul>
368				</section>
369				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
370					<a name="setvisualsplitcount" class="tsd-anchor"></a>
371					<h3>set<wbr>Visual<wbr>Split<wbr>Count</h3>
372					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
373						<li class="tsd-signature tsd-kind-icon">set<wbr>Visual<wbr>Split<wbr>Count<span class="tsd-signature-symbol">(</span>count<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
374					</ul>
375					<ul class="tsd-descriptions">
376						<li class="tsd-description">
377							<aside class="tsd-sources">
378								<p>Inherited from <a href="splitscomponentrefmut.html">SplitsComponentRefMut</a>.<a href="splitscomponentrefmut.html#setvisualsplitcount">setVisualSplitCount</a></p>
379								<ul>
380									<li>Defined in livesplit_core.ts:5825</li>
381								</ul>
382							</aside>
383							<div class="tsd-comment tsd-typography">
384								<div class="lead">
385									<p>The amount of segments to show in the list at any given time. If this is
386										set to 0, all the segments are shown. If this is set to a number lower
387										than the total amount of segments, only a certain window of all the
388									segments is shown. This window can scroll up or down.</p>
389								</div>
390							</div>
391							<h4 class="tsd-parameters-title">Parameters</h4>
392							<ul class="tsd-parameters">
393								<li>
394									<h5>count: <span class="tsd-signature-type">number</span></h5>
395								</li>
396							</ul>
397							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
398						</li>
399					</ul>
400				</section>
401				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
402					<a name="state" class="tsd-anchor"></a>
403					<h3>state</h3>
404					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
405						<li class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">(</span>timer<span class="tsd-signature-symbol">: </span><a href="timerref.html" class="tsd-signature-type">TimerRef</a>, layoutSettings<span class="tsd-signature-symbol">: </span><a href="generallayoutsettingsref.html" class="tsd-signature-type">GeneralLayoutSettingsRef</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="splitscomponentstate.html" class="tsd-signature-type">SplitsComponentState</a></li>
406					</ul>
407					<ul class="tsd-descriptions">
408						<li class="tsd-description">
409							<aside class="tsd-sources">
410								<p>Inherited from <a href="splitscomponentrefmut.html">SplitsComponentRefMut</a>.<a href="splitscomponentrefmut.html#state">state</a></p>
411								<ul>
412									<li>Defined in livesplit_core.ts:5786</li>
413								</ul>
414							</aside>
415							<div class="tsd-comment tsd-typography">
416								<div class="lead">
417									<p>Calculates the component&#39;s state based on the timer and layout settings
418									provided.</p>
419								</div>
420							</div>
421							<h4 class="tsd-parameters-title">Parameters</h4>
422							<ul class="tsd-parameters">
423								<li>
424									<h5>timer: <a href="timerref.html" class="tsd-signature-type">TimerRef</a></h5>
425								</li>
426								<li>
427									<h5>layoutSettings: <a href="generallayoutsettingsref.html" class="tsd-signature-type">GeneralLayoutSettingsRef</a></h5>
428								</li>
429							</ul>
430							<h4 class="tsd-returns-title">Returns <a href="splitscomponentstate.html" class="tsd-signature-type">SplitsComponentState</a></h4>
431						</li>
432					</ul>
433				</section>
434				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
435					<a name="stateasjson" class="tsd-anchor"></a>
436					<h3>state<wbr>AsJson</h3>
437					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
438						<li class="tsd-signature tsd-kind-icon">state<wbr>AsJson<span class="tsd-signature-symbol">(</span>timer<span class="tsd-signature-symbol">: </span><a href="timerref.html" class="tsd-signature-type">TimerRef</a>, layoutSettings<span class="tsd-signature-symbol">: </span><a href="generallayoutsettingsref.html" class="tsd-signature-type">GeneralLayoutSettingsRef</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
439					</ul>
440					<ul class="tsd-descriptions">
441						<li class="tsd-description">
442							<aside class="tsd-sources">
443								<p>Inherited from <a href="splitscomponentrefmut.html">SplitsComponentRefMut</a>.<a href="splitscomponentrefmut.html#stateasjson">stateAsJson</a></p>
444								<ul>
445									<li>Defined in livesplit_core.ts:5769</li>
446								</ul>
447							</aside>
448							<div class="tsd-comment tsd-typography">
449								<div class="lead">
450									<p>Encodes the component&#39;s state information as JSON.</p>
451								</div>
452							</div>
453							<h4 class="tsd-parameters-title">Parameters</h4>
454							<ul class="tsd-parameters">
455								<li>
456									<h5>timer: <a href="timerref.html" class="tsd-signature-type">TimerRef</a></h5>
457								</li>
458								<li>
459									<h5>layoutSettings: <a href="generallayoutsettingsref.html" class="tsd-signature-type">GeneralLayoutSettingsRef</a></h5>
460								</li>
461							</ul>
462							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
463						</li>
464					</ul>
465				</section>
466				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
467					<a name="with" class="tsd-anchor"></a>
468					<h3>with</h3>
469					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
470						<li class="tsd-signature tsd-kind-icon">with&lt;T&gt;<span class="tsd-signature-symbol">(</span>closure<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
471					</ul>
472					<ul class="tsd-descriptions">
473						<li class="tsd-description">
474							<aside class="tsd-sources">
475								<ul>
476									<li>Defined in livesplit_core.ts:5884</li>
477								</ul>
478							</aside>
479							<div class="tsd-comment tsd-typography">
480								<div class="lead">
481									<p>Allows for scoped usage of the object. The object is guaranteed to get
482										disposed once this function returns. You are free to dispose the object
483										early yourself anywhere within the scope. The scope&#39;s return value gets
484									carried to the outside of this function.</p>
485								</div>
486							</div>
487							<h4 class="tsd-type-parameters-title">Type parameters</h4>
488							<ul class="tsd-type-parameters">
489								<li>
490									<h4>T</h4>
491								</li>
492							</ul>
493							<h4 class="tsd-parameters-title">Parameters</h4>
494							<ul class="tsd-parameters">
495								<li>
496									<h5>closure: <span class="tsd-signature-type">function</span></h5>
497									<ul class="tsd-parameters">
498										<li class="tsd-parameter-siganture">
499											<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
500												<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><a href="splitscomponent.html" class="tsd-signature-type">SplitsComponent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
501											</ul>
502											<ul class="tsd-descriptions">
503												<li class="tsd-description">
504													<h4 class="tsd-parameters-title">Parameters</h4>
505													<ul class="tsd-parameters">
506														<li>
507															<h5>obj: <a href="splitscomponent.html" class="tsd-signature-type">SplitsComponent</a></h5>
508														</li>
509													</ul>
510													<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
511												</li>
512											</ul>
513										</li>
514									</ul>
515								</li>
516							</ul>
517							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
518						</li>
519					</ul>
520				</section>
521				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
522					<a name="new" class="tsd-anchor"></a>
523					<h3><span class="tsd-flag ts-flagStatic">Static</span> new</h3>
524					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
525						<li class="tsd-signature tsd-kind-icon">new<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="splitscomponent.html" class="tsd-signature-type">SplitsComponent</a></li>
526					</ul>
527					<ul class="tsd-descriptions">
528						<li class="tsd-description">
529							<aside class="tsd-sources">
530								<ul>
531									<li>Defined in livesplit_core.ts:5905</li>
532								</ul>
533							</aside>
534							<div class="tsd-comment tsd-typography">
535								<div class="lead">
536									<p>Creates a new Splits Component.</p>
537								</div>
538							</div>
539							<h4 class="tsd-returns-title">Returns <a href="splitscomponent.html" class="tsd-signature-type">SplitsComponent</a></h4>
540						</li>
541					</ul>
542				</section>
543			</section>
544		</div>
545		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
546			<nav class="tsd-navigation primary">
547				<ul>
548					<li class="globals  ">
549						<a href="../globals.html"><em>Globals</em></a>
550					</li>
551				</ul>
552			</nav>
553			<nav class="tsd-navigation secondary menu-sticky">
554				<ul class="before-current">
555				</ul>
556				<ul class="current">
557					<li class="current tsd-kind-class">
558						<a href="splitscomponent.html" class="tsd-kind-icon">Splits<wbr>Component</a>
559						<ul>
560							<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
561								<a href="splitscomponent.html#constructor" class="tsd-kind-icon">constructor</a>
562							</li>
563							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
564								<a href="splitscomponent.html#ptr" class="tsd-kind-icon">ptr</a>
565							</li>
566							<li class=" tsd-kind-method tsd-parent-kind-class">
567								<a href="splitscomponent.html#dispose" class="tsd-kind-icon">dispose</a>
568							</li>
569							<li class=" tsd-kind-method tsd-parent-kind-class">
570								<a href="splitscomponent.html#intogeneric" class="tsd-kind-icon">into<wbr>Generic</a>
571							</li>
572							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
573								<a href="splitscomponent.html#scrolldown" class="tsd-kind-icon">scroll<wbr>Down</a>
574							</li>
575							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
576								<a href="splitscomponent.html#scrollup" class="tsd-kind-icon">scroll<wbr>Up</a>
577							</li>
578							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
579								<a href="splitscomponent.html#setalwaysshowlastsplit" class="tsd-kind-icon">set<wbr>Always<wbr>Show<wbr>Last<wbr>Split</a>
580							</li>
581							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
582								<a href="splitscomponent.html#setseparatorlastsplit" class="tsd-kind-icon">set<wbr>Separator<wbr>Last<wbr>Split</a>
583							</li>
584							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
585								<a href="splitscomponent.html#setsplitpreviewcount" class="tsd-kind-icon">set<wbr>Split<wbr>Preview<wbr>Count</a>
586							</li>
587							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
588								<a href="splitscomponent.html#setvisualsplitcount" class="tsd-kind-icon">set<wbr>Visual<wbr>Split<wbr>Count</a>
589							</li>
590							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
591								<a href="splitscomponent.html#state" class="tsd-kind-icon">state</a>
592							</li>
593							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
594								<a href="splitscomponent.html#stateasjson" class="tsd-kind-icon">state<wbr>AsJson</a>
595							</li>
596							<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
597								<a href="splitscomponent.html#with" class="tsd-kind-icon">with</a>
598							</li>
599							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
600								<a href="splitscomponent.html#new" class="tsd-kind-icon">new</a>
601							</li>
602						</ul>
603					</li>
604				</ul>
605				<ul class="after-current">
606				</ul>
607			</nav>
608		</div>
609	</div>
610</div>
611<footer class="with-border-bottom">
612	<div class="container">
613		<h2>Legend</h2>
614		<div class="tsd-legend-group">
615			<ul class="tsd-legend">
616				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
617				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
618				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
619				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
620				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
621				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
622				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
623			</ul>
624			<ul class="tsd-legend">
625				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
626				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
627				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
628				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
629			</ul>
630			<ul class="tsd-legend">
631				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
632				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
633				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
634				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
635				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
636				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
637			</ul>
638			<ul class="tsd-legend">
639				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
640				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
641				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
642				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
643				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
644				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
645				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
646			</ul>
647			<ul class="tsd-legend">
648				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
649				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
650				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
651				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
652			</ul>
653			<ul class="tsd-legend">
654				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
655				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
656				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
657			</ul>
658			<ul class="tsd-legend">
659				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
660				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
661				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
662			</ul>
663			<ul class="tsd-legend">
664				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
665				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
666			</ul>
667		</div>
668	</div>
669</footer>
670<div class="container tsd-generator">
671	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
672</div>
673<div class="overlay"></div>
674<script src="../assets/js/main.js"></script>
675<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
676</body>
677</html>