fork/livesplit-core

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

Christopher SerrAdd docsee16b86

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