UNPKG

145 kBHTMLView Raw
1<!DOCTYPE html>
2
3<html lang="en">
4<head>
5 <meta charset="utf-8">
6 <meta name="viewport" content="width=device-width">
7 <title>CrossBrowdy API documentation Namespace: CB_Screen</title>
8
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
13
14 <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
15
16</head>
17
18<body style="min-width:800px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
19
20<div class="navbar navbar-default navbar-fixed-top ">
21<div class="container">
22 <div class="navbar-header">
23 <a class="navbar-brand" href="index.html">CrossBrowdy API documentation</a>
24 <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
25 <span class="icon-bar"></span>
26 <span class="icon-bar"></span>
27 <span class="icon-bar"></span>
28 </button>
29 </div>
30 <div class="navbar-collapse collapse" id="topNavigation">
31 <ul class="nav navbar-nav">
32
33 <li class="dropdown">
34 <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
35 <ul class="dropdown-menu inline">
36 <li><a href="CB_Arrays.html">CB_Arrays</a></li><li><a href="CB_AudioDetector.html">CB_AudioDetector</a></li><li><a href="CB_Client.html">CB_Client</a></li><li><a href="CB_Collisions.html">CB_Collisions</a></li><li><a href="CB_Configuration.html">CB_Configuration</a></li><li><a href="CB_Configuration.CrossBase.html">CB_Configuration.CrossBase</a></li><li><a href="CB_Configuration.CrossBrowdy.html">CB_Configuration.CrossBrowdy</a></li><li><a href="CB_Controllers.html">CB_Controllers</a></li><li><a href="CB_Controllers_Proprietary.html">CB_Controllers_Proprietary</a></li><li><a href="CB_Controllers_Proprietary.WII.html">CB_Controllers_Proprietary.WII</a></li><li><a href="CB_Controllers_Proprietary.WII_U.html">CB_Controllers_Proprietary.WII_U</a></li><li><a href="CB_Device.html">CB_Device</a></li><li><a href="CB_Device.AmbientLight.html">CB_Device.AmbientLight</a></li><li><a href="CB_Device.Battery.html">CB_Device.Battery</a></li><li><a href="CB_Device.Location.html">CB_Device.Location</a></li><li><a href="CB_Device.Motion.html">CB_Device.Motion</a></li><li><a href="CB_Device.Orientation.html">CB_Device.Orientation</a></li><li><a href="CB_Device.Proximity.html">CB_Device.Proximity</a></li><li><a href="CB_Device.Vibration.html">CB_Device.Vibration</a></li><li><a href="CB_Elements.html">CB_Elements</a></li><li><a href="CB_Events.html">CB_Events</a></li><li><a href="CB_Keyboard.html">CB_Keyboard</a></li><li><a href="CB_Keyboard.chars.html">CB_Keyboard.chars</a></li><li><a href="CB_Keyboard.extended.html">CB_Keyboard.extended</a></li><li><a href="CB_Keyboard.keys.html">CB_Keyboard.keys</a></li><li><a href="CB_Modules.html">CB_Modules</a></li><li><a href="CB_Mouse.html">CB_Mouse</a></li><li><a href="CB_Mouse.CursorImage.html">CB_Mouse.CursorImage</a></li><li><a href="CB_Net.html">CB_Net</a></li><li><a href="CB_Net.Fetch.html">CB_Net.Fetch</a></li><li><a href="CB_Net.REST.html">CB_Net.REST</a></li><li><a href="CB_Net.Sockets.html">CB_Net.Sockets</a></li><li><a href="CB_Net.Sockets.SockJS.html">CB_Net.Sockets.SockJS</a></li><li><a href="CB_Net.XHR.html">CB_Net.XHR</a></li><li><a href="CB_Pointer.html">CB_Pointer</a></li><li><a href="CB_Screen.html">CB_Screen</a></li><li><a href="CB_Speaker.html">CB_Speaker</a></li><li><a href="CB_Touch.html">CB_Touch</a></li><li><a href="CB_baseSymbols.html">CB_baseSymbols</a></li>
37 </ul>
38 </li>
39
40 <li class="dropdown">
41 <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
42 <ul class="dropdown-menu inline">
43 <li><a href="CB_AudioFile.html">CB_AudioFile</a></li><li><a href="CB_AudioFileCache.html">CB_AudioFileCache</a></li><li><a href="CB_AudioFileSprites.html">CB_AudioFileSprites</a></li><li><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></li><li><a href="CB_AudioFile_API.AAPI.html">CB_AudioFile_API.AAPI</a></li><li><a href="CB_AudioFile_API.ACMP.html">CB_AudioFile_API.ACMP</a></li><li><a href="CB_AudioFile_API.SM2.html">CB_AudioFile_API.SM2</a></li><li><a href="CB_AudioFile_API.WAAPI.html">CB_AudioFile_API.WAAPI</a></li><li><a href="CB_Canvas.html">CB_Canvas</a></li><li><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></li><li><a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a></li>
44 </ul>
45 </li>
46
47 <li class="dropdown">
48 <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
49 <ul class="dropdown-menu inline">
50 <li><a href="global.html#CB_BASE_NAME">CB_BASE_NAME</a></li><li><a href="global.html#CB_CREDITS_DEFAULT">CB_CREDITS_DEFAULT</a></li><li><a href="global.html#CB_NAME">CB_NAME</a></li><li><a href="global.html#CB_OPTIONS">CB_OPTIONS</a></li><li><a href="global.html#CB_VERSION">CB_VERSION</a></li><li><a href="global.html#CB_addCredits">CB_addCredits</a></li><li><a href="global.html#CB_baseToBase">CB_baseToBase</a></li><li><a href="global.html#CB_baseToInt">CB_baseToInt</a></li><li><a href="global.html#CB_br2nl">CB_br2nl</a></li><li><a href="global.html#CB_brToNl">CB_brToNl</a></li><li><a href="global.html#CB_combineArraysOrObjects">CB_combineArraysOrObjects</a></li><li><a href="global.html#CB_combineAutomatically">CB_combineAutomatically</a></li><li><a href="global.html#CB_combineJSON">CB_combineJSON</a></li><li><a href="global.html#CB_combineURIParameters">CB_combineURIParameters</a></li><li><a href="global.html#CB_combineURLParameters">CB_combineURLParameters</a></li><li><a href="global.html#CB_console">CB_console</a></li><li><a href="global.html#CB_copyObject">CB_copyObject</a></li><li><a href="global.html#CB_countDecimalDigits">CB_countDecimalDigits</a></li><li><a href="global.html#CB_countDecimalPart">CB_countDecimalPart</a></li><li><a href="global.html#CB_countDecimals">CB_countDecimals</a></li><li><a href="global.html#CB_countIntegerDigits">CB_countIntegerDigits</a></li><li><a href="global.html#CB_countIntegerPart">CB_countIntegerPart</a></li><li><a href="global.html#CB_credits">CB_credits</a></li><li><a href="global.html#CB_forEach">CB_forEach</a></li><li><a href="global.html#CB_forceString">CB_forceString</a></li><li><a href="global.html#CB_getBase64StringObject">CB_getBase64StringObject</a></li><li><a href="global.html#CB_getCookie">CB_getCookie</a></li><li><a href="global.html#CB_getDatum">CB_getDatum</a></li><li><a href="global.html#CB_getJSONPropertyValue">CB_getJSONPropertyValue</a></li><li><a href="global.html#CB_getLZStringObject">CB_getLZStringObject</a></li><li><a href="global.html#CB_getValueIndex">CB_getValueIndex</a></li><li><a href="global.html#CB_getValuePath">CB_getValuePath</a></li><li><a href="global.html#CB_includeJSFile">CB_includeJSFile</a></li><li><a href="global.html#CB_indexOf">CB_indexOf</a></li><li><a href="global.html#CB_init">CB_init</a></li><li><a href="global.html#CB_intToBase">CB_intToBase</a></li><li><a href="global.html#CB_isArray">CB_isArray</a></li><li><a href="global.html#CB_isEmail">CB_isEmail</a></li><li><a href="global.html#CB_isFileLocal">CB_isFileLocal</a></li><li><a href="global.html#CB_isString">CB_isString</a></li><li><a href="global.html#CB_lastIndexOf">CB_lastIndexOf</a></li><li><a href="global.html#CB_ltrim">CB_ltrim</a></li><li><a href="global.html#CB_nl2br">CB_nl2br</a></li><li><a href="global.html#CB_nlToBr">CB_nlToBr</a></li><li><a href="global.html#CB_numberFormat">CB_numberFormat</a></li><li><a href="global.html#CB_numberOfDecimalDigits">CB_numberOfDecimalDigits</a></li><li><a href="global.html#CB_numberOfDecimals">CB_numberOfDecimals</a></li><li><a href="global.html#CB_numberOfIntegerDigits">CB_numberOfIntegerDigits</a></li><li><a href="global.html#CB_parseJSON">CB_parseJSON</a></li><li><a href="global.html#CB_parseString">CB_parseString</a></li><li><a href="global.html#CB_regularExpressionString">CB_regularExpressionString</a></li><li><a href="global.html#CB_renderString">CB_renderString</a></li><li><a href="global.html#CB_replaceAll">CB_replaceAll</a></li><li><a href="global.html#CB_rtrim">CB_rtrim</a></li><li><a href="global.html#CB_scriptPath">CB_scriptPath</a></li><li><a href="global.html#CB_scriptPathCalculate">CB_scriptPathCalculate</a></li><li><a href="global.html#CB_setCookie">CB_setCookie</a></li><li><a href="global.html#CB_setDatum">CB_setDatum</a></li><li><a href="global.html#CB_sizeOf">CB_sizeOf</a></li><li><a href="global.html#CB_sizeof">CB_sizeof</a></li><li><a href="global.html#CB_stringifyJSON">CB_stringifyJSON</a></li><li><a href="global.html#CB_symmetricCall">CB_symmetricCall</a></li><li><a href="global.html#CB_symmetricCallClear">CB_symmetricCallClear</a></li><li><a href="global.html#CB_this">CB_this</a></li><li><a href="global.html#CB_trim">CB_trim</a></li>
51 </ul>
52 </li>
53
54 </ul>
55
56 <div class="col-sm-3 col-md-3">
57 <form class="navbar-form" role="search">
58 <div class="input-group">
59 <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
60 <div class="input-group-btn">
61 <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
62 </div>
63 </div>
64 </form>
65 </div>
66
67 </div>
68
69</div>
70</div>
71
72
73<div class="container" id="toc-content" style="width:100%;">
74<div class="row" style="width:100%;">
75
76
77 <div class="col-md-8" style="width:85%;">
78
79 <div id="main">
80
81
82
83 <h1 class="page-title">Namespace: CB_Screen</h1>
84
85<section>
86
87<header>
88
89 <h2>
90 CB_Screen
91 </h2>
92
93
94</header>
95
96
97<article>
98 <div class="container-overview">
99
100
101 <div class="description"><p>Static class to manage the screen. It will return itself if it is tried to be instantiated. It can use <a href="https://github.com/tombigel/detect-zoom">detect-zoom</a> and <a href="https://github.com/richtr/NoSleep.js?utm_source=recordnotfound.com">NoSleep.js</a>.</p></div>
102
103
104
105<dl class="details">
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 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
136 <dd class="tag-source">
137 <ul class="dummy">
138 <li>
139 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
140 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-12">line 12</a>
141 </li>
142 </ul>
143 </dd>
144
145
146
147
148
149
150
151</dl>
152
153
154
155
156 </div>
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171 <h3 class="subsection-title">Methods</h3>
172
173 <dl>
174
175<hr>
176<dt>
177 <h4 class="name" id=".focus"><span class="type-signature">&lt;static> </span>focus<span class="signature">()</span><span class="type-signature"></span></h4>
178
179
180</dt>
181<dd>
182
183
184 <div class="description">
185 <p>Sets the focus to the main window (if possible).</p>
186 </div>
187
188
189
190
191
192
193
194
195
196
197<dl class="details">
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 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
228 <dd class="tag-source">
229 <ul class="dummy">
230 <li>
231 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
232 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-647">line 647</a>
233 </li>
234 </ul>
235 </dd>
236
237
238
239
240
241
242
243</dl>
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259</dd>
260
261
262
263<hr>
264<dt>
265 <h4 class="name" id=".getAvailableHeight"><span class="type-signature">&lt;static> </span>getAvailableHeight<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
266
267
268</dt>
269<dd>
270
271
272 <div class="description">
273 <p>Gets the current available screen height (vertical resolution). Uses the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Screen/availHeight">window.screen.availHeight</a> property internally, when possible.</p>
274 </div>
275
276
277
278
279
280
281
282
283
284
285<dl class="details">
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 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
316 <dd class="tag-source">
317 <ul class="dummy">
318 <li>
319 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
320 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-244">line 244</a>
321 </li>
322 </ul>
323 </dd>
324
325
326
327
328
329
330
331</dl>
332
333
334
335
336
337
338
339
340
341
342
343
344
345 <h5>Returns:</h5>
346
347
348<div class="param-desc">
349 <p>Returns the current available screen height (vertical resolution) in pixels.</p>
350</div>
351
352
353
354<dl>
355 <dt>
356 Type
357 </dt>
358 <dd>
359
360<span class="param-type">number</span>
361
362
363
364 </dd>
365</dl>
366
367
368
369
370
371</dd>
372
373
374
375<hr>
376<dt>
377 <h4 class="name" id=".getAvailableHeightPrevious"><span class="type-signature">&lt;static> </span>getAvailableHeightPrevious<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
378
379
380</dt>
381<dd>
382
383
384 <div class="description">
385 <p>Gets the previous available screen height (vertical resolution). Useful when the resolution (screen size and/or orientation) changed. Uses the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Screen/availHeight">window.screen.availHeight</a> property internally, when possible.</p>
386 </div>
387
388
389
390
391
392
393
394
395
396
397<dl class="details">
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
424
425
426
427 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
428 <dd class="tag-source">
429 <ul class="dummy">
430 <li>
431 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
432 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-272">line 272</a>
433 </li>
434 </ul>
435 </dd>
436
437
438
439
440
441
442
443</dl>
444
445
446
447
448
449
450
451
452
453
454
455
456
457 <h5>Returns:</h5>
458
459
460<div class="param-desc">
461 <p>Returns the previous available screen height (vertical resolution) in pixels.</p>
462</div>
463
464
465
466<dl>
467 <dt>
468 Type
469 </dt>
470 <dd>
471
472<span class="param-type">number</span>
473
474
475
476 </dd>
477</dl>
478
479
480
481
482
483</dd>
484
485
486
487<hr>
488<dt>
489 <h4 class="name" id=".getAvailableWidth"><span class="type-signature">&lt;static> </span>getAvailableWidth<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
490
491
492</dt>
493<dd>
494
495
496 <div class="description">
497 <p>Gets the current available screen width (horizontal resolution). Uses the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Screen/availWidth">window.screen.availWidth</a> property internally, when possible.</p>
498 </div>
499
500
501
502
503
504
505
506
507
508
509<dl class="details">
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
540 <dd class="tag-source">
541 <ul class="dummy">
542 <li>
543 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
544 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-228">line 228</a>
545 </li>
546 </ul>
547 </dd>
548
549
550
551
552
553
554
555</dl>
556
557
558
559
560
561
562
563
564
565
566
567
568
569 <h5>Returns:</h5>
570
571
572<div class="param-desc">
573 <p>Returns the current available screen width (horizontal resolution) in pixels.</p>
574</div>
575
576
577
578<dl>
579 <dt>
580 Type
581 </dt>
582 <dd>
583
584<span class="param-type">number</span>
585
586
587
588 </dd>
589</dl>
590
591
592
593
594
595</dd>
596
597
598
599<hr>
600<dt>
601 <h4 class="name" id=".getAvailableWidthPrevious"><span class="type-signature">&lt;static> </span>getAvailableWidthPrevious<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
602
603
604</dt>
605<dd>
606
607
608 <div class="description">
609 <p>Gets the previous available screen width (horizontal resolution). Useful when the resolution (screen size and/or orientation) changed. Uses the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Screen/availWidth">window.screen.availWidth</a> property internally, when possible.</p>
610 </div>
611
612
613
614
615
616
617
618
619
620
621<dl class="details">
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
652 <dd class="tag-source">
653 <ul class="dummy">
654 <li>
655 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
656 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-260">line 260</a>
657 </li>
658 </ul>
659 </dd>
660
661
662
663
664
665
666
667</dl>
668
669
670
671
672
673
674
675
676
677
678
679
680
681 <h5>Returns:</h5>
682
683
684<div class="param-desc">
685 <p>Returns the previous available screen width (horizontal resolution) in pixels.</p>
686</div>
687
688
689
690<dl>
691 <dt>
692 Type
693 </dt>
694 <dd>
695
696<span class="param-type">number</span>
697
698
699
700 </dd>
701</dl>
702
703
704
705
706
707</dd>
708
709
710
711<hr>
712<dt>
713 <h4 class="name" id=".getColorDepth"><span class="type-signature">&lt;static> </span>getColorDepth<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
714
715
716</dt>
717<dd>
718
719
720 <div class="description">
721 <p>Gets the current color depth. Uses the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Screen/colorDepth">window.screen.colorDepth</a> property internally, when possible.</p>
722 </div>
723
724
725
726
727
728
729
730
731
732
733<dl class="details">
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
764 <dd class="tag-source">
765 <ul class="dummy">
766 <li>
767 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
768 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-354">line 354</a>
769 </li>
770 </ul>
771 </dd>
772
773
774
775
776
777
778
779</dl>
780
781
782
783
784
785
786
787
788
789
790
791
792
793 <h5>Returns:</h5>
794
795
796<div class="param-desc">
797 <p>Returns the current color depth.</p>
798</div>
799
800
801
802<dl>
803 <dt>
804 Type
805 </dt>
806 <dd>
807
808<span class="param-type">number</span>
809
810
811
812 </dd>
813</dl>
814
815
816
817
818
819</dd>
820
821
822
823<hr>
824<dt>
825 <h4 class="name" id=".getHeight"><span class="type-signature">&lt;static> </span>getHeight<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
826
827
828</dt>
829<dd>
830
831
832 <div class="description">
833 <p>Gets the current screen height (vertical resolution). Uses the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Screen/height">window.screen.height</a> property internally, when possible.</p>
834 </div>
835
836
837
838
839
840
841
842
843
844
845<dl class="details">
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
876 <dd class="tag-source">
877 <ul class="dummy">
878 <li>
879 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
880 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-188">line 188</a>
881 </li>
882 </ul>
883 </dd>
884
885
886
887
888
889
890
891</dl>
892
893
894
895
896
897
898
899
900
901
902
903
904
905 <h5>Returns:</h5>
906
907
908<div class="param-desc">
909 <p>Returns the current screen height (vertical resolution) in pixels.</p>
910</div>
911
912
913
914<dl>
915 <dt>
916 Type
917 </dt>
918 <dd>
919
920<span class="param-type">number</span>
921
922
923
924 </dd>
925</dl>
926
927
928
929
930
931</dd>
932
933
934
935<hr>
936<dt>
937 <h4 class="name" id=".getHeightPrevious"><span class="type-signature">&lt;static> </span>getHeightPrevious<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
938
939
940</dt>
941<dd>
942
943
944 <div class="description">
945 <p>Gets the previous screen height (vertical resolution). Calculated through the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Screen/height">window.screen.height</a> property internally, when possible. Useful when the resolution (screen size and/or orientation) changed.</p>
946 </div>
947
948
949
950
951
952
953
954
955
956
957<dl class="details">
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
988 <dd class="tag-source">
989 <ul class="dummy">
990 <li>
991 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
992 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-216">line 216</a>
993 </li>
994 </ul>
995 </dd>
996
997
998
999
1000
1001
1002
1003</dl>
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017 <h5>Returns:</h5>
1018
1019
1020<div class="param-desc">
1021 <p>Returns the previous screen height (vertical resolution) in pixels.</p>
1022</div>
1023
1024
1025
1026<dl>
1027 <dt>
1028 Type
1029 </dt>
1030 <dd>
1031
1032<span class="param-type">number</span>
1033
1034
1035
1036 </dd>
1037</dl>
1038
1039
1040
1041
1042
1043</dd>
1044
1045
1046
1047<hr>
1048<dt>
1049 <h4 class="name" id=".getOrientation"><span class="type-signature">&lt;static> </span>getOrientation<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
1050
1051
1052</dt>
1053<dd>
1054
1055
1056 <div class="description">
1057 <p>Gets the current orientation from the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Screen/orientation">screen orientation object</a> of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/ScreenOrientation">Screen Orientation API</a>.</p>
1058 </div>
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069<dl class="details">
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1100 <dd class="tag-source">
1101 <ul class="dummy">
1102 <li>
1103 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
1104 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-1724">line 1724</a>
1105 </li>
1106 </ul>
1107 </dd>
1108
1109
1110
1111
1112
1113
1114
1115</dl>
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129 <h5>Returns:</h5>
1130
1131
1132<div class="param-desc">
1133 <p>Returns a string with the current orientation from the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Screen/orientation">screen orientation object</a> of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/ScreenOrientation">Screen Orientation API</a>. If cannot be found, it will return &quot;landscape-primary&quot; as default.</p>
1134</div>
1135
1136
1137
1138<dl>
1139 <dt>
1140 Type
1141 </dt>
1142 <dd>
1143
1144<span class="param-type">string</span>
1145
1146
1147
1148 </dd>
1149</dl>
1150
1151
1152
1153
1154
1155</dd>
1156
1157
1158
1159<hr>
1160<dt>
1161 <h4 class="name" id=".getOrientationObject"><span class="type-signature">&lt;static> </span>getOrientationObject<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
1162
1163
1164</dt>
1165<dd>
1166
1167
1168 <div class="description">
1169 <p>Gets the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Screen/orientation">screen orientation object</a> of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/ScreenOrientation">Screen Orientation API</a>.</p>
1170 </div>
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181<dl class="details">
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1212 <dd class="tag-source">
1213 <ul class="dummy">
1214 <li>
1215 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
1216 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-1691">line 1691</a>
1217 </li>
1218 </ul>
1219 </dd>
1220
1221
1222
1223
1224
1225
1226
1227</dl>
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241 <h5>Returns:</h5>
1242
1243
1244<div class="param-desc">
1245 <p>Returns the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Screen/orientation">screen orientation object</a> of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/ScreenOrientation">Screen Orientation API</a>.</p>
1246</div>
1247
1248
1249
1250<dl>
1251 <dt>
1252 Type
1253 </dt>
1254 <dd>
1255
1256<span class="param-type">Object</span>
1257
1258
1259
1260 </dd>
1261</dl>
1262
1263
1264
1265
1266
1267</dd>
1268
1269
1270
1271<hr>
1272<dt>
1273 <h4 class="name" id=".getPixelRatio"><span class="type-signature">&lt;static> </span>getPixelRatio<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
1274
1275
1276</dt>
1277<dd>
1278
1279
1280 <div class="description">
1281 <p>Gets the current pixel ratio of the screen (main window). Uses <a href="https://github.com/tombigel/detect-zoom">detect-zoom</a> internally.</p>
1282 </div>
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293<dl class="details">
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1324 <dd class="tag-source">
1325 <ul class="dummy">
1326 <li>
1327 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
1328 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-467">line 467</a>
1329 </li>
1330 </ul>
1331 </dd>
1332
1333
1334
1335
1336
1337
1338
1339 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
1340 <dd class="tag-todo">
1341 <ul>
1342 <li>Find a better and more-compatible way to detect pixel ratio which supports as many web clients as possible.</li>
1343 </ul>
1344 </dd>
1345
1346</dl>
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360 <h5>Returns:</h5>
1361
1362
1363<div class="param-desc">
1364 <p>Returns the current pixel ratio of the screen (main window). Default pixel ratio is 1 (one) even when it fails.</p>
1365</div>
1366
1367
1368
1369<dl>
1370 <dt>
1371 Type
1372 </dt>
1373 <dd>
1374
1375<span class="param-type">number</span>
1376
1377
1378
1379 </dd>
1380</dl>
1381
1382
1383
1384
1385
1386</dd>
1387
1388
1389
1390<hr>
1391<dt>
1392 <h4 class="name" id=".getPixelRatioPrevious"><span class="type-signature">&lt;static> </span>getPixelRatioPrevious<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
1393
1394
1395</dt>
1396<dd>
1397
1398
1399 <div class="description">
1400 <p>Gets the previous pixel ratio of the screen (main window). Useful when the zoom/pixel-ratio changed. Uses <a href="https://github.com/tombigel/detect-zoom">detect-zoom</a> internally.</p>
1401 </div>
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412<dl class="details">
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1443 <dd class="tag-source">
1444 <ul class="dummy">
1445 <li>
1446 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
1447 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-487">line 487</a>
1448 </li>
1449 </ul>
1450 </dd>
1451
1452
1453
1454
1455
1456
1457
1458 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
1459 <dd class="tag-todo">
1460 <ul>
1461 <li>Find a better and more-compatible way to detect pixel ratio which supports as many web clients as possible.</li>
1462 </ul>
1463 </dd>
1464
1465</dl>
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479 <h5>Returns:</h5>
1480
1481
1482<div class="param-desc">
1483 <p>Returns the previous pixel ratio of the screen (main window). Default previous pixel ratio is 0 (zero) even when it fails.</p>
1484</div>
1485
1486
1487
1488<dl>
1489 <dt>
1490 Type
1491 </dt>
1492 <dd>
1493
1494<span class="param-type">number</span>
1495
1496
1497
1498 </dd>
1499</dl>
1500
1501
1502
1503
1504
1505</dd>
1506
1507
1508
1509<hr>
1510<dt>
1511 <h4 class="name" id=".getScrollLeft"><span class="type-signature">&lt;static> </span>getScrollLeft<span class="signature">()</span><span class="type-signature"> &rarr; {number|null}</span></h4>
1512
1513
1514</dt>
1515<dd>
1516
1517
1518 <div class="description">
1519 <p>Gets the current scroll left position (horizontal scroll) of the screen (main window). Uses the <a href="CB_Elements.html#.getScrollLeftById"><code>CB_Elements.getScrollLeftById</code></a> function internally.</p>
1520 </div>
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531<dl class="details">
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1562 <dd class="tag-source">
1563 <ul class="dummy">
1564 <li>
1565 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
1566 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-369">line 369</a>
1567 </li>
1568 </ul>
1569 </dd>
1570
1571
1572
1573
1574
1575
1576
1577</dl>
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591 <h5>Returns:</h5>
1592
1593
1594<div class="param-desc">
1595 <p>Returns the current scroll left position (horizontal scroll) of the screen (main window). It could return null if something fails.</p>
1596</div>
1597
1598
1599
1600<dl>
1601 <dt>
1602 Type
1603 </dt>
1604 <dd>
1605
1606<span class="param-type">number</span>
1607|
1608
1609<span class="param-type">null</span>
1610
1611
1612
1613 </dd>
1614</dl>
1615
1616
1617
1618
1619
1620</dd>
1621
1622
1623
1624<hr>
1625<dt>
1626 <h4 class="name" id=".getScrollTop"><span class="type-signature">&lt;static> </span>getScrollTop<span class="signature">()</span><span class="type-signature"> &rarr; {number|null}</span></h4>
1627
1628
1629</dt>
1630<dd>
1631
1632
1633 <div class="description">
1634 <p>Gets the current scroll top position (vertical scroll) of the screen (main window). Uses the <a href="CB_Elements.html#.getScrollTopById"><code>CB_Elements.getScrollTopById</code></a> function internally.</p>
1635 </div>
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646<dl class="details">
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1677 <dd class="tag-source">
1678 <ul class="dummy">
1679 <li>
1680 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
1681 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-402">line 402</a>
1682 </li>
1683 </ul>
1684 </dd>
1685
1686
1687
1688
1689
1690
1691
1692</dl>
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706 <h5>Returns:</h5>
1707
1708
1709<div class="param-desc">
1710 <p>Returns the current scroll top position (vertical scroll) of the screen (main window). It could return null if something fails.</p>
1711</div>
1712
1713
1714
1715<dl>
1716 <dt>
1717 Type
1718 </dt>
1719 <dd>
1720
1721<span class="param-type">number</span>
1722|
1723
1724<span class="param-type">null</span>
1725
1726
1727
1728 </dd>
1729</dl>
1730
1731
1732
1733
1734
1735</dd>
1736
1737
1738
1739<hr>
1740<dt>
1741 <h4 class="name" id=".getWidth"><span class="type-signature">&lt;static> </span>getWidth<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
1742
1743
1744</dt>
1745<dd>
1746
1747
1748 <div class="description">
1749 <p>Gets the current screen width (horizontal resolution). Uses the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Screen/width">window.screen.width</a> property internally, when possible.</p>
1750 </div>
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761<dl class="details">
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1792 <dd class="tag-source">
1793 <ul class="dummy">
1794 <li>
1795 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
1796 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-172">line 172</a>
1797 </li>
1798 </ul>
1799 </dd>
1800
1801
1802
1803
1804
1805
1806
1807</dl>
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821 <h5>Returns:</h5>
1822
1823
1824<div class="param-desc">
1825 <p>Returns the current screen width (horizontal resolution) in pixels.</p>
1826</div>
1827
1828
1829
1830<dl>
1831 <dt>
1832 Type
1833 </dt>
1834 <dd>
1835
1836<span class="param-type">number</span>
1837
1838
1839
1840 </dd>
1841</dl>
1842
1843
1844
1845
1846
1847</dd>
1848
1849
1850
1851<hr>
1852<dt>
1853 <h4 class="name" id=".getWidthPrevious"><span class="type-signature">&lt;static> </span>getWidthPrevious<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
1854
1855
1856</dt>
1857<dd>
1858
1859
1860 <div class="description">
1861 <p>Gets the previous screen width (horizontal resolution). Calculated through the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Screen/width">window.screen.width</a> property internally, when possible. Useful when the resolution (screen size and/or orientation) changed.</p>
1862 </div>
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873<dl class="details">
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
1904 <dd class="tag-source">
1905 <ul class="dummy">
1906 <li>
1907 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
1908 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-204">line 204</a>
1909 </li>
1910 </ul>
1911 </dd>
1912
1913
1914
1915
1916
1917
1918
1919</dl>
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933 <h5>Returns:</h5>
1934
1935
1936<div class="param-desc">
1937 <p>Returns the previous screen width (horizontal resolution) in pixels.</p>
1938</div>
1939
1940
1941
1942<dl>
1943 <dt>
1944 Type
1945 </dt>
1946 <dd>
1947
1948<span class="param-type">number</span>
1949
1950
1951
1952 </dd>
1953</dl>
1954
1955
1956
1957
1958
1959</dd>
1960
1961
1962
1963<hr>
1964<dt>
1965 <h4 class="name" id=".getWindowHeight"><span class="type-signature">&lt;static> </span>getWindowHeight<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
1966
1967
1968</dt>
1969<dd>
1970
1971
1972 <div class="description">
1973 <p>Gets the current window height (vertical resolution). Internally, uses the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/innerHeight">window.innerHeight</a> if possible and fallbacks to <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/clientHeight">document.documentElement.clientHeight</a> or <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/clientHeight">document.body.clientHeight</a> property otherwise, when possible.</p>
1974 </div>
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985<dl class="details">
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2016 <dd class="tag-source">
2017 <ul class="dummy">
2018 <li>
2019 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
2020 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-307">line 307</a>
2021 </li>
2022 </ul>
2023 </dd>
2024
2025
2026
2027
2028
2029
2030
2031</dl>
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045 <h5>Returns:</h5>
2046
2047
2048<div class="param-desc">
2049 <p>Returns the current window height (vertical resolution) in pixels.</p>
2050</div>
2051
2052
2053
2054<dl>
2055 <dt>
2056 Type
2057 </dt>
2058 <dd>
2059
2060<span class="param-type">number</span>
2061
2062
2063
2064 </dd>
2065</dl>
2066
2067
2068
2069
2070
2071</dd>
2072
2073
2074
2075<hr>
2076<dt>
2077 <h4 class="name" id=".getWindowHeightPrevious"><span class="type-signature">&lt;static> </span>getWindowHeightPrevious<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
2078
2079
2080</dt>
2081<dd>
2082
2083
2084 <div class="description">
2085 <p>Gets the previous window height (vertical resolution). Useful when the resolution (screen size and/or orientation) or window size changed. Internally, uses the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/innerHeight">window.innerHeight</a> if possible and fallbacks to <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/clientHeight">document.documentElement.clientHeight</a> or <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/clientHeight">document.body.clientHeight</a> property otherwise, when possible.</p>
2086 </div>
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097<dl class="details">
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2128 <dd class="tag-source">
2129 <ul class="dummy">
2130 <li>
2131 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
2132 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-342">line 342</a>
2133 </li>
2134 </ul>
2135 </dd>
2136
2137
2138
2139
2140
2141
2142
2143</dl>
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157 <h5>Returns:</h5>
2158
2159
2160<div class="param-desc">
2161 <p>Returns the previous window height (vertical resolution) in pixels.</p>
2162</div>
2163
2164
2165
2166<dl>
2167 <dt>
2168 Type
2169 </dt>
2170 <dd>
2171
2172<span class="param-type">number</span>
2173
2174
2175
2176 </dd>
2177</dl>
2178
2179
2180
2181
2182
2183</dd>
2184
2185
2186
2187<hr>
2188<dt>
2189 <h4 class="name" id=".getWindowWidth"><span class="type-signature">&lt;static> </span>getWindowWidth<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
2190
2191
2192</dt>
2193<dd>
2194
2195
2196 <div class="description">
2197 <p>Gets the current window width (horizontal resolution). Internally, uses the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/innerWidth">window.innerWidth</a> if possible and fallbacks to <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/clientWidth">document.documentElement.clientWidth</a> or <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/clientWidth">document.body.clientWidth</a> property otherwise, when possible.</p>
2198 </div>
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209<dl class="details">
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2240 <dd class="tag-source">
2241 <ul class="dummy">
2242 <li>
2243 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
2244 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-284">line 284</a>
2245 </li>
2246 </ul>
2247 </dd>
2248
2249
2250
2251
2252
2253
2254
2255</dl>
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269 <h5>Returns:</h5>
2270
2271
2272<div class="param-desc">
2273 <p>Returns the current window width (horizontal resolution) in pixels.</p>
2274</div>
2275
2276
2277
2278<dl>
2279 <dt>
2280 Type
2281 </dt>
2282 <dd>
2283
2284<span class="param-type">number</span>
2285
2286
2287
2288 </dd>
2289</dl>
2290
2291
2292
2293
2294
2295</dd>
2296
2297
2298
2299<hr>
2300<dt>
2301 <h4 class="name" id=".getWindowWidthPrevious"><span class="type-signature">&lt;static> </span>getWindowWidthPrevious<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
2302
2303
2304</dt>
2305<dd>
2306
2307
2308 <div class="description">
2309 <p>Gets the previous window width (horizontal resolution). Useful when the resolution (screen size and/or orientation) or window size changed. Internally, uses the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/innerWidth">window.innerWidth</a> if possible and fallbacks to <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/clientWidth">document.documentElement.clientWidth</a> or <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/clientWidth">document.body.clientWidth</a> property otherwise, when possible.</p>
2310 </div>
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321<dl class="details">
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2352 <dd class="tag-source">
2353 <ul class="dummy">
2354 <li>
2355 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
2356 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-330">line 330</a>
2357 </li>
2358 </ul>
2359 </dd>
2360
2361
2362
2363
2364
2365
2366
2367</dl>
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381 <h5>Returns:</h5>
2382
2383
2384<div class="param-desc">
2385 <p>Returns the previous window width (horizontal resolution) in pixels.</p>
2386</div>
2387
2388
2389
2390<dl>
2391 <dt>
2392 Type
2393 </dt>
2394 <dd>
2395
2396<span class="param-type">number</span>
2397
2398
2399
2400 </dd>
2401</dl>
2402
2403
2404
2405
2406
2407</dd>
2408
2409
2410
2411<hr>
2412<dt>
2413 <h4 class="name" id=".getZoom"><span class="type-signature">&lt;static> </span>getZoom<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
2414
2415
2416</dt>
2417<dd>
2418
2419
2420 <div class="description">
2421 <p>Gets the current zoom level of the screen (main window). Uses <a href="https://github.com/tombigel/detect-zoom">detect-zoom</a> internally.</p>
2422 </div>
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433<dl class="details">
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2464 <dd class="tag-source">
2465 <ul class="dummy">
2466 <li>
2467 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
2468 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-436">line 436</a>
2469 </li>
2470 </ul>
2471 </dd>
2472
2473
2474
2475
2476
2477
2478
2479 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
2480 <dd class="tag-todo">
2481 <ul>
2482 <li>Find a better and more-compatible way to detect zoom which supports as many web clients as possible.</li>
2483 </ul>
2484 </dd>
2485
2486</dl>
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500 <h5>Returns:</h5>
2501
2502
2503<div class="param-desc">
2504 <p>Returns the current zoom level of the screen (main window). Default zoom level is 1 (one) even when it fails.</p>
2505</div>
2506
2507
2508
2509<dl>
2510 <dt>
2511 Type
2512 </dt>
2513 <dd>
2514
2515<span class="param-type">number</span>
2516
2517
2518
2519 </dd>
2520</dl>
2521
2522
2523
2524
2525
2526</dd>
2527
2528
2529
2530<hr>
2531<dt>
2532 <h4 class="name" id=".getZoomPrevious"><span class="type-signature">&lt;static> </span>getZoomPrevious<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
2533
2534
2535</dt>
2536<dd>
2537
2538
2539 <div class="description">
2540 <p>Gets the previous zoom level of the screen (main window). Useful when the zoom changed. Uses <a href="https://github.com/tombigel/detect-zoom">detect-zoom</a> internally.</p>
2541 </div>
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552<dl class="details">
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2583 <dd class="tag-source">
2584 <ul class="dummy">
2585 <li>
2586 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
2587 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-455">line 455</a>
2588 </li>
2589 </ul>
2590 </dd>
2591
2592
2593
2594
2595
2596
2597
2598</dl>
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612 <h5>Returns:</h5>
2613
2614
2615<div class="param-desc">
2616 <p>Returns the previous zoom level of the screen (main window). Default previous zoom level is 0 (zero) even when it fails.</p>
2617</div>
2618
2619
2620
2621<dl>
2622 <dt>
2623 Type
2624 </dt>
2625 <dd>
2626
2627<span class="param-type">number</span>
2628
2629
2630
2631 </dd>
2632</dl>
2633
2634
2635
2636
2637
2638</dd>
2639
2640
2641
2642<hr>
2643<dt>
2644 <h4 class="name" id=".isFocused"><span class="type-signature">&lt;static> </span>isFocused<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
2645
2646
2647</dt>
2648<dd>
2649
2650
2651 <div class="description">
2652 <p>Tells whether the main window is focused or not.</p>
2653 </div>
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664<dl class="details">
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2695 <dd class="tag-source">
2696 <ul class="dummy">
2697 <li>
2698 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
2699 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-637">line 637</a>
2700 </li>
2701 </ul>
2702 </dd>
2703
2704
2705
2706
2707
2708
2709
2710</dl>
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724 <h5>Returns:</h5>
2725
2726
2727<div class="param-desc">
2728 <p>Returns whether the main window is focused or not.</p>
2729</div>
2730
2731
2732
2733<dl>
2734 <dt>
2735 Type
2736 </dt>
2737 <dd>
2738
2739<span class="param-type">boolean</span>
2740
2741
2742
2743 </dd>
2744</dl>
2745
2746
2747
2748
2749
2750</dd>
2751
2752
2753
2754<hr>
2755<dt>
2756 <h4 class="name" id=".isFullScreen"><span class="type-signature">&lt;static> </span>isFullScreen<span class="signature">( [allowedWidthMarginPercentage] [, allowedHeightMarginPercentage])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
2757
2758
2759</dt>
2760<dd>
2761
2762
2763 <div class="description">
2764 <p>Tells whether we are in full screen mode or not. Uses the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API">Fullscreen API</a> and fallbacks to other methods internally, including <a href="https://nwjs.io/">NW.js (formerly node-webkit)</a> and <a href="https://electronjs.org/">Electron (Electron.js)</a> ones, when not available.</p>
2765 </div>
2766
2767
2768
2769
2770
2771
2772
2773
2774 <h5>Parameters:</h5>
2775
2776
2777<table class="params table table-striped">
2778 <thead>
2779 <tr>
2780
2781 <th style="width:12%; min-width:110px;">Name</th>
2782
2783
2784 <th style="width:12%; min-width:110px;">Type</th>
2785
2786
2787 <th style="width:12%; min-width:110px;">Argument</th>
2788
2789
2790
2791 <th style="width:12%; min-width:110px;">Default</th>
2792
2793
2794 <th class="last" style="min-width:310px;">Description</th>
2795 </tr>
2796 </thead>
2797
2798 <tbody>
2799
2800
2801 <tr>
2802
2803 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>allowedWidthMarginPercentage</code></td>
2804
2805
2806 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2807
2808
2809<span class="param-type">number</span>
2810
2811
2812
2813
2814 </td>
2815
2816
2817 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2818
2819 &lt;optional><br>
2820
2821
2822
2823
2824
2825 </td>
2826
2827
2828
2829 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2830
2831 CB_Configuration.CrossBase.CB_Screen_isFullScreen_ALLOWED_WIDTH_MARGIN_PERCENTAGE
2832
2833 </td>
2834
2835
2836 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Allowed width margin, in percentage, of the total screen available to detect whether it is in full screen or not. Needed by old web clients without <a href="https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API">Fullscreen API</a> support, mainly.</p></td>
2837 </tr>
2838
2839
2840
2841 <tr>
2842
2843 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>allowedHeightMarginPercentage</code></td>
2844
2845
2846 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2847
2848
2849<span class="param-type">number</span>
2850
2851
2852
2853
2854 </td>
2855
2856
2857 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2858
2859 &lt;optional><br>
2860
2861
2862
2863
2864
2865 </td>
2866
2867
2868
2869 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
2870
2871 CB_Configuration.CrossBase.CB_Screen_isFullScreen_ALLOWED_HEIGHT_MARGIN_PERCENTAGE
2872
2873 </td>
2874
2875
2876 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Allowed height margin, in percentage, of the total screen available to detect whether it is in full screen or not. Needed by old web clients without <a href="https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API">Fullscreen API</a> support, mainly.</p></td>
2877 </tr>
2878
2879
2880 </tbody>
2881</table>
2882
2883
2884
2885
2886<dl class="details">
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
2917 <dd class="tag-source">
2918 <ul class="dummy">
2919 <li>
2920 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
2921 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-1245">line 1245</a>
2922 </li>
2923 </ul>
2924 </dd>
2925
2926
2927
2928
2929
2930
2931
2932</dl>
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946 <h5>Returns:</h5>
2947
2948
2949<div class="param-desc">
2950 <p>Returns whether we are in full screen mode or not.</p>
2951</div>
2952
2953
2954
2955<dl>
2956 <dt>
2957 Type
2958 </dt>
2959 <dd>
2960
2961<span class="param-type">boolean</span>
2962
2963
2964
2965 </dd>
2966</dl>
2967
2968
2969
2970
2971
2972</dd>
2973
2974
2975
2976<hr>
2977<dt>
2978 <h4 class="name" id=".isFullScreenAPICompatible"><span class="type-signature">&lt;static> </span>isFullScreenAPICompatible<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
2979
2980
2981</dt>
2982<dd>
2983
2984
2985 <div class="description">
2986 <p>Tells whether the web client is compatible with the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API">FullScreen API</a> or not.</p>
2987 </div>
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998<dl class="details">
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3029 <dd class="tag-source">
3030 <ul class="dummy">
3031 <li>
3032 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
3033 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-873">line 873</a>
3034 </li>
3035 </ul>
3036 </dd>
3037
3038
3039
3040
3041
3042
3043
3044</dl>
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058 <h5>Returns:</h5>
3059
3060
3061<div class="param-desc">
3062 <p>Returns whether the web client is compatible with the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API">FullScreen API</a> or not.</p>
3063</div>
3064
3065
3066
3067<dl>
3068 <dt>
3069 Type
3070 </dt>
3071 <dd>
3072
3073<span class="param-type">boolean</span>
3074
3075
3076
3077 </dd>
3078</dl>
3079
3080
3081
3082
3083
3084</dd>
3085
3086
3087
3088<hr>
3089<dt>
3090 <h4 class="name" id=".isLandscape"><span class="type-signature">&lt;static> </span>isLandscape<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
3091
3092
3093</dt>
3094<dd>
3095
3096
3097 <div class="description">
3098 <p>Tells whether the screen (main window) is in landscape position.</p>
3099 </div>
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110<dl class="details">
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3141 <dd class="tag-source">
3142 <ul class="dummy">
3143 <li>
3144 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
3145 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-498">line 498</a>
3146 </li>
3147 </ul>
3148 </dd>
3149
3150
3151
3152
3153
3154
3155
3156</dl>
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170 <h5>Returns:</h5>
3171
3172
3173<div class="param-desc">
3174 <p>Returns whether the screen is in landscape position.</p>
3175</div>
3176
3177
3178
3179<dl>
3180 <dt>
3181 Type
3182 </dt>
3183 <dd>
3184
3185<span class="param-type">boolean</span>
3186
3187
3188
3189 </dd>
3190</dl>
3191
3192
3193
3194
3195
3196</dd>
3197
3198
3199
3200<hr>
3201<dt>
3202 <h4 class="name" id=".isVisible"><span class="type-signature">&lt;static> </span>isVisible<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
3203
3204
3205</dt>
3206<dd>
3207
3208
3209 <div class="description">
3210 <p>Tells whether the main window is visible or not.</p>
3211 </div>
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222<dl class="details">
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3253 <dd class="tag-source">
3254 <ul class="dummy">
3255 <li>
3256 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
3257 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-585">line 585</a>
3258 </li>
3259 </ul>
3260 </dd>
3261
3262
3263
3264
3265
3266
3267
3268</dl>
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282 <h5>Returns:</h5>
3283
3284
3285<div class="param-desc">
3286 <p>Returns whether the main window is visible or not.</p>
3287</div>
3288
3289
3290
3291<dl>
3292 <dt>
3293 Type
3294 </dt>
3295 <dd>
3296
3297<span class="param-type">boolean</span>
3298
3299
3300
3301 </dd>
3302</dl>
3303
3304
3305
3306
3307
3308</dd>
3309
3310
3311
3312<hr>
3313<dt>
3314 <h4 class="name" id=".keepAwake"><span class="type-signature">&lt;static> </span>keepAwake<span class="signature">( [callbackOk] [, callbackError])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
3315
3316
3317</dt>
3318<dd>
3319
3320
3321 <div class="description">
3322 <p>Keeps the screen awake and prevents it from turning off. Uses different methods internally: <a href="https://github.com/EddyVerbruggen/Insomnia-PhoneGap-Plugin">Apache Cordova's Insomnia plugin</a>, <a href="https://lists.w3.org/Archives/Public/public-device-apis/2014Feb/att-0001/Standby_API_Specification.pdf">Standby API</a>, <a href="https://developer.mozilla.org/en-US/docs/Archive/B2G_OS/API/Wake_Lock_API">Mozilla's Wake Lock API</a>, <a href="https://w3.org/TR/wake-lock/">new W3C's Wake Lock API</a>, <a href="https://w3.org/TR/2016/WD-wake-lock-20160714/">old W3C's Wake Lock API</a>, <a href="https://github.com/richtr/NoSleep.js?utm_source=recordnotfound.com">NoSleep.js library</a> (it should be activated by an event fired by the user as onclick or ontouchstart, etc.)...</p>
3323 </div>
3324
3325
3326
3327
3328
3329
3330
3331
3332 <h5>Parameters:</h5>
3333
3334
3335<table class="params table table-striped">
3336 <thead>
3337 <tr>
3338
3339 <th style="width:12%; min-width:110px;">Name</th>
3340
3341
3342 <th style="width:12%; min-width:110px;">Type</th>
3343
3344
3345 <th style="width:12%; min-width:110px;">Argument</th>
3346
3347
3348
3349
3350 <th class="last" style="min-width:310px;">Description</th>
3351 </tr>
3352 </thead>
3353
3354 <tbody>
3355
3356
3357 <tr>
3358
3359 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackOk</code></td>
3360
3361
3362 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3363
3364
3365<span class="param-type">function</span>
3366
3367
3368
3369
3370 </td>
3371
3372
3373 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3374
3375 &lt;optional><br>
3376
3377
3378
3379
3380
3381 </td>
3382
3383
3384
3385
3386 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Function that will be called if the action has been performed successfully, without parameters.</p></td>
3387 </tr>
3388
3389
3390
3391 <tr>
3392
3393 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackError</code></td>
3394
3395
3396 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3397
3398
3399<span class="param-type">function</span>
3400
3401
3402
3403
3404 </td>
3405
3406
3407 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3408
3409 &lt;optional><br>
3410
3411
3412
3413
3414
3415 </td>
3416
3417
3418
3419
3420 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Function that will be called if the action has not been performed successfully, without parameters.</p></td>
3421 </tr>
3422
3423
3424 </tbody>
3425</table>
3426
3427
3428
3429
3430<dl class="details">
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3461 <dd class="tag-source">
3462 <ul class="dummy">
3463 <li>
3464 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
3465 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-1846">line 1846</a>
3466 </li>
3467 </ul>
3468 </dd>
3469
3470
3471
3472
3473
3474
3475
3476 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
3477 <dd class="tag-todo">
3478 <ul>
3479 <li>Pay attention since many internal functions as the <a href="https://w3.org/TR/wake-lock/">new W3C's Wake Lock API</a> are still experimental and not well-tested.</li>
3480 </ul>
3481 </dd>
3482
3483</dl>
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497 <h5>Returns:</h5>
3498
3499
3500<div class="param-desc">
3501 <p>If it uses the <a href="https://w3.org/TR/wake-lock/">new W3C's Wake Lock API</a> internally, it will return a <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>. Otherwise, it will return a boolean depending on whether the internal method has been called successfully or not. The fact that the internal method has been called successfully does not mean that the action will perform successfully so it is recommended to relay on the &quot;callbackOk&quot; and &quot;callbackError&quot; functions and ignore this returning value.</p>
3502</div>
3503
3504
3505
3506<dl>
3507 <dt>
3508 Type
3509 </dt>
3510 <dd>
3511
3512<span class="param-type">boolean</span>
3513
3514
3515
3516 </dd>
3517</dl>
3518
3519
3520
3521
3522
3523</dd>
3524
3525
3526
3527<hr>
3528<dt>
3529 <h4 class="name" id=".keepAwakeDisable"><span class="type-signature">&lt;static> </span>keepAwakeDisable<span class="signature">( [callbackOk] [, callbackError])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
3530
3531
3532</dt>
3533<dd>
3534
3535
3536 <div class="description">
3537 <p>Lets the screen sleep again and stops preventing it from turning off. Uses different methods internally: <a href="https://github.com/EddyVerbruggen/Insomnia-PhoneGap-Plugin">Apache Cordova's Insomnia plugin</a>, <a href="https://lists.w3.org/Archives/Public/public-device-apis/2014Feb/att-0001/Standby_API_Specification.pdf">Standby API</a>, <a href="https://developer.mozilla.org/en-US/docs/Archive/B2G_OS/API/Wake_Lock_API">Mozilla's Wake Lock API</a>, <a href="https://w3.org/TR/wake-lock/">new W3C's Wake Lock API</a>, <a href="https://w3.org/TR/2016/WD-wake-lock-20160714/">old W3C's Wake Lock API</a>, <a href="https://github.com/richtr/NoSleep.js?utm_source=recordnotfound.com">NoSleep.js library</a> (it should be activated by an event fired by the user as onclick or ontouchstart, etc.)...</p>
3538 </div>
3539
3540
3541
3542
3543
3544
3545
3546
3547 <h5>Parameters:</h5>
3548
3549
3550<table class="params table table-striped">
3551 <thead>
3552 <tr>
3553
3554 <th style="width:12%; min-width:110px;">Name</th>
3555
3556
3557 <th style="width:12%; min-width:110px;">Type</th>
3558
3559
3560 <th style="width:12%; min-width:110px;">Argument</th>
3561
3562
3563
3564
3565 <th class="last" style="min-width:310px;">Description</th>
3566 </tr>
3567 </thead>
3568
3569 <tbody>
3570
3571
3572 <tr>
3573
3574 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackOk</code></td>
3575
3576
3577 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3578
3579
3580<span class="param-type">function</span>
3581
3582
3583
3584
3585 </td>
3586
3587
3588 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3589
3590 &lt;optional><br>
3591
3592
3593
3594
3595
3596 </td>
3597
3598
3599
3600
3601 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Function that will be called if the action has been performed successfully, without parameters.</p></td>
3602 </tr>
3603
3604
3605
3606 <tr>
3607
3608 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackError</code></td>
3609
3610
3611 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3612
3613
3614<span class="param-type">function</span>
3615
3616
3617
3618
3619 </td>
3620
3621
3622 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3623
3624 &lt;optional><br>
3625
3626
3627
3628
3629
3630 </td>
3631
3632
3633
3634
3635 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Function that will be called if the action has not been performed successfully, without parameters.</p></td>
3636 </tr>
3637
3638
3639 </tbody>
3640</table>
3641
3642
3643
3644
3645<dl class="details">
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3676 <dd class="tag-source">
3677 <ul class="dummy">
3678 <li>
3679 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
3680 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-1949">line 1949</a>
3681 </li>
3682 </ul>
3683 </dd>
3684
3685
3686
3687
3688
3689
3690
3691 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
3692 <dd class="tag-todo">
3693 <ul>
3694 <li>Pay attention since many internal functions as the <a href="https://w3.org/TR/wake-lock/">new W3C's Wake Lock API</a> are still experimental and not well-tested.</li>
3695 </ul>
3696 </dd>
3697
3698</dl>
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712 <h5>Returns:</h5>
3713
3714
3715<div class="param-desc">
3716 <p>If it uses the <a href="https://w3.org/TR/wake-lock/">new W3C's Wake Lock API</a> internally, it will return a <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>. Otherwise, it will return a boolean depending on whether the internal method has been called successfully or not. The fact that the internal method has been called successfully does not mean that the action will perform successfully so it is recommended to relay on the &quot;callbackOk&quot; and &quot;callbackError&quot; functions and ignore this returning value.</p>
3717</div>
3718
3719
3720
3721<dl>
3722 <dt>
3723 Type
3724 </dt>
3725 <dd>
3726
3727<span class="param-type">boolean</span>
3728
3729
3730
3731 </dd>
3732</dl>
3733
3734
3735
3736
3737
3738</dd>
3739
3740
3741
3742<hr>
3743<dt>
3744 <h4 class="name" id=".lockOrientation"><span class="type-signature">&lt;static> </span>lockOrientation<span class="signature">(orientationMode [, onSuccess] [, onError])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
3745
3746
3747</dt>
3748<dd>
3749
3750
3751 <div class="description">
3752 <p>Function that forces a desired screen orientation. Using the <a href="https://developer.mozilla.org/en-US/docs/Web/API/ScreenOrientation/lock">lock</a> function and fallbacks to the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Screen/lockOrientation">lockOrientation</a> function of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/ScreenOrientation">Screen Orientation API</a> internally.</p>
3753 </div>
3754
3755
3756
3757
3758
3759
3760
3761
3762 <h5>Parameters:</h5>
3763
3764
3765<table class="params table table-striped">
3766 <thead>
3767 <tr>
3768
3769 <th style="width:12%; min-width:110px;">Name</th>
3770
3771
3772 <th style="width:12%; min-width:110px;">Type</th>
3773
3774
3775 <th style="width:12%; min-width:110px;">Argument</th>
3776
3777
3778
3779
3780 <th class="last" style="min-width:310px;">Description</th>
3781 </tr>
3782 </thead>
3783
3784 <tbody>
3785
3786
3787 <tr>
3788
3789 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>orientationMode</code></td>
3790
3791
3792 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3793
3794
3795<span class="param-type">'default'</span>
3796|
3797
3798<span class="param-type">'any'</span>
3799|
3800
3801<span class="param-type">'natural'</span>
3802|
3803
3804<span class="param-type">'landscape'</span>
3805|
3806
3807<span class="param-type">'portrait'</span>
3808|
3809
3810<span class="param-type">'portrait-primary'</span>
3811|
3812
3813<span class="param-type">'portrait-secondary'</span>
3814|
3815
3816<span class="param-type">'landscape-primary'</span>
3817|
3818
3819<span class="param-type">'landscape-secondary'</span>
3820
3821
3822
3823
3824 </td>
3825
3826
3827 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3828
3829
3830
3831
3832
3833 </td>
3834
3835
3836
3837
3838 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Desired orientation. Internally, &quot;default&quot; and &quot;natural&quot; will be exchanged and &quot;any&quot; will be transformed to &quot;default&quot;, depending on the internal function used. Values &quot;default&quot;, &quot;any&quot; and &quot;natural&quot; are not recommended because they are not supported in all web clients.</p></td>
3839 </tr>
3840
3841
3842
3843 <tr>
3844
3845 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>onSuccess</code></td>
3846
3847
3848 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3849
3850
3851<span class="param-type">function</span>
3852
3853
3854
3855
3856 </td>
3857
3858
3859 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3860
3861 &lt;optional><br>
3862
3863
3864
3865
3866
3867 </td>
3868
3869
3870
3871
3872 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Callback function with no parameters that will be called if the orientation has been set successfully.</p></td>
3873 </tr>
3874
3875
3876
3877 <tr>
3878
3879 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>onError</code></td>
3880
3881
3882 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3883
3884
3885<span class="param-type">function</span>
3886
3887
3888
3889
3890 </td>
3891
3892
3893 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
3894
3895 &lt;optional><br>
3896
3897
3898
3899
3900
3901 </td>
3902
3903
3904
3905
3906 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Callback function that will be called if the orientation has not been set successfully. Unique parameter received will be an error object (probably a <a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMException">DOMException</a>, depending on the client) with the error.</p></td>
3907 </tr>
3908
3909
3910 </tbody>
3911</table>
3912
3913
3914
3915
3916<dl class="details">
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
3947 <dd class="tag-source">
3948 <ul class="dummy">
3949 <li>
3950 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
3951 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-1611">line 1611</a>
3952 </li>
3953 </ul>
3954 </dd>
3955
3956
3957
3958
3959
3960
3961
3962 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
3963 <dd class="tag-todo">
3964 <ul>
3965 <li>Transform values of "default", "any" and "natural" to "portrait", "landscape", etc. when the web clients do not support it (calculating current orientation and trying to guess natural/default one, etc.).</li>
3966 </ul>
3967 </dd>
3968
3969</dl>
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983 <h5>Returns:</h5>
3984
3985
3986<div class="param-desc">
3987 <p>Returns the same <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a> that the <a href="https://developer.mozilla.org/en-US/docs/Web/API/ScreenOrientation/lock">lock</a> function returns, if available. Otherwise, returns the same boolean as the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Screen/lockOrientation">lockOrientation</a> function (true if the locking action has been performed successfully), if available. Otherwise, returns false when the <a href="https://developer.mozilla.org/en-US/docs/Web/API/ScreenOrientation">Screen Orientation API</a> is not available.</p>
3988</div>
3989
3990
3991
3992<dl>
3993 <dt>
3994 Type
3995 </dt>
3996 <dd>
3997
3998<span class="param-type">boolean</span>
3999
4000
4001
4002 </dd>
4003</dl>
4004
4005
4006
4007
4008
4009</dd>
4010
4011
4012
4013<hr>
4014<dt>
4015 <h4 class="name" id=".onFocusChange"><span class="type-signature">&lt;static> </span>onFocusChange<span class="signature">(callbackFunction [, keepOldFunction])</span><span class="type-signature"></span></h4>
4016
4017
4018</dt>
4019<dd>
4020
4021
4022 <div class="description">
4023 <p>Sets a function to execute when the screen (main window) focus is changed or removes it.</p>
4024 </div>
4025
4026
4027
4028
4029
4030
4031
4032
4033 <h5>Parameters:</h5>
4034
4035
4036<table class="params table table-striped">
4037 <thead>
4038 <tr>
4039
4040 <th style="width:12%; min-width:110px;">Name</th>
4041
4042
4043 <th style="width:12%; min-width:110px;">Type</th>
4044
4045
4046 <th style="width:12%; min-width:110px;">Argument</th>
4047
4048
4049
4050 <th style="width:12%; min-width:110px;">Default</th>
4051
4052
4053 <th class="last" style="min-width:310px;">Description</th>
4054 </tr>
4055 </thead>
4056
4057 <tbody>
4058
4059
4060 <tr>
4061
4062 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackFunction</code></td>
4063
4064
4065 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4066
4067
4068<span class="param-type">function</span>
4069|
4070
4071<span class="param-type">null</span>
4072
4073
4074
4075
4076 </td>
4077
4078
4079 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4080
4081
4082
4083
4084
4085 </td>
4086
4087
4088
4089 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4090
4091 </td>
4092
4093
4094 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The function (event listener) that we want to execute when the event is fired, with no parameters. If a null value is used, the event will be removed.</p></td>
4095 </tr>
4096
4097
4098
4099 <tr>
4100
4101 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldFunction</code></td>
4102
4103
4104 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4105
4106
4107<span class="param-type">boolean</span>
4108
4109
4110
4111
4112 </td>
4113
4114
4115 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4116
4117 &lt;optional><br>
4118
4119
4120
4121
4122
4123 </td>
4124
4125
4126
4127 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4128
4129 true
4130
4131 </td>
4132
4133
4134 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep any possible previous event listener for the same target and event name or not.</p></td>
4135 </tr>
4136
4137
4138 </tbody>
4139</table>
4140
4141
4142
4143
4144<dl class="details">
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
4175 <dd class="tag-source">
4176 <ul class="dummy">
4177 <li>
4178 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
4179 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-708">line 708</a>
4180 </li>
4181 </ul>
4182 </dd>
4183
4184
4185
4186
4187
4188
4189
4190</dl>
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206</dd>
4207
4208
4209
4210<hr>
4211<dt>
4212 <h4 class="name" id=".onFullScreenChange"><span class="type-signature">&lt;static> </span>onFullScreenChange<span class="signature">(callbackFunction [, keepOldFunction])</span><span class="type-signature"></span></h4>
4213
4214
4215</dt>
4216<dd>
4217
4218
4219 <div class="description">
4220 <p>Sets a function to execute when full screen mode is changed (enabled or disabled) or removes it.</p>
4221 </div>
4222
4223
4224
4225
4226
4227
4228
4229
4230 <h5>Parameters:</h5>
4231
4232
4233<table class="params table table-striped">
4234 <thead>
4235 <tr>
4236
4237 <th style="width:12%; min-width:110px;">Name</th>
4238
4239
4240 <th style="width:12%; min-width:110px;">Type</th>
4241
4242
4243 <th style="width:12%; min-width:110px;">Argument</th>
4244
4245
4246
4247 <th style="width:12%; min-width:110px;">Default</th>
4248
4249
4250 <th class="last" style="min-width:310px;">Description</th>
4251 </tr>
4252 </thead>
4253
4254 <tbody>
4255
4256
4257 <tr>
4258
4259 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackFunction</code></td>
4260
4261
4262 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4263
4264
4265<span class="param-type">function</span>
4266|
4267
4268<span class="param-type">null</span>
4269
4270
4271
4272
4273 </td>
4274
4275
4276 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4277
4278
4279
4280
4281
4282 </td>
4283
4284
4285
4286 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4287
4288 </td>
4289
4290
4291 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The function (event listener) that we want to execute when the event is fired, with no parameters. If a null value is used, the event will be removed.</p></td>
4292 </tr>
4293
4294
4295
4296 <tr>
4297
4298 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldFunction</code></td>
4299
4300
4301 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4302
4303
4304<span class="param-type">boolean</span>
4305
4306
4307
4308
4309 </td>
4310
4311
4312 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4313
4314 &lt;optional><br>
4315
4316
4317
4318
4319
4320 </td>
4321
4322
4323
4324 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4325
4326 true
4327
4328 </td>
4329
4330
4331 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep any possible previous event listener for the same target and event name or not.</p></td>
4332 </tr>
4333
4334
4335 </tbody>
4336</table>
4337
4338
4339
4340
4341<dl class="details">
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
4372 <dd class="tag-source">
4373 <ul class="dummy">
4374 <li>
4375 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
4376 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-829">line 829</a>
4377 </li>
4378 </ul>
4379 </dd>
4380
4381
4382
4383
4384
4385
4386
4387</dl>
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403</dd>
4404
4405
4406
4407<hr>
4408<dt>
4409 <h4 class="name" id=".onOrientationChange"><span class="type-signature">&lt;static> </span>onOrientationChange<span class="signature">(callbackFunction [, keepOldFunction])</span><span class="type-signature"></span></h4>
4410
4411
4412</dt>
4413<dd>
4414
4415
4416 <div class="description">
4417 <p>Sets a function to execute when the screen (main window) orientation is changed (portrait or landscape) or removes it.</p>
4418 </div>
4419
4420
4421
4422
4423
4424
4425
4426
4427 <h5>Parameters:</h5>
4428
4429
4430<table class="params table table-striped">
4431 <thead>
4432 <tr>
4433
4434 <th style="width:12%; min-width:110px;">Name</th>
4435
4436
4437 <th style="width:12%; min-width:110px;">Type</th>
4438
4439
4440 <th style="width:12%; min-width:110px;">Argument</th>
4441
4442
4443
4444 <th style="width:12%; min-width:110px;">Default</th>
4445
4446
4447 <th class="last" style="min-width:310px;">Description</th>
4448 </tr>
4449 </thead>
4450
4451 <tbody>
4452
4453
4454 <tr>
4455
4456 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackFunction</code></td>
4457
4458
4459 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4460
4461
4462<span class="param-type">function</span>
4463|
4464
4465<span class="param-type">null</span>
4466
4467
4468
4469
4470 </td>
4471
4472
4473 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4474
4475
4476
4477
4478
4479 </td>
4480
4481
4482
4483 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4484
4485 </td>
4486
4487
4488 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The function (event listener) that we want to execute when the event is fired, with no parameters. If a null value is used, the event will be removed.</p></td>
4489 </tr>
4490
4491
4492
4493 <tr>
4494
4495 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldFunction</code></td>
4496
4497
4498 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4499
4500
4501<span class="param-type">boolean</span>
4502
4503
4504
4505
4506 </td>
4507
4508
4509 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4510
4511 &lt;optional><br>
4512
4513
4514
4515
4516
4517 </td>
4518
4519
4520
4521 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4522
4523 true
4524
4525 </td>
4526
4527
4528 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep any possible previous event listener for the same target and event name or not.</p></td>
4529 </tr>
4530
4531
4532 </tbody>
4533</table>
4534
4535
4536
4537
4538<dl class="details">
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
4569 <dd class="tag-source">
4570 <ul class="dummy">
4571 <li>
4572 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
4573 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-684">line 684</a>
4574 </li>
4575 </ul>
4576 </dd>
4577
4578
4579
4580
4581
4582
4583
4584</dl>
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600</dd>
4601
4602
4603
4604<hr>
4605<dt>
4606 <h4 class="name" id=".onResize"><span class="type-signature">&lt;static> </span>onResize<span class="signature">(callbackFunction [, keepOldFunction])</span><span class="type-signature"></span></h4>
4607
4608
4609</dt>
4610<dd>
4611
4612
4613 <div class="description">
4614 <p>Sets a function to execute when the screen (main window) is resized (<a href="https://developer.mozilla.org/en-US/docs/Web/Events/resize">onResize</a> event) or removes it.</p>
4615 </div>
4616
4617
4618
4619
4620
4621
4622
4623
4624 <h5>Parameters:</h5>
4625
4626
4627<table class="params table table-striped">
4628 <thead>
4629 <tr>
4630
4631 <th style="width:12%; min-width:110px;">Name</th>
4632
4633
4634 <th style="width:12%; min-width:110px;">Type</th>
4635
4636
4637 <th style="width:12%; min-width:110px;">Argument</th>
4638
4639
4640
4641 <th style="width:12%; min-width:110px;">Default</th>
4642
4643
4644 <th class="last" style="min-width:310px;">Description</th>
4645 </tr>
4646 </thead>
4647
4648 <tbody>
4649
4650
4651 <tr>
4652
4653 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackFunction</code></td>
4654
4655
4656 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4657
4658
4659<span class="param-type">function</span>
4660|
4661
4662<span class="param-type">null</span>
4663
4664
4665
4666
4667 </td>
4668
4669
4670 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4671
4672
4673
4674
4675
4676 </td>
4677
4678
4679
4680 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4681
4682 </td>
4683
4684
4685 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The function (event listener) that we want to execute when the event is fired, with no parameters. If a null value is used, the event will be removed.</p></td>
4686 </tr>
4687
4688
4689
4690 <tr>
4691
4692 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldFunction</code></td>
4693
4694
4695 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4696
4697
4698<span class="param-type">boolean</span>
4699
4700
4701
4702
4703 </td>
4704
4705
4706 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4707
4708 &lt;optional><br>
4709
4710
4711
4712
4713
4714 </td>
4715
4716
4717
4718 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4719
4720 true
4721
4722 </td>
4723
4724
4725 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep any possible previous event listener for the same target and event name or not.</p></td>
4726 </tr>
4727
4728
4729 </tbody>
4730</table>
4731
4732
4733
4734
4735<dl class="details">
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
4766 <dd class="tag-source">
4767 <ul class="dummy">
4768 <li>
4769 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
4770 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-720">line 720</a>
4771 </li>
4772 </ul>
4773 </dd>
4774
4775
4776
4777
4778
4779
4780
4781</dl>
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797</dd>
4798
4799
4800
4801<hr>
4802<dt>
4803 <h4 class="name" id=".onResizeOrZoom"><span class="type-signature">&lt;static> </span>onResizeOrZoom<span class="signature">(callbackFunction [, keepOldFunction])</span><span class="type-signature"></span></h4>
4804
4805
4806</dt>
4807<dd>
4808
4809
4810 <div class="description">
4811 <p>Sets a function to execute when the screen (main window) is resized or the zoom is changed, or removes it.</p>
4812 </div>
4813
4814
4815
4816
4817
4818
4819
4820
4821 <h5>Parameters:</h5>
4822
4823
4824<table class="params table table-striped">
4825 <thead>
4826 <tr>
4827
4828 <th style="width:12%; min-width:110px;">Name</th>
4829
4830
4831 <th style="width:12%; min-width:110px;">Type</th>
4832
4833
4834 <th style="width:12%; min-width:110px;">Argument</th>
4835
4836
4837
4838 <th style="width:12%; min-width:110px;">Default</th>
4839
4840
4841 <th class="last" style="min-width:310px;">Description</th>
4842 </tr>
4843 </thead>
4844
4845 <tbody>
4846
4847
4848 <tr>
4849
4850 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackFunction</code></td>
4851
4852
4853 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4854
4855
4856<span class="param-type">function</span>
4857|
4858
4859<span class="param-type">null</span>
4860
4861
4862
4863
4864 </td>
4865
4866
4867 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4868
4869
4870
4871
4872
4873 </td>
4874
4875
4876
4877 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4878
4879 </td>
4880
4881
4882 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The function (event listener) that we want to execute when the event is fired, with no parameters. If a null value is used, the event will be removed.</p></td>
4883 </tr>
4884
4885
4886
4887 <tr>
4888
4889 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldFunction</code></td>
4890
4891
4892 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4893
4894
4895<span class="param-type">boolean</span>
4896
4897
4898
4899
4900 </td>
4901
4902
4903 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4904
4905 &lt;optional><br>
4906
4907
4908
4909
4910
4911 </td>
4912
4913
4914
4915 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
4916
4917 true
4918
4919 </td>
4920
4921
4922 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep any possible previous event listener for the same target and event name or not.</p></td>
4923 </tr>
4924
4925
4926 </tbody>
4927</table>
4928
4929
4930
4931
4932<dl class="details">
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
4963 <dd class="tag-source">
4964 <ul class="dummy">
4965 <li>
4966 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
4967 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-817">line 817</a>
4968 </li>
4969 </ul>
4970 </dd>
4971
4972
4973
4974
4975
4976
4977
4978</dl>
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994</dd>
4995
4996
4997
4998<hr>
4999<dt>
5000 <h4 class="name" id=".onScrollLeft"><span class="type-signature">&lt;static> </span>onScrollLeft<span class="signature">(callbackFunction [, keepOldFunction])</span><span class="type-signature"></span></h4>
5001
5002
5003</dt>
5004<dd>
5005
5006
5007 <div class="description">
5008 <p>Sets a function to execute when the left scroll position (horizontal scroll) is changed in the screen (main window) or removes it.</p>
5009 </div>
5010
5011
5012
5013
5014
5015
5016
5017
5018 <h5>Parameters:</h5>
5019
5020
5021<table class="params table table-striped">
5022 <thead>
5023 <tr>
5024
5025 <th style="width:12%; min-width:110px;">Name</th>
5026
5027
5028 <th style="width:12%; min-width:110px;">Type</th>
5029
5030
5031 <th style="width:12%; min-width:110px;">Argument</th>
5032
5033
5034
5035 <th style="width:12%; min-width:110px;">Default</th>
5036
5037
5038 <th class="last" style="min-width:310px;">Description</th>
5039 </tr>
5040 </thead>
5041
5042 <tbody>
5043
5044
5045 <tr>
5046
5047 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackFunction</code></td>
5048
5049
5050 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5051
5052
5053<span class="param-type">function</span>
5054|
5055
5056<span class="param-type">null</span>
5057
5058
5059
5060
5061 </td>
5062
5063
5064 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5065
5066
5067
5068
5069
5070 </td>
5071
5072
5073
5074 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5075
5076 </td>
5077
5078
5079 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The function (event listener) that we want to execute when the event is fired, with no parameters. If a null value is used, the event will be removed.</p></td>
5080 </tr>
5081
5082
5083
5084 <tr>
5085
5086 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldFunction</code></td>
5087
5088
5089 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5090
5091
5092<span class="param-type">boolean</span>
5093
5094
5095
5096
5097 </td>
5098
5099
5100 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5101
5102 &lt;optional><br>
5103
5104
5105
5106
5107
5108 </td>
5109
5110
5111
5112 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5113
5114 true
5115
5116 </td>
5117
5118
5119 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep any possible previous event listener for the same target and event name or not.</p></td>
5120 </tr>
5121
5122
5123 </tbody>
5124</table>
5125
5126
5127
5128
5129<dl class="details">
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5160 <dd class="tag-source">
5161 <ul class="dummy">
5162 <li>
5163 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
5164 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-660">line 660</a>
5165 </li>
5166 </ul>
5167 </dd>
5168
5169
5170
5171
5172
5173
5174
5175</dl>
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191</dd>
5192
5193
5194
5195<hr>
5196<dt>
5197 <h4 class="name" id=".onScrollTop"><span class="type-signature">&lt;static> </span>onScrollTop<span class="signature">(callbackFunction [, keepOldFunction])</span><span class="type-signature"></span></h4>
5198
5199
5200</dt>
5201<dd>
5202
5203
5204 <div class="description">
5205 <p>Sets a function to execute when the top scroll position (vertical scroll) is changed in the screen (main window) or removes it.</p>
5206 </div>
5207
5208
5209
5210
5211
5212
5213
5214
5215 <h5>Parameters:</h5>
5216
5217
5218<table class="params table table-striped">
5219 <thead>
5220 <tr>
5221
5222 <th style="width:12%; min-width:110px;">Name</th>
5223
5224
5225 <th style="width:12%; min-width:110px;">Type</th>
5226
5227
5228 <th style="width:12%; min-width:110px;">Argument</th>
5229
5230
5231
5232 <th style="width:12%; min-width:110px;">Default</th>
5233
5234
5235 <th class="last" style="min-width:310px;">Description</th>
5236 </tr>
5237 </thead>
5238
5239 <tbody>
5240
5241
5242 <tr>
5243
5244 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackFunction</code></td>
5245
5246
5247 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5248
5249
5250<span class="param-type">function</span>
5251|
5252
5253<span class="param-type">null</span>
5254
5255
5256
5257
5258 </td>
5259
5260
5261 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5262
5263
5264
5265
5266
5267 </td>
5268
5269
5270
5271 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5272
5273 </td>
5274
5275
5276 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The function (event listener) that we want to execute when the event is fired, with no parameters. If a null value is used, the event will be removed.</p></td>
5277 </tr>
5278
5279
5280
5281 <tr>
5282
5283 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldFunction</code></td>
5284
5285
5286 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5287
5288
5289<span class="param-type">boolean</span>
5290
5291
5292
5293
5294 </td>
5295
5296
5297 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5298
5299 &lt;optional><br>
5300
5301
5302
5303
5304
5305 </td>
5306
5307
5308
5309 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5310
5311 true
5312
5313 </td>
5314
5315
5316 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep any possible previous event listener for the same target and event name or not.</p></td>
5317 </tr>
5318
5319
5320 </tbody>
5321</table>
5322
5323
5324
5325
5326<dl class="details">
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5357 <dd class="tag-source">
5358 <ul class="dummy">
5359 <li>
5360 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
5361 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-672">line 672</a>
5362 </li>
5363 </ul>
5364 </dd>
5365
5366
5367
5368
5369
5370
5371
5372</dl>
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388</dd>
5389
5390
5391
5392<hr>
5393<dt>
5394 <h4 class="name" id=".onVisibilityChange"><span class="type-signature">&lt;static> </span>onVisibilityChange<span class="signature">(callbackFunction [, keepOldFunction])</span><span class="type-signature"></span></h4>
5395
5396
5397</dt>
5398<dd>
5399
5400
5401 <div class="description">
5402 <p>Sets a function to execute when the screen (main window) visibility is changed or removes it.</p>
5403 </div>
5404
5405
5406
5407
5408
5409
5410
5411
5412 <h5>Parameters:</h5>
5413
5414
5415<table class="params table table-striped">
5416 <thead>
5417 <tr>
5418
5419 <th style="width:12%; min-width:110px;">Name</th>
5420
5421
5422 <th style="width:12%; min-width:110px;">Type</th>
5423
5424
5425 <th style="width:12%; min-width:110px;">Argument</th>
5426
5427
5428
5429 <th style="width:12%; min-width:110px;">Default</th>
5430
5431
5432 <th class="last" style="min-width:310px;">Description</th>
5433 </tr>
5434 </thead>
5435
5436 <tbody>
5437
5438
5439 <tr>
5440
5441 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>callbackFunction</code></td>
5442
5443
5444 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5445
5446
5447<span class="param-type">function</span>
5448|
5449
5450<span class="param-type">null</span>
5451
5452
5453
5454
5455 </td>
5456
5457
5458 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5459
5460
5461
5462
5463
5464 </td>
5465
5466
5467
5468 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5469
5470 </td>
5471
5472
5473 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The function (event listener) that we want to execute when the event is fired, with no parameters. If a null value is used, the event will be removed.</p></td>
5474 </tr>
5475
5476
5477
5478 <tr>
5479
5480 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>keepOldFunction</code></td>
5481
5482
5483 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5484
5485
5486<span class="param-type">boolean</span>
5487
5488
5489
5490
5491 </td>
5492
5493
5494 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5495
5496 &lt;optional><br>
5497
5498
5499
5500
5501
5502 </td>
5503
5504
5505
5506 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5507
5508 true
5509
5510 </td>
5511
5512
5513 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to keep any possible previous event listener for the same target and event name or not.</p></td>
5514 </tr>
5515
5516
5517 </tbody>
5518</table>
5519
5520
5521
5522
5523<dl class="details">
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5554 <dd class="tag-source">
5555 <ul class="dummy">
5556 <li>
5557 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
5558 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-696">line 696</a>
5559 </li>
5560 </ul>
5561 </dd>
5562
5563
5564
5565
5566
5567
5568
5569</dl>
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585</dd>
5586
5587
5588
5589<hr>
5590<dt>
5591 <h4 class="name" id=".setFullScreen"><span class="type-signature">&lt;static> </span>setFullScreen<span class="signature">( [useFullScreen] [, element] [, allowReload])</span><span class="type-signature"></span></h4>
5592
5593
5594</dt>
5595<dd>
5596
5597
5598 <div class="description">
5599 <p>Toggles between full screen and normal mode. Uses the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API">Fullscreen API</a> and fallbacks to other methods internally, including <a href="https://nwjs.io/">NW.js (formerly node-webkit)</a> and <a href="https://electronjs.org/">Electron (Electron.js)</a> ones, when not available. Recommended to be called through an event fired by the user as onclick or ontouchstart, etc.</p>
5600 </div>
5601
5602
5603
5604
5605
5606
5607
5608
5609 <h5>Parameters:</h5>
5610
5611
5612<table class="params table table-striped">
5613 <thead>
5614 <tr>
5615
5616 <th style="width:12%; min-width:110px;">Name</th>
5617
5618
5619 <th style="width:12%; min-width:110px;">Type</th>
5620
5621
5622 <th style="width:12%; min-width:110px;">Argument</th>
5623
5624
5625
5626 <th style="width:12%; min-width:110px;">Default</th>
5627
5628
5629 <th class="last" style="min-width:310px;">Description</th>
5630 </tr>
5631 </thead>
5632
5633 <tbody>
5634
5635
5636 <tr>
5637
5638 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>useFullScreen</code></td>
5639
5640
5641 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5642
5643
5644<span class="param-type">boolean</span>
5645
5646
5647
5648
5649 </td>
5650
5651
5652 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5653
5654 &lt;optional><br>
5655
5656
5657
5658
5659
5660 </td>
5661
5662
5663
5664 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5665
5666 true
5667
5668 </td>
5669
5670
5671 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If set to true, it will try to enable full screen mode. Otherwise, it will try to enable normal mode.</p></td>
5672 </tr>
5673
5674
5675
5676 <tr>
5677
5678 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>element</code></td>
5679
5680
5681 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5682
5683
5684<span class="param-type">Element</span>
5685
5686
5687
5688
5689 </td>
5690
5691
5692 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5693
5694 &lt;optional><br>
5695
5696
5697
5698
5699
5700 </td>
5701
5702
5703
5704 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5705
5706 document.documentElement|document.body
5707
5708 </td>
5709
5710
5711 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Element which we want to use in full screen mode. By default uses the whole document body. Only used when the &quot;useFullScreen&quot; parameter is set to true. If an element is provided, it will use neither <a href="https://nwjs.io/">NW.js (formerly node-webkit)</a> nor <a href="https://electronjs.org/">Electron (Electron.js)</a> methods.</p></td>
5712 </tr>
5713
5714
5715
5716 <tr>
5717
5718 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>allowReload</code></td>
5719
5720
5721 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5722
5723
5724<span class="param-type">boolean</span>
5725
5726
5727
5728
5729 </td>
5730
5731
5732 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5733
5734 &lt;optional><br>
5735
5736
5737
5738
5739
5740 </td>
5741
5742
5743
5744 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5745
5746 false
5747
5748 </td>
5749
5750
5751 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If set to true and &quot;useFullScreen&quot; is set to true but it fails to enable full screen normally, it will try to reload the entire current document again in a new bigger window. Useful for very old web clients. Only used when the &quot;useFullScreen&quot; parameter is set to true.</p></td>
5752 </tr>
5753
5754
5755 </tbody>
5756</table>
5757
5758
5759
5760
5761<dl class="details">
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5792 <dd class="tag-source">
5793 <ul class="dummy">
5794 <li>
5795 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
5796 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-898">line 898</a>
5797 </li>
5798 </ul>
5799 </dd>
5800
5801
5802
5803
5804
5805
5806
5807</dl>
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823</dd>
5824
5825
5826
5827<hr>
5828<dt>
5829 <h4 class="name" id=".setOrientation"><span class="type-signature">&lt;static> </span>setOrientation<span class="signature">()</span><span class="type-signature"></span></h4>
5830
5831
5832</dt>
5833<dd>
5834
5835
5836 <div class="description">
5837 <p>Alias for <a href="CB_Screen.html#.lockOrientation"><code>CB_Screen.lockOrientation</code></a>.</p>
5838 </div>
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849<dl class="details">
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
5880 <dd class="tag-source">
5881 <ul class="dummy">
5882 <li>
5883 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
5884 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-1597">line 1597</a>
5885 </li>
5886 </ul>
5887 </dd>
5888
5889
5890
5891
5892
5893 <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
5894 <dd class="tag-see">
5895 <ul>
5896 <li><a href="CB_Screen.html#.lockOrientation"><code>CB_Screen.lockOrientation</code></a></li>
5897 </ul>
5898 </dd>
5899
5900
5901
5902</dl>
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918</dd>
5919
5920
5921
5922<hr>
5923<dt>
5924 <h4 class="name" id=".setViewport"><span class="type-signature">&lt;static> </span>setViewport<span class="signature">( [width] [, height] [, userScalable] [, initialScale] [, minimumScale] [, maximumScale] [, shrinkToFit] [, targetDensityDPI])</span><span class="type-signature"> &rarr; {Node|null}</span></h4>
5925
5926
5927</dt>
5928<dd>
5929
5930
5931 <div class="description">
5932 <p>Sets the <a href="https://developer.mozilla.org/en-US/docs/Mozilla/Mobile/Viewport_meta_tag">Viewport</a> meta tag dynamically with the desired options. If the <a href="https://developer.mozilla.org/en-US/docs/Mozilla/Mobile/Viewport_meta_tag">Viewport</a> meta tag already exists, it will be updated. Otherwise, it will create a new one (and append it to the <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/head">HEAD</a> tag, if found).</p>
5933 </div>
5934
5935
5936
5937
5938
5939
5940
5941
5942 <h5>Parameters:</h5>
5943
5944
5945<table class="params table table-striped">
5946 <thead>
5947 <tr>
5948
5949 <th style="width:12%; min-width:110px;">Name</th>
5950
5951
5952 <th style="width:12%; min-width:110px;">Type</th>
5953
5954
5955 <th style="width:12%; min-width:110px;">Argument</th>
5956
5957
5958
5959 <th style="width:12%; min-width:110px;">Default</th>
5960
5961
5962 <th class="last" style="min-width:310px;">Description</th>
5963 </tr>
5964 </thead>
5965
5966 <tbody>
5967
5968
5969 <tr>
5970
5971 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>width</code></td>
5972
5973
5974 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5975
5976
5977<span class="param-type">string</span>
5978|
5979
5980<span class="param-type">integer</span>
5981
5982
5983
5984
5985 </td>
5986
5987
5988 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
5989
5990 &lt;optional><br>
5991
5992
5993
5994
5995
5996 </td>
5997
5998
5999
6000 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6001
6002 </td>
6003
6004
6005 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Desired value for the &quot;width&quot; parameter.</p></td>
6006 </tr>
6007
6008
6009
6010 <tr>
6011
6012 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>height</code></td>
6013
6014
6015 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6016
6017
6018<span class="param-type">string</span>
6019|
6020
6021<span class="param-type">integer</span>
6022
6023
6024
6025
6026 </td>
6027
6028
6029 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6030
6031 &lt;optional><br>
6032
6033
6034
6035
6036
6037 </td>
6038
6039
6040
6041 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6042
6043 </td>
6044
6045
6046 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Desired value for the &quot;height&quot; parameter.</p></td>
6047 </tr>
6048
6049
6050
6051 <tr>
6052
6053 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>userScalable</code></td>
6054
6055
6056 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6057
6058
6059<span class="param-type">string</span>
6060|
6061
6062<span class="param-type">boolean</span>
6063
6064
6065
6066
6067 </td>
6068
6069
6070 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6071
6072 &lt;optional><br>
6073
6074
6075
6076
6077
6078 </td>
6079
6080
6081
6082 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6083
6084 'no'
6085
6086 </td>
6087
6088
6089 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Desired value for the &quot;user-scalable&quot; parameter.</p></td>
6090 </tr>
6091
6092
6093
6094 <tr>
6095
6096 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>initialScale</code></td>
6097
6098
6099 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6100
6101
6102<span class="param-type">number</span>
6103
6104
6105
6106
6107 </td>
6108
6109
6110 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6111
6112 &lt;optional><br>
6113
6114
6115
6116
6117
6118 </td>
6119
6120
6121
6122 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6123
6124 </td>
6125
6126
6127 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Desired value for the &quot;initial-scale&quot; parameter.</p></td>
6128 </tr>
6129
6130
6131
6132 <tr>
6133
6134 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>minimumScale</code></td>
6135
6136
6137 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6138
6139
6140<span class="param-type">number</span>
6141
6142
6143
6144
6145 </td>
6146
6147
6148 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6149
6150 &lt;optional><br>
6151
6152
6153
6154
6155
6156 </td>
6157
6158
6159
6160 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6161
6162 </td>
6163
6164
6165 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Desired value for the &quot;minimum-scale&quot; parameter.</p></td>
6166 </tr>
6167
6168
6169
6170 <tr>
6171
6172 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>maximumScale</code></td>
6173
6174
6175 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6176
6177
6178<span class="param-type">number</span>
6179
6180
6181
6182
6183 </td>
6184
6185
6186 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6187
6188 &lt;optional><br>
6189
6190
6191
6192
6193
6194 </td>
6195
6196
6197
6198 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6199
6200 </td>
6201
6202
6203 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Desired value for the &quot;maximum-scale&quot; parameter.</p></td>
6204 </tr>
6205
6206
6207
6208 <tr>
6209
6210 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>shrinkToFit</code></td>
6211
6212
6213 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6214
6215
6216<span class="param-type">string</span>
6217
6218
6219
6220
6221 </td>
6222
6223
6224 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6225
6226 &lt;optional><br>
6227
6228
6229
6230
6231
6232 </td>
6233
6234
6235
6236 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6237
6238 </td>
6239
6240
6241 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Desired value for the &quot;shrink-to-fit&quot; parameter.</p></td>
6242 </tr>
6243
6244
6245
6246 <tr>
6247
6248 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>targetDensityDPI</code></td>
6249
6250
6251 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6252
6253
6254<span class="param-type">string</span>
6255|
6256
6257<span class="param-type">number</span>
6258
6259
6260
6261
6262 </td>
6263
6264
6265 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6266
6267 &lt;optional><br>
6268
6269
6270
6271
6272
6273 </td>
6274
6275
6276
6277 <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6278
6279 </td>
6280
6281
6282 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Desired value for the &quot;target-densitydpi&quot; parameter.</p></td>
6283 </tr>
6284
6285
6286 </tbody>
6287</table>
6288
6289
6290
6291
6292<dl class="details">
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
6323 <dd class="tag-source">
6324 <ul class="dummy">
6325 <li>
6326 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
6327 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-1754">line 1754</a>
6328 </li>
6329 </ul>
6330 </dd>
6331
6332
6333
6334
6335
6336
6337
6338</dl>
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352 <h5>Returns:</h5>
6353
6354
6355<div class="param-desc">
6356 <p>Returns the DOM element which belongs to the <a href="https://developer.mozilla.org/en-US/docs/Mozilla/Mobile/Viewport_meta_tag">Viewport</a> meta tag affected (it will have been just created if no one existed before). If a <a href="https://developer.mozilla.org/en-US/docs/Mozilla/Mobile/Viewport_meta_tag">Viewport</a> meta tag could not be created or modified, returns null.</p>
6357</div>
6358
6359
6360
6361<dl>
6362 <dt>
6363 Type
6364 </dt>
6365 <dd>
6366
6367<span class="param-type">Node</span>
6368|
6369
6370<span class="param-type">null</span>
6371
6372
6373
6374 </dd>
6375</dl>
6376
6377
6378
6379
6380
6381</dd>
6382
6383
6384
6385<hr>
6386<dt>
6387 <h4 class="name" id=".unlockOrientation"><span class="type-signature">&lt;static> </span>unlockOrientation<span class="signature">( [onError])</span><span class="type-signature"> &rarr; {boolean}</span></h4>
6388
6389
6390</dt>
6391<dd>
6392
6393
6394 <div class="description">
6395 <p>Function that unlocks the screen orientation. Using the <a href="https://developer.mozilla.org/en-US/docs/Web/API/ScreenOrientation/unlock">unlock</a> function and fallbacks to the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Screen/unlockOrientation">unlockOrientation</a> function of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/ScreenOrientation">Screen Orientation API</a> internally.</p>
6396 </div>
6397
6398
6399
6400
6401
6402
6403
6404
6405 <h5>Parameters:</h5>
6406
6407
6408<table class="params table table-striped">
6409 <thead>
6410 <tr>
6411
6412 <th style="width:12%; min-width:110px;">Name</th>
6413
6414
6415 <th style="width:12%; min-width:110px;">Type</th>
6416
6417
6418 <th style="width:12%; min-width:110px;">Argument</th>
6419
6420
6421
6422
6423 <th class="last" style="min-width:310px;">Description</th>
6424 </tr>
6425 </thead>
6426
6427 <tbody>
6428
6429
6430 <tr>
6431
6432 <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>onError</code></td>
6433
6434
6435 <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6436
6437
6438<span class="param-type">function</span>
6439
6440
6441
6442
6443 </td>
6444
6445
6446 <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
6447
6448 &lt;optional><br>
6449
6450
6451
6452
6453
6454 </td>
6455
6456
6457
6458
6459 <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Callback function that will be called if the orientation has not been unlocked successfully. Unique parameter received will be an error object (probably a <a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMException">DOMException</a>, depending on the client) with the error.</p></td>
6460 </tr>
6461
6462
6463 </tbody>
6464</table>
6465
6466
6467
6468
6469<dl class="details">
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
6500 <dd class="tag-source">
6501 <ul class="dummy">
6502 <li>
6503 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
6504 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-1513">line 1513</a>
6505 </li>
6506 </ul>
6507 </dd>
6508
6509
6510
6511
6512
6513
6514
6515</dl>
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529 <h5>Returns:</h5>
6530
6531
6532<div class="param-desc">
6533 <p>Returns the same that the <a href="https://developer.mozilla.org/en-US/docs/Web/API/ScreenOrientation/unlock">unlock</a> function returns (undefined, normally), if available. Otherwise, returns the same boolean as the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Screen/unlockOrientation">unlockOrientation</a> function (true if the unlocking action has been performed successfully), if available. Otherwise, returns false when the <a href="https://developer.mozilla.org/en-US/docs/Web/API/ScreenOrientation">Screen Orientation API</a> is not available.</p>
6534</div>
6535
6536
6537
6538<dl>
6539 <dt>
6540 Type
6541 </dt>
6542 <dd>
6543
6544<span class="param-type">boolean</span>
6545
6546
6547
6548 </dd>
6549</dl>
6550
6551
6552
6553
6554
6555</dd>
6556
6557
6558
6559<hr>
6560<dt>
6561 <h4 class="name" id=".unsetOrientation"><span class="type-signature">&lt;static> </span>unsetOrientation<span class="signature">()</span><span class="type-signature"></span></h4>
6562
6563
6564</dt>
6565<dd>
6566
6567
6568 <div class="description">
6569 <p>Alias for <a href="CB_Screen.html#.unlockOrientation"><code>CB_Screen.unlockOrientation</code></a>.</p>
6570 </div>
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581<dl class="details">
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
6612 <dd class="tag-source">
6613 <ul class="dummy">
6614 <li>
6615 <a href="CrossBase_audiovisual_image_CB_Screen.js.html">CrossBase/audiovisual/image/CB_Screen.js</a>,
6616 <a href="CrossBase_audiovisual_image_CB_Screen.js.html#sunlight-1-line-1502">line 1502</a>
6617 </li>
6618 </ul>
6619 </dd>
6620
6621
6622
6623
6624
6625 <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
6626 <dd class="tag-see">
6627 <ul>
6628 <li><a href="CB_Screen.html#.unlockOrientation"><code>CB_Screen.unlockOrientation</code></a></li>
6629 </ul>
6630 </dd>
6631
6632
6633
6634</dl>
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650</dd>
6651
6652 </dl>
6653
6654
6655
6656
6657
6658</article>
6659
6660</section>
6661
6662
6663
6664
6665 </div>
6666 </div>
6667
6668 <div class="clearfix"></div>
6669
6670
6671 <div class="col-md-3">
6672 <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
6673 </div>
6674
6675
6676</div>
6677</div>
6678
6679
6680 <div class="modal fade" id="searchResults">
6681 <div class="modal-dialog">
6682 <div class="modal-content">
6683 <div class="modal-header">
6684 <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
6685 <h4 class="modal-title">Search results</h4>
6686 </div>
6687 <div class="modal-body"></div>
6688 <div class="modal-footer">
6689 <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
6690 </div>
6691 </div><!-- /.modal-content -->
6692 </div><!-- /.modal-dialog -->
6693 </div>
6694
6695
6696<footer>
6697
6698
6699 <span class="copyright">
6700 <a href="printable/" target="_blank">See a more printer-friendly version</a><hr /><span style="color:#000000">© <address style="display:inline; font-style:normal;"><a href="https://crossbrowdy.com/" target="_blank">CrossBrowdy</a> API documentation</address> by <a href="https://joanalbamaldonado.com/" target="_blank">Joan Alba Maldonado</a> - <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank">Creative Commons Attribution 4.0 International</a><br />DocStrap Copyright © 2012-2015 The contributors to the JSDoc3 and DocStrap projects.</span>
6701 </span>
6702
6703<span class="jsdoc-message">
6704 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
6705
6706 on Wed Mar 22nd 2023
6707
6708 using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
6709</span>
6710</footer>
6711
6712<script src="scripts/docstrap.lib.js"></script>
6713<script src="scripts/toc.js"></script>
6714
6715 <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
6716
6717
6718<script>
6719$( function () {
6720 $( "[id*='$']" ).each( function () {
6721 var $this = $( this );
6722
6723 $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
6724 } );
6725
6726 $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
6727 var $this = $( this );
6728
6729 var example = $this.find( "code" );
6730 exampleText = example.html();
6731 var lang = /{@lang (.*?)}/.exec( exampleText );
6732 if ( lang && lang[1] ) {
6733 exampleText = exampleText.replace( lang[0], "" );
6734 example.html( exampleText );
6735 lang = lang[1];
6736 } else {
6737 var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
6738 lang = langClassMatch ? langClassMatch[1] : "javascript";
6739 }
6740
6741 if ( lang ) {
6742
6743 $this
6744 .addClass( "sunlight-highlight-" + lang )
6745 .addClass( "linenums" )
6746 .html( example.html() );
6747
6748 }
6749 } );
6750
6751 Sunlight.highlightAll( {
6752 lineNumbers : true,
6753 showMenu : true,
6754 enableDoclinks : true
6755 } );
6756
6757 $.catchAnchorLinks( {
6758 navbarOffset: 10
6759 } );
6760 $( "#toc" ).toc( {
6761 anchorName : function ( i, heading, prefix ) {
6762 return $( heading ).attr( "id" ) || ( prefix + i );
6763 },
6764 selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
6765 showAndHide : false,
6766 smoothScrolling: true
6767 } );
6768
6769 $( "#main span[id^='toc']" ).addClass( "toc-shim" );
6770 $( '.dropdown-toggle' ).dropdown();
6771
6772 $( "table" ).each( function () {
6773 var $this = $( this );
6774 $this.addClass('table');
6775 } );
6776
6777} );
6778</script>
6779
6780
6781
6782<!--Navigation and Symbol Display-->
6783
6784<script>
6785 $( function () {
6786 $( '#main' ).localScroll( {
6787 offset : { top : 60 } //offset by the height of your header (give or take a few px, see what works for you)
6788 } );
6789 $( "dt.name" ).each( function () {
6790 var $this = $( this ).find("h4");
6791 var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
6792 var dt = $(this);
6793 var children = dt.next( "dd" );
6794
6795 dt.prepend( icon ).css( {cursor : "pointer"} );
6796 dt.addClass( "member-collapsed" ).addClass( "member" );
6797
6798
6799 children.hide();
6800
6801 dt.children().on( "click", function () {
6802 children = dt.next( "dd" );
6803 children.slideToggle( "fast", function () {
6804
6805 if ( children.is( ":visible" ) ) {
6806 icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
6807 dt.addClass( "member-open" ).animate( "member-collapsed" );
6808 } else {
6809 icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
6810 dt.addClass( "member-collapsed" ).removeClass( "member-open" );
6811 }
6812 } );
6813 } );
6814
6815 } );
6816 } );
6817</script>
6818
6819
6820<!--Google Analytics-->
6821
6822
6823
6824 <script type="text/javascript">
6825 $(document).ready(function() {
6826 SearcherDisplay.init();
6827 });
6828 </script>
6829
6830
6831</body>
6832</html>
\No newline at end of file