fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
13.5 KiB287 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>SumOfBestComponentStateJson | 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="sumofbestcomponentstatejson.html">SumOfBestComponentStateJson</a>
60				</li>
61			</ul>
62			<h1>Interface SumOfBestComponentStateJson</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">SumOfBestComponentStateJson</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="sumofbestcomponentstatejson.html#background" class="tsd-kind-icon">background</a></li>
92								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="sumofbestcomponentstatejson.html#label_color" class="tsd-kind-icon">label_<wbr>color</a></li>
93								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="sumofbestcomponentstatejson.html#text" class="tsd-kind-icon">text</a></li>
94								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="sumofbestcomponentstatejson.html#time" class="tsd-kind-icon">time</a></li>
95								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="sumofbestcomponentstatejson.html#value_color" class="tsd-kind-icon">value_<wbr>color</a></li>
96							</ul>
97						</section>
98					</div>
99				</section>
100			</section>
101			<section class="tsd-panel-group tsd-member-group ">
102				<h2>Properties</h2>
103				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
104					<a name="background" class="tsd-anchor"></a>
105					<h3>background</h3>
106					<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>
107					<aside class="tsd-sources">
108						<ul>
109							<li>Defined in livesplit_core.ts:253</li>
110						</ul>
111					</aside>
112					<div class="tsd-comment tsd-typography">
113						<div class="lead">
114							<p>The background shown behind the component.</p>
115						</div>
116					</div>
117				</section>
118				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
119					<a name="label_color" class="tsd-anchor"></a>
120					<h3>label_<wbr>color</h3>
121					<div class="tsd-signature tsd-kind-icon">label_<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>
122					<aside class="tsd-sources">
123						<ul>
124							<li>Defined in livesplit_core.ts:258</li>
125						</ul>
126					</aside>
127					<div class="tsd-comment tsd-typography">
128						<div class="lead">
129							<p>The color of the label. If <code>null</code> is specified, the color is taken from
130							the layout.</p>
131						</div>
132					</div>
133				</section>
134				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
135					<a name="text" class="tsd-anchor"></a>
136					<h3>text</h3>
137					<div class="tsd-signature tsd-kind-icon">text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
138					<aside class="tsd-sources">
139						<ul>
140							<li>Defined in livesplit_core.ts:265</li>
141						</ul>
142					</aside>
143					<div class="tsd-comment tsd-typography">
144						<div class="lead">
145							<p>The label&#39;s text.</p>
146						</div>
147					</div>
148				</section>
149				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
150					<a name="time" class="tsd-anchor"></a>
151					<h3>time</h3>
152					<div class="tsd-signature tsd-kind-icon">time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
153					<aside class="tsd-sources">
154						<ul>
155							<li>Defined in livesplit_core.ts:267</li>
156						</ul>
157					</aside>
158					<div class="tsd-comment tsd-typography">
159						<div class="lead">
160							<p>The sum of best segments.</p>
161						</div>
162					</div>
163				</section>
164				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
165					<a name="value_color" class="tsd-anchor"></a>
166					<h3>value_<wbr>color</h3>
167					<div class="tsd-signature tsd-kind-icon">value_<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>
168					<aside class="tsd-sources">
169						<ul>
170							<li>Defined in livesplit_core.ts:263</li>
171						</ul>
172					</aside>
173					<div class="tsd-comment tsd-typography">
174						<div class="lead">
175							<p>The color of the value. If <code>null</code> is specified, the color is taken from
176							the layout.</p>
177						</div>
178					</div>
179				</section>
180			</section>
181		</div>
182		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
183			<nav class="tsd-navigation primary">
184				<ul>
185					<li class="globals  ">
186						<a href="../globals.html"><em>Globals</em></a>
187					</li>
188				</ul>
189			</nav>
190			<nav class="tsd-navigation secondary menu-sticky">
191				<ul class="before-current">
192				</ul>
193				<ul class="current">
194					<li class="current tsd-kind-interface">
195						<a href="sumofbestcomponentstatejson.html" class="tsd-kind-icon">Sum<wbr>OfBest<wbr>Component<wbr>State<wbr>Json</a>
196						<ul>
197							<li class=" tsd-kind-property tsd-parent-kind-interface">
198								<a href="sumofbestcomponentstatejson.html#background" class="tsd-kind-icon">background</a>
199							</li>
200							<li class=" tsd-kind-property tsd-parent-kind-interface">
201								<a href="sumofbestcomponentstatejson.html#label_color" class="tsd-kind-icon">label_<wbr>color</a>
202							</li>
203							<li class=" tsd-kind-property tsd-parent-kind-interface">
204								<a href="sumofbestcomponentstatejson.html#text" class="tsd-kind-icon">text</a>
205							</li>
206							<li class=" tsd-kind-property tsd-parent-kind-interface">
207								<a href="sumofbestcomponentstatejson.html#time" class="tsd-kind-icon">time</a>
208							</li>
209							<li class=" tsd-kind-property tsd-parent-kind-interface">
210								<a href="sumofbestcomponentstatejson.html#value_color" class="tsd-kind-icon">value_<wbr>color</a>
211							</li>
212						</ul>
213					</li>
214				</ul>
215				<ul class="after-current">
216				</ul>
217			</nav>
218		</div>
219	</div>
220</div>
221<footer class="with-border-bottom">
222	<div class="container">
223		<h2>Legend</h2>
224		<div class="tsd-legend-group">
225			<ul class="tsd-legend">
226				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
227				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
228				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
229				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
230				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
231				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
232				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
233			</ul>
234			<ul class="tsd-legend">
235				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
236				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
237				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
238				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
239			</ul>
240			<ul class="tsd-legend">
241				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
242				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
243				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
244				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
245				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
246				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
247			</ul>
248			<ul class="tsd-legend">
249				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
250				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
251				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
252				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
253				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
254				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
255				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
256			</ul>
257			<ul class="tsd-legend">
258				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
259				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
260				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
261				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
262			</ul>
263			<ul class="tsd-legend">
264				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
265				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
266				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
267			</ul>
268			<ul class="tsd-legend">
269				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
270				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
271				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
272			</ul>
273			<ul class="tsd-legend">
274				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
275				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
276			</ul>
277		</div>
278	</div>
279</footer>
280<div class="container tsd-generator">
281	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
282</div>
283<div class="overlay"></div>
284<script src="../assets/js/main.js"></script>
285<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
286</body>
287</html>