fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
13.6 KiB288 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>LayoutEditorStateJson | 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="layouteditorstatejson.html">LayoutEditorStateJson</a>
60				</li>
61			</ul>
62			<h1>Interface LayoutEditorStateJson</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>Represents the current state of the Layout Editor in order to visualize it
73						properly.</p>
74					</div>
75				</div>
76			</section>
77			<section class="tsd-panel tsd-hierarchy">
78				<h3>Hierarchy</h3>
79				<ul class="tsd-hierarchy">
80					<li>
81						<span class="target">LayoutEditorStateJson</span>
82					</li>
83				</ul>
84			</section>
85			<section class="tsd-panel-group tsd-index-group">
86				<h2>Index</h2>
87				<section class="tsd-panel tsd-index-panel">
88					<div class="tsd-index-content">
89						<section class="tsd-index-section ">
90							<h3>Properties</h3>
91							<ul class="tsd-index-list">
92								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="layouteditorstatejson.html#buttons" class="tsd-kind-icon">buttons</a></li>
93								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="layouteditorstatejson.html#component_settings" class="tsd-kind-icon">component_<wbr>settings</a></li>
94								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="layouteditorstatejson.html#components" class="tsd-kind-icon">components</a></li>
95								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="layouteditorstatejson.html#general_settings" class="tsd-kind-icon">general_<wbr>settings</a></li>
96								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="layouteditorstatejson.html#selected_component" class="tsd-kind-icon">selected_<wbr>component</a></li>
97							</ul>
98						</section>
99					</div>
100				</section>
101			</section>
102			<section class="tsd-panel-group tsd-member-group ">
103				<h2>Properties</h2>
104				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
105					<a name="buttons" class="tsd-anchor"></a>
106					<h3>buttons</h3>
107					<div class="tsd-signature tsd-kind-icon">buttons<span class="tsd-signature-symbol">:</span> <a href="layouteditorbuttonsjson.html" class="tsd-signature-type">LayoutEditorButtonsJson</a></div>
108					<aside class="tsd-sources">
109						<ul>
110							<li>Defined in livesplit_core.ts:503</li>
111						</ul>
112					</aside>
113					<div class="tsd-comment tsd-typography">
114						<div class="lead">
115							<p>Describes which actions are currently available.</p>
116						</div>
117					</div>
118				</section>
119				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
120					<a name="component_settings" class="tsd-anchor"></a>
121					<h3>component_<wbr>settings</h3>
122					<div class="tsd-signature tsd-kind-icon">component_<wbr>settings<span class="tsd-signature-symbol">:</span> <a href="settingsdescriptionjson.html" class="tsd-signature-type">SettingsDescriptionJson</a></div>
123					<aside class="tsd-sources">
124						<ul>
125							<li>Defined in livesplit_core.ts:510</li>
126						</ul>
127					</aside>
128					<div class="tsd-comment tsd-typography">
129						<div class="lead">
130							<p>A generic description of the settings available for the selected
131							component and their current values.</p>
132						</div>
133					</div>
134				</section>
135				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
136					<a name="components" class="tsd-anchor"></a>
137					<h3>components</h3>
138					<div class="tsd-signature tsd-kind-icon">components<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
139					<aside class="tsd-sources">
140						<ul>
141							<li>Defined in livesplit_core.ts:501</li>
142						</ul>
143					</aside>
144					<div class="tsd-comment tsd-typography">
145						<div class="lead">
146							<p>The name of all the components in the layout.</p>
147						</div>
148					</div>
149				</section>
150				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
151					<a name="general_settings" class="tsd-anchor"></a>
152					<h3>general_<wbr>settings</h3>
153					<div class="tsd-signature tsd-kind-icon">general_<wbr>settings<span class="tsd-signature-symbol">:</span> <a href="settingsdescriptionjson.html" class="tsd-signature-type">SettingsDescriptionJson</a></div>
154					<aside class="tsd-sources">
155						<ul>
156							<li>Defined in livesplit_core.ts:515</li>
157						</ul>
158					</aside>
159					<div class="tsd-comment tsd-typography">
160						<div class="lead">
161							<p>A generic description of the general settings available for the layout
162							and their current values.</p>
163						</div>
164					</div>
165				</section>
166				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
167					<a name="selected_component" class="tsd-anchor"></a>
168					<h3>selected_<wbr>component</h3>
169					<div class="tsd-signature tsd-kind-icon">selected_<wbr>component<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
170					<aside class="tsd-sources">
171						<ul>
172							<li>Defined in livesplit_core.ts:505</li>
173						</ul>
174					</aside>
175					<div class="tsd-comment tsd-typography">
176						<div class="lead">
177							<p>The index of the currently selected component.</p>
178						</div>
179					</div>
180				</section>
181			</section>
182		</div>
183		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
184			<nav class="tsd-navigation primary">
185				<ul>
186					<li class="globals  ">
187						<a href="../globals.html"><em>Globals</em></a>
188					</li>
189				</ul>
190			</nav>
191			<nav class="tsd-navigation secondary menu-sticky">
192				<ul class="before-current">
193				</ul>
194				<ul class="current">
195					<li class="current tsd-kind-interface">
196						<a href="layouteditorstatejson.html" class="tsd-kind-icon">Layout<wbr>Editor<wbr>State<wbr>Json</a>
197						<ul>
198							<li class=" tsd-kind-property tsd-parent-kind-interface">
199								<a href="layouteditorstatejson.html#buttons" class="tsd-kind-icon">buttons</a>
200							</li>
201							<li class=" tsd-kind-property tsd-parent-kind-interface">
202								<a href="layouteditorstatejson.html#component_settings" class="tsd-kind-icon">component_<wbr>settings</a>
203							</li>
204							<li class=" tsd-kind-property tsd-parent-kind-interface">
205								<a href="layouteditorstatejson.html#components" class="tsd-kind-icon">components</a>
206							</li>
207							<li class=" tsd-kind-property tsd-parent-kind-interface">
208								<a href="layouteditorstatejson.html#general_settings" class="tsd-kind-icon">general_<wbr>settings</a>
209							</li>
210							<li class=" tsd-kind-property tsd-parent-kind-interface">
211								<a href="layouteditorstatejson.html#selected_component" class="tsd-kind-icon">selected_<wbr>component</a>
212							</li>
213						</ul>
214					</li>
215				</ul>
216				<ul class="after-current">
217				</ul>
218			</nav>
219		</div>
220	</div>
221</div>
222<footer class="with-border-bottom">
223	<div class="container">
224		<h2>Legend</h2>
225		<div class="tsd-legend-group">
226			<ul class="tsd-legend">
227				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
228				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
229				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
230				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
231				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
232				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
233				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
234			</ul>
235			<ul class="tsd-legend">
236				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
237				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
238				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
239				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
240			</ul>
241			<ul class="tsd-legend">
242				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
243				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
244				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
245				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
246				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
247				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
248			</ul>
249			<ul class="tsd-legend">
250				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
251				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
252				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
253				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
254				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
255				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
256				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
257			</ul>
258			<ul class="tsd-legend">
259				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
260				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
261				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
262				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
263			</ul>
264			<ul class="tsd-legend">
265				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
266				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
267				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
268			</ul>
269			<ul class="tsd-legend">
270				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
271				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
272				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
273			</ul>
274			<ul class="tsd-legend">
275				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
276				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
277			</ul>
278		</div>
279	</div>
280</footer>
281<div class="container tsd-generator">
282	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
283</div>
284<div class="overlay"></div>
285<script src="../assets/js/main.js"></script>
286<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
287</body>
288</html>