fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
15.1 KiB323 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>TimerComponentStateJson | 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="timercomponentstatejson.html">TimerComponentStateJson</a>
60				</li>
61			</ul>
62			<h1>Interface TimerComponentStateJson</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">TimerComponentStateJson</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="timercomponentstatejson.html#background" class="tsd-kind-icon">background</a></li>
92								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="timercomponentstatejson.html#bottom_color" class="tsd-kind-icon">bottom_<wbr>color</a></li>
93								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="timercomponentstatejson.html#fraction" class="tsd-kind-icon">fraction</a></li>
94								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="timercomponentstatejson.html#height" class="tsd-kind-icon">height</a></li>
95								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="timercomponentstatejson.html#semantic_color" class="tsd-kind-icon">semantic_<wbr>color</a></li>
96								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="timercomponentstatejson.html#time" class="tsd-kind-icon">time</a></li>
97								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="timercomponentstatejson.html#top_color" class="tsd-kind-icon">top_<wbr>color</a></li>
98							</ul>
99						</section>
100					</div>
101				</section>
102			</section>
103			<section class="tsd-panel-group tsd-member-group ">
104				<h2>Properties</h2>
105				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
106					<a name="background" class="tsd-anchor"></a>
107					<h3>background</h3>
108					<div class="tsd-signature tsd-kind-icon">background<span class="tsd-signature-symbol">:</span> <a href="../globals.html#gradient" class="tsd-signature-type">Gradient</a></div>
109					<aside class="tsd-sources">
110						<ul>
111							<li>Defined in livesplit_core.ts:102</li>
112						</ul>
113					</aside>
114					<div class="tsd-comment tsd-typography">
115						<div class="lead">
116							<p>The background shown behind the component.</p>
117						</div>
118					</div>
119				</section>
120				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
121					<a name="bottom_color" class="tsd-anchor"></a>
122					<h3>bottom_<wbr>color</h3>
123					<div class="tsd-signature tsd-kind-icon">bottom_<wbr>color<span class="tsd-signature-symbol">:</span> <a href="../globals.html#color" class="tsd-signature-type">Color</a></div>
124					<aside class="tsd-sources">
125						<ul>
126							<li>Defined in livesplit_core.ts:112</li>
127						</ul>
128					</aside>
129					<div class="tsd-comment tsd-typography">
130						<div class="lead">
131							<p>The bottom color of the timer&#39;s gradient.</p>
132						</div>
133					</div>
134				</section>
135				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
136					<a name="fraction" class="tsd-anchor"></a>
137					<h3>fraction</h3>
138					<div class="tsd-signature tsd-kind-icon">fraction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
139					<aside class="tsd-sources">
140						<ul>
141							<li>Defined in livesplit_core.ts:106</li>
142						</ul>
143					</aside>
144					<div class="tsd-comment tsd-typography">
145						<div class="lead">
146							<p>The fractional part of the time shown (including the dot).</p>
147						</div>
148					</div>
149				</section>
150				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
151					<a name="height" class="tsd-anchor"></a>
152					<h3>height</h3>
153					<div class="tsd-signature tsd-kind-icon">height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
154					<aside class="tsd-sources">
155						<ul>
156							<li>Defined in livesplit_core.ts:114</li>
157						</ul>
158					</aside>
159					<div class="tsd-comment tsd-typography">
160						<div class="lead">
161							<p>The height of the timer.</p>
162						</div>
163					</div>
164				</section>
165				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
166					<a name="semantic_color" class="tsd-anchor"></a>
167					<h3>semantic_<wbr>color</h3>
168					<div class="tsd-signature tsd-kind-icon">semantic_<wbr>color<span class="tsd-signature-symbol">:</span> <a href="../globals.html#semanticcolor" class="tsd-signature-type">SemanticColor</a></div>
169					<aside class="tsd-sources">
170						<ul>
171							<li>Defined in livesplit_core.ts:108</li>
172						</ul>
173					</aside>
174					<div class="tsd-comment tsd-typography">
175						<div class="lead">
176							<p>The semantic coloring information the time carries.</p>
177						</div>
178					</div>
179				</section>
180				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
181					<a name="time" class="tsd-anchor"></a>
182					<h3>time</h3>
183					<div class="tsd-signature tsd-kind-icon">time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
184					<aside class="tsd-sources">
185						<ul>
186							<li>Defined in livesplit_core.ts:104</li>
187						</ul>
188					</aside>
189					<div class="tsd-comment tsd-typography">
190						<div class="lead">
191							<p>The time shown by the component without the fractional part.</p>
192						</div>
193					</div>
194				</section>
195				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
196					<a name="top_color" class="tsd-anchor"></a>
197					<h3>top_<wbr>color</h3>
198					<div class="tsd-signature tsd-kind-icon">top_<wbr>color<span class="tsd-signature-symbol">:</span> <a href="../globals.html#color" class="tsd-signature-type">Color</a></div>
199					<aside class="tsd-sources">
200						<ul>
201							<li>Defined in livesplit_core.ts:110</li>
202						</ul>
203					</aside>
204					<div class="tsd-comment tsd-typography">
205						<div class="lead">
206							<p>The top color of the timer&#39;s gradient.</p>
207						</div>
208					</div>
209				</section>
210			</section>
211		</div>
212		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
213			<nav class="tsd-navigation primary">
214				<ul>
215					<li class="globals  ">
216						<a href="../globals.html"><em>Globals</em></a>
217					</li>
218				</ul>
219			</nav>
220			<nav class="tsd-navigation secondary menu-sticky">
221				<ul class="before-current">
222				</ul>
223				<ul class="current">
224					<li class="current tsd-kind-interface">
225						<a href="timercomponentstatejson.html" class="tsd-kind-icon">Timer<wbr>Component<wbr>State<wbr>Json</a>
226						<ul>
227							<li class=" tsd-kind-property tsd-parent-kind-interface">
228								<a href="timercomponentstatejson.html#background" class="tsd-kind-icon">background</a>
229							</li>
230							<li class=" tsd-kind-property tsd-parent-kind-interface">
231								<a href="timercomponentstatejson.html#bottom_color" class="tsd-kind-icon">bottom_<wbr>color</a>
232							</li>
233							<li class=" tsd-kind-property tsd-parent-kind-interface">
234								<a href="timercomponentstatejson.html#fraction" class="tsd-kind-icon">fraction</a>
235							</li>
236							<li class=" tsd-kind-property tsd-parent-kind-interface">
237								<a href="timercomponentstatejson.html#height" class="tsd-kind-icon">height</a>
238							</li>
239							<li class=" tsd-kind-property tsd-parent-kind-interface">
240								<a href="timercomponentstatejson.html#semantic_color" class="tsd-kind-icon">semantic_<wbr>color</a>
241							</li>
242							<li class=" tsd-kind-property tsd-parent-kind-interface">
243								<a href="timercomponentstatejson.html#time" class="tsd-kind-icon">time</a>
244							</li>
245							<li class=" tsd-kind-property tsd-parent-kind-interface">
246								<a href="timercomponentstatejson.html#top_color" class="tsd-kind-icon">top_<wbr>color</a>
247							</li>
248						</ul>
249					</li>
250				</ul>
251				<ul class="after-current">
252				</ul>
253			</nav>
254		</div>
255	</div>
256</div>
257<footer class="with-border-bottom">
258	<div class="container">
259		<h2>Legend</h2>
260		<div class="tsd-legend-group">
261			<ul class="tsd-legend">
262				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
263				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
264				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
265				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
266				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
267				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
268				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
269			</ul>
270			<ul class="tsd-legend">
271				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
272				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
273				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
274				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
275			</ul>
276			<ul class="tsd-legend">
277				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
278				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
279				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
280				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
281				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
282				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
283			</ul>
284			<ul class="tsd-legend">
285				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
286				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
287				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
288				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
289				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
290				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
291				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
292			</ul>
293			<ul class="tsd-legend">
294				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
295				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
296				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
297				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
298			</ul>
299			<ul class="tsd-legend">
300				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
301				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
302				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
303			</ul>
304			<ul class="tsd-legend">
305				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
306				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
307				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
308			</ul>
309			<ul class="tsd-legend">
310				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
311				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
312			</ul>
313		</div>
314	</div>
315</footer>
316<div class="container tsd-generator">
317	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
318</div>
319<div class="overlay"></div>
320<script src="../assets/js/main.js"></script>
321<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
322</body>
323</html>