fork/livesplit-core

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

Christopher SerrAdd docsee16b86

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