fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
40.2 KiB772 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>LayoutEditor | 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="layouteditor.html">LayoutEditor</a>
60				</li>
61			</ul>
62			<h1>Class LayoutEditor</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 Layout Editor allows modifying Layouts while ensuring all the different
73							invariants of the Layout objects are upheld no matter what kind of
74							operations are being applied. It provides the current state of the editor as
75						state objects that can be visualized by any kind of User Interface.</p>
76					</div>
77				</div>
78			</section>
79			<section class="tsd-panel tsd-hierarchy">
80				<h3>Hierarchy</h3>
81				<ul class="tsd-hierarchy">
82					<li>
83						<a href="layouteditorrefmut.html" class="tsd-signature-type">LayoutEditorRefMut</a>
84						<ul class="tsd-hierarchy">
85							<li>
86								<span class="target">LayoutEditor</span>
87							</li>
88						</ul>
89					</li>
90				</ul>
91			</section>
92			<section class="tsd-panel-group tsd-index-group">
93				<h2>Index</h2>
94				<section class="tsd-panel tsd-index-panel">
95					<div class="tsd-index-content">
96						<section class="tsd-index-section tsd-is-inherited">
97							<h3>Constructors</h3>
98							<ul class="tsd-index-list">
99								<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="layouteditor.html#constructor" class="tsd-kind-icon">constructor</a></li>
100							</ul>
101						</section>
102						<section class="tsd-index-section tsd-is-inherited">
103							<h3>Properties</h3>
104							<ul class="tsd-index-list">
105								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="layouteditor.html#ptr" class="tsd-kind-icon">ptr</a></li>
106							</ul>
107						</section>
108						<section class="tsd-index-section ">
109							<h3>Methods</h3>
110							<ul class="tsd-index-list">
111								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="layouteditor.html#addcomponent" class="tsd-kind-icon">add<wbr>Component</a></li>
112								<li class="tsd-kind-method tsd-parent-kind-class"><a href="layouteditor.html#close" class="tsd-kind-icon">close</a></li>
113								<li class="tsd-kind-method tsd-parent-kind-class"><a href="layouteditor.html#dispose" class="tsd-kind-icon">dispose</a></li>
114								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="layouteditor.html#duplicatecomponent" class="tsd-kind-icon">duplicate<wbr>Component</a></li>
115								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="layouteditor.html#layoutstateasjson" class="tsd-kind-icon">layout<wbr>State<wbr>AsJson</a></li>
116								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="layouteditor.html#movecomponent" class="tsd-kind-icon">move<wbr>Component</a></li>
117								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="layouteditor.html#movecomponentdown" class="tsd-kind-icon">move<wbr>Component<wbr>Down</a></li>
118								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="layouteditor.html#movecomponentup" class="tsd-kind-icon">move<wbr>Component<wbr>Up</a></li>
119								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="layouteditor.html#removecomponent" class="tsd-kind-icon">remove<wbr>Component</a></li>
120								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="layouteditor.html#select" class="tsd-kind-icon">select</a></li>
121								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="layouteditor.html#setcomponentsettingsvalue" class="tsd-kind-icon">set<wbr>Component<wbr>Settings<wbr>Value</a></li>
122								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="layouteditor.html#setgeneralsettingsvalue" class="tsd-kind-icon">set<wbr>General<wbr>Settings<wbr>Value</a></li>
123								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="layouteditor.html#stateasjson" class="tsd-kind-icon">state<wbr>AsJson</a></li>
124								<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="layouteditor.html#with" class="tsd-kind-icon">with</a></li>
125								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="layouteditor.html#new" class="tsd-kind-icon">new</a></li>
126							</ul>
127						</section>
128					</div>
129				</section>
130			</section>
131			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
132				<h2>Constructors</h2>
133				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
134					<a name="constructor" class="tsd-anchor"></a>
135					<h3>constructor</h3>
136					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
137						<li class="tsd-signature tsd-kind-icon">new <wbr>Layout<wbr>Editor<span class="tsd-signature-symbol">(</span>ptr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="layouteditor.html" class="tsd-signature-type">LayoutEditor</a></li>
138					</ul>
139					<ul class="tsd-descriptions">
140						<li class="tsd-description">
141							<aside class="tsd-sources">
142								<p>Inherited from <a href="layouteditorref.html">LayoutEditorRef</a>.<a href="layouteditorref.html#constructor">constructor</a></p>
143								<ul>
144									<li>Defined in livesplit_core.ts:3160</li>
145								</ul>
146							</aside>
147							<div class="tsd-comment tsd-typography">
148								<div class="lead">
149									<p>This constructor is an implementation detail. Do not use this.</p>
150								</div>
151							</div>
152							<h4 class="tsd-parameters-title">Parameters</h4>
153							<ul class="tsd-parameters">
154								<li>
155									<h5>ptr: <span class="tsd-signature-type">number</span></h5>
156								</li>
157							</ul>
158							<h4 class="tsd-returns-title">Returns <a href="layouteditor.html" class="tsd-signature-type">LayoutEditor</a></h4>
159						</li>
160					</ul>
161				</section>
162			</section>
163			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
164				<h2>Properties</h2>
165				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
166					<a name="ptr" class="tsd-anchor"></a>
167					<h3>ptr</h3>
168					<div class="tsd-signature tsd-kind-icon">ptr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
169					<aside class="tsd-sources">
170						<p>Inherited from <a href="layouteditorref.html">LayoutEditorRef</a>.<a href="layouteditorref.html#ptr">ptr</a></p>
171						<ul>
172							<li>Defined in livesplit_core.ts:3150</li>
173						</ul>
174					</aside>
175				</section>
176			</section>
177			<section class="tsd-panel-group tsd-member-group ">
178				<h2>Methods</h2>
179				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
180					<a name="addcomponent" class="tsd-anchor"></a>
181					<h3>add<wbr>Component</h3>
182					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
183						<li class="tsd-signature tsd-kind-icon">add<wbr>Component<span class="tsd-signature-symbol">(</span>component<span class="tsd-signature-symbol">: </span><a href="component.html" class="tsd-signature-type">Component</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
184					</ul>
185					<ul class="tsd-descriptions">
186						<li class="tsd-description">
187							<aside class="tsd-sources">
188								<p>Inherited from <a href="layouteditorrefmut.html">LayoutEditorRefMut</a>.<a href="layouteditorrefmut.html#addcomponent">addComponent</a></p>
189								<ul>
190									<li>Defined in livesplit_core.ts:3206</li>
191								</ul>
192							</aside>
193							<div class="tsd-comment tsd-typography">
194								<div class="lead">
195									<p>Adds the component provided to the end of the layout. The newly added
196									component becomes the selected component.</p>
197								</div>
198							</div>
199							<h4 class="tsd-parameters-title">Parameters</h4>
200							<ul class="tsd-parameters">
201								<li>
202									<h5>component: <a href="component.html" class="tsd-signature-type">Component</a></h5>
203								</li>
204							</ul>
205							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
206						</li>
207					</ul>
208				</section>
209				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
210					<a name="close" class="tsd-anchor"></a>
211					<h3>close</h3>
212					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
213						<li class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="layout.html" class="tsd-signature-type">Layout</a></li>
214					</ul>
215					<ul class="tsd-descriptions">
216						<li class="tsd-description">
217							<aside class="tsd-sources">
218								<ul>
219									<li>Defined in livesplit_core.ts:3356</li>
220								</ul>
221							</aside>
222							<div class="tsd-comment tsd-typography">
223								<div class="lead">
224									<p>Closes the Layout Editor and gives back access to the modified Layout. In
225										case you want to implement a Cancel Button, just dispose the Layout object
226									you get here.</p>
227								</div>
228							</div>
229							<h4 class="tsd-returns-title">Returns <a href="layout.html" class="tsd-signature-type">Layout</a></h4>
230						</li>
231					</ul>
232				</section>
233				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
234					<a name="dispose" class="tsd-anchor"></a>
235					<h3>dispose</h3>
236					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
237						<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
238					</ul>
239					<ul class="tsd-descriptions">
240						<li class="tsd-description">
241							<aside class="tsd-sources">
242								<ul>
243									<li>Defined in livesplit_core.ts:3330</li>
244								</ul>
245							</aside>
246							<div class="tsd-comment tsd-typography">
247								<div class="lead">
248									<p>Disposes the object, allowing it to clean up all of its memory. You need
249										to call this for every object that you don&#39;t use anymore and hasn&#39;t
250									already been disposed.</p>
251								</div>
252							</div>
253							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
254						</li>
255					</ul>
256				</section>
257				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
258					<a name="duplicatecomponent" class="tsd-anchor"></a>
259					<h3>duplicate<wbr>Component</h3>
260					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
261						<li class="tsd-signature tsd-kind-icon">duplicate<wbr>Component<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
262					</ul>
263					<ul class="tsd-descriptions">
264						<li class="tsd-description">
265							<aside class="tsd-sources">
266								<p>Inherited from <a href="layouteditorrefmut.html">LayoutEditorRefMut</a>.<a href="layouteditorrefmut.html#duplicatecomponent">duplicateComponent</a></p>
267								<ul>
268									<li>Defined in livesplit_core.ts:3261</li>
269								</ul>
270							</aside>
271							<div class="tsd-comment tsd-typography">
272								<div class="lead">
273									<p>Duplicates the currently selected component. The copy gets placed right
274									after the selected component and becomes the newly selected component.</p>
275								</div>
276							</div>
277							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
278						</li>
279					</ul>
280				</section>
281				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
282					<a name="layoutstateasjson" class="tsd-anchor"></a>
283					<h3>layout<wbr>State<wbr>AsJson</h3>
284					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
285						<li class="tsd-signature tsd-kind-icon">layout<wbr>State<wbr>AsJson<span class="tsd-signature-symbol">(</span>timer<span class="tsd-signature-symbol">: </span><a href="timerref.html" class="tsd-signature-type">TimerRef</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
286					</ul>
287					<ul class="tsd-descriptions">
288						<li class="tsd-description">
289							<aside class="tsd-sources">
290								<p>Inherited from <a href="layouteditorrefmut.html">LayoutEditorRefMut</a>.<a href="layouteditorrefmut.html#layoutstateasjson">layoutStateAsJson</a></p>
291								<ul>
292									<li>Defined in livesplit_core.ts:3181</li>
293								</ul>
294							</aside>
295							<div class="tsd-comment tsd-typography">
296								<div class="lead">
297									<p>Encodes the layout&#39;s state as JSON based on the timer provided. You can use
298										this to visualize all of the components of a layout, while it is still being
299									edited by the Layout Editor.</p>
300								</div>
301							</div>
302							<h4 class="tsd-parameters-title">Parameters</h4>
303							<ul class="tsd-parameters">
304								<li>
305									<h5>timer: <a href="timerref.html" class="tsd-signature-type">TimerRef</a></h5>
306								</li>
307							</ul>
308							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
309						</li>
310					</ul>
311				</section>
312				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
313					<a name="movecomponent" class="tsd-anchor"></a>
314					<h3>move<wbr>Component</h3>
315					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
316						<li class="tsd-signature tsd-kind-icon">move<wbr>Component<span class="tsd-signature-symbol">(</span>dstIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
317					</ul>
318					<ul class="tsd-descriptions">
319						<li class="tsd-description">
320							<aside class="tsd-sources">
321								<p>Inherited from <a href="layouteditorrefmut.html">LayoutEditorRefMut</a>.<a href="layouteditorrefmut.html#movecomponent">moveComponent</a></p>
322								<ul>
323									<li>Defined in livesplit_core.ts:3251</li>
324								</ul>
325							</aside>
326							<div class="tsd-comment tsd-typography">
327								<div class="lead">
328									<p>Moves the selected component to the index provided. You may not provide
329									an invalid index.</p>
330								</div>
331							</div>
332							<h4 class="tsd-parameters-title">Parameters</h4>
333							<ul class="tsd-parameters">
334								<li>
335									<h5>dstIndex: <span class="tsd-signature-type">number</span></h5>
336								</li>
337							</ul>
338							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
339						</li>
340					</ul>
341				</section>
342				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
343					<a name="movecomponentdown" class="tsd-anchor"></a>
344					<h3>move<wbr>Component<wbr>Down</h3>
345					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
346						<li class="tsd-signature tsd-kind-icon">move<wbr>Component<wbr>Down<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
347					</ul>
348					<ul class="tsd-descriptions">
349						<li class="tsd-description">
350							<aside class="tsd-sources">
351								<p>Inherited from <a href="layouteditorrefmut.html">LayoutEditorRefMut</a>.<a href="layouteditorrefmut.html#movecomponentdown">moveComponentDown</a></p>
352								<ul>
353									<li>Defined in livesplit_core.ts:3241</li>
354								</ul>
355							</aside>
356							<div class="tsd-comment tsd-typography">
357								<div class="lead">
358									<p>Moves the selected component down, unless the last component is
359									selected.</p>
360								</div>
361							</div>
362							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
363						</li>
364					</ul>
365				</section>
366				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
367					<a name="movecomponentup" class="tsd-anchor"></a>
368					<h3>move<wbr>Component<wbr>Up</h3>
369					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
370						<li class="tsd-signature tsd-kind-icon">move<wbr>Component<wbr>Up<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
371					</ul>
372					<ul class="tsd-descriptions">
373						<li class="tsd-description">
374							<aside class="tsd-sources">
375								<p>Inherited from <a href="layouteditorrefmut.html">LayoutEditorRefMut</a>.<a href="layouteditorrefmut.html#movecomponentup">moveComponentUp</a></p>
376								<ul>
377									<li>Defined in livesplit_core.ts:3231</li>
378								</ul>
379							</aside>
380							<div class="tsd-comment tsd-typography">
381								<div class="lead">
382									<p>Moves the selected component up, unless the first component is selected.</p>
383								</div>
384							</div>
385							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
386						</li>
387					</ul>
388				</section>
389				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
390					<a name="removecomponent" class="tsd-anchor"></a>
391					<h3>remove<wbr>Component</h3>
392					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
393						<li class="tsd-signature tsd-kind-icon">remove<wbr>Component<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
394					</ul>
395					<ul class="tsd-descriptions">
396						<li class="tsd-description">
397							<aside class="tsd-sources">
398								<p>Inherited from <a href="layouteditorrefmut.html">LayoutEditorRefMut</a>.<a href="layouteditorrefmut.html#removecomponent">removeComponent</a></p>
399								<ul>
400									<li>Defined in livesplit_core.ts:3222</li>
401								</ul>
402							</aside>
403							<div class="tsd-comment tsd-typography">
404								<div class="lead">
405									<p>Removes the currently selected component, unless there&#39;s only one
406										component in the layout. The next component becomes the selected
407										component. If there&#39;s none, the previous component becomes the selected
408									component instead.</p>
409								</div>
410							</div>
411							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
412						</li>
413					</ul>
414				</section>
415				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
416					<a name="select" class="tsd-anchor"></a>
417					<h3>select</h3>
418					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
419						<li class="tsd-signature tsd-kind-icon">select<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
420					</ul>
421					<ul class="tsd-descriptions">
422						<li class="tsd-description">
423							<aside class="tsd-sources">
424								<p>Inherited from <a href="layouteditorrefmut.html">LayoutEditorRefMut</a>.<a href="layouteditorrefmut.html#select">select</a></p>
425								<ul>
426									<li>Defined in livesplit_core.ts:3196</li>
427								</ul>
428							</aside>
429							<div class="tsd-comment tsd-typography">
430								<div class="lead">
431									<p>Selects the component with the given index in order to modify its
432										settings. Only a single component is selected at any given time. You may
433									not provide an invalid index.</p>
434								</div>
435							</div>
436							<h4 class="tsd-parameters-title">Parameters</h4>
437							<ul class="tsd-parameters">
438								<li>
439									<h5>index: <span class="tsd-signature-type">number</span></h5>
440								</li>
441							</ul>
442							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
443						</li>
444					</ul>
445				</section>
446				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
447					<a name="setcomponentsettingsvalue" class="tsd-anchor"></a>
448					<h3>set<wbr>Component<wbr>Settings<wbr>Value</h3>
449					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
450						<li class="tsd-signature tsd-kind-icon">set<wbr>Component<wbr>Settings<wbr>Value<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, value<span class="tsd-signature-symbol">: </span><a href="settingvalue.html" class="tsd-signature-type">SettingValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
451					</ul>
452					<ul class="tsd-descriptions">
453						<li class="tsd-description">
454							<aside class="tsd-sources">
455								<p>Inherited from <a href="layouteditorrefmut.html">LayoutEditorRefMut</a>.<a href="layouteditorrefmut.html#setcomponentsettingsvalue">setComponentSettingsValue</a></p>
456								<ul>
457									<li>Defined in livesplit_core.ts:3275</li>
458								</ul>
459							</aside>
460							<div class="tsd-comment tsd-typography">
461								<div class="lead">
462									<p>Sets a setting&#39;s value of the selected component by its setting index
463									to the given value.</p>
464								</div>
465								<p>This panics if the type of the value to be set is not compatible with
466									the type of the setting&#39;s value. A panic can also occur if the index of
467								the setting provided is out of bounds.</p>
468							</div>
469							<h4 class="tsd-parameters-title">Parameters</h4>
470							<ul class="tsd-parameters">
471								<li>
472									<h5>index: <span class="tsd-signature-type">number</span></h5>
473								</li>
474								<li>
475									<h5>value: <a href="settingvalue.html" class="tsd-signature-type">SettingValue</a></h5>
476								</li>
477							</ul>
478							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
479						</li>
480					</ul>
481				</section>
482				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
483					<a name="setgeneralsettingsvalue" class="tsd-anchor"></a>
484					<h3>set<wbr>General<wbr>Settings<wbr>Value</h3>
485					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
486						<li class="tsd-signature tsd-kind-icon">set<wbr>General<wbr>Settings<wbr>Value<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, value<span class="tsd-signature-symbol">: </span><a href="settingvalue.html" class="tsd-signature-type">SettingValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
487					</ul>
488					<ul class="tsd-descriptions">
489						<li class="tsd-description">
490							<aside class="tsd-sources">
491								<p>Inherited from <a href="layouteditorrefmut.html">LayoutEditorRefMut</a>.<a href="layouteditorrefmut.html#setgeneralsettingsvalue">setGeneralSettingsValue</a></p>
492								<ul>
493									<li>Defined in livesplit_core.ts:3293</li>
494								</ul>
495							</aside>
496							<div class="tsd-comment tsd-typography">
497								<div class="lead">
498									<p>Sets a setting&#39;s value of the general settings by its setting index to
499									the given value.</p>
500								</div>
501								<p>This panics if the type of the value to be set is not compatible with
502									the type of the setting&#39;s value. A panic can also occur if the index of
503								the setting provided is out of bounds.</p>
504							</div>
505							<h4 class="tsd-parameters-title">Parameters</h4>
506							<ul class="tsd-parameters">
507								<li>
508									<h5>index: <span class="tsd-signature-type">number</span></h5>
509								</li>
510								<li>
511									<h5>value: <a href="settingvalue.html" class="tsd-signature-type">SettingValue</a></h5>
512								</li>
513							</ul>
514							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
515						</li>
516					</ul>
517				</section>
518				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
519					<a name="stateasjson" class="tsd-anchor"></a>
520					<h3>state<wbr>AsJson</h3>
521					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
522						<li class="tsd-signature tsd-kind-icon">state<wbr>AsJson<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
523					</ul>
524					<ul class="tsd-descriptions">
525						<li class="tsd-description">
526							<aside class="tsd-sources">
527								<p>Inherited from <a href="layouteditorref.html">LayoutEditorRef</a>.<a href="layouteditorref.html#stateasjson">stateAsJson</a></p>
528								<ul>
529									<li>Defined in livesplit_core.ts:3154</li>
530								</ul>
531							</aside>
532							<div class="tsd-comment tsd-typography">
533								<div class="lead">
534									<p>Encodes the Layout Editor&#39;s state as JSON in order to visualize it.</p>
535								</div>
536							</div>
537							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
538						</li>
539					</ul>
540				</section>
541				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
542					<a name="with" class="tsd-anchor"></a>
543					<h3>with</h3>
544					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
545						<li class="tsd-signature tsd-kind-icon">with&lt;T&gt;<span class="tsd-signature-symbol">(</span>closure<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
546					</ul>
547					<ul class="tsd-descriptions">
548						<li class="tsd-description">
549							<aside class="tsd-sources">
550								<ul>
551									<li>Defined in livesplit_core.ts:3318</li>
552								</ul>
553							</aside>
554							<div class="tsd-comment tsd-typography">
555								<div class="lead">
556									<p>Allows for scoped usage of the object. The object is guaranteed to get
557										disposed once this function returns. You are free to dispose the object
558										early yourself anywhere within the scope. The scope&#39;s return value gets
559									carried to the outside of this function.</p>
560								</div>
561							</div>
562							<h4 class="tsd-type-parameters-title">Type parameters</h4>
563							<ul class="tsd-type-parameters">
564								<li>
565									<h4>T</h4>
566								</li>
567							</ul>
568							<h4 class="tsd-parameters-title">Parameters</h4>
569							<ul class="tsd-parameters">
570								<li>
571									<h5>closure: <span class="tsd-signature-type">function</span></h5>
572									<ul class="tsd-parameters">
573										<li class="tsd-parameter-siganture">
574											<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
575												<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><a href="layouteditor.html" class="tsd-signature-type">LayoutEditor</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
576											</ul>
577											<ul class="tsd-descriptions">
578												<li class="tsd-description">
579													<h4 class="tsd-parameters-title">Parameters</h4>
580													<ul class="tsd-parameters">
581														<li>
582															<h5>obj: <a href="layouteditor.html" class="tsd-signature-type">LayoutEditor</a></h5>
583														</li>
584													</ul>
585													<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
586												</li>
587											</ul>
588										</li>
589									</ul>
590								</li>
591							</ul>
592							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
593						</li>
594					</ul>
595				</section>
596				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
597					<a name="new" class="tsd-anchor"></a>
598					<h3><span class="tsd-flag ts-flagStatic">Static</span> new</h3>
599					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
600						<li class="tsd-signature tsd-kind-icon">new<span class="tsd-signature-symbol">(</span>layout<span class="tsd-signature-symbol">: </span><a href="layout.html" class="tsd-signature-type">Layout</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="layouteditor.html" class="tsd-signature-type">LayoutEditor</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li>
601					</ul>
602					<ul class="tsd-descriptions">
603						<li class="tsd-description">
604							<aside class="tsd-sources">
605								<ul>
606									<li>Defined in livesplit_core.ts:3340</li>
607								</ul>
608							</aside>
609							<div class="tsd-comment tsd-typography">
610								<div class="lead">
611									<p>Creates a new Layout Editor that modifies the Layout provided. Creation of
612										the Layout Editor fails when a Layout with no components is provided. In
613									that case null is returned instead.</p>
614								</div>
615							</div>
616							<h4 class="tsd-parameters-title">Parameters</h4>
617							<ul class="tsd-parameters">
618								<li>
619									<h5>layout: <a href="layout.html" class="tsd-signature-type">Layout</a></h5>
620								</li>
621							</ul>
622							<h4 class="tsd-returns-title">Returns <a href="layouteditor.html" class="tsd-signature-type">LayoutEditor</a>
623								<span class="tsd-signature-symbol"> | </span>
624								<span class="tsd-signature-type">null</span>
625							</h4>
626						</li>
627					</ul>
628				</section>
629			</section>
630		</div>
631		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
632			<nav class="tsd-navigation primary">
633				<ul>
634					<li class="globals  ">
635						<a href="../globals.html"><em>Globals</em></a>
636					</li>
637				</ul>
638			</nav>
639			<nav class="tsd-navigation secondary menu-sticky">
640				<ul class="before-current">
641				</ul>
642				<ul class="current">
643					<li class="current tsd-kind-class">
644						<a href="layouteditor.html" class="tsd-kind-icon">Layout<wbr>Editor</a>
645						<ul>
646							<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
647								<a href="layouteditor.html#constructor" class="tsd-kind-icon">constructor</a>
648							</li>
649							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
650								<a href="layouteditor.html#ptr" class="tsd-kind-icon">ptr</a>
651							</li>
652							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
653								<a href="layouteditor.html#addcomponent" class="tsd-kind-icon">add<wbr>Component</a>
654							</li>
655							<li class=" tsd-kind-method tsd-parent-kind-class">
656								<a href="layouteditor.html#close" class="tsd-kind-icon">close</a>
657							</li>
658							<li class=" tsd-kind-method tsd-parent-kind-class">
659								<a href="layouteditor.html#dispose" class="tsd-kind-icon">dispose</a>
660							</li>
661							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
662								<a href="layouteditor.html#duplicatecomponent" class="tsd-kind-icon">duplicate<wbr>Component</a>
663							</li>
664							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
665								<a href="layouteditor.html#layoutstateasjson" class="tsd-kind-icon">layout<wbr>State<wbr>AsJson</a>
666							</li>
667							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
668								<a href="layouteditor.html#movecomponent" class="tsd-kind-icon">move<wbr>Component</a>
669							</li>
670							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
671								<a href="layouteditor.html#movecomponentdown" class="tsd-kind-icon">move<wbr>Component<wbr>Down</a>
672							</li>
673							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
674								<a href="layouteditor.html#movecomponentup" class="tsd-kind-icon">move<wbr>Component<wbr>Up</a>
675							</li>
676							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
677								<a href="layouteditor.html#removecomponent" class="tsd-kind-icon">remove<wbr>Component</a>
678							</li>
679							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
680								<a href="layouteditor.html#select" class="tsd-kind-icon">select</a>
681							</li>
682							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
683								<a href="layouteditor.html#setcomponentsettingsvalue" class="tsd-kind-icon">set<wbr>Component<wbr>Settings<wbr>Value</a>
684							</li>
685							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
686								<a href="layouteditor.html#setgeneralsettingsvalue" class="tsd-kind-icon">set<wbr>General<wbr>Settings<wbr>Value</a>
687							</li>
688							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
689								<a href="layouteditor.html#stateasjson" class="tsd-kind-icon">state<wbr>AsJson</a>
690							</li>
691							<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
692								<a href="layouteditor.html#with" class="tsd-kind-icon">with</a>
693							</li>
694							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
695								<a href="layouteditor.html#new" class="tsd-kind-icon">new</a>
696							</li>
697						</ul>
698					</li>
699				</ul>
700				<ul class="after-current">
701				</ul>
702			</nav>
703		</div>
704	</div>
705</div>
706<footer class="with-border-bottom">
707	<div class="container">
708		<h2>Legend</h2>
709		<div class="tsd-legend-group">
710			<ul class="tsd-legend">
711				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
712				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
713				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
714				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
715				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
716				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
717				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
718			</ul>
719			<ul class="tsd-legend">
720				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
721				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
722				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
723				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
724			</ul>
725			<ul class="tsd-legend">
726				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
727				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
728				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
729				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
730				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
731				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
732			</ul>
733			<ul class="tsd-legend">
734				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
735				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
736				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
737				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
738				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
739				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
740				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
741			</ul>
742			<ul class="tsd-legend">
743				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
744				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
745				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
746				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
747			</ul>
748			<ul class="tsd-legend">
749				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
750				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
751				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
752			</ul>
753			<ul class="tsd-legend">
754				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
755				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
756				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
757			</ul>
758			<ul class="tsd-legend">
759				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
760				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
761			</ul>
762		</div>
763	</div>
764</footer>
765<div class="container tsd-generator">
766	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
767</div>
768<div class="overlay"></div>
769<script src="../assets/js/main.js"></script>
770<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
771</body>
772</html>