fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
12.1 KiB256 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>GeneralLayoutSettingsRefMut | 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="generallayoutsettingsrefmut.html">GeneralLayoutSettingsRefMut</a>
60				</li>
61			</ul>
62			<h1>Class GeneralLayoutSettingsRefMut</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 general settings of the layout that apply to all components.</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						<a href="generallayoutsettingsref.html" class="tsd-signature-type">GeneralLayoutSettingsRef</a>
81						<ul class="tsd-hierarchy">
82							<li>
83								<span class="target">GeneralLayoutSettingsRefMut</span>
84								<ul class="tsd-hierarchy">
85									<li>
86										<a href="generallayoutsettings.html" class="tsd-signature-type">GeneralLayoutSettings</a>
87									</li>
88								</ul>
89							</li>
90						</ul>
91					</li>
92				</ul>
93			</section>
94			<section class="tsd-panel-group tsd-index-group">
95				<h2>Index</h2>
96				<section class="tsd-panel tsd-index-panel">
97					<div class="tsd-index-content">
98						<section class="tsd-index-section tsd-is-inherited">
99							<h3>Constructors</h3>
100							<ul class="tsd-index-list">
101								<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="generallayoutsettingsrefmut.html#constructor" class="tsd-kind-icon">constructor</a></li>
102							</ul>
103						</section>
104						<section class="tsd-index-section tsd-is-inherited">
105							<h3>Properties</h3>
106							<ul class="tsd-index-list">
107								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="generallayoutsettingsrefmut.html#ptr" class="tsd-kind-icon">ptr</a></li>
108							</ul>
109						</section>
110					</div>
111				</section>
112			</section>
113			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
114				<h2>Constructors</h2>
115				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
116					<a name="constructor" class="tsd-anchor"></a>
117					<h3>constructor</h3>
118					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
119						<li class="tsd-signature tsd-kind-icon">new <wbr>General<wbr>Layout<wbr>Settings<wbr>Ref<wbr>Mut<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="generallayoutsettingsrefmut.html" class="tsd-signature-type">GeneralLayoutSettingsRefMut</a></li>
120					</ul>
121					<ul class="tsd-descriptions">
122						<li class="tsd-description">
123							<aside class="tsd-sources">
124								<p>Inherited from <a href="generallayoutsettingsref.html">GeneralLayoutSettingsRef</a>.<a href="generallayoutsettingsref.html#constructor">constructor</a></p>
125								<ul>
126									<li>Defined in livesplit_core.ts:2556</li>
127								</ul>
128							</aside>
129							<div class="tsd-comment tsd-typography">
130								<div class="lead">
131									<p>This constructor is an implementation detail. Do not use this.</p>
132								</div>
133							</div>
134							<h4 class="tsd-parameters-title">Parameters</h4>
135							<ul class="tsd-parameters">
136								<li>
137									<h5>ptr: <span class="tsd-signature-type">number</span></h5>
138								</li>
139							</ul>
140							<h4 class="tsd-returns-title">Returns <a href="generallayoutsettingsrefmut.html" class="tsd-signature-type">GeneralLayoutSettingsRefMut</a></h4>
141						</li>
142					</ul>
143				</section>
144			</section>
145			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
146				<h2>Properties</h2>
147				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
148					<a name="ptr" class="tsd-anchor"></a>
149					<h3>ptr</h3>
150					<div class="tsd-signature tsd-kind-icon">ptr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
151					<aside class="tsd-sources">
152						<p>Inherited from <a href="generallayoutsettingsref.html">GeneralLayoutSettingsRef</a>.<a href="generallayoutsettingsref.html#ptr">ptr</a></p>
153						<ul>
154							<li>Defined in livesplit_core.ts:2556</li>
155						</ul>
156					</aside>
157				</section>
158			</section>
159		</div>
160		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
161			<nav class="tsd-navigation primary">
162				<ul>
163					<li class="globals  ">
164						<a href="../globals.html"><em>Globals</em></a>
165					</li>
166				</ul>
167			</nav>
168			<nav class="tsd-navigation secondary menu-sticky">
169				<ul class="before-current">
170				</ul>
171				<ul class="current">
172					<li class="current tsd-kind-class">
173						<a href="generallayoutsettingsrefmut.html" class="tsd-kind-icon">General<wbr>Layout<wbr>Settings<wbr>Ref<wbr>Mut</a>
174						<ul>
175							<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
176								<a href="generallayoutsettingsrefmut.html#constructor" class="tsd-kind-icon">constructor</a>
177							</li>
178							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
179								<a href="generallayoutsettingsrefmut.html#ptr" class="tsd-kind-icon">ptr</a>
180							</li>
181						</ul>
182					</li>
183				</ul>
184				<ul class="after-current">
185				</ul>
186			</nav>
187		</div>
188	</div>
189</div>
190<footer class="with-border-bottom">
191	<div class="container">
192		<h2>Legend</h2>
193		<div class="tsd-legend-group">
194			<ul class="tsd-legend">
195				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
196				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
197				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
198				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
199				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
200				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
201				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
202			</ul>
203			<ul class="tsd-legend">
204				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
205				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
206				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
207				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
208			</ul>
209			<ul class="tsd-legend">
210				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
211				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
212				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
213				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
214				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
215				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
216			</ul>
217			<ul class="tsd-legend">
218				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
219				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
220				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
221				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
222				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
223				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
224				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
225			</ul>
226			<ul class="tsd-legend">
227				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
228				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
229				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
230				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
231			</ul>
232			<ul class="tsd-legend">
233				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
234				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
235				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
236			</ul>
237			<ul class="tsd-legend">
238				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
239				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
240				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
241			</ul>
242			<ul class="tsd-legend">
243				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
244				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
245			</ul>
246		</div>
247	</div>
248</footer>
249<div class="container tsd-generator">
250	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
251</div>
252<div class="overlay"></div>
253<script src="../assets/js/main.js"></script>
254<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
255</body>
256</html>