-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathshady_render.html
423 lines (422 loc) · 23.9 KB
/
shady_render.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>shady-render | lit-html API</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<link rel="stylesheet" href="../../css/main.css">
<link rel="stylesheet" href="../../css/pygments.css">
<link rel="stylesheet" href="../../css/theme.css">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto">
<style>
body {
position: relative;
margin-top: 60px;
}
@media screen and (max-width: 640px) {
body {
margin-top: 56px;
}
}
</style>
</head>
<body>
<nav class="main-nav" markdown="0">
<a class="nav-title" href="../..">lit-html</a>
<div class="flex"></div>
<a class="nav-item" href="../../guide">Guide</a>
<a class="nav-item active" href="../index.html">API</a>
<a class="icon" href="https://github.com/polymer/lit-html" title="GitHub">
<svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="currentcolor">
<path d="M12,2C6.48,2,2,6.59,2,12.25c0,4.53,2.87,8.37,6.84,9.73c0.5,0.09,0.68-0.22,0.68-0.49c0-0.24-0.01-0.89-0.01-1.74c-2.78,0.62-3.37-1.37-3.37-1.37c-0.45-1.18-1.11-1.5-1.11-1.5c-0.91-0.64,0.07-0.62,0.07-0.62c1,0.07,1.53,1.06,1.53,1.06c0.89,1.57,2.34,1.11,2.91,0.85c0.09-0.66,0.35-1.11,0.63-1.37c-2.22-0.26-4.56-1.14-4.56-5.07c0-1.12,0.39-2.03,1.03-2.75c-0.1-0.26-0.45-1.3,0.1-2.71c0,0,0.84-0.28,2.75,1.05c0.8-0.23,1.65-0.34,2.5-0.34c0.85,0,1.7,0.12,2.5,0.34c1.91-1.33,2.75-1.05,2.75-1.05c0.55,1.41,0.2,2.45,0.1,2.71c0.64,0.72,1.03,1.63,1.03,2.75c0,3.94-2.34,4.81-4.57,5.06c0.36,0.32,0.68,0.94,0.68,1.9c0,1.37-0.01,2.48-0.01,2.81c0,0.27,0.18,0.59,0.69,0.49c3.97-1.36,6.83-5.2,6.83-9.73C22,6.59,17.52,2,12,2"/>
</svg>
</a>
<a class="icon" href="javascript:searchBox.focus()" title="Search">
<svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="currentcolor">
<path d="M15.5 14h-.79l-.28-.27C15.41 12.59 16 11.11 16 9.5 16 5.91 13.09 3 9.5 3S3 5.91 3 9.5 5.91 16 9.5 16c1.61 0 3.09-.59 4.23-1.57l.27.28v.79l5 4.99L20.49 19l-4.99-5zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"/>
</svg>
</a>
<input id="searchBox" type="search" class="search-box" placeholder="Search" aria-label="Search">
</nav>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">lit-html API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="shady_render.html">shady-render</a>
</li>
</ul>
<h1>External module shady-render</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Module to add shady DOM/shady CSS polyfill support to lit-html template
rendering. See the <a href="shady_render.html#render">render</a> method for details.</p>
</div>
</div>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/shady_render.shadyrenderoptions.html" class="tsd-kind-icon">Shady<wbr>Render<wbr>Options</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="shady_render.html#insertnodeintotemplate" class="tsd-kind-icon">insert<wbr>Node<wbr>Into<wbr>Template</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="shady_render.html#removenodesfromtemplate" class="tsd-kind-icon">remove<wbr>Nodes<wbr>From<wbr>Template</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="shady_render.html#render" class="tsd-kind-icon">render</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a name="insertnodeintotemplate" class="tsd-anchor"></a>
<h3>insert<wbr>Node<wbr>Into<wbr>Template</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<li class="tsd-signature tsd-kind-icon">insert<wbr>Node<wbr>Into<wbr>Template<span class="tsd-signature-symbol">(</span>template<span class="tsd-signature-symbol">: </span><a href="../classes/lit_html.template.html" class="tsd-signature-type">Template</a>, node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Node</span>, refNode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Node</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/modify-template.ts:93</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Inserts the given node into the Template, optionally before the given
refNode. In addition to inserting the node into the Template, the Template
part indices are updated to match the mutated Template DOM.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>template: <a href="../classes/lit_html.template.html" class="tsd-signature-type">Template</a></h5>
</li>
<li>
<h5>node: <span class="tsd-signature-type">Node</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> refNode: <span class="tsd-signature-type">Node</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a name="removenodesfromtemplate" class="tsd-anchor"></a>
<h3>remove<wbr>Nodes<wbr>From<wbr>Template</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<li class="tsd-signature tsd-kind-icon">remove<wbr>Nodes<wbr>From<wbr>Template<span class="tsd-signature-symbol">(</span>template<span class="tsd-signature-symbol">: </span><a href="../classes/lit_html.template.html" class="tsd-signature-type">Template</a>, nodesToRemove<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Node</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/modify-template.ts:26</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Removes the list of nodes from a Template safely. In addition to removing
nodes from the Template, the Template part indices are updated to match
the mutated Template DOM.</p>
</div>
<p>As the template is walked the removal state is tracked and
part indices are adjusted as needed.</p>
<p>div
div#1 (remove) <-- start removing (removing node is div#1)
div
div#2 (remove) <-- continue removing (removing node is still div#1)
div
div <-- stop removing since previous sibling is the removing node (div#1,
removed 4 nodes)</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>template: <a href="../classes/lit_html.template.html" class="tsd-signature-type">Template</a></h5>
</li>
<li>
<h5>nodesToRemove: <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Node</span><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module">
<a name="render" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> render</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
<li class="tsd-signature tsd-kind-icon">render<span class="tsd-signature-symbol">(</span>result<span class="tsd-signature-symbol">: </span><a href="../classes/lit_html.templateresult.html" class="tsd-signature-type">TemplateResult</a>, container<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DocumentFragment</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ShadowRoot</span>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/shady_render.shadyrenderoptions.html" class="tsd-signature-type">ShadyRenderOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in lib/shady-render.ts:229</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Extension to the standard <code>render</code> method which supports rendering
to ShadowRoots when the ShadyDOM (<a href="https://github.com/webcomponents/shadydom">https://github.com/webcomponents/shadydom</a>)
and ShadyCSS (<a href="https://github.com/webcomponents/shadycss">https://github.com/webcomponents/shadycss</a>) polyfills are used
or when the webcomponentsjs
(<a href="https://github.com/webcomponents/webcomponentsjs">https://github.com/webcomponents/webcomponentsjs</a>) polyfill is used.</p>
</div>
<p>Adds a <code>scopeName</code> option which is used to scope element DOM and stylesheets
when native ShadowDOM is unavailable. The <code>scopeName</code> will be added to
the class attribute of all rendered DOM. In addition, any style elements will
be automatically re-written with this <code>scopeName</code> selector and moved out
of the rendered DOM and into the document <code><head></code>.</p>
<p>It is common to use this render method in conjunction with a custom element
which renders a shadowRoot. When this is done, typically the element's
<code>localName</code> should be used as the <code>scopeName</code>.</p>
<p>In addition to DOM scoping, ShadyCSS also supports a basic shim for css
custom properties (needed only on older browsers like IE11) and a shim for
a deprecated feature called <code>@apply</code> that supports applying a set of css
custom properties to a given location.</p>
<p>Usage considerations:</p>
<ul>
<li><p>Part values in <code><style></code> elements are only applied the first time a given
<code>scopeName</code> renders. Subsequent changes to parts in style elements will have
no effect. Because of this, parts in style elements should only be used for
values that will never change, for example parts that set scope-wide theme
values or parts which render shared style elements.</p>
</li>
<li><p>Note, due to a limitation of the ShadyDOM polyfill, rendering in a
custom element's <code>constructor</code> is not supported. Instead rendering should
either done asynchronously, for example at microtask timing (for example
<code>Promise.resolve()</code>), or be deferred until the first time the element's
<code>connectedCallback</code> runs.</p>
</li>
</ul>
<p>Usage considerations when using shimmed custom properties or <code>@apply</code>:</p>
<ul>
<li><p>Whenever any dynamic changes are made which affect
css custom properties, <code>ShadyCSS.styleElement(element)</code> must be called
to update the element. There are two cases when this is needed:
(1) the element is connected to a new parent, (2) a class is added to the
element that causes it to match different custom properties.
To address the first case when rendering a custom element, <code>styleElement</code>
should be called in the element's <code>connectedCallback</code>.</p>
</li>
<li><p>Shimmed custom properties may only be defined either for an entire
shadowRoot (for example, in a <code>:host</code> rule) or via a rule that directly
matches an element with a shadowRoot. In other words, instead of flowing from
parent to child as do native css custom properties, shimmed custom properties
flow only from shadowRoots to nested shadowRoots.</p>
</li>
<li><p>When using <code>@apply</code> mixing css shorthand property names with
non-shorthand names (for example <code>border</code> and <code>border-width</code>) is not
supported.</p>
</li>
</ul>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>result: <a href="../classes/lit_html.templateresult.html" class="tsd-signature-type">TemplateResult</a></h5>
</li>
<li>
<h5>container: <span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DocumentFragment</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ShadowRoot</span></h5>
</li>
<li>
<h5>options: <a href="../interfaces/shady_render.shadyrenderoptions.html" class="tsd-signature-type">ShadyRenderOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="label tsd-is-external">
<span>Externals</span>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="lit_html.html">lit-<wbr>html</a>
</li>
<li class="current tsd-kind-external-module tsd-is-external">
<a href="shady_render.html">shady-<wbr>render</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/shady_render.shadyrenderoptions.html" class="tsd-kind-icon">Shady<wbr>Render<wbr>Options</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a href="shady_render.html#insertnodeintotemplate" class="tsd-kind-icon">insert<wbr>Node<wbr>Into<wbr>Template</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a href="shady_render.html#removenodesfromtemplate" class="tsd-kind-icon">remove<wbr>Nodes<wbr>From<wbr>Template</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="shady_render.html#render" class="tsd-kind-icon">render</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
<script>
searchBox.addEventListener('keypress', function(event) {
if (event.keyCode === 13 /* enter */) {
const site = window.location.hostname;
const query = encodeURIComponent(searchBox.value);
ga('send', 'pageview', '/search?q='+query);
window.location = 'https://www.google.com/search?q=site%3A'+site+'+'+query;
event.preventDefault();
}
});
// TypeDoc's main.js installs a `keydown` handler on `body` for its own
// search functionality - stop our search box from triggering that.
searchBox.addEventListener('keydown', function(event) {
event.stopPropagation();
});
</script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-39334307-23', '');
ga('send', 'pageview');
</script>
</body>
</html>