fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
17.1 KiB352 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>TitleComponentStateJson | 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="titlecomponentstatejson.html">TitleComponentStateJson</a>
60				</li>
61			</ul>
62			<h1>Interface TitleComponentStateJson</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">TitleComponentStateJson</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="titlecomponentstatejson.html#attempts" class="tsd-kind-icon">attempts</a></li>
92								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="titlecomponentstatejson.html#background" class="tsd-kind-icon">background</a></li>
93								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="titlecomponentstatejson.html#finished_runs" class="tsd-kind-icon">finished_<wbr>runs</a></li>
94								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="titlecomponentstatejson.html#icon_change" class="tsd-kind-icon">icon_<wbr>change</a></li>
95								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="titlecomponentstatejson.html#is_centered" class="tsd-kind-icon">is_<wbr>centered</a></li>
96								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="titlecomponentstatejson.html#line1" class="tsd-kind-icon">line1</a></li>
97								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="titlecomponentstatejson.html#line2" class="tsd-kind-icon">line2</a></li>
98								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="titlecomponentstatejson.html#text_color" class="tsd-kind-icon">text_<wbr>color</a></li>
99							</ul>
100						</section>
101					</div>
102				</section>
103			</section>
104			<section class="tsd-panel-group tsd-member-group ">
105				<h2>Properties</h2>
106				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
107					<a name="attempts" class="tsd-anchor"></a>
108					<h3>attempts</h3>
109					<div class="tsd-signature tsd-kind-icon">attempts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
110					<aside class="tsd-sources">
111						<ul>
112							<li>Defined in livesplit_core.ts:158</li>
113						</ul>
114					</aside>
115					<div class="tsd-comment tsd-typography">
116						<div class="lead">
117							<p>The amount of total attempts. If <code>null</code> is specified, the amount of total
118							attempts isn&#39;t supposed to be shown.</p>
119						</div>
120					</div>
121				</section>
122				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
123					<a name="background" class="tsd-anchor"></a>
124					<h3>background</h3>
125					<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>
126					<aside class="tsd-sources">
127						<ul>
128							<li>Defined in livesplit_core.ts:120</li>
129						</ul>
130					</aside>
131					<div class="tsd-comment tsd-typography">
132						<div class="lead">
133							<p>The background shown behind the component.</p>
134						</div>
135					</div>
136				</section>
137				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
138					<a name="finished_runs" class="tsd-anchor"></a>
139					<h3>finished_<wbr>runs</h3>
140					<div class="tsd-signature tsd-kind-icon">finished_<wbr>runs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
141					<aside class="tsd-sources">
142						<ul>
143							<li>Defined in livesplit_core.ts:153</li>
144						</ul>
145					</aside>
146					<div class="tsd-comment tsd-typography">
147						<div class="lead">
148							<p>The amount of successfully finished attempts. If <code>null</code> is specified, the
149							amount of successfully finished attempts isn&#39;t supposed to be shown.</p>
150						</div>
151					</div>
152				</section>
153				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
154					<a name="icon_change" class="tsd-anchor"></a>
155					<h3>icon_<wbr>change</h3>
156					<div class="tsd-signature tsd-kind-icon">icon_<wbr>change<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
157					<aside class="tsd-sources">
158						<ul>
159							<li>Defined in livesplit_core.ts:132</li>
160						</ul>
161					</aside>
162					<div class="tsd-comment tsd-typography">
163						<div class="lead">
164							<p>The game&#39;s icon encoded as a Data URL. This value is only specified
165								whenever the icon changes. If you explicitly want to query this value,
166								remount the component. The String itself may be empty. This indicates
167							that there is no icon.</p>
168						</div>
169					</div>
170				</section>
171				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
172					<a name="is_centered" class="tsd-anchor"></a>
173					<h3>is_<wbr>centered</h3>
174					<div class="tsd-signature tsd-kind-icon">is_<wbr>centered<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
175					<aside class="tsd-sources">
176						<ul>
177							<li>Defined in livesplit_core.ts:148</li>
178						</ul>
179					</aside>
180					<div class="tsd-comment tsd-typography">
181						<div class="lead">
182							<p>Specifies whether the title should centered or aligned to the left
183							instead.</p>
184						</div>
185					</div>
186				</section>
187				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
188					<a name="line1" class="tsd-anchor"></a>
189					<h3>line1</h3>
190					<div class="tsd-signature tsd-kind-icon">line1<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
191					<aside class="tsd-sources">
192						<ul>
193							<li>Defined in livesplit_core.ts:137</li>
194						</ul>
195					</aside>
196					<div class="tsd-comment tsd-typography">
197						<div class="lead">
198							<p>The first title line to show. This is either the game&#39;s name, or a
199							combination of the game&#39;s name and the category.</p>
200						</div>
201					</div>
202				</section>
203				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
204					<a name="line2" class="tsd-anchor"></a>
205					<h3>line2</h3>
206					<div class="tsd-signature tsd-kind-icon">line2<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
207					<aside class="tsd-sources">
208						<ul>
209							<li>Defined in livesplit_core.ts:143</li>
210						</ul>
211					</aside>
212					<div class="tsd-comment tsd-typography">
213						<div class="lead">
214							<p>By default the category name is shown on the second line. Based on the
215								settings, it can however instead be shown in a single line together with
216							the game name.</p>
217						</div>
218					</div>
219				</section>
220				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
221					<a name="text_color" class="tsd-anchor"></a>
222					<h3>text_<wbr>color</h3>
223					<div class="tsd-signature tsd-kind-icon">text_<wbr>color<span class="tsd-signature-symbol">:</span> <a href="../globals.html#color" class="tsd-signature-type">Color</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
224					<aside class="tsd-sources">
225						<ul>
226							<li>Defined in livesplit_core.ts:125</li>
227						</ul>
228					</aside>
229					<div class="tsd-comment tsd-typography">
230						<div class="lead">
231							<p>The color of the text. If <code>null</code> is specified, the color is taken from
232							the layout.</p>
233						</div>
234					</div>
235				</section>
236			</section>
237		</div>
238		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
239			<nav class="tsd-navigation primary">
240				<ul>
241					<li class="globals  ">
242						<a href="../globals.html"><em>Globals</em></a>
243					</li>
244				</ul>
245			</nav>
246			<nav class="tsd-navigation secondary menu-sticky">
247				<ul class="before-current">
248				</ul>
249				<ul class="current">
250					<li class="current tsd-kind-interface">
251						<a href="titlecomponentstatejson.html" class="tsd-kind-icon">Title<wbr>Component<wbr>State<wbr>Json</a>
252						<ul>
253							<li class=" tsd-kind-property tsd-parent-kind-interface">
254								<a href="titlecomponentstatejson.html#attempts" class="tsd-kind-icon">attempts</a>
255							</li>
256							<li class=" tsd-kind-property tsd-parent-kind-interface">
257								<a href="titlecomponentstatejson.html#background" class="tsd-kind-icon">background</a>
258							</li>
259							<li class=" tsd-kind-property tsd-parent-kind-interface">
260								<a href="titlecomponentstatejson.html#finished_runs" class="tsd-kind-icon">finished_<wbr>runs</a>
261							</li>
262							<li class=" tsd-kind-property tsd-parent-kind-interface">
263								<a href="titlecomponentstatejson.html#icon_change" class="tsd-kind-icon">icon_<wbr>change</a>
264							</li>
265							<li class=" tsd-kind-property tsd-parent-kind-interface">
266								<a href="titlecomponentstatejson.html#is_centered" class="tsd-kind-icon">is_<wbr>centered</a>
267							</li>
268							<li class=" tsd-kind-property tsd-parent-kind-interface">
269								<a href="titlecomponentstatejson.html#line1" class="tsd-kind-icon">line1</a>
270							</li>
271							<li class=" tsd-kind-property tsd-parent-kind-interface">
272								<a href="titlecomponentstatejson.html#line2" class="tsd-kind-icon">line2</a>
273							</li>
274							<li class=" tsd-kind-property tsd-parent-kind-interface">
275								<a href="titlecomponentstatejson.html#text_color" class="tsd-kind-icon">text_<wbr>color</a>
276							</li>
277						</ul>
278					</li>
279				</ul>
280				<ul class="after-current">
281				</ul>
282			</nav>
283		</div>
284	</div>
285</div>
286<footer class="with-border-bottom">
287	<div class="container">
288		<h2>Legend</h2>
289		<div class="tsd-legend-group">
290			<ul class="tsd-legend">
291				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
292				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
293				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
294				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
295				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
296				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
297				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
298			</ul>
299			<ul class="tsd-legend">
300				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
301				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
302				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
303				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
304			</ul>
305			<ul class="tsd-legend">
306				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
307				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
308				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
309				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
310				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
311				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
312			</ul>
313			<ul class="tsd-legend">
314				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
315				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
316				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
317				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
318				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
319				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
320				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
321			</ul>
322			<ul class="tsd-legend">
323				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
324				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
325				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
326				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
327			</ul>
328			<ul class="tsd-legend">
329				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
330				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
331				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
332			</ul>
333			<ul class="tsd-legend">
334				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
335				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
336				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
337			</ul>
338			<ul class="tsd-legend">
339				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
340				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
341			</ul>
342		</div>
343	</div>
344</footer>
345<div class="container tsd-generator">
346	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
347</div>
348<div class="overlay"></div>
349<script src="../assets/js/main.js"></script>
350<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
351</body>
352</html>