fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
14.1 KiB311 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>TextComponentRef | 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="textcomponentref.html">TextComponentRef</a>
60				</li>
61			</ul>
62			<h1>Class TextComponentRef</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 Text Component simply visualizes any given text. This can either be a
73							single centered text, or split up into a left and right text, which is
74						suitable for a situation where you have a label and a value.</p>
75					</div>
76				</div>
77			</section>
78			<section class="tsd-panel tsd-hierarchy">
79				<h3>Hierarchy</h3>
80				<ul class="tsd-hierarchy">
81					<li>
82						<span class="target">TextComponentRef</span>
83						<ul class="tsd-hierarchy">
84							<li>
85								<a href="textcomponentrefmut.html" class="tsd-signature-type">TextComponentRefMut</a>
86							</li>
87						</ul>
88					</li>
89				</ul>
90			</section>
91			<section class="tsd-panel-group tsd-index-group">
92				<h2>Index</h2>
93				<section class="tsd-panel tsd-index-panel">
94					<div class="tsd-index-content">
95						<section class="tsd-index-section ">
96							<h3>Constructors</h3>
97							<ul class="tsd-index-list">
98								<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="textcomponentref.html#constructor" class="tsd-kind-icon">constructor</a></li>
99							</ul>
100						</section>
101						<section class="tsd-index-section ">
102							<h3>Properties</h3>
103							<ul class="tsd-index-list">
104								<li class="tsd-kind-property tsd-parent-kind-class"><a href="textcomponentref.html#ptr" class="tsd-kind-icon">ptr</a></li>
105							</ul>
106						</section>
107						<section class="tsd-index-section ">
108							<h3>Methods</h3>
109							<ul class="tsd-index-list">
110								<li class="tsd-kind-method tsd-parent-kind-class"><a href="textcomponentref.html#state" class="tsd-kind-icon">state</a></li>
111								<li class="tsd-kind-method tsd-parent-kind-class"><a href="textcomponentref.html#stateasjson" class="tsd-kind-icon">state<wbr>AsJson</a></li>
112							</ul>
113						</section>
114					</div>
115				</section>
116			</section>
117			<section class="tsd-panel-group tsd-member-group ">
118				<h2>Constructors</h2>
119				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
120					<a name="constructor" class="tsd-anchor"></a>
121					<h3>constructor</h3>
122					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
123						<li class="tsd-signature tsd-kind-icon">new <wbr>Text<wbr>Component<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="textcomponentref.html" class="tsd-signature-type">TextComponentRef</a></li>
124					</ul>
125					<ul class="tsd-descriptions">
126						<li class="tsd-description">
127							<aside class="tsd-sources">
128								<ul>
129									<li>Defined in livesplit_core.ts:6381</li>
130								</ul>
131							</aside>
132							<div class="tsd-comment tsd-typography">
133								<div class="lead">
134									<p>This constructor is an implementation detail. Do not use this.</p>
135								</div>
136							</div>
137							<h4 class="tsd-parameters-title">Parameters</h4>
138							<ul class="tsd-parameters">
139								<li>
140									<h5>ptr: <span class="tsd-signature-type">number</span></h5>
141								</li>
142							</ul>
143							<h4 class="tsd-returns-title">Returns <a href="textcomponentref.html" class="tsd-signature-type">TextComponentRef</a></h4>
144						</li>
145					</ul>
146				</section>
147			</section>
148			<section class="tsd-panel-group tsd-member-group ">
149				<h2>Properties</h2>
150				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
151					<a name="ptr" class="tsd-anchor"></a>
152					<h3>ptr</h3>
153					<div class="tsd-signature tsd-kind-icon">ptr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
154					<aside class="tsd-sources">
155						<ul>
156							<li>Defined in livesplit_core.ts:6361</li>
157						</ul>
158					</aside>
159				</section>
160			</section>
161			<section class="tsd-panel-group tsd-member-group ">
162				<h2>Methods</h2>
163				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
164					<a name="state" class="tsd-anchor"></a>
165					<h3>state</h3>
166					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
167						<li class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="textcomponentstate.html" class="tsd-signature-type">TextComponentState</a></li>
168					</ul>
169					<ul class="tsd-descriptions">
170						<li class="tsd-description">
171							<aside class="tsd-sources">
172								<ul>
173									<li>Defined in livesplit_core.ts:6375</li>
174								</ul>
175							</aside>
176							<div class="tsd-comment tsd-typography">
177								<div class="lead">
178									<p>Calculates the component&#39;s state.</p>
179								</div>
180							</div>
181							<h4 class="tsd-returns-title">Returns <a href="textcomponentstate.html" class="tsd-signature-type">TextComponentState</a></h4>
182						</li>
183					</ul>
184				</section>
185				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
186					<a name="stateasjson" class="tsd-anchor"></a>
187					<h3>state<wbr>AsJson</h3>
188					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
189						<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>
190					</ul>
191					<ul class="tsd-descriptions">
192						<li class="tsd-description">
193							<aside class="tsd-sources">
194								<ul>
195									<li>Defined in livesplit_core.ts:6365</li>
196								</ul>
197							</aside>
198							<div class="tsd-comment tsd-typography">
199								<div class="lead">
200									<p>Encodes the component&#39;s state information as JSON.</p>
201								</div>
202							</div>
203							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
204						</li>
205					</ul>
206				</section>
207			</section>
208		</div>
209		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
210			<nav class="tsd-navigation primary">
211				<ul>
212					<li class="globals  ">
213						<a href="../globals.html"><em>Globals</em></a>
214					</li>
215				</ul>
216			</nav>
217			<nav class="tsd-navigation secondary menu-sticky">
218				<ul class="before-current">
219				</ul>
220				<ul class="current">
221					<li class="current tsd-kind-class">
222						<a href="textcomponentref.html" class="tsd-kind-icon">Text<wbr>Component<wbr>Ref</a>
223						<ul>
224							<li class=" tsd-kind-constructor tsd-parent-kind-class">
225								<a href="textcomponentref.html#constructor" class="tsd-kind-icon">constructor</a>
226							</li>
227							<li class=" tsd-kind-property tsd-parent-kind-class">
228								<a href="textcomponentref.html#ptr" class="tsd-kind-icon">ptr</a>
229							</li>
230							<li class=" tsd-kind-method tsd-parent-kind-class">
231								<a href="textcomponentref.html#state" class="tsd-kind-icon">state</a>
232							</li>
233							<li class=" tsd-kind-method tsd-parent-kind-class">
234								<a href="textcomponentref.html#stateasjson" class="tsd-kind-icon">state<wbr>AsJson</a>
235							</li>
236						</ul>
237					</li>
238				</ul>
239				<ul class="after-current">
240				</ul>
241			</nav>
242		</div>
243	</div>
244</div>
245<footer class="with-border-bottom">
246	<div class="container">
247		<h2>Legend</h2>
248		<div class="tsd-legend-group">
249			<ul class="tsd-legend">
250				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
251				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
252				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
253				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
254				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
255				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
256				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
257			</ul>
258			<ul class="tsd-legend">
259				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
260				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
261				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
262				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
263			</ul>
264			<ul class="tsd-legend">
265				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
266				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
267				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
268				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
269				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
270				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
271			</ul>
272			<ul class="tsd-legend">
273				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
274				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
275				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
276				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
277				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
278				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
279				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
280			</ul>
281			<ul class="tsd-legend">
282				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
283				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
284				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
285				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
286			</ul>
287			<ul class="tsd-legend">
288				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
289				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
290				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
291			</ul>
292			<ul class="tsd-legend">
293				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
294				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
295				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
296			</ul>
297			<ul class="tsd-legend">
298				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
299				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
300			</ul>
301		</div>
302	</div>
303</footer>
304<div class="container tsd-generator">
305	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
306</div>
307<div class="overlay"></div>
308<script src="../assets/js/main.js"></script>
309<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
310</body>
311</html>