fork/livesplit-core

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

Christopher SerrAdd docsee16b86

v0.11.0
11.0 KiB235 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>SplitsComponentIconChangeJson | 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="splitscomponenticonchangejson.html">SplitsComponentIconChangeJson</a>
60				</li>
61			</ul>
62			<h1>Interface SplitsComponentIconChangeJson</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>Describes the icon to be shown for a certain segment. This is provided
73							whenever a segment is first shown or whenever its icon changes. If necessary,
74							you may remount this component to reset the component into a state where
75						these icons are provided again.</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						<span class="target">SplitsComponentIconChangeJson</span>
84					</li>
85				</ul>
86			</section>
87			<section class="tsd-panel-group tsd-index-group">
88				<h2>Index</h2>
89				<section class="tsd-panel tsd-index-panel">
90					<div class="tsd-index-content">
91						<section class="tsd-index-section ">
92							<h3>Properties</h3>
93							<ul class="tsd-index-list">
94								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="splitscomponenticonchangejson.html#icon" class="tsd-kind-icon">icon</a></li>
95								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="splitscomponenticonchangejson.html#segment_index" class="tsd-kind-icon">segment_<wbr>index</a></li>
96							</ul>
97						</section>
98					</div>
99				</section>
100			</section>
101			<section class="tsd-panel-group tsd-member-group ">
102				<h2>Properties</h2>
103				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
104					<a name="icon" class="tsd-anchor"></a>
105					<h3>icon</h3>
106					<div class="tsd-signature tsd-kind-icon">icon<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
107					<aside class="tsd-sources">
108						<ul>
109							<li>Defined in livesplit_core.ts:202</li>
110						</ul>
111					</aside>
112					<div class="tsd-comment tsd-typography">
113						<div class="lead">
114							<p>The segment&#39;s icon encoded as a Data URL. The String itself may be empty.
115							This indicates that there is no icon.</p>
116						</div>
117					</div>
118				</section>
119				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
120					<a name="segment_index" class="tsd-anchor"></a>
121					<h3>segment_<wbr>index</h3>
122					<div class="tsd-signature tsd-kind-icon">segment_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
123					<aside class="tsd-sources">
124						<ul>
125							<li>Defined in livesplit_core.ts:197</li>
126						</ul>
127					</aside>
128					<div class="tsd-comment tsd-typography">
129						<div class="lead">
130							<p>The index of the segment of which the icon changed. This is based on the
131								index in the run, not on the index of the <code>SplitStateJson</code> in the
132								<code>SplitsComponentStateJson</code> object. The corresponding index is the <code>index</code>
133							field of the <code>SplitStateJson</code> object.</p>
134						</div>
135					</div>
136				</section>
137			</section>
138		</div>
139		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
140			<nav class="tsd-navigation primary">
141				<ul>
142					<li class="globals  ">
143						<a href="../globals.html"><em>Globals</em></a>
144					</li>
145				</ul>
146			</nav>
147			<nav class="tsd-navigation secondary menu-sticky">
148				<ul class="before-current">
149				</ul>
150				<ul class="current">
151					<li class="current tsd-kind-interface">
152						<a href="splitscomponenticonchangejson.html" class="tsd-kind-icon">Splits<wbr>Component<wbr>Icon<wbr>Change<wbr>Json</a>
153						<ul>
154							<li class=" tsd-kind-property tsd-parent-kind-interface">
155								<a href="splitscomponenticonchangejson.html#icon" class="tsd-kind-icon">icon</a>
156							</li>
157							<li class=" tsd-kind-property tsd-parent-kind-interface">
158								<a href="splitscomponenticonchangejson.html#segment_index" class="tsd-kind-icon">segment_<wbr>index</a>
159							</li>
160						</ul>
161					</li>
162				</ul>
163				<ul class="after-current">
164				</ul>
165			</nav>
166		</div>
167	</div>
168</div>
169<footer class="with-border-bottom">
170	<div class="container">
171		<h2>Legend</h2>
172		<div class="tsd-legend-group">
173			<ul class="tsd-legend">
174				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
175				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
176				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
177				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
178				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
179				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
180				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
181			</ul>
182			<ul class="tsd-legend">
183				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
184				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
185				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
186				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
187			</ul>
188			<ul class="tsd-legend">
189				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
190				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
191				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
192				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
193				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
194				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
195			</ul>
196			<ul class="tsd-legend">
197				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
198				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
199				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
200				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
201				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
202				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
203				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
204			</ul>
205			<ul class="tsd-legend">
206				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
207				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
208				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
209				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
210			</ul>
211			<ul class="tsd-legend">
212				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
213				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
214				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
215			</ul>
216			<ul class="tsd-legend">
217				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
218				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
219				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
220			</ul>
221			<ul class="tsd-legend">
222				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
223				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
224			</ul>
225		</div>
226	</div>
227</footer>
228<div class="container tsd-generator">
229	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
230</div>
231<div class="overlay"></div>
232<script src="../assets/js/main.js"></script>
233<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
234</body>
235</html>