fork/livesplit-core

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

Christopher SerrAdd docsee16b86

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