fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
13.0 KiB271 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>SplitsComponentStateJson | 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="splitscomponentstatejson.html">SplitsComponentStateJson</a>
60				</li>
61			</ul>
62			<h1>Interface SplitsComponentStateJson</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 state object describes the information to visualize for this component.</p>
73					</div>
74				</div>
75			</section>
76			<section class="tsd-panel tsd-hierarchy">
77				<h3>Hierarchy</h3>
78				<ul class="tsd-hierarchy">
79					<li>
80						<span class="target">SplitsComponentStateJson</span>
81					</li>
82				</ul>
83			</section>
84			<section class="tsd-panel-group tsd-index-group">
85				<h2>Index</h2>
86				<section class="tsd-panel tsd-index-panel">
87					<div class="tsd-index-content">
88						<section class="tsd-index-section ">
89							<h3>Properties</h3>
90							<ul class="tsd-index-list">
91								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="splitscomponentstatejson.html#current_split_gradient" class="tsd-kind-icon">current_<wbr>split_<wbr>gradient</a></li>
92								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="splitscomponentstatejson.html#icon_changes" class="tsd-kind-icon">icon_<wbr>changes</a></li>
93								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="splitscomponentstatejson.html#show_final_separator" class="tsd-kind-icon">show_<wbr>final_<wbr>separator</a></li>
94								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="splitscomponentstatejson.html#splits" class="tsd-kind-icon">splits</a></li>
95							</ul>
96						</section>
97					</div>
98				</section>
99			</section>
100			<section class="tsd-panel-group tsd-member-group ">
101				<h2>Properties</h2>
102				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
103					<a name="current_split_gradient" class="tsd-anchor"></a>
104					<h3>current_<wbr>split_<wbr>gradient</h3>
105					<div class="tsd-signature tsd-kind-icon">current_<wbr>split_<wbr>gradient<span class="tsd-signature-symbol">:</span> <a href="../globals.html#gradient" class="tsd-signature-type">Gradient</a></div>
106					<aside class="tsd-sources">
107						<ul>
108							<li>Defined in livesplit_core.ts:181</li>
109						</ul>
110					</aside>
111					<div class="tsd-comment tsd-typography">
112						<div class="lead">
113							<p>The gradient to show behind the current segment as an indicator of it
114							being the current segment.</p>
115						</div>
116					</div>
117				</section>
118				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
119					<a name="icon_changes" class="tsd-anchor"></a>
120					<h3>icon_<wbr>changes</h3>
121					<div class="tsd-signature tsd-kind-icon">icon_<wbr>changes<span class="tsd-signature-symbol">:</span> <a href="splitscomponenticonchangejson.html" class="tsd-signature-type">SplitsComponentIconChangeJson</a><span class="tsd-signature-symbol">[]</span></div>
122					<aside class="tsd-sources">
123						<ul>
124							<li>Defined in livesplit_core.ts:171</li>
125						</ul>
126					</aside>
127					<div class="tsd-comment tsd-typography">
128						<div class="lead">
129							<p>This list describes all the icon changes that happened. Each time a
130								segment is first shown or its icon changes, the new icon is provided in
131								this list. If necessary, you may remount this component to reset the
132							component into a state where these icons are provided again.</p>
133						</div>
134					</div>
135				</section>
136				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
137					<a name="show_final_separator" class="tsd-anchor"></a>
138					<h3>show_<wbr>final_<wbr>separator</h3>
139					<div class="tsd-signature tsd-kind-icon">show_<wbr>final_<wbr>separator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
140					<aside class="tsd-sources">
141						<ul>
142							<li>Defined in livesplit_core.ts:176</li>
143						</ul>
144					</aside>
145					<div class="tsd-comment tsd-typography">
146						<div class="lead">
147							<p>Describes whether a more pronounced separator should be shown in front of
148							the last segment provided.</p>
149						</div>
150					</div>
151				</section>
152				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
153					<a name="splits" class="tsd-anchor"></a>
154					<h3>splits</h3>
155					<div class="tsd-signature tsd-kind-icon">splits<span class="tsd-signature-symbol">:</span> <a href="splitstatejson.html" class="tsd-signature-type">SplitStateJson</a><span class="tsd-signature-symbol">[]</span></div>
156					<aside class="tsd-sources">
157						<ul>
158							<li>Defined in livesplit_core.ts:164</li>
159						</ul>
160					</aside>
161					<div class="tsd-comment tsd-typography">
162						<div class="lead">
163							<p>The list of all the segments to visualize.</p>
164						</div>
165					</div>
166				</section>
167			</section>
168		</div>
169		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
170			<nav class="tsd-navigation primary">
171				<ul>
172					<li class="globals  ">
173						<a href="../globals.html"><em>Globals</em></a>
174					</li>
175				</ul>
176			</nav>
177			<nav class="tsd-navigation secondary menu-sticky">
178				<ul class="before-current">
179				</ul>
180				<ul class="current">
181					<li class="current tsd-kind-interface">
182						<a href="splitscomponentstatejson.html" class="tsd-kind-icon">Splits<wbr>Component<wbr>State<wbr>Json</a>
183						<ul>
184							<li class=" tsd-kind-property tsd-parent-kind-interface">
185								<a href="splitscomponentstatejson.html#current_split_gradient" class="tsd-kind-icon">current_<wbr>split_<wbr>gradient</a>
186							</li>
187							<li class=" tsd-kind-property tsd-parent-kind-interface">
188								<a href="splitscomponentstatejson.html#icon_changes" class="tsd-kind-icon">icon_<wbr>changes</a>
189							</li>
190							<li class=" tsd-kind-property tsd-parent-kind-interface">
191								<a href="splitscomponentstatejson.html#show_final_separator" class="tsd-kind-icon">show_<wbr>final_<wbr>separator</a>
192							</li>
193							<li class=" tsd-kind-property tsd-parent-kind-interface">
194								<a href="splitscomponentstatejson.html#splits" class="tsd-kind-icon">splits</a>
195							</li>
196						</ul>
197					</li>
198				</ul>
199				<ul class="after-current">
200				</ul>
201			</nav>
202		</div>
203	</div>
204</div>
205<footer class="with-border-bottom">
206	<div class="container">
207		<h2>Legend</h2>
208		<div class="tsd-legend-group">
209			<ul class="tsd-legend">
210				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
211				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
212				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
213				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
214				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
215				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
216				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
217			</ul>
218			<ul class="tsd-legend">
219				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
220				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
221				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
222				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
223			</ul>
224			<ul class="tsd-legend">
225				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
226				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
227				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
228				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
229				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
230				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
231			</ul>
232			<ul class="tsd-legend">
233				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
234				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
235				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
236				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
237				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
238				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
239				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
240			</ul>
241			<ul class="tsd-legend">
242				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
243				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
244				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
245				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
246			</ul>
247			<ul class="tsd-legend">
248				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
249				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
250				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
251			</ul>
252			<ul class="tsd-legend">
253				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
254				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
255				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
256			</ul>
257			<ul class="tsd-legend">
258				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
259				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
260			</ul>
261		</div>
262	</div>
263</footer>
264<div class="container tsd-generator">
265	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
266</div>
267<div class="overlay"></div>
268<script src="../assets/js/main.js"></script>
269<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
270</body>
271</html>