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 [printable] Global</title>
|
8 |
|
9 | |
10 |
|
11 |
|
12 | <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
|
13 |
|
14 | <link type="text/css" rel="stylesheet" href="styles/site.yeti.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 [printable]</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">Global</h1>
|
84 |
|
85 | <section>
|
86 |
|
87 | <header>
|
88 |
|
89 | <h2>
|
90 |
|
91 | </h2>
|
92 |
|
93 |
|
94 | </header>
|
95 |
|
96 |
|
97 | <article>
|
98 | <div class="container-overview">
|
99 |
|
100 |
|
101 |
|
102 |
|
103 | <dl class="details">
|
104 |
|
105 |
|
106 |
|
107 |
|
108 |
|
109 |
|
110 |
|
111 |
|
112 |
|
113 |
|
114 |
|
115 |
|
116 |
|
117 |
|
118 |
|
119 |
|
120 |
|
121 |
|
122 |
|
123 |
|
124 |
|
125 |
|
126 |
|
127 |
|
128 |
|
129 |
|
130 |
|
131 |
|
132 |
|
133 |
|
134 |
|
135 |
|
136 |
|
137 |
|
138 |
|
139 | </dl>
|
140 |
|
141 |
|
142 |
|
143 |
|
144 | </div>
|
145 |
|
146 |
|
147 |
|
148 |
|
149 |
|
150 |
|
151 |
|
152 |
|
153 |
|
154 |
|
155 |
|
156 |
|
157 | <h3 class="subsection-title">Members</h3>
|
158 |
|
159 | <dl>
|
160 |
|
161 | <hr>
|
162 | <dt class="name" id="CB_BASE_NAME">
|
163 | <h4 id="CB_BASE_NAME"><span class="type-signature"><constant> </span>CB_BASE_NAME<span class="type-signature"> :string</span></h4>
|
164 |
|
165 |
|
166 | </dt>
|
167 | <dd>
|
168 |
|
169 | <div class="description">
|
170 | <p>Keeps the name of the CrossBase module.</p>
|
171 | </div>
|
172 |
|
173 |
|
174 |
|
175 | <h5>Type:</h5>
|
176 | <ul>
|
177 | <li>
|
178 |
|
179 | <span class="param-type">string</span>
|
180 |
|
181 |
|
182 |
|
183 | </li>
|
184 | </ul>
|
185 |
|
186 |
|
187 |
|
188 | <dl class="details">
|
189 |
|
190 |
|
191 |
|
192 |
|
193 |
|
194 |
|
195 |
|
196 |
|
197 |
|
198 |
|
199 |
|
200 |
|
201 |
|
202 |
|
203 |
|
204 |
|
205 |
|
206 |
|
207 |
|
208 |
|
209 |
|
210 |
|
211 |
|
212 |
|
213 |
|
214 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
215 | <dd class="tag-default">
|
216 | <ul class="dummy">
|
217 | <li>CrossBase</li>
|
218 | </ul>
|
219 | </dd>
|
220 |
|
221 |
|
222 |
|
223 |
|
224 |
|
225 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
226 | <dd class="tag-source">
|
227 | <ul class="dummy">
|
228 | <li>
|
229 | <a href="CrossBase_CrossBase.js.html">CrossBase/CrossBase.js</a>,
|
230 | <a href="CrossBase_CrossBase.js.html#sunlight-1-line-50">line 50</a>
|
231 | </li>
|
232 | </ul>
|
233 | </dd>
|
234 |
|
235 |
|
236 |
|
237 |
|
238 |
|
239 |
|
240 |
|
241 | </dl>
|
242 |
|
243 |
|
244 |
|
245 | </dd>
|
246 |
|
247 |
|
248 |
|
249 | <hr>
|
250 | <dt class="name" id="CB_CREDITS_DEFAULT">
|
251 | <h4 id="CB_CREDITS_DEFAULT"><span class="type-signature"><readonly> </span>CB_CREDITS_DEFAULT<span class="type-signature"> :string</span></h4>
|
252 |
|
253 |
|
254 | </dt>
|
255 | <dd>
|
256 |
|
257 | <div class="description">
|
258 | <p>Default credits.</p>
|
259 | </div>
|
260 |
|
261 |
|
262 |
|
263 | <h5>Type:</h5>
|
264 | <ul>
|
265 | <li>
|
266 |
|
267 | <span class="param-type">string</span>
|
268 |
|
269 |
|
270 |
|
271 | </li>
|
272 | </ul>
|
273 |
|
274 |
|
275 |
|
276 | <dl class="details">
|
277 |
|
278 |
|
279 |
|
280 |
|
281 |
|
282 |
|
283 |
|
284 |
|
285 |
|
286 |
|
287 |
|
288 |
|
289 |
|
290 |
|
291 |
|
292 |
|
293 |
|
294 |
|
295 |
|
296 |
|
297 |
|
298 |
|
299 |
|
300 |
|
301 |
|
302 |
|
303 |
|
304 |
|
305 |
|
306 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
307 | <dd class="tag-source">
|
308 | <ul class="dummy">
|
309 | <li>
|
310 | <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
|
311 | <a href="CrossBrowdy.js.html#sunlight-1-line-299">line 299</a>
|
312 | </li>
|
313 | </ul>
|
314 | </dd>
|
315 |
|
316 |
|
317 |
|
318 |
|
319 |
|
320 |
|
321 |
|
322 | </dl>
|
323 |
|
324 |
|
325 |
|
326 | </dd>
|
327 |
|
328 |
|
329 |
|
330 | <hr>
|
331 | <dt class="name" id="CB_NAME">
|
332 | <h4 id="CB_NAME"><span class="type-signature"><constant> </span>CB_NAME<span class="type-signature"> :string</span></h4>
|
333 |
|
334 |
|
335 | </dt>
|
336 | <dd>
|
337 |
|
338 | <div class="description">
|
339 | <p>Keeps the name of the script (the main script will use this name with the ".js" extension). Case sensitive.</p>
|
340 | </div>
|
341 |
|
342 |
|
343 |
|
344 | <h5>Type:</h5>
|
345 | <ul>
|
346 | <li>
|
347 |
|
348 | <span class="param-type">string</span>
|
349 |
|
350 |
|
351 |
|
352 | </li>
|
353 | </ul>
|
354 |
|
355 |
|
356 |
|
357 | <dl class="details">
|
358 |
|
359 |
|
360 |
|
361 |
|
362 |
|
363 |
|
364 |
|
365 |
|
366 |
|
367 |
|
368 |
|
369 |
|
370 |
|
371 |
|
372 |
|
373 |
|
374 |
|
375 |
|
376 |
|
377 |
|
378 |
|
379 |
|
380 |
|
381 |
|
382 |
|
383 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
384 | <dd class="tag-default">
|
385 | <ul class="dummy">
|
386 | <li>CrossBrowdy</li>
|
387 | </ul>
|
388 | </dd>
|
389 |
|
390 |
|
391 |
|
392 |
|
393 |
|
394 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
395 | <dd class="tag-source">
|
396 | <ul class="dummy">
|
397 | <li>
|
398 | <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
|
399 | <a href="CrossBrowdy.js.html#sunlight-1-line-18">line 18</a>
|
400 | </li>
|
401 | </ul>
|
402 | </dd>
|
403 |
|
404 |
|
405 |
|
406 |
|
407 |
|
408 |
|
409 |
|
410 | </dl>
|
411 |
|
412 |
|
413 |
|
414 | </dd>
|
415 |
|
416 |
|
417 |
|
418 | <hr>
|
419 | <dt class="name" id="CB_OPTIONS">
|
420 | <h4 id="CB_OPTIONS"><span class="type-signature"><constant> </span>CB_OPTIONS<span class="type-signature"> :Object</span></h4>
|
421 |
|
422 |
|
423 | </dt>
|
424 | <dd>
|
425 |
|
426 | <div class="description">
|
427 | <p>Two-dimensional object defined by the user with the desired options for CrossBrowdy and its modules. The options supported are the ones used by the <a href="CB_Configuration.html"><code>CB_Configuration</code></a> object.<br>
|
428 | <br><br>
|
429 | First-level indexes should belong to the module name (or to "CrossBrowdy", for general options) and second-level indexes should belong to the option name.<br>
|
430 | <br><br>
|
431 | Example:<br>
|
432 | <br><br>
|
433 | {<br>
|
434 | CrossBrowdy:<br>
|
435 | {<br>
|
436 | CB_console_ALLOW_ALERTS: false<br>
|
437 | },<br>
|
438 | CrossBase:<br>
|
439 | {<br>
|
440 | SLCANVAS_LOAD : true,<br>
|
441 | FLASHCANVAS_LOAD : true<br>
|
442 | }<br>
|
443 | }</p>
|
444 | </div>
|
445 |
|
446 |
|
447 |
|
448 | <h5>Type:</h5>
|
449 | <ul>
|
450 | <li>
|
451 |
|
452 | <span class="param-type">Object</span>
|
453 |
|
454 |
|
455 |
|
456 | </li>
|
457 | </ul>
|
458 |
|
459 |
|
460 |
|
461 | <dl class="details">
|
462 |
|
463 |
|
464 |
|
465 |
|
466 |
|
467 |
|
468 |
|
469 |
|
470 |
|
471 |
|
472 |
|
473 |
|
474 |
|
475 |
|
476 |
|
477 |
|
478 |
|
479 |
|
480 |
|
481 |
|
482 |
|
483 |
|
484 |
|
485 |
|
486 |
|
487 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
488 | <dd class="tag-default">
|
489 | <ul class="dummy">
|
490 | <li>undefined</li>
|
491 | </ul>
|
492 | </dd>
|
493 |
|
494 |
|
495 |
|
496 |
|
497 |
|
498 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
499 | <dd class="tag-source">
|
500 | <ul class="dummy">
|
501 | <li>
|
502 | <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
|
503 | <a href="CrossBrowdy.js.html#sunlight-1-line-34">line 34</a>
|
504 | </li>
|
505 | </ul>
|
506 | </dd>
|
507 |
|
508 |
|
509 |
|
510 |
|
511 |
|
512 |
|
513 |
|
514 | </dl>
|
515 |
|
516 |
|
517 |
|
518 | </dd>
|
519 |
|
520 |
|
521 |
|
522 | <hr>
|
523 | <dt class="name" id="CB_VERSION">
|
524 | <h4 id="CB_VERSION"><span class="type-signature"><constant> </span>CB_VERSION<span class="type-signature"> :string</span></h4>
|
525 |
|
526 |
|
527 | </dt>
|
528 | <dd>
|
529 |
|
530 | <div class="description">
|
531 | <p>CrossBrowdy version.</p>
|
532 | </div>
|
533 |
|
534 |
|
535 |
|
536 | <h5>Type:</h5>
|
537 | <ul>
|
538 | <li>
|
539 |
|
540 | <span class="param-type">string</span>
|
541 |
|
542 |
|
543 |
|
544 | </li>
|
545 | </ul>
|
546 |
|
547 |
|
548 |
|
549 | <dl class="details">
|
550 |
|
551 |
|
552 |
|
553 |
|
554 |
|
555 |
|
556 |
|
557 |
|
558 |
|
559 |
|
560 |
|
561 |
|
562 |
|
563 |
|
564 |
|
565 |
|
566 |
|
567 |
|
568 |
|
569 |
|
570 |
|
571 |
|
572 |
|
573 |
|
574 |
|
575 |
|
576 |
|
577 |
|
578 |
|
579 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
580 | <dd class="tag-source">
|
581 | <ul class="dummy">
|
582 | <li>
|
583 | <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
|
584 | <a href="CrossBrowdy.js.html#sunlight-1-line-25">line 25</a>
|
585 | </li>
|
586 | </ul>
|
587 | </dd>
|
588 |
|
589 |
|
590 |
|
591 |
|
592 |
|
593 |
|
594 |
|
595 | </dl>
|
596 |
|
597 |
|
598 |
|
599 | </dd>
|
600 |
|
601 |
|
602 |
|
603 | <hr>
|
604 | <dt class="name" id="CB_scriptPath">
|
605 | <h4 id="CB_scriptPath"><span class="type-signature"><readonly> </span>CB_scriptPath<span class="type-signature"> :string</span></h4>
|
606 |
|
607 |
|
608 | </dt>
|
609 | <dd>
|
610 |
|
611 | <div class="description">
|
612 | <p>It will contain the CrossBrowdy path when it finally loads.</p>
|
613 | </div>
|
614 |
|
615 |
|
616 |
|
617 | <h5>Type:</h5>
|
618 | <ul>
|
619 | <li>
|
620 |
|
621 | <span class="param-type">string</span>
|
622 |
|
623 |
|
624 |
|
625 | </li>
|
626 | </ul>
|
627 |
|
628 |
|
629 |
|
630 | <dl class="details">
|
631 |
|
632 |
|
633 |
|
634 |
|
635 |
|
636 |
|
637 |
|
638 |
|
639 |
|
640 |
|
641 |
|
642 |
|
643 |
|
644 |
|
645 |
|
646 |
|
647 |
|
648 |
|
649 |
|
650 |
|
651 |
|
652 |
|
653 |
|
654 |
|
655 |
|
656 | <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
|
657 | <dd class="tag-default">
|
658 | <ul class="dummy">
|
659 | <li><a href="global.html#CB_scriptPathCalculate"><code>CB_scriptPathCalculate</code></a>();</li>
|
660 | </ul>
|
661 | </dd>
|
662 |
|
663 |
|
664 |
|
665 |
|
666 |
|
667 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
668 | <dd class="tag-source">
|
669 | <ul class="dummy">
|
670 | <li>
|
671 | <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
|
672 | <a href="CrossBrowdy.js.html#sunlight-1-line-145">line 145</a>
|
673 | </li>
|
674 | </ul>
|
675 | </dd>
|
676 |
|
677 |
|
678 |
|
679 |
|
680 |
|
681 |
|
682 |
|
683 | </dl>
|
684 |
|
685 |
|
686 |
|
687 | </dd>
|
688 |
|
689 |
|
690 |
|
691 | <hr>
|
692 | <dt class="name" id="CB_this">
|
693 | <h4 id="CB_this"><span class="type-signature"><constant> </span>CB_this<span class="type-signature"> :Object</span></h4>
|
694 |
|
695 |
|
696 | </dt>
|
697 | <dd>
|
698 |
|
699 | <div class="description">
|
700 | <p>Keeps the CrossBrowdy "this" context.</p>
|
701 | </div>
|
702 |
|
703 |
|
704 |
|
705 | <h5>Type:</h5>
|
706 | <ul>
|
707 | <li>
|
708 |
|
709 | <span class="param-type">Object</span>
|
710 |
|
711 |
|
712 |
|
713 | </li>
|
714 | </ul>
|
715 |
|
716 |
|
717 |
|
718 | <dl class="details">
|
719 |
|
720 |
|
721 |
|
722 |
|
723 |
|
724 |
|
725 |
|
726 |
|
727 |
|
728 |
|
729 |
|
730 |
|
731 |
|
732 |
|
733 |
|
734 |
|
735 |
|
736 |
|
737 |
|
738 |
|
739 |
|
740 |
|
741 |
|
742 |
|
743 |
|
744 |
|
745 |
|
746 |
|
747 |
|
748 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
749 | <dd class="tag-source">
|
750 | <ul class="dummy">
|
751 | <li>
|
752 | <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
|
753 | <a href="CrossBrowdy.js.html#sunlight-1-line-32">line 32</a>
|
754 | </li>
|
755 | </ul>
|
756 | </dd>
|
757 |
|
758 |
|
759 |
|
760 |
|
761 |
|
762 |
|
763 |
|
764 | </dl>
|
765 |
|
766 |
|
767 |
|
768 | </dd>
|
769 |
|
770 | </dl>
|
771 |
|
772 |
|
773 |
|
774 | <h3 class="subsection-title">Methods</h3>
|
775 |
|
776 | <dl>
|
777 |
|
778 | <hr>
|
779 | <dt>
|
780 | <h4 class="name" id="CB_addCredits"><span class="type-signature"></span>CB_addCredits<span class="signature">(credits)</span><span class="type-signature"> → {string}</span></h4>
|
781 |
|
782 |
|
783 | </dt>
|
784 | <dd>
|
785 |
|
786 |
|
787 | <div class="description">
|
788 | <p>Attaches the given credits to the default ones (to <a href="global.html#CB_CREDITS_DEFAULT"><code>CB_CREDITS_DEFAULT</code></a>).</p>
|
789 | </div>
|
790 |
|
791 |
|
792 |
|
793 |
|
794 |
|
795 |
|
796 |
|
797 |
|
798 | <h5>Parameters:</h5>
|
799 |
|
800 |
|
801 | <table class="params table table-striped">
|
802 | <thead>
|
803 | <tr>
|
804 |
|
805 | <th style="width:12%; min-width:110px;">Name</th>
|
806 |
|
807 |
|
808 | <th style="width:12%; min-width:110px;">Type</th>
|
809 |
|
810 |
|
811 |
|
812 |
|
813 |
|
814 | <th class="last" style="min-width:310px;">Description</th>
|
815 | </tr>
|
816 | </thead>
|
817 |
|
818 | <tbody>
|
819 |
|
820 |
|
821 | <tr>
|
822 |
|
823 | <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>credits</code></td>
|
824 |
|
825 |
|
826 | <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;">
|
827 |
|
828 |
|
829 | <span class="param-type">string</span>
|
830 |
|
831 |
|
832 |
|
833 |
|
834 | </td>
|
835 |
|
836 |
|
837 |
|
838 |
|
839 |
|
840 | <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>Path to the JS file.</p></td>
|
841 | </tr>
|
842 |
|
843 |
|
844 | </tbody>
|
845 | </table>
|
846 |
|
847 |
|
848 |
|
849 |
|
850 | <dl class="details">
|
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 |
|
876 |
|
877 |
|
878 |
|
879 |
|
880 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
881 | <dd class="tag-source">
|
882 | <ul class="dummy">
|
883 | <li>
|
884 | <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
|
885 | <a href="CrossBrowdy.js.html#sunlight-1-line-313">line 313</a>
|
886 | </li>
|
887 | </ul>
|
888 | </dd>
|
889 |
|
890 |
|
891 |
|
892 |
|
893 |
|
894 |
|
895 |
|
896 | </dl>
|
897 |
|
898 |
|
899 |
|
900 |
|
901 |
|
902 |
|
903 |
|
904 |
|
905 |
|
906 |
|
907 |
|
908 |
|
909 |
|
910 | <h5>Returns:</h5>
|
911 |
|
912 |
|
913 | <div class="param-desc">
|
914 | <p>Returns the default credits after attaching the given ones.</p>
|
915 | </div>
|
916 |
|
917 |
|
918 |
|
919 | <dl>
|
920 | <dt>
|
921 | Type
|
922 | </dt>
|
923 | <dd>
|
924 |
|
925 | <span class="param-type">string</span>
|
926 |
|
927 |
|
928 |
|
929 | </dd>
|
930 | </dl>
|
931 |
|
932 |
|
933 |
|
934 |
|
935 |
|
936 | </dd>
|
937 |
|
938 |
|
939 |
|
940 | <hr>
|
941 | <dt>
|
942 | <h4 class="name" id="CB_baseToBase"><span class="type-signature"></span>CB_baseToBase<span class="signature">(number [, baseSymbolsOrigin] [, baseSymbolsDestiny] [, unsigned] [, minusSymbolOrigin] [, minusSymbolDestiny] [, prefixOrigin] [, prefixDestiny])</span><span class="type-signature"> → {string}</span></h4>
|
943 |
|
944 |
|
945 | </dt>
|
946 | <dd>
|
947 |
|
948 |
|
949 | <div class="description">
|
950 | <p>Converts a given number which is already in a desired base into another chosen base.<br>
|
951 | <br /><br>
|
952 | Note: Uses <a href="global.html#CB_baseToInt"><code>CB_baseToInt</code></a> and <a href="global.html#CB_intToBase"><code>CB_intToBase</code></a> internally.</p>
|
953 | </div>
|
954 |
|
955 |
|
956 |
|
957 |
|
958 |
|
959 |
|
960 |
|
961 |
|
962 | <h5>Parameters:</h5>
|
963 |
|
964 |
|
965 | <table class="params table table-striped">
|
966 | <thead>
|
967 | <tr>
|
968 |
|
969 | <th style="width:12%; min-width:110px;">Name</th>
|
970 |
|
971 |
|
972 | <th style="width:12%; min-width:110px;">Type</th>
|
973 |
|
974 |
|
975 | <th style="width:12%; min-width:110px;">Argument</th>
|
976 |
|
977 |
|
978 |
|
979 | <th style="width:12%; min-width:110px;">Default</th>
|
980 |
|
981 |
|
982 | <th class="last" style="min-width:310px;">Description</th>
|
983 | </tr>
|
984 | </thead>
|
985 |
|
986 | <tbody>
|
987 |
|
988 |
|
989 | <tr>
|
990 |
|
991 | <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>number</code></td>
|
992 |
|
993 |
|
994 | <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;">
|
995 |
|
996 |
|
997 | <span class="param-type">string</span>
|
998 |
|
999 |
|
1000 |
|
1001 |
|
1002 | </td>
|
1003 |
|
1004 |
|
1005 | <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;">
|
1006 |
|
1007 |
|
1008 |
|
1009 |
|
1010 |
|
1011 | </td>
|
1012 |
|
1013 |
|
1014 |
|
1015 | <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;">
|
1016 |
|
1017 | </td>
|
1018 |
|
1019 |
|
1020 | <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>A string containing the number which is already in the desired base and that we want to convert into the another chosen base. Used as the "number" parameter for calling both <a href="global.html#CB_intToBase"><code>CB_intToBase</code></a> and <a href="global.html#CB_baseToInt"><code>CB_baseToInt</code></a> functions internally.</p></td>
|
1021 | </tr>
|
1022 |
|
1023 |
|
1024 |
|
1025 | <tr>
|
1026 |
|
1027 | <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>baseSymbolsOrigin</code></td>
|
1028 |
|
1029 |
|
1030 | <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;">
|
1031 |
|
1032 |
|
1033 | <span class="param-type">array</span>
|
1034 | |
|
1035 |
|
1036 | <span class="param-type">integer</span>
|
1037 |
|
1038 |
|
1039 |
|
1040 |
|
1041 | </td>
|
1042 |
|
1043 |
|
1044 | <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;">
|
1045 |
|
1046 | <optional><br>
|
1047 |
|
1048 |
|
1049 |
|
1050 |
|
1051 |
|
1052 | </td>
|
1053 |
|
1054 |
|
1055 |
|
1056 | <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;">
|
1057 |
|
1058 | <a href="CB_baseSymbols.html#.66"><code>CB_baseSymbols.66</code></a>
|
1059 |
|
1060 | </td>
|
1061 |
|
1062 |
|
1063 | <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>Used as the "baseSymbols" parameter when calling the <a href="global.html#CB_baseToInt"><code>CB_baseToInt</code></a> function internally.</p></td>
|
1064 | </tr>
|
1065 |
|
1066 |
|
1067 |
|
1068 | <tr>
|
1069 |
|
1070 | <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>baseSymbolsDestiny</code></td>
|
1071 |
|
1072 |
|
1073 | <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;">
|
1074 |
|
1075 |
|
1076 | <span class="param-type">array</span>
|
1077 | |
|
1078 |
|
1079 | <span class="param-type">integer</span>
|
1080 |
|
1081 |
|
1082 |
|
1083 |
|
1084 | </td>
|
1085 |
|
1086 |
|
1087 | <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;">
|
1088 |
|
1089 | <optional><br>
|
1090 |
|
1091 |
|
1092 |
|
1093 |
|
1094 |
|
1095 | </td>
|
1096 |
|
1097 |
|
1098 |
|
1099 | <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;">
|
1100 |
|
1101 | <a href="CB_baseSymbols.html#.66"><code>CB_baseSymbols.66</code></a>
|
1102 |
|
1103 | </td>
|
1104 |
|
1105 |
|
1106 | <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>Used as the "baseSymbols" parameter when calling the <a href="global.html#CB_intToBase"><code>CB_intToBase</code></a> function internally.</p></td>
|
1107 | </tr>
|
1108 |
|
1109 |
|
1110 |
|
1111 | <tr>
|
1112 |
|
1113 | <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>unsigned</code></td>
|
1114 |
|
1115 |
|
1116 | <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;">
|
1117 |
|
1118 |
|
1119 | <span class="param-type">boolean</span>
|
1120 |
|
1121 |
|
1122 |
|
1123 |
|
1124 | </td>
|
1125 |
|
1126 |
|
1127 | <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;">
|
1128 |
|
1129 | <optional><br>
|
1130 |
|
1131 |
|
1132 |
|
1133 |
|
1134 |
|
1135 | </td>
|
1136 |
|
1137 |
|
1138 |
|
1139 | <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;">
|
1140 |
|
1141 | false
|
1142 |
|
1143 | </td>
|
1144 |
|
1145 |
|
1146 | <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>Determines whether to treat the input and output numbers as unsigned or not. Used as the "unsigned" parameter for calling both <a href="global.html#CB_intToBase"><code>CB_intToBase</code></a> and <a href="global.html#CB_baseToInt"><code>CB_baseToInt</code></a> functions internally.</p></td>
|
1147 | </tr>
|
1148 |
|
1149 |
|
1150 |
|
1151 | <tr>
|
1152 |
|
1153 | <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>minusSymbolOrigin</code></td>
|
1154 |
|
1155 |
|
1156 | <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;">
|
1157 |
|
1158 |
|
1159 | <span class="param-type">string</span>
|
1160 |
|
1161 |
|
1162 |
|
1163 |
|
1164 | </td>
|
1165 |
|
1166 |
|
1167 | <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;">
|
1168 |
|
1169 | <optional><br>
|
1170 |
|
1171 |
|
1172 |
|
1173 |
|
1174 |
|
1175 | </td>
|
1176 |
|
1177 |
|
1178 |
|
1179 | <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;">
|
1180 |
|
1181 | '-'|'0'
|
1182 |
|
1183 | </td>
|
1184 |
|
1185 |
|
1186 | <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>Used as the "minusSymbol" parameter when calling the <a href="global.html#CB_baseToInt"><code>CB_baseToInt</code></a> function internally.</p></td>
|
1187 | </tr>
|
1188 |
|
1189 |
|
1190 |
|
1191 | <tr>
|
1192 |
|
1193 | <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>minusSymbolDestiny</code></td>
|
1194 |
|
1195 |
|
1196 | <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;">
|
1197 |
|
1198 |
|
1199 | <span class="param-type">string</span>
|
1200 |
|
1201 |
|
1202 |
|
1203 |
|
1204 | </td>
|
1205 |
|
1206 |
|
1207 | <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;">
|
1208 |
|
1209 | <optional><br>
|
1210 |
|
1211 |
|
1212 |
|
1213 |
|
1214 |
|
1215 | </td>
|
1216 |
|
1217 |
|
1218 |
|
1219 | <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;">
|
1220 |
|
1221 | '-'|'0'
|
1222 |
|
1223 | </td>
|
1224 |
|
1225 |
|
1226 | <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>Used as the "minusSymbol" parameter when calling the <a href="global.html#CB_intToBase"><code>CB_intToBase</code></a> function internally.</p></td>
|
1227 | </tr>
|
1228 |
|
1229 |
|
1230 |
|
1231 | <tr>
|
1232 |
|
1233 | <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>prefixOrigin</code></td>
|
1234 |
|
1235 |
|
1236 | <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;">
|
1237 |
|
1238 |
|
1239 | <span class="param-type">prefix</span>
|
1240 |
|
1241 |
|
1242 |
|
1243 |
|
1244 | </td>
|
1245 |
|
1246 |
|
1247 | <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;">
|
1248 |
|
1249 | <optional><br>
|
1250 |
|
1251 |
|
1252 |
|
1253 |
|
1254 |
|
1255 | </td>
|
1256 |
|
1257 |
|
1258 |
|
1259 | <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;">
|
1260 |
|
1261 | '0'|'0x'|''
|
1262 |
|
1263 | </td>
|
1264 |
|
1265 |
|
1266 | <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>Used as the "prefix" parameter when calling the <a href="global.html#CB_baseToInt"><code>CB_baseToInt</code></a> function internally.</p></td>
|
1267 | </tr>
|
1268 |
|
1269 |
|
1270 |
|
1271 | <tr>
|
1272 |
|
1273 | <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>prefixDestiny</code></td>
|
1274 |
|
1275 |
|
1276 | <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;">
|
1277 |
|
1278 |
|
1279 | <span class="param-type">prefix</span>
|
1280 |
|
1281 |
|
1282 |
|
1283 |
|
1284 | </td>
|
1285 |
|
1286 |
|
1287 | <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;">
|
1288 |
|
1289 | <optional><br>
|
1290 |
|
1291 |
|
1292 |
|
1293 |
|
1294 |
|
1295 | </td>
|
1296 |
|
1297 |
|
1298 |
|
1299 | <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;">
|
1300 |
|
1301 | '0'|'0x'|''
|
1302 |
|
1303 | </td>
|
1304 |
|
1305 |
|
1306 | <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>Used as the "prefix" parameter when calling the <a href="global.html#CB_intToBase"><code>CB_intToBase</code></a> function internally.</p></td>
|
1307 | </tr>
|
1308 |
|
1309 |
|
1310 | </tbody>
|
1311 | </table>
|
1312 |
|
1313 |
|
1314 |
|
1315 |
|
1316 | <dl class="details">
|
1317 |
|
1318 |
|
1319 |
|
1320 |
|
1321 |
|
1322 |
|
1323 |
|
1324 |
|
1325 |
|
1326 |
|
1327 |
|
1328 |
|
1329 |
|
1330 |
|
1331 |
|
1332 |
|
1333 |
|
1334 |
|
1335 |
|
1336 |
|
1337 |
|
1338 |
|
1339 |
|
1340 |
|
1341 |
|
1342 |
|
1343 |
|
1344 |
|
1345 |
|
1346 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1347 | <dd class="tag-source">
|
1348 | <ul class="dummy">
|
1349 | <li>
|
1350 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
1351 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-1421">line 1421</a>
|
1352 | </li>
|
1353 | </ul>
|
1354 | </dd>
|
1355 |
|
1356 |
|
1357 |
|
1358 |
|
1359 |
|
1360 |
|
1361 |
|
1362 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
1363 | <dd class="tag-todo">
|
1364 | <ul>
|
1365 | <li>Think about accepting a decimal symbol to separate decimals and support float numbers.</li>
|
1366 | </ul>
|
1367 | </dd>
|
1368 |
|
1369 | </dl>
|
1370 |
|
1371 |
|
1372 |
|
1373 |
|
1374 |
|
1375 |
|
1376 |
|
1377 |
|
1378 |
|
1379 |
|
1380 |
|
1381 |
|
1382 |
|
1383 | <h5>Returns:</h5>
|
1384 |
|
1385 |
|
1386 | <div class="param-desc">
|
1387 | <p>Returns the returning value of the internal call to the <a href="global.html#CB_intToBase"><code>CB_intToBase</code></a> function.</p>
|
1388 | </div>
|
1389 |
|
1390 |
|
1391 |
|
1392 | <dl>
|
1393 | <dt>
|
1394 | Type
|
1395 | </dt>
|
1396 | <dd>
|
1397 |
|
1398 | <span class="param-type">string</span>
|
1399 |
|
1400 |
|
1401 |
|
1402 | </dd>
|
1403 | </dl>
|
1404 |
|
1405 |
|
1406 |
|
1407 |
|
1408 |
|
1409 | </dd>
|
1410 |
|
1411 |
|
1412 |
|
1413 | <hr>
|
1414 | <dt>
|
1415 | <h4 class="name" id="CB_baseToInt"><span class="type-signature"></span>CB_baseToInt<span class="signature">(number [, baseSymbols] [, unsigned] [, minusSymbol] [, prefix])</span><span class="type-signature"> → {integer}</span></h4>
|
1416 |
|
1417 |
|
1418 | </dt>
|
1419 | <dd>
|
1420 |
|
1421 |
|
1422 | <div class="description">
|
1423 | <p>Converts a given number which is already in a desired base into an integer (decimal base).<br>
|
1424 | <br /><br>
|
1425 | Note: It can return wrong values when the value exceeds the maximum allowed by a number in the client's JavaScript engine. It can also depend on the "baseSymbols" used.</p>
|
1426 | </div>
|
1427 |
|
1428 |
|
1429 |
|
1430 |
|
1431 |
|
1432 |
|
1433 |
|
1434 |
|
1435 | <h5>Parameters:</h5>
|
1436 |
|
1437 |
|
1438 | <table class="params table table-striped">
|
1439 | <thead>
|
1440 | <tr>
|
1441 |
|
1442 | <th style="width:12%; min-width:110px;">Name</th>
|
1443 |
|
1444 |
|
1445 | <th style="width:12%; min-width:110px;">Type</th>
|
1446 |
|
1447 |
|
1448 | <th style="width:12%; min-width:110px;">Argument</th>
|
1449 |
|
1450 |
|
1451 |
|
1452 | <th style="width:12%; min-width:110px;">Default</th>
|
1453 |
|
1454 |
|
1455 | <th class="last" style="min-width:310px;">Description</th>
|
1456 | </tr>
|
1457 | </thead>
|
1458 |
|
1459 | <tbody>
|
1460 |
|
1461 |
|
1462 | <tr>
|
1463 |
|
1464 | <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>number</code></td>
|
1465 |
|
1466 |
|
1467 | <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;">
|
1468 |
|
1469 |
|
1470 | <span class="param-type">string</span>
|
1471 |
|
1472 |
|
1473 |
|
1474 |
|
1475 | </td>
|
1476 |
|
1477 |
|
1478 | <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;">
|
1479 |
|
1480 |
|
1481 |
|
1482 |
|
1483 |
|
1484 | </td>
|
1485 |
|
1486 |
|
1487 |
|
1488 | <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;">
|
1489 |
|
1490 | </td>
|
1491 |
|
1492 |
|
1493 | <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>A string containing the number which is already in the desired base and that we want to convert to an integer.</p></td>
|
1494 | </tr>
|
1495 |
|
1496 |
|
1497 |
|
1498 | <tr>
|
1499 |
|
1500 | <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>baseSymbols</code></td>
|
1501 |
|
1502 |
|
1503 | <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;">
|
1504 |
|
1505 |
|
1506 | <span class="param-type">array</span>
|
1507 | |
|
1508 |
|
1509 | <span class="param-type">integer</span>
|
1510 |
|
1511 |
|
1512 |
|
1513 |
|
1514 | </td>
|
1515 |
|
1516 |
|
1517 | <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;">
|
1518 |
|
1519 | <optional><br>
|
1520 |
|
1521 |
|
1522 |
|
1523 |
|
1524 |
|
1525 | </td>
|
1526 |
|
1527 |
|
1528 |
|
1529 | <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;">
|
1530 |
|
1531 | <a href="CB_baseSymbols.html#.66"><code>CB_baseSymbols.66</code></a>
|
1532 |
|
1533 | </td>
|
1534 |
|
1535 |
|
1536 | <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>Array with the desired symbols, using only one per index (their value will correspond to their index). The base (radix) will be the total number of indexes. It should be the base which is already being used by the given number. If an integer greater or equal than 2 is provided, it will try to use it as an index of the <a href="CB_baseSymbols.html"><code>CB_baseSymbols</code></a> object and use it if found or use it as a parameter to call the <a href="CB_baseSymbols.html#.get"><code>CB_baseSymbols.get</code></a> function otherwise. If not provided or the integer is lower than 2, it will use base 66 (defined in the <a href="CB_baseSymbols.html#._66"><code>CB_baseSymbols._66</code></a> property of the <a href="CB_baseSymbols.html"><code>CB_baseSymbols</code></a> object). It is recommended not to exceed 4096 (or even lower, depending on the client, although some clients could support up to 63988 or even more). The properties of the <a href="CB_baseSymbols.html"><code>CB_baseSymbols</code></a> object or the <a href="CB_baseSymbols.html#.get"><code>CB_baseSymbols.get</code></a> function can be used for this parameter.</p></td>
|
1537 | </tr>
|
1538 |
|
1539 |
|
1540 |
|
1541 | <tr>
|
1542 |
|
1543 | <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>unsigned</code></td>
|
1544 |
|
1545 |
|
1546 | <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;">
|
1547 |
|
1548 |
|
1549 | <span class="param-type">boolean</span>
|
1550 |
|
1551 |
|
1552 |
|
1553 |
|
1554 | </td>
|
1555 |
|
1556 |
|
1557 | <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;">
|
1558 |
|
1559 | <optional><br>
|
1560 |
|
1561 |
|
1562 |
|
1563 |
|
1564 |
|
1565 | </td>
|
1566 |
|
1567 |
|
1568 |
|
1569 | <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;">
|
1570 |
|
1571 | false
|
1572 |
|
1573 | </td>
|
1574 |
|
1575 |
|
1576 | <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>Determines whether to treat the input and output numbers as unsigned or not.</p></td>
|
1577 | </tr>
|
1578 |
|
1579 |
|
1580 |
|
1581 | <tr>
|
1582 |
|
1583 | <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>minusSymbol</code></td>
|
1584 |
|
1585 |
|
1586 | <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;">
|
1587 |
|
1588 |
|
1589 | <span class="param-type">string</span>
|
1590 |
|
1591 |
|
1592 |
|
1593 |
|
1594 | </td>
|
1595 |
|
1596 |
|
1597 | <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;">
|
1598 |
|
1599 | <optional><br>
|
1600 |
|
1601 |
|
1602 |
|
1603 |
|
1604 |
|
1605 | </td>
|
1606 |
|
1607 |
|
1608 |
|
1609 | <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;">
|
1610 |
|
1611 | '-'|'0'
|
1612 |
|
1613 | </td>
|
1614 |
|
1615 |
|
1616 | <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>Determines the minus symbol or string for the input, to mark negative numbers. If not provided, it will be '-' for bases equal or lower than 16 (hexadecimal) or '0' (zero character) otherwise. This parameter is ignored if the "unsigned" parameter is set to true.</p></td>
|
1617 | </tr>
|
1618 |
|
1619 |
|
1620 |
|
1621 | <tr>
|
1622 |
|
1623 | <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>prefix</code></td>
|
1624 |
|
1625 |
|
1626 | <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;">
|
1627 |
|
1628 |
|
1629 | <span class="param-type">prefix</span>
|
1630 |
|
1631 |
|
1632 |
|
1633 |
|
1634 | </td>
|
1635 |
|
1636 |
|
1637 | <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;">
|
1638 |
|
1639 | <optional><br>
|
1640 |
|
1641 |
|
1642 |
|
1643 |
|
1644 |
|
1645 | </td>
|
1646 |
|
1647 |
|
1648 |
|
1649 | <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;">
|
1650 |
|
1651 | '0'|'0x'|''
|
1652 |
|
1653 | </td>
|
1654 |
|
1655 |
|
1656 | <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>Determines the prefix for the input. If not provided, it will be '0' (zero character) for base 8 (octal), '0x' for base 16 (hexadecimal) or nothing (empty string) for all the others. Use an empty string to avoid using anything.</p></td>
|
1657 | </tr>
|
1658 |
|
1659 |
|
1660 | </tbody>
|
1661 | </table>
|
1662 |
|
1663 |
|
1664 |
|
1665 |
|
1666 | <dl class="details">
|
1667 |
|
1668 |
|
1669 |
|
1670 |
|
1671 |
|
1672 |
|
1673 |
|
1674 |
|
1675 |
|
1676 |
|
1677 |
|
1678 |
|
1679 |
|
1680 |
|
1681 |
|
1682 |
|
1683 |
|
1684 |
|
1685 |
|
1686 |
|
1687 |
|
1688 |
|
1689 |
|
1690 |
|
1691 |
|
1692 |
|
1693 |
|
1694 |
|
1695 |
|
1696 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1697 | <dd class="tag-source">
|
1698 | <ul class="dummy">
|
1699 | <li>
|
1700 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
1701 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-1349">line 1349</a>
|
1702 | </li>
|
1703 | </ul>
|
1704 | </dd>
|
1705 |
|
1706 |
|
1707 |
|
1708 |
|
1709 |
|
1710 |
|
1711 |
|
1712 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
1713 | <dd class="tag-todo">
|
1714 | <ul>
|
1715 | <li>Think about allowing to return a string, for bigger numbers (to exceed the limit for integers). Internally, it would need to perform operations comparisons, multiplications with strings, etc.</li>
|
1716 |
|
1717 | <li>Think about allowing to specify the base for the integer.</li>
|
1718 |
|
1719 | <li>Think about accepting a decimal symbol to separate decimals and support float numbers.</li>
|
1720 | </ul>
|
1721 | </dd>
|
1722 |
|
1723 | </dl>
|
1724 |
|
1725 |
|
1726 |
|
1727 |
|
1728 |
|
1729 |
|
1730 |
|
1731 |
|
1732 |
|
1733 |
|
1734 |
|
1735 |
|
1736 |
|
1737 | <h5>Returns:</h5>
|
1738 |
|
1739 |
|
1740 | <div class="param-desc">
|
1741 | <p>Returns the integer number in decimal base.</p>
|
1742 | </div>
|
1743 |
|
1744 |
|
1745 |
|
1746 | <dl>
|
1747 | <dt>
|
1748 | Type
|
1749 | </dt>
|
1750 | <dd>
|
1751 |
|
1752 | <span class="param-type">integer</span>
|
1753 |
|
1754 |
|
1755 |
|
1756 | </dd>
|
1757 | </dl>
|
1758 |
|
1759 |
|
1760 |
|
1761 |
|
1762 |
|
1763 | </dd>
|
1764 |
|
1765 |
|
1766 |
|
1767 | <hr>
|
1768 | <dt>
|
1769 | <h4 class="name" id="CB_br2nl"><span class="type-signature"></span>CB_br2nl<span class="signature">(string)</span><span class="type-signature"> → {string}</span></h4>
|
1770 |
|
1771 |
|
1772 | </dt>
|
1773 | <dd>
|
1774 |
|
1775 |
|
1776 | <div class="description">
|
1777 | <p>Changes <br />'s, <br/>'s and <br>'s for new lines (\n) in a given string.</p>
|
1778 | </div>
|
1779 |
|
1780 |
|
1781 |
|
1782 |
|
1783 |
|
1784 |
|
1785 |
|
1786 |
|
1787 | <h5>Parameters:</h5>
|
1788 |
|
1789 |
|
1790 | <table class="params table table-striped">
|
1791 | <thead>
|
1792 | <tr>
|
1793 |
|
1794 | <th style="width:12%; min-width:110px;">Name</th>
|
1795 |
|
1796 |
|
1797 | <th style="width:12%; min-width:110px;">Type</th>
|
1798 |
|
1799 |
|
1800 |
|
1801 |
|
1802 |
|
1803 | <th class="last" style="min-width:310px;">Description</th>
|
1804 | </tr>
|
1805 | </thead>
|
1806 |
|
1807 | <tbody>
|
1808 |
|
1809 |
|
1810 | <tr>
|
1811 |
|
1812 | <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>string</code></td>
|
1813 |
|
1814 |
|
1815 | <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;">
|
1816 |
|
1817 |
|
1818 | <span class="param-type">string</span>
|
1819 |
|
1820 |
|
1821 |
|
1822 |
|
1823 | </td>
|
1824 |
|
1825 |
|
1826 |
|
1827 |
|
1828 |
|
1829 | <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 string we want to modify.</p></td>
|
1830 | </tr>
|
1831 |
|
1832 |
|
1833 | </tbody>
|
1834 | </table>
|
1835 |
|
1836 |
|
1837 |
|
1838 |
|
1839 | <dl class="details">
|
1840 |
|
1841 |
|
1842 |
|
1843 |
|
1844 |
|
1845 |
|
1846 |
|
1847 |
|
1848 |
|
1849 |
|
1850 |
|
1851 |
|
1852 |
|
1853 |
|
1854 |
|
1855 |
|
1856 |
|
1857 |
|
1858 |
|
1859 |
|
1860 |
|
1861 |
|
1862 |
|
1863 |
|
1864 |
|
1865 |
|
1866 |
|
1867 |
|
1868 |
|
1869 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1870 | <dd class="tag-source">
|
1871 | <ul class="dummy">
|
1872 | <li>
|
1873 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
1874 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-442">line 442</a>
|
1875 | </li>
|
1876 | </ul>
|
1877 | </dd>
|
1878 |
|
1879 |
|
1880 |
|
1881 |
|
1882 |
|
1883 |
|
1884 |
|
1885 | </dl>
|
1886 |
|
1887 |
|
1888 |
|
1889 |
|
1890 |
|
1891 |
|
1892 |
|
1893 |
|
1894 |
|
1895 |
|
1896 |
|
1897 |
|
1898 |
|
1899 | <h5>Returns:</h5>
|
1900 |
|
1901 |
|
1902 | <div class="param-desc">
|
1903 | <p>Returns the string with all the occurrences replaced or an empty string if the element given was not a string.</p>
|
1904 | </div>
|
1905 |
|
1906 |
|
1907 |
|
1908 | <dl>
|
1909 | <dt>
|
1910 | Type
|
1911 | </dt>
|
1912 | <dd>
|
1913 |
|
1914 | <span class="param-type">string</span>
|
1915 |
|
1916 |
|
1917 |
|
1918 | </dd>
|
1919 | </dl>
|
1920 |
|
1921 |
|
1922 |
|
1923 |
|
1924 |
|
1925 | </dd>
|
1926 |
|
1927 |
|
1928 |
|
1929 | <hr>
|
1930 | <dt>
|
1931 | <h4 class="name" id="CB_brToNl"><span class="type-signature"></span>CB_brToNl<span class="signature">()</span><span class="type-signature"></span></h4>
|
1932 |
|
1933 |
|
1934 | </dt>
|
1935 | <dd>
|
1936 |
|
1937 |
|
1938 | <div class="description">
|
1939 | <p>Alias for <a href="global.html#CB_br2nl"><code>CB_br2nl</code></a>.</p>
|
1940 | </div>
|
1941 |
|
1942 |
|
1943 |
|
1944 |
|
1945 |
|
1946 |
|
1947 |
|
1948 |
|
1949 |
|
1950 |
|
1951 | <dl class="details">
|
1952 |
|
1953 |
|
1954 |
|
1955 |
|
1956 |
|
1957 |
|
1958 |
|
1959 |
|
1960 |
|
1961 |
|
1962 |
|
1963 |
|
1964 |
|
1965 |
|
1966 |
|
1967 |
|
1968 |
|
1969 |
|
1970 |
|
1971 |
|
1972 |
|
1973 |
|
1974 |
|
1975 |
|
1976 |
|
1977 |
|
1978 |
|
1979 |
|
1980 |
|
1981 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
1982 | <dd class="tag-source">
|
1983 | <ul class="dummy">
|
1984 | <li>
|
1985 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
1986 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-431">line 431</a>
|
1987 | </li>
|
1988 | </ul>
|
1989 | </dd>
|
1990 |
|
1991 |
|
1992 |
|
1993 |
|
1994 |
|
1995 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
1996 | <dd class="tag-see">
|
1997 | <ul>
|
1998 | <li><a href="global.html#CB_br2nl"><code>CB_br2nl</code></a></li>
|
1999 | </ul>
|
2000 | </dd>
|
2001 |
|
2002 |
|
2003 |
|
2004 | </dl>
|
2005 |
|
2006 |
|
2007 |
|
2008 |
|
2009 |
|
2010 |
|
2011 |
|
2012 |
|
2013 |
|
2014 |
|
2015 |
|
2016 |
|
2017 |
|
2018 |
|
2019 |
|
2020 | </dd>
|
2021 |
|
2022 |
|
2023 |
|
2024 | <hr>
|
2025 | <dt>
|
2026 | <h4 class="name" id="CB_combineArraysOrObjects"><span class="type-signature"></span>CB_combineArraysOrObjects<span class="signature">( [arrayOrObjectA] [, arrayOrObjectB], avoidDuplicatedValuesInArray [, modifyArrayOrObjectA])</span><span class="type-signature"> → {array|Object}</span></h4>
|
2027 |
|
2028 |
|
2029 | </dt>
|
2030 | <dd>
|
2031 |
|
2032 |
|
2033 | <div class="description">
|
2034 | <p>Returns a combined array or object from two arrays or objects. Using the following rules:<br>
|
2035 | <br /><br>
|
2036 | If they both are arrays (numeric indexes), it will keep all elements (attaching the elements of the second array after the elements of the first one).<br>
|
2037 | <br /><br>
|
2038 | Otherwise, if either of them is not an array (it should be an associative array which is an object in JavaScript), it will merge the elements (overwritting those whose index is the same and keeping the ones from the second array/object):</p>
|
2039 | </div>
|
2040 |
|
2041 |
|
2042 |
|
2043 |
|
2044 |
|
2045 |
|
2046 |
|
2047 |
|
2048 | <h5>Parameters:</h5>
|
2049 |
|
2050 |
|
2051 | <table class="params table table-striped">
|
2052 | <thead>
|
2053 | <tr>
|
2054 |
|
2055 | <th style="width:12%; min-width:110px;">Name</th>
|
2056 |
|
2057 |
|
2058 | <th style="width:12%; min-width:110px;">Type</th>
|
2059 |
|
2060 |
|
2061 | <th style="width:12%; min-width:110px;">Argument</th>
|
2062 |
|
2063 |
|
2064 |
|
2065 | <th style="width:12%; min-width:110px;">Default</th>
|
2066 |
|
2067 |
|
2068 | <th class="last" style="min-width:310px;">Description</th>
|
2069 | </tr>
|
2070 | </thead>
|
2071 |
|
2072 | <tbody>
|
2073 |
|
2074 |
|
2075 | <tr>
|
2076 |
|
2077 | <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>arrayOrObjectA</code></td>
|
2078 |
|
2079 |
|
2080 | <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;">
|
2081 |
|
2082 |
|
2083 | <span class="param-type">array</span>
|
2084 | |
|
2085 |
|
2086 | <span class="param-type">Object</span>
|
2087 | |
|
2088 |
|
2089 | <span class="param-type">string</span>
|
2090 | |
|
2091 |
|
2092 | <span class="param-type">null</span>
|
2093 | |
|
2094 |
|
2095 | <span class="param-type">undefined</span>
|
2096 |
|
2097 |
|
2098 |
|
2099 |
|
2100 | </td>
|
2101 |
|
2102 |
|
2103 | <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;">
|
2104 |
|
2105 | <optional><br>
|
2106 |
|
2107 |
|
2108 |
|
2109 |
|
2110 |
|
2111 | </td>
|
2112 |
|
2113 |
|
2114 |
|
2115 | <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;">
|
2116 |
|
2117 | []|{}
|
2118 |
|
2119 | </td>
|
2120 |
|
2121 |
|
2122 | <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>One of the arrays (numeric indexes) or associative arrays (object) that we want to combine. If a string is provided, it will try to convert it into a new object (the string should be a JSON-valid string). It can be optional if "arrayOrObjectB" is a valid value and neither null nor undefined. If not provided but the "arrayOrObjectB" is provided, it will be a new empty array if the "arrayOrObjectB" is an array or it will be an empty object otherwise.</p></td>
|
2123 | </tr>
|
2124 |
|
2125 |
|
2126 |
|
2127 | <tr>
|
2128 |
|
2129 | <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>arrayOrObjectB</code></td>
|
2130 |
|
2131 |
|
2132 | <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;">
|
2133 |
|
2134 |
|
2135 | <span class="param-type">array</span>
|
2136 | |
|
2137 |
|
2138 | <span class="param-type">Object</span>
|
2139 | |
|
2140 |
|
2141 | <span class="param-type">string</span>
|
2142 | |
|
2143 |
|
2144 | <span class="param-type">null</span>
|
2145 | |
|
2146 |
|
2147 | <span class="param-type">undefined</span>
|
2148 |
|
2149 |
|
2150 |
|
2151 |
|
2152 | </td>
|
2153 |
|
2154 |
|
2155 | <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;">
|
2156 |
|
2157 | <optional><br>
|
2158 |
|
2159 |
|
2160 |
|
2161 |
|
2162 |
|
2163 | </td>
|
2164 |
|
2165 |
|
2166 |
|
2167 | <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;">
|
2168 |
|
2169 | []|{}
|
2170 |
|
2171 | </td>
|
2172 |
|
2173 |
|
2174 | <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>One of the arrays (numeric indexes) or associative arrays (object) that we want to combine. If a string is provided, it will try to convert it into a new object (the string should be a JSON-valid string). It can be optional if "arrayOrObjectA" is a valid value and neither null nor undefined. If not provided but the "arrayOrObjectA" is provided, it will be a new empty array if the "arrayOrObjectA" is an array or it will be an empty object otherwise.</p></td>
|
2175 | </tr>
|
2176 |
|
2177 |
|
2178 |
|
2179 | <tr>
|
2180 |
|
2181 | <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>avoidDuplicatedValuesInArray</code></td>
|
2182 |
|
2183 |
|
2184 | <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;">
|
2185 |
|
2186 |
|
2187 | <span class="param-type">boolean</span>
|
2188 |
|
2189 |
|
2190 |
|
2191 |
|
2192 | </td>
|
2193 |
|
2194 |
|
2195 | <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;">
|
2196 |
|
2197 |
|
2198 |
|
2199 |
|
2200 |
|
2201 | </td>
|
2202 |
|
2203 |
|
2204 |
|
2205 | <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;">
|
2206 |
|
2207 | </td>
|
2208 |
|
2209 |
|
2210 | <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>Tells whether to avoid or allow items with duplicated values in the returned array or not. Only applies when both arrays to combine are numeric arrays.</p></td>
|
2211 | </tr>
|
2212 |
|
2213 |
|
2214 |
|
2215 | <tr>
|
2216 |
|
2217 | <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>modifyArrayOrObjectA</code></td>
|
2218 |
|
2219 |
|
2220 | <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;">
|
2221 |
|
2222 |
|
2223 | <span class="param-type">boolean</span>
|
2224 |
|
2225 |
|
2226 |
|
2227 |
|
2228 | </td>
|
2229 |
|
2230 |
|
2231 | <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;">
|
2232 |
|
2233 | <optional><br>
|
2234 |
|
2235 |
|
2236 |
|
2237 |
|
2238 |
|
2239 | </td>
|
2240 |
|
2241 |
|
2242 |
|
2243 | <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;">
|
2244 |
|
2245 | false
|
2246 |
|
2247 | </td>
|
2248 |
|
2249 |
|
2250 | <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>Parameter that will be used in the case that <a href="global.html#CB_combineJSON"><code>CB_combineJSON</code></a> or <a href="global.html#CB_combineArraysOrObjects"><code>CB_combineArraysOrObjects</code></a> is called. If set to true, it will modify the original "arrayOrObjectA" array or object.</p></td>
|
2251 | </tr>
|
2252 |
|
2253 |
|
2254 | </tbody>
|
2255 | </table>
|
2256 |
|
2257 |
|
2258 |
|
2259 |
|
2260 | <dl class="details">
|
2261 |
|
2262 |
|
2263 |
|
2264 |
|
2265 |
|
2266 |
|
2267 |
|
2268 |
|
2269 |
|
2270 |
|
2271 |
|
2272 |
|
2273 |
|
2274 |
|
2275 |
|
2276 |
|
2277 |
|
2278 |
|
2279 |
|
2280 |
|
2281 |
|
2282 |
|
2283 |
|
2284 |
|
2285 |
|
2286 |
|
2287 |
|
2288 |
|
2289 |
|
2290 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2291 | <dd class="tag-source">
|
2292 | <ul class="dummy">
|
2293 | <li>
|
2294 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
2295 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-1007">line 1007</a>
|
2296 | </li>
|
2297 | </ul>
|
2298 | </dd>
|
2299 |
|
2300 |
|
2301 |
|
2302 |
|
2303 |
|
2304 |
|
2305 |
|
2306 | </dl>
|
2307 |
|
2308 |
|
2309 |
|
2310 |
|
2311 |
|
2312 |
|
2313 |
|
2314 |
|
2315 |
|
2316 |
|
2317 |
|
2318 |
|
2319 |
|
2320 | <h5>Returns:</h5>
|
2321 |
|
2322 |
|
2323 |
|
2324 |
|
2325 | <dl>
|
2326 | <dt>
|
2327 | Type
|
2328 | </dt>
|
2329 | <dd>
|
2330 |
|
2331 | <span class="param-type">array</span>
|
2332 | |
|
2333 |
|
2334 | <span class="param-type">Object</span>
|
2335 |
|
2336 |
|
2337 |
|
2338 | </dd>
|
2339 | </dl>
|
2340 |
|
2341 |
|
2342 |
|
2343 |
|
2344 |
|
2345 | </dd>
|
2346 |
|
2347 |
|
2348 |
|
2349 | <hr>
|
2350 | <dt>
|
2351 | <h4 class="name" id="CB_combineAutomatically"><span class="type-signature"></span>CB_combineAutomatically<span class="signature">( [a] [, b] [, avoidDuplicatedValuesInArray] [, modifyArrayOrObjectA])</span><span class="type-signature"> → {*}</span></h4>
|
2352 |
|
2353 |
|
2354 | </dt>
|
2355 | <dd>
|
2356 |
|
2357 |
|
2358 | <div class="description">
|
2359 | <p>Tries to combine two given values guessing the best way to do it and returns their combination. Using the following rules:<br>
|
2360 | <br /><br>
|
2361 | If both values are either undefined or null, returns null.<br>
|
2362 | <br /><br>
|
2363 | Otherwise, if both values are boolean, returns the AND operation for the two of them (a && b).<br>
|
2364 | <br /><br>
|
2365 | Otherwise, if either of the two is a string (not empty) and is not JSON valid, combines them as URL (GET) parameters using <a href="global.html#CB_combineURIParameters"><code>CB_combineURIParameters</code></a>.<br>
|
2366 | <br /><br>
|
2367 | Otherwise, if either of them is JSON valid, combines them as JSON using <a href="global.html#CB_combineJSON"><code>CB_combineJSON</code></a> (passing the received avoidDuplicatedValuesInArray value as a parameter).<br>
|
2368 | <br /><br>
|
2369 | Otherwise, combines them as arrays or objects using <a href="global.html#CB_combineArraysOrObjects"><code>CB_combineArraysOrObjects</code></a> (passing the received "avoidDuplicatedValuesInArray" value as a parameter).</p>
|
2370 | </div>
|
2371 |
|
2372 |
|
2373 |
|
2374 |
|
2375 |
|
2376 |
|
2377 |
|
2378 |
|
2379 | <h5>Parameters:</h5>
|
2380 |
|
2381 |
|
2382 | <table class="params table table-striped">
|
2383 | <thead>
|
2384 | <tr>
|
2385 |
|
2386 | <th style="width:12%; min-width:110px;">Name</th>
|
2387 |
|
2388 |
|
2389 | <th style="width:12%; min-width:110px;">Type</th>
|
2390 |
|
2391 |
|
2392 | <th style="width:12%; min-width:110px;">Argument</th>
|
2393 |
|
2394 |
|
2395 |
|
2396 | <th style="width:12%; min-width:110px;">Default</th>
|
2397 |
|
2398 |
|
2399 | <th class="last" style="min-width:310px;">Description</th>
|
2400 | </tr>
|
2401 | </thead>
|
2402 |
|
2403 | <tbody>
|
2404 |
|
2405 |
|
2406 | <tr>
|
2407 |
|
2408 | <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>a</code></td>
|
2409 |
|
2410 |
|
2411 | <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;">
|
2412 |
|
2413 |
|
2414 | <span class="param-type">*</span>
|
2415 |
|
2416 |
|
2417 |
|
2418 |
|
2419 | </td>
|
2420 |
|
2421 |
|
2422 | <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;">
|
2423 |
|
2424 | <optional><br>
|
2425 |
|
2426 |
|
2427 |
|
2428 |
|
2429 |
|
2430 | </td>
|
2431 |
|
2432 |
|
2433 |
|
2434 | <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;">
|
2435 |
|
2436 | null|[]|{}
|
2437 |
|
2438 | </td>
|
2439 |
|
2440 |
|
2441 | <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>First value. It can be optional if "b" is a valid value, defined and not null.</p></td>
|
2442 | </tr>
|
2443 |
|
2444 |
|
2445 |
|
2446 | <tr>
|
2447 |
|
2448 | <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>b</code></td>
|
2449 |
|
2450 |
|
2451 | <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;">
|
2452 |
|
2453 |
|
2454 | <span class="param-type">*</span>
|
2455 |
|
2456 |
|
2457 |
|
2458 |
|
2459 | </td>
|
2460 |
|
2461 |
|
2462 | <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;">
|
2463 |
|
2464 | <optional><br>
|
2465 |
|
2466 |
|
2467 |
|
2468 |
|
2469 |
|
2470 | </td>
|
2471 |
|
2472 |
|
2473 |
|
2474 | <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;">
|
2475 |
|
2476 | null|[]|{}
|
2477 |
|
2478 | </td>
|
2479 |
|
2480 |
|
2481 | <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>Second value. It can be optional if "a" is a valid value, defined and not null.</p></td>
|
2482 | </tr>
|
2483 |
|
2484 |
|
2485 |
|
2486 | <tr>
|
2487 |
|
2488 | <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>avoidDuplicatedValuesInArray</code></td>
|
2489 |
|
2490 |
|
2491 | <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;">
|
2492 |
|
2493 |
|
2494 | <span class="param-type">boolean</span>
|
2495 |
|
2496 |
|
2497 |
|
2498 |
|
2499 | </td>
|
2500 |
|
2501 |
|
2502 | <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;">
|
2503 |
|
2504 | <optional><br>
|
2505 |
|
2506 |
|
2507 |
|
2508 |
|
2509 |
|
2510 | </td>
|
2511 |
|
2512 |
|
2513 |
|
2514 | <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;">
|
2515 |
|
2516 | false
|
2517 |
|
2518 | </td>
|
2519 |
|
2520 |
|
2521 | <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>Parameter that will be used in the case that <a href="global.html#CB_combineJSON"><code>CB_combineJSON</code></a> or <a href="global.html#CB_combineArraysOrObjects"><code>CB_combineArraysOrObjects</code></a> is called.</p></td>
|
2522 | </tr>
|
2523 |
|
2524 |
|
2525 |
|
2526 | <tr>
|
2527 |
|
2528 | <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>modifyArrayOrObjectA</code></td>
|
2529 |
|
2530 |
|
2531 | <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;">
|
2532 |
|
2533 |
|
2534 | <span class="param-type">boolean</span>
|
2535 |
|
2536 |
|
2537 |
|
2538 |
|
2539 | </td>
|
2540 |
|
2541 |
|
2542 | <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;">
|
2543 |
|
2544 | <optional><br>
|
2545 |
|
2546 |
|
2547 |
|
2548 |
|
2549 |
|
2550 | </td>
|
2551 |
|
2552 |
|
2553 |
|
2554 | <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;">
|
2555 |
|
2556 | false
|
2557 |
|
2558 | </td>
|
2559 |
|
2560 |
|
2561 | <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>Parameter that will be used in the case that <a href="global.html#CB_combineJSON"><code>CB_combineJSON</code></a> or <a href="global.html#CB_combineArraysOrObjects"><code>CB_combineArraysOrObjects</code></a> is called. If set to true, it will modify the original "a" array or object.</p></td>
|
2562 | </tr>
|
2563 |
|
2564 |
|
2565 | </tbody>
|
2566 | </table>
|
2567 |
|
2568 |
|
2569 |
|
2570 |
|
2571 | <dl class="details">
|
2572 |
|
2573 |
|
2574 |
|
2575 |
|
2576 |
|
2577 |
|
2578 |
|
2579 |
|
2580 |
|
2581 |
|
2582 |
|
2583 |
|
2584 |
|
2585 |
|
2586 |
|
2587 |
|
2588 |
|
2589 |
|
2590 |
|
2591 |
|
2592 |
|
2593 |
|
2594 |
|
2595 |
|
2596 |
|
2597 |
|
2598 |
|
2599 |
|
2600 |
|
2601 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2602 | <dd class="tag-source">
|
2603 | <ul class="dummy">
|
2604 | <li>
|
2605 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
2606 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-952">line 952</a>
|
2607 | </li>
|
2608 | </ul>
|
2609 | </dd>
|
2610 |
|
2611 |
|
2612 |
|
2613 |
|
2614 |
|
2615 |
|
2616 |
|
2617 | </dl>
|
2618 |
|
2619 |
|
2620 |
|
2621 |
|
2622 |
|
2623 |
|
2624 |
|
2625 |
|
2626 |
|
2627 |
|
2628 |
|
2629 |
|
2630 |
|
2631 | <h5>Returns:</h5>
|
2632 |
|
2633 |
|
2634 |
|
2635 |
|
2636 | <dl>
|
2637 | <dt>
|
2638 | Type
|
2639 | </dt>
|
2640 | <dd>
|
2641 |
|
2642 | <span class="param-type">*</span>
|
2643 |
|
2644 |
|
2645 |
|
2646 | </dd>
|
2647 | </dl>
|
2648 |
|
2649 |
|
2650 |
|
2651 |
|
2652 |
|
2653 | </dd>
|
2654 |
|
2655 |
|
2656 |
|
2657 | <hr>
|
2658 | <dt>
|
2659 | <h4 class="name" id="CB_combineJSON"><span class="type-signature"></span>CB_combineJSON<span class="signature">()</span><span class="type-signature"></span></h4>
|
2660 |
|
2661 |
|
2662 | </dt>
|
2663 | <dd>
|
2664 |
|
2665 |
|
2666 | <div class="description">
|
2667 | <p>Alias for <a href="global.html#CB_combineArraysOrObjects"><code>CB_combineArraysOrObjects</code></a>.</p>
|
2668 | </div>
|
2669 |
|
2670 |
|
2671 |
|
2672 |
|
2673 |
|
2674 |
|
2675 |
|
2676 |
|
2677 |
|
2678 |
|
2679 | <dl class="details">
|
2680 |
|
2681 |
|
2682 |
|
2683 |
|
2684 |
|
2685 |
|
2686 |
|
2687 |
|
2688 |
|
2689 |
|
2690 |
|
2691 |
|
2692 |
|
2693 |
|
2694 |
|
2695 |
|
2696 |
|
2697 |
|
2698 |
|
2699 |
|
2700 |
|
2701 |
|
2702 |
|
2703 |
|
2704 |
|
2705 |
|
2706 |
|
2707 |
|
2708 |
|
2709 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2710 | <dd class="tag-source">
|
2711 | <ul class="dummy">
|
2712 | <li>
|
2713 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
2714 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-1089">line 1089</a>
|
2715 | </li>
|
2716 | </ul>
|
2717 | </dd>
|
2718 |
|
2719 |
|
2720 |
|
2721 |
|
2722 |
|
2723 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
2724 | <dd class="tag-see">
|
2725 | <ul>
|
2726 | <li><a href="global.html#CB_combineArraysOrObjects"><code>CB_combineArraysOrObjects</code></a></li>
|
2727 | </ul>
|
2728 | </dd>
|
2729 |
|
2730 |
|
2731 |
|
2732 | </dl>
|
2733 |
|
2734 |
|
2735 |
|
2736 |
|
2737 |
|
2738 |
|
2739 |
|
2740 |
|
2741 |
|
2742 |
|
2743 |
|
2744 |
|
2745 |
|
2746 |
|
2747 |
|
2748 | </dd>
|
2749 |
|
2750 |
|
2751 |
|
2752 | <hr>
|
2753 | <dt>
|
2754 | <h4 class="name" id="CB_combineURIParameters"><span class="type-signature"></span>CB_combineURIParameters<span class="signature">(parametersA, parametersB)</span><span class="type-signature"> → {string}</span></h4>
|
2755 |
|
2756 |
|
2757 | </dt>
|
2758 | <dd>
|
2759 |
|
2760 |
|
2761 | <div class="description">
|
2762 | <p>Combines two strings as URL (GET) parameters. If either "parametersA" or "parametersB" is not a string, internally it will use the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify">JSON.stringify</a> method if available or otherwise it will use <a href="https://bestiejs.github.io/json3/">JSON 3</a> instead.</p>
|
2763 | </div>
|
2764 |
|
2765 |
|
2766 |
|
2767 |
|
2768 |
|
2769 |
|
2770 |
|
2771 |
|
2772 | <h5>Parameters:</h5>
|
2773 |
|
2774 |
|
2775 | <table class="params table table-striped">
|
2776 | <thead>
|
2777 | <tr>
|
2778 |
|
2779 | <th style="width:12%; min-width:110px;">Name</th>
|
2780 |
|
2781 |
|
2782 | <th style="width:12%; min-width:110px;">Type</th>
|
2783 |
|
2784 |
|
2785 |
|
2786 |
|
2787 |
|
2788 | <th class="last" style="min-width:310px;">Description</th>
|
2789 | </tr>
|
2790 | </thead>
|
2791 |
|
2792 | <tbody>
|
2793 |
|
2794 |
|
2795 | <tr>
|
2796 |
|
2797 | <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>parametersA</code></td>
|
2798 |
|
2799 |
|
2800 | <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;">
|
2801 |
|
2802 |
|
2803 | <span class="param-type">string</span>
|
2804 |
|
2805 |
|
2806 |
|
2807 |
|
2808 | </td>
|
2809 |
|
2810 |
|
2811 |
|
2812 |
|
2813 |
|
2814 | <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>String with the desired parameter or parameters. It can be optional if "parametersB" is a valid string. It will trim any "&" and "?" character at the beginning and at the end, and finally use "&" to concatenate the two strings (if needed).</p></td>
|
2815 | </tr>
|
2816 |
|
2817 |
|
2818 |
|
2819 | <tr>
|
2820 |
|
2821 | <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>parametersB</code></td>
|
2822 |
|
2823 |
|
2824 | <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;">
|
2825 |
|
2826 |
|
2827 | <span class="param-type">string</span>
|
2828 |
|
2829 |
|
2830 |
|
2831 |
|
2832 | </td>
|
2833 |
|
2834 |
|
2835 |
|
2836 |
|
2837 |
|
2838 | <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>String with the desired parameter or parameters. It can be optional if "parametersA" is a valid string. It will trim any "&" and "?" character at the beginning and at the end, and finally use "&" to concatenate the two strings (if needed).</p></td>
|
2839 | </tr>
|
2840 |
|
2841 |
|
2842 | </tbody>
|
2843 | </table>
|
2844 |
|
2845 |
|
2846 |
|
2847 |
|
2848 | <dl class="details">
|
2849 |
|
2850 |
|
2851 |
|
2852 |
|
2853 |
|
2854 |
|
2855 |
|
2856 |
|
2857 |
|
2858 |
|
2859 |
|
2860 |
|
2861 |
|
2862 |
|
2863 |
|
2864 |
|
2865 |
|
2866 |
|
2867 |
|
2868 |
|
2869 |
|
2870 |
|
2871 |
|
2872 |
|
2873 |
|
2874 |
|
2875 |
|
2876 |
|
2877 |
|
2878 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2879 | <dd class="tag-source">
|
2880 | <ul class="dummy">
|
2881 | <li>
|
2882 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
2883 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-981">line 981</a>
|
2884 | </li>
|
2885 | </ul>
|
2886 | </dd>
|
2887 |
|
2888 |
|
2889 |
|
2890 |
|
2891 |
|
2892 |
|
2893 |
|
2894 | </dl>
|
2895 |
|
2896 |
|
2897 |
|
2898 |
|
2899 |
|
2900 |
|
2901 |
|
2902 |
|
2903 |
|
2904 |
|
2905 |
|
2906 |
|
2907 |
|
2908 | <h5>Returns:</h5>
|
2909 |
|
2910 |
|
2911 | <div class="param-desc">
|
2912 | <p>For example, if parametersA is "parameter1=value1&parameter2=value2" and parametersB is "parameter3=value3&what=ever" then it will return "parameter1=value1&parameter2=value2&parameter3=value3&what=ever".</p>
|
2913 | </div>
|
2914 |
|
2915 |
|
2916 |
|
2917 | <dl>
|
2918 | <dt>
|
2919 | Type
|
2920 | </dt>
|
2921 | <dd>
|
2922 |
|
2923 | <span class="param-type">string</span>
|
2924 |
|
2925 |
|
2926 |
|
2927 | </dd>
|
2928 | </dl>
|
2929 |
|
2930 |
|
2931 |
|
2932 |
|
2933 |
|
2934 | </dd>
|
2935 |
|
2936 |
|
2937 |
|
2938 | <hr>
|
2939 | <dt>
|
2940 | <h4 class="name" id="CB_combineURLParameters"><span class="type-signature"></span>CB_combineURLParameters<span class="signature">()</span><span class="type-signature"></span></h4>
|
2941 |
|
2942 |
|
2943 | </dt>
|
2944 | <dd>
|
2945 |
|
2946 |
|
2947 | <div class="description">
|
2948 | <p>Alias for <a href="global.html#CB_combineURIParameters"><code>CB_combineURIParameters</code></a>.</p>
|
2949 | </div>
|
2950 |
|
2951 |
|
2952 |
|
2953 |
|
2954 |
|
2955 |
|
2956 |
|
2957 |
|
2958 |
|
2959 |
|
2960 | <dl class="details">
|
2961 |
|
2962 |
|
2963 |
|
2964 |
|
2965 |
|
2966 |
|
2967 |
|
2968 |
|
2969 |
|
2970 |
|
2971 |
|
2972 |
|
2973 |
|
2974 |
|
2975 |
|
2976 |
|
2977 |
|
2978 |
|
2979 |
|
2980 |
|
2981 |
|
2982 |
|
2983 |
|
2984 |
|
2985 |
|
2986 |
|
2987 |
|
2988 |
|
2989 |
|
2990 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
2991 | <dd class="tag-source">
|
2992 | <ul class="dummy">
|
2993 | <li>
|
2994 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
2995 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-969">line 969</a>
|
2996 | </li>
|
2997 | </ul>
|
2998 | </dd>
|
2999 |
|
3000 |
|
3001 |
|
3002 |
|
3003 |
|
3004 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
3005 | <dd class="tag-see">
|
3006 | <ul>
|
3007 | <li><a href="global.html#CB_combineURIParameters"><code>CB_combineURIParameters</code></a></li>
|
3008 | </ul>
|
3009 | </dd>
|
3010 |
|
3011 |
|
3012 |
|
3013 | </dl>
|
3014 |
|
3015 |
|
3016 |
|
3017 |
|
3018 |
|
3019 |
|
3020 |
|
3021 |
|
3022 |
|
3023 |
|
3024 |
|
3025 |
|
3026 |
|
3027 |
|
3028 |
|
3029 | </dd>
|
3030 |
|
3031 |
|
3032 |
|
3033 | <hr>
|
3034 | <dt>
|
3035 | <h4 class="name" id="CB_console"><span class="type-signature"></span>CB_console<span class="signature">(message)</span><span class="type-signature"></span></h4>
|
3036 |
|
3037 |
|
3038 | </dt>
|
3039 | <dd>
|
3040 |
|
3041 |
|
3042 | <div class="description">
|
3043 | <p>Alias for the "console" function which fallbacks to a DOM element with "CB_console" id (its CSS "style" attribute will be modified if needed, which means that its "display" property will be set to "block" if it is "none" and its "visibility" property to "visible" regardless its previous value) or even to an alert when it is not available ("alert" will only be used as a fallback in the case that the <code>CB_console_ALLOW_ALERTS</code> parameter is set to true).</p>
|
3044 | </div>
|
3045 |
|
3046 |
|
3047 |
|
3048 |
|
3049 |
|
3050 |
|
3051 |
|
3052 |
|
3053 | <h5>Parameters:</h5>
|
3054 |
|
3055 |
|
3056 | <table class="params table table-striped">
|
3057 | <thead>
|
3058 | <tr>
|
3059 |
|
3060 | <th style="width:12%; min-width:110px;">Name</th>
|
3061 |
|
3062 |
|
3063 | <th style="width:12%; min-width:110px;">Type</th>
|
3064 |
|
3065 |
|
3066 |
|
3067 |
|
3068 |
|
3069 | <th class="last" style="min-width:310px;">Description</th>
|
3070 | </tr>
|
3071 | </thead>
|
3072 |
|
3073 | <tbody>
|
3074 |
|
3075 |
|
3076 | <tr>
|
3077 |
|
3078 | <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>message</code></td>
|
3079 |
|
3080 |
|
3081 | <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;">
|
3082 |
|
3083 |
|
3084 | <span class="param-type">string</span>
|
3085 |
|
3086 |
|
3087 |
|
3088 |
|
3089 | </td>
|
3090 |
|
3091 |
|
3092 |
|
3093 |
|
3094 |
|
3095 | <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>Message to display</p></td>
|
3096 | </tr>
|
3097 |
|
3098 |
|
3099 | </tbody>
|
3100 | </table>
|
3101 |
|
3102 |
|
3103 |
|
3104 |
|
3105 | <dl class="details">
|
3106 |
|
3107 |
|
3108 |
|
3109 |
|
3110 |
|
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 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3136 | <dd class="tag-source">
|
3137 | <ul class="dummy">
|
3138 | <li>
|
3139 | <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
|
3140 | <a href="CrossBrowdy.js.html#sunlight-1-line-325">line 325</a>
|
3141 | </li>
|
3142 | </ul>
|
3143 | </dd>
|
3144 |
|
3145 |
|
3146 |
|
3147 |
|
3148 |
|
3149 |
|
3150 |
|
3151 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
3152 | <dd class="tag-todo">
|
3153 | <ul>
|
3154 | <li>When "console" is not available and it gets polyfilled, allow more parameters (use "arguments").</li>
|
3155 | </ul>
|
3156 | </dd>
|
3157 |
|
3158 | </dl>
|
3159 |
|
3160 |
|
3161 |
|
3162 |
|
3163 |
|
3164 |
|
3165 |
|
3166 |
|
3167 |
|
3168 |
|
3169 |
|
3170 |
|
3171 |
|
3172 |
|
3173 |
|
3174 | </dd>
|
3175 |
|
3176 |
|
3177 |
|
3178 | <hr>
|
3179 | <dt>
|
3180 | <h4 class="name" id="CB_copyObject"><span class="type-signature"></span>CB_copyObject<span class="signature">(element [, onlyOwn])</span><span class="type-signature"> → {object}</span></h4>
|
3181 |
|
3182 |
|
3183 | </dt>
|
3184 | <dd>
|
3185 |
|
3186 |
|
3187 | <div class="description">
|
3188 | <p>Returns an object copied from the given one.</p>
|
3189 | </div>
|
3190 |
|
3191 |
|
3192 |
|
3193 |
|
3194 |
|
3195 |
|
3196 |
|
3197 |
|
3198 | <h5>Parameters:</h5>
|
3199 |
|
3200 |
|
3201 | <table class="params table table-striped">
|
3202 | <thead>
|
3203 | <tr>
|
3204 |
|
3205 | <th style="width:12%; min-width:110px;">Name</th>
|
3206 |
|
3207 |
|
3208 | <th style="width:12%; min-width:110px;">Type</th>
|
3209 |
|
3210 |
|
3211 | <th style="width:12%; min-width:110px;">Argument</th>
|
3212 |
|
3213 |
|
3214 |
|
3215 | <th style="width:12%; min-width:110px;">Default</th>
|
3216 |
|
3217 |
|
3218 | <th class="last" style="min-width:310px;">Description</th>
|
3219 | </tr>
|
3220 | </thead>
|
3221 |
|
3222 | <tbody>
|
3223 |
|
3224 |
|
3225 | <tr>
|
3226 |
|
3227 | <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>
|
3228 |
|
3229 |
|
3230 | <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;">
|
3231 |
|
3232 |
|
3233 | <span class="param-type">object</span>
|
3234 |
|
3235 |
|
3236 |
|
3237 |
|
3238 | </td>
|
3239 |
|
3240 |
|
3241 | <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;">
|
3242 |
|
3243 |
|
3244 |
|
3245 |
|
3246 |
|
3247 | </td>
|
3248 |
|
3249 |
|
3250 |
|
3251 | <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;">
|
3252 |
|
3253 | </td>
|
3254 |
|
3255 |
|
3256 | <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 element whose properties and values we want to copy. It should be an object.</p></td>
|
3257 | </tr>
|
3258 |
|
3259 |
|
3260 |
|
3261 | <tr>
|
3262 |
|
3263 | <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>onlyOwn</code></td>
|
3264 |
|
3265 |
|
3266 | <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;">
|
3267 |
|
3268 |
|
3269 | <span class="param-type">boolean</span>
|
3270 |
|
3271 |
|
3272 |
|
3273 |
|
3274 | </td>
|
3275 |
|
3276 |
|
3277 | <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;">
|
3278 |
|
3279 | <optional><br>
|
3280 |
|
3281 |
|
3282 |
|
3283 |
|
3284 |
|
3285 | </td>
|
3286 |
|
3287 |
|
3288 |
|
3289 | <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;">
|
3290 |
|
3291 | false
|
3292 |
|
3293 | </td>
|
3294 |
|
3295 |
|
3296 | <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 the "element" given is not an object, this parameter will be ignored. Otherwise, if it is set to true, it will only have into account the properties which the object has as their own property and have not been inherited (using the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty">Object.hasOwnProperty</a> method).</p></td>
|
3297 | </tr>
|
3298 |
|
3299 |
|
3300 | </tbody>
|
3301 | </table>
|
3302 |
|
3303 |
|
3304 |
|
3305 |
|
3306 | <dl class="details">
|
3307 |
|
3308 |
|
3309 |
|
3310 |
|
3311 |
|
3312 |
|
3313 |
|
3314 |
|
3315 |
|
3316 |
|
3317 |
|
3318 |
|
3319 |
|
3320 |
|
3321 |
|
3322 |
|
3323 |
|
3324 |
|
3325 |
|
3326 |
|
3327 |
|
3328 |
|
3329 |
|
3330 |
|
3331 |
|
3332 |
|
3333 |
|
3334 |
|
3335 |
|
3336 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3337 | <dd class="tag-source">
|
3338 | <ul class="dummy">
|
3339 | <li>
|
3340 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
3341 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-837">line 837</a>
|
3342 | </li>
|
3343 | </ul>
|
3344 | </dd>
|
3345 |
|
3346 |
|
3347 |
|
3348 |
|
3349 |
|
3350 |
|
3351 |
|
3352 | </dl>
|
3353 |
|
3354 |
|
3355 |
|
3356 |
|
3357 |
|
3358 |
|
3359 |
|
3360 |
|
3361 |
|
3362 |
|
3363 |
|
3364 |
|
3365 |
|
3366 | <h5>Returns:</h5>
|
3367 |
|
3368 |
|
3369 | <div class="param-desc">
|
3370 | <p>Returns an object copied from the given one. Returns an empty object if the given "element" was not an object.</p>
|
3371 | </div>
|
3372 |
|
3373 |
|
3374 |
|
3375 | <dl>
|
3376 | <dt>
|
3377 | Type
|
3378 | </dt>
|
3379 | <dd>
|
3380 |
|
3381 | <span class="param-type">object</span>
|
3382 |
|
3383 |
|
3384 |
|
3385 | </dd>
|
3386 | </dl>
|
3387 |
|
3388 |
|
3389 |
|
3390 |
|
3391 |
|
3392 | </dd>
|
3393 |
|
3394 |
|
3395 |
|
3396 | <hr>
|
3397 | <dt>
|
3398 | <h4 class="name" id="CB_countDecimalDigits"><span class="type-signature"></span>CB_countDecimalDigits<span class="signature">()</span><span class="type-signature"></span></h4>
|
3399 |
|
3400 |
|
3401 | </dt>
|
3402 | <dd>
|
3403 |
|
3404 |
|
3405 | <div class="description">
|
3406 | <p>Alias for <a href="global.html#CB_countDecimalPart"><code>CB_countDecimalPart</code></a>.</p>
|
3407 | </div>
|
3408 |
|
3409 |
|
3410 |
|
3411 |
|
3412 |
|
3413 |
|
3414 |
|
3415 |
|
3416 |
|
3417 |
|
3418 | <dl class="details">
|
3419 |
|
3420 |
|
3421 |
|
3422 |
|
3423 |
|
3424 |
|
3425 |
|
3426 |
|
3427 |
|
3428 |
|
3429 |
|
3430 |
|
3431 |
|
3432 |
|
3433 |
|
3434 |
|
3435 |
|
3436 |
|
3437 |
|
3438 |
|
3439 |
|
3440 |
|
3441 |
|
3442 |
|
3443 |
|
3444 |
|
3445 |
|
3446 |
|
3447 |
|
3448 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3449 | <dd class="tag-source">
|
3450 | <ul class="dummy">
|
3451 | <li>
|
3452 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
3453 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-598">line 598</a>
|
3454 | </li>
|
3455 | </ul>
|
3456 | </dd>
|
3457 |
|
3458 |
|
3459 |
|
3460 |
|
3461 |
|
3462 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
3463 | <dd class="tag-see">
|
3464 | <ul>
|
3465 | <li><a href="global.html#CB_countDecimalPart"><code>CB_countDecimalPart</code></a></li>
|
3466 | </ul>
|
3467 | </dd>
|
3468 |
|
3469 |
|
3470 |
|
3471 | </dl>
|
3472 |
|
3473 |
|
3474 |
|
3475 |
|
3476 |
|
3477 |
|
3478 |
|
3479 |
|
3480 |
|
3481 |
|
3482 |
|
3483 |
|
3484 |
|
3485 |
|
3486 |
|
3487 | </dd>
|
3488 |
|
3489 |
|
3490 |
|
3491 | <hr>
|
3492 | <dt>
|
3493 | <h4 class="name" id="CB_countDecimalPart"><span class="type-signature"></span>CB_countDecimalPart<span class="signature">(number)</span><span class="type-signature"> → {integer}</span></h4>
|
3494 |
|
3495 |
|
3496 | </dt>
|
3497 | <dd>
|
3498 |
|
3499 |
|
3500 | <div class="description">
|
3501 | <p>Returns the number of decimals of the given number. It also works with numbers in exponential notation (as for example '1e-13' which would be 0.0000000000001).</p>
|
3502 | </div>
|
3503 |
|
3504 |
|
3505 |
|
3506 |
|
3507 |
|
3508 |
|
3509 |
|
3510 |
|
3511 | <h5>Parameters:</h5>
|
3512 |
|
3513 |
|
3514 | <table class="params table table-striped">
|
3515 | <thead>
|
3516 | <tr>
|
3517 |
|
3518 | <th style="width:12%; min-width:110px;">Name</th>
|
3519 |
|
3520 |
|
3521 | <th style="width:12%; min-width:110px;">Type</th>
|
3522 |
|
3523 |
|
3524 |
|
3525 |
|
3526 |
|
3527 | <th class="last" style="min-width:310px;">Description</th>
|
3528 | </tr>
|
3529 | </thead>
|
3530 |
|
3531 | <tbody>
|
3532 |
|
3533 |
|
3534 | <tr>
|
3535 |
|
3536 | <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>number</code></td>
|
3537 |
|
3538 |
|
3539 | <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;">
|
3540 |
|
3541 |
|
3542 | <span class="param-type">integer</span>
|
3543 | |
|
3544 |
|
3545 | <span class="param-type">float</span>
|
3546 | |
|
3547 |
|
3548 | <span class="param-type">string</span>
|
3549 |
|
3550 |
|
3551 |
|
3552 |
|
3553 | </td>
|
3554 |
|
3555 |
|
3556 |
|
3557 |
|
3558 |
|
3559 | <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 number whose decimals we want to count. It can be a string.</p></td>
|
3560 | </tr>
|
3561 |
|
3562 |
|
3563 | </tbody>
|
3564 | </table>
|
3565 |
|
3566 |
|
3567 |
|
3568 |
|
3569 | <dl class="details">
|
3570 |
|
3571 |
|
3572 |
|
3573 |
|
3574 |
|
3575 |
|
3576 |
|
3577 |
|
3578 |
|
3579 |
|
3580 |
|
3581 |
|
3582 |
|
3583 |
|
3584 |
|
3585 |
|
3586 |
|
3587 |
|
3588 |
|
3589 |
|
3590 |
|
3591 |
|
3592 |
|
3593 |
|
3594 |
|
3595 |
|
3596 |
|
3597 |
|
3598 |
|
3599 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3600 | <dd class="tag-source">
|
3601 | <ul class="dummy">
|
3602 | <li>
|
3603 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
3604 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-619">line 619</a>
|
3605 | </li>
|
3606 | </ul>
|
3607 | </dd>
|
3608 |
|
3609 |
|
3610 |
|
3611 |
|
3612 |
|
3613 |
|
3614 |
|
3615 | </dl>
|
3616 |
|
3617 |
|
3618 |
|
3619 |
|
3620 |
|
3621 |
|
3622 |
|
3623 |
|
3624 |
|
3625 |
|
3626 |
|
3627 |
|
3628 |
|
3629 | <h5>Returns:</h5>
|
3630 |
|
3631 |
|
3632 | <div class="param-desc">
|
3633 | <p>Returns zero in the case a non-valid number has been provided. Otherwise, it returns the number of decimals counted.</p>
|
3634 | </div>
|
3635 |
|
3636 |
|
3637 |
|
3638 | <dl>
|
3639 | <dt>
|
3640 | Type
|
3641 | </dt>
|
3642 | <dd>
|
3643 |
|
3644 | <span class="param-type">integer</span>
|
3645 |
|
3646 |
|
3647 |
|
3648 | </dd>
|
3649 | </dl>
|
3650 |
|
3651 |
|
3652 |
|
3653 |
|
3654 |
|
3655 | </dd>
|
3656 |
|
3657 |
|
3658 |
|
3659 | <hr>
|
3660 | <dt>
|
3661 | <h4 class="name" id="CB_countDecimals"><span class="type-signature"></span>CB_countDecimals<span class="signature">()</span><span class="type-signature"></span></h4>
|
3662 |
|
3663 |
|
3664 | </dt>
|
3665 | <dd>
|
3666 |
|
3667 |
|
3668 | <div class="description">
|
3669 | <p>Alias for <a href="global.html#CB_countDecimalPart"><code>CB_countDecimalPart</code></a>.</p>
|
3670 | </div>
|
3671 |
|
3672 |
|
3673 |
|
3674 |
|
3675 |
|
3676 |
|
3677 |
|
3678 |
|
3679 |
|
3680 |
|
3681 | <dl class="details">
|
3682 |
|
3683 |
|
3684 |
|
3685 |
|
3686 |
|
3687 |
|
3688 |
|
3689 |
|
3690 |
|
3691 |
|
3692 |
|
3693 |
|
3694 |
|
3695 |
|
3696 |
|
3697 |
|
3698 |
|
3699 |
|
3700 |
|
3701 |
|
3702 |
|
3703 |
|
3704 |
|
3705 |
|
3706 |
|
3707 |
|
3708 |
|
3709 |
|
3710 |
|
3711 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3712 | <dd class="tag-source">
|
3713 | <ul class="dummy">
|
3714 | <li>
|
3715 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
3716 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-593">line 593</a>
|
3717 | </li>
|
3718 | </ul>
|
3719 | </dd>
|
3720 |
|
3721 |
|
3722 |
|
3723 |
|
3724 |
|
3725 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
3726 | <dd class="tag-see">
|
3727 | <ul>
|
3728 | <li><a href="global.html#CB_countDecimalPart"><code>CB_countDecimalPart</code></a></li>
|
3729 | </ul>
|
3730 | </dd>
|
3731 |
|
3732 |
|
3733 |
|
3734 | </dl>
|
3735 |
|
3736 |
|
3737 |
|
3738 |
|
3739 |
|
3740 |
|
3741 |
|
3742 |
|
3743 |
|
3744 |
|
3745 |
|
3746 |
|
3747 |
|
3748 |
|
3749 |
|
3750 | </dd>
|
3751 |
|
3752 |
|
3753 |
|
3754 | <hr>
|
3755 | <dt>
|
3756 | <h4 class="name" id="CB_countIntegerDigits"><span class="type-signature"></span>CB_countIntegerDigits<span class="signature">()</span><span class="type-signature"></span></h4>
|
3757 |
|
3758 |
|
3759 | </dt>
|
3760 | <dd>
|
3761 |
|
3762 |
|
3763 | <div class="description">
|
3764 | <p>Alias for <a href="global.html#CB_countIntegerPart"><code>CB_countIntegerPart</code></a>.</p>
|
3765 | </div>
|
3766 |
|
3767 |
|
3768 |
|
3769 |
|
3770 |
|
3771 |
|
3772 |
|
3773 |
|
3774 |
|
3775 |
|
3776 | <dl class="details">
|
3777 |
|
3778 |
|
3779 |
|
3780 |
|
3781 |
|
3782 |
|
3783 |
|
3784 |
|
3785 |
|
3786 |
|
3787 |
|
3788 |
|
3789 |
|
3790 |
|
3791 |
|
3792 |
|
3793 |
|
3794 |
|
3795 |
|
3796 |
|
3797 |
|
3798 |
|
3799 |
|
3800 |
|
3801 |
|
3802 |
|
3803 |
|
3804 |
|
3805 |
|
3806 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3807 | <dd class="tag-source">
|
3808 | <ul class="dummy">
|
3809 | <li>
|
3810 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
3811 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-644">line 644</a>
|
3812 | </li>
|
3813 | </ul>
|
3814 | </dd>
|
3815 |
|
3816 |
|
3817 |
|
3818 |
|
3819 |
|
3820 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
3821 | <dd class="tag-see">
|
3822 | <ul>
|
3823 | <li><a href="global.html#CB_countIntegerPart"><code>CB_countIntegerPart</code></a></li>
|
3824 | </ul>
|
3825 | </dd>
|
3826 |
|
3827 |
|
3828 |
|
3829 | </dl>
|
3830 |
|
3831 |
|
3832 |
|
3833 |
|
3834 |
|
3835 |
|
3836 |
|
3837 |
|
3838 |
|
3839 |
|
3840 |
|
3841 |
|
3842 |
|
3843 |
|
3844 |
|
3845 | </dd>
|
3846 |
|
3847 |
|
3848 |
|
3849 | <hr>
|
3850 | <dt>
|
3851 | <h4 class="name" id="CB_countIntegerPart"><span class="type-signature"></span>CB_countIntegerPart<span class="signature">(number)</span><span class="type-signature"> → {integer}</span></h4>
|
3852 |
|
3853 |
|
3854 | </dt>
|
3855 | <dd>
|
3856 |
|
3857 |
|
3858 | <div class="description">
|
3859 | <p>Returns the number of integer digits (the number of digits that belong to the integer part) of the given number. It also works with numbers in exponential notation (as for example '1e-13' which would be 0.0000000000001).</p>
|
3860 | </div>
|
3861 |
|
3862 |
|
3863 |
|
3864 |
|
3865 |
|
3866 |
|
3867 |
|
3868 |
|
3869 | <h5>Parameters:</h5>
|
3870 |
|
3871 |
|
3872 | <table class="params table table-striped">
|
3873 | <thead>
|
3874 | <tr>
|
3875 |
|
3876 | <th style="width:12%; min-width:110px;">Name</th>
|
3877 |
|
3878 |
|
3879 | <th style="width:12%; min-width:110px;">Type</th>
|
3880 |
|
3881 |
|
3882 |
|
3883 |
|
3884 |
|
3885 | <th class="last" style="min-width:310px;">Description</th>
|
3886 | </tr>
|
3887 | </thead>
|
3888 |
|
3889 | <tbody>
|
3890 |
|
3891 |
|
3892 | <tr>
|
3893 |
|
3894 | <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>number</code></td>
|
3895 |
|
3896 |
|
3897 | <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;">
|
3898 |
|
3899 |
|
3900 | <span class="param-type">integer</span>
|
3901 | |
|
3902 |
|
3903 | <span class="param-type">float</span>
|
3904 | |
|
3905 |
|
3906 | <span class="param-type">string</span>
|
3907 |
|
3908 |
|
3909 |
|
3910 |
|
3911 | </td>
|
3912 |
|
3913 |
|
3914 |
|
3915 |
|
3916 |
|
3917 | <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 number whose integer digits (the digits that belong to the integer part) we want to count. It can be a string.</p></td>
|
3918 | </tr>
|
3919 |
|
3920 |
|
3921 | </tbody>
|
3922 | </table>
|
3923 |
|
3924 |
|
3925 |
|
3926 |
|
3927 | <dl class="details">
|
3928 |
|
3929 |
|
3930 |
|
3931 |
|
3932 |
|
3933 |
|
3934 |
|
3935 |
|
3936 |
|
3937 |
|
3938 |
|
3939 |
|
3940 |
|
3941 |
|
3942 |
|
3943 |
|
3944 |
|
3945 |
|
3946 |
|
3947 |
|
3948 |
|
3949 |
|
3950 |
|
3951 |
|
3952 |
|
3953 |
|
3954 |
|
3955 |
|
3956 |
|
3957 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
3958 | <dd class="tag-source">
|
3959 | <ul class="dummy">
|
3960 | <li>
|
3961 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
3962 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-655">line 655</a>
|
3963 | </li>
|
3964 | </ul>
|
3965 | </dd>
|
3966 |
|
3967 |
|
3968 |
|
3969 |
|
3970 |
|
3971 |
|
3972 |
|
3973 | </dl>
|
3974 |
|
3975 |
|
3976 |
|
3977 |
|
3978 |
|
3979 |
|
3980 |
|
3981 |
|
3982 |
|
3983 |
|
3984 |
|
3985 |
|
3986 |
|
3987 | <h5>Returns:</h5>
|
3988 |
|
3989 |
|
3990 | <div class="param-desc">
|
3991 | <p>Returns zero in the case a non-valid number has been provided. Otherwise, it returns the number of integer digits (the number of digits that belong to the integer part) counted.</p>
|
3992 | </div>
|
3993 |
|
3994 |
|
3995 |
|
3996 | <dl>
|
3997 | <dt>
|
3998 | Type
|
3999 | </dt>
|
4000 | <dd>
|
4001 |
|
4002 | <span class="param-type">integer</span>
|
4003 |
|
4004 |
|
4005 |
|
4006 | </dd>
|
4007 | </dl>
|
4008 |
|
4009 |
|
4010 |
|
4011 |
|
4012 |
|
4013 | </dd>
|
4014 |
|
4015 |
|
4016 |
|
4017 | <hr>
|
4018 | <dt>
|
4019 | <h4 class="name" id="CB_credits"><span class="type-signature"></span>CB_credits<span class="signature">( [credits] [, html] [, showPrefix])</span><span class="type-signature"> → {string}</span></h4>
|
4020 |
|
4021 |
|
4022 | </dt>
|
4023 | <dd>
|
4024 |
|
4025 |
|
4026 | <div class="description">
|
4027 | <p>Returns the credits with the desired format.</p>
|
4028 | </div>
|
4029 |
|
4030 |
|
4031 |
|
4032 |
|
4033 |
|
4034 |
|
4035 |
|
4036 |
|
4037 | <h5>Parameters:</h5>
|
4038 |
|
4039 |
|
4040 | <table class="params table table-striped">
|
4041 | <thead>
|
4042 | <tr>
|
4043 |
|
4044 | <th style="width:12%; min-width:110px;">Name</th>
|
4045 |
|
4046 |
|
4047 | <th style="width:12%; min-width:110px;">Type</th>
|
4048 |
|
4049 |
|
4050 | <th style="width:12%; min-width:110px;">Argument</th>
|
4051 |
|
4052 |
|
4053 |
|
4054 | <th style="width:12%; min-width:110px;">Default</th>
|
4055 |
|
4056 |
|
4057 | <th class="last" style="min-width:310px;">Description</th>
|
4058 | </tr>
|
4059 | </thead>
|
4060 |
|
4061 | <tbody>
|
4062 |
|
4063 |
|
4064 | <tr>
|
4065 |
|
4066 | <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>credits</code></td>
|
4067 |
|
4068 |
|
4069 | <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;">
|
4070 |
|
4071 |
|
4072 | <span class="param-type">string</span>
|
4073 |
|
4074 |
|
4075 |
|
4076 |
|
4077 | </td>
|
4078 |
|
4079 |
|
4080 | <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;">
|
4081 |
|
4082 | <optional><br>
|
4083 |
|
4084 |
|
4085 |
|
4086 |
|
4087 |
|
4088 | </td>
|
4089 |
|
4090 |
|
4091 |
|
4092 | <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;">
|
4093 |
|
4094 | <a href="global.html#CB_CREDITS_DEFAULT"><code>CB_CREDITS_DEFAULT</code></a>
|
4095 |
|
4096 | </td>
|
4097 |
|
4098 |
|
4099 | <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 credits to be shown.</p></td>
|
4100 | </tr>
|
4101 |
|
4102 |
|
4103 |
|
4104 | <tr>
|
4105 |
|
4106 | <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>html</code></td>
|
4107 |
|
4108 |
|
4109 | <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;">
|
4110 |
|
4111 |
|
4112 | <span class="param-type">boolean</span>
|
4113 |
|
4114 |
|
4115 |
|
4116 |
|
4117 | </td>
|
4118 |
|
4119 |
|
4120 | <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;">
|
4121 |
|
4122 | <optional><br>
|
4123 |
|
4124 |
|
4125 |
|
4126 |
|
4127 |
|
4128 | </td>
|
4129 |
|
4130 |
|
4131 |
|
4132 | <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;">
|
4133 |
|
4134 | true
|
4135 |
|
4136 | </td>
|
4137 |
|
4138 |
|
4139 | <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>Strips all HTML tags (if any) when it is false.</p></td>
|
4140 | </tr>
|
4141 |
|
4142 |
|
4143 |
|
4144 | <tr>
|
4145 |
|
4146 | <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>showPrefix</code></td>
|
4147 |
|
4148 |
|
4149 | <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;">
|
4150 |
|
4151 |
|
4152 | <span class="param-type">boolean</span>
|
4153 |
|
4154 |
|
4155 |
|
4156 |
|
4157 | </td>
|
4158 |
|
4159 |
|
4160 | <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;">
|
4161 |
|
4162 | <optional><br>
|
4163 |
|
4164 |
|
4165 |
|
4166 |
|
4167 |
|
4168 | </td>
|
4169 |
|
4170 |
|
4171 |
|
4172 | <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;">
|
4173 |
|
4174 | true
|
4175 |
|
4176 | </td>
|
4177 |
|
4178 |
|
4179 | <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 to show the "[CB]" prefix for every line or not (it will remove all "[CB]" occurrences if it is false).</p></td>
|
4180 | </tr>
|
4181 |
|
4182 |
|
4183 | </tbody>
|
4184 | </table>
|
4185 |
|
4186 |
|
4187 |
|
4188 |
|
4189 | <dl class="details">
|
4190 |
|
4191 |
|
4192 |
|
4193 |
|
4194 |
|
4195 |
|
4196 |
|
4197 |
|
4198 |
|
4199 |
|
4200 |
|
4201 |
|
4202 |
|
4203 |
|
4204 |
|
4205 |
|
4206 |
|
4207 |
|
4208 |
|
4209 |
|
4210 |
|
4211 |
|
4212 |
|
4213 |
|
4214 |
|
4215 |
|
4216 |
|
4217 |
|
4218 |
|
4219 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4220 | <dd class="tag-source">
|
4221 | <ul class="dummy">
|
4222 | <li>
|
4223 | <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
|
4224 | <a href="CrossBrowdy.js.html#sunlight-1-line-1122">line 1122</a>
|
4225 | </li>
|
4226 | </ul>
|
4227 | </dd>
|
4228 |
|
4229 |
|
4230 |
|
4231 |
|
4232 |
|
4233 |
|
4234 |
|
4235 | </dl>
|
4236 |
|
4237 |
|
4238 |
|
4239 |
|
4240 |
|
4241 |
|
4242 |
|
4243 |
|
4244 |
|
4245 |
|
4246 |
|
4247 |
|
4248 |
|
4249 | <h5>Returns:</h5>
|
4250 |
|
4251 |
|
4252 |
|
4253 |
|
4254 | <dl>
|
4255 | <dt>
|
4256 | Type
|
4257 | </dt>
|
4258 | <dd>
|
4259 |
|
4260 | <span class="param-type">string</span>
|
4261 |
|
4262 |
|
4263 |
|
4264 | </dd>
|
4265 | </dl>
|
4266 |
|
4267 |
|
4268 |
|
4269 |
|
4270 |
|
4271 | </dd>
|
4272 |
|
4273 |
|
4274 |
|
4275 | <hr>
|
4276 | <dt>
|
4277 | <h4 class="name" id="CB_forEach"><span class="type-signature"></span>CB_forEach<span class="signature">(array, callback [, thisArg] [, extendedDOM])</span><span class="type-signature"> → {array|undefined}</span></h4>
|
4278 |
|
4279 |
|
4280 | </dt>
|
4281 | <dd>
|
4282 |
|
4283 |
|
4284 | <div class="description">
|
4285 | <p>Implementation of the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach">Array.forEach</a> method for browsers that do not support it natively.<br>
|
4286 | <br><br>
|
4287 | Executes a function for each element of a given array.</p>
|
4288 | </div>
|
4289 |
|
4290 |
|
4291 |
|
4292 |
|
4293 |
|
4294 |
|
4295 |
|
4296 |
|
4297 | <h5>Parameters:</h5>
|
4298 |
|
4299 |
|
4300 | <table class="params table table-striped">
|
4301 | <thead>
|
4302 | <tr>
|
4303 |
|
4304 | <th style="width:12%; min-width:110px;">Name</th>
|
4305 |
|
4306 |
|
4307 | <th style="width:12%; min-width:110px;">Type</th>
|
4308 |
|
4309 |
|
4310 | <th style="width:12%; min-width:110px;">Argument</th>
|
4311 |
|
4312 |
|
4313 |
|
4314 | <th style="width:12%; min-width:110px;">Default</th>
|
4315 |
|
4316 |
|
4317 | <th class="last" style="min-width:310px;">Description</th>
|
4318 | </tr>
|
4319 | </thead>
|
4320 |
|
4321 | <tbody>
|
4322 |
|
4323 |
|
4324 | <tr>
|
4325 |
|
4326 | <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>array</code></td>
|
4327 |
|
4328 |
|
4329 | <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;">
|
4330 |
|
4331 |
|
4332 | <span class="param-type">array</span>
|
4333 |
|
4334 |
|
4335 |
|
4336 |
|
4337 | </td>
|
4338 |
|
4339 |
|
4340 | <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;">
|
4341 |
|
4342 |
|
4343 |
|
4344 |
|
4345 |
|
4346 | </td>
|
4347 |
|
4348 |
|
4349 |
|
4350 | <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;">
|
4351 |
|
4352 | </td>
|
4353 |
|
4354 |
|
4355 | <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 array.</p></td>
|
4356 | </tr>
|
4357 |
|
4358 |
|
4359 |
|
4360 | <tr>
|
4361 |
|
4362 | <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>callback</code></td>
|
4363 |
|
4364 |
|
4365 | <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;">
|
4366 |
|
4367 |
|
4368 | <span class="param-type">function</span>
|
4369 |
|
4370 |
|
4371 |
|
4372 |
|
4373 | </td>
|
4374 |
|
4375 |
|
4376 | <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;">
|
4377 |
|
4378 |
|
4379 |
|
4380 |
|
4381 |
|
4382 | </td>
|
4383 |
|
4384 |
|
4385 |
|
4386 | <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;">
|
4387 |
|
4388 | </td>
|
4389 |
|
4390 |
|
4391 | <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 executed for each element of the given array. Following the same rules as the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach">Array.forEach</a> method, it will receive three arguments: currentValue, currentIndex and the array given.</p></td>
|
4392 | </tr>
|
4393 |
|
4394 |
|
4395 |
|
4396 | <tr>
|
4397 |
|
4398 | <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>thisArg</code></td>
|
4399 |
|
4400 |
|
4401 | <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;">
|
4402 |
|
4403 |
|
4404 | <span class="param-type">*</span>
|
4405 |
|
4406 |
|
4407 |
|
4408 |
|
4409 | </td>
|
4410 |
|
4411 |
|
4412 | <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;">
|
4413 |
|
4414 | <optional><br>
|
4415 |
|
4416 |
|
4417 |
|
4418 |
|
4419 |
|
4420 | </td>
|
4421 |
|
4422 |
|
4423 |
|
4424 | <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;">
|
4425 |
|
4426 | </td>
|
4427 |
|
4428 |
|
4429 | <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>Value that will be passed as "this" every time the function is called.</p></td>
|
4430 | </tr>
|
4431 |
|
4432 |
|
4433 |
|
4434 | <tr>
|
4435 |
|
4436 | <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>extendedDOM</code></td>
|
4437 |
|
4438 |
|
4439 | <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;">
|
4440 |
|
4441 |
|
4442 | <span class="param-type">boolean</span>
|
4443 |
|
4444 |
|
4445 |
|
4446 |
|
4447 | </td>
|
4448 |
|
4449 |
|
4450 | <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;">
|
4451 |
|
4452 | <optional><br>
|
4453 |
|
4454 |
|
4455 |
|
4456 |
|
4457 |
|
4458 | </td>
|
4459 |
|
4460 |
|
4461 |
|
4462 | <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;">
|
4463 |
|
4464 | false
|
4465 |
|
4466 | </td>
|
4467 |
|
4468 |
|
4469 | <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 the function is being called by a native function which was extended. Internal usage recommended only.</p></td>
|
4470 | </tr>
|
4471 |
|
4472 |
|
4473 | </tbody>
|
4474 | </table>
|
4475 |
|
4476 |
|
4477 |
|
4478 |
|
4479 | <dl class="details">
|
4480 |
|
4481 |
|
4482 |
|
4483 |
|
4484 |
|
4485 |
|
4486 |
|
4487 |
|
4488 |
|
4489 |
|
4490 |
|
4491 |
|
4492 |
|
4493 |
|
4494 |
|
4495 |
|
4496 |
|
4497 |
|
4498 |
|
4499 |
|
4500 |
|
4501 |
|
4502 |
|
4503 |
|
4504 |
|
4505 |
|
4506 |
|
4507 |
|
4508 |
|
4509 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4510 | <dd class="tag-source">
|
4511 | <ul class="dummy">
|
4512 | <li>
|
4513 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
4514 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-136">line 136</a>
|
4515 | </li>
|
4516 | </ul>
|
4517 | </dd>
|
4518 |
|
4519 |
|
4520 |
|
4521 |
|
4522 |
|
4523 |
|
4524 |
|
4525 | </dl>
|
4526 |
|
4527 |
|
4528 |
|
4529 |
|
4530 |
|
4531 |
|
4532 |
|
4533 |
|
4534 |
|
4535 |
|
4536 |
|
4537 |
|
4538 |
|
4539 | <h5>Returns:</h5>
|
4540 |
|
4541 |
|
4542 | <div class="param-desc">
|
4543 | <p>If the "extendedDOM" parameter is set to false, returns the given "array" again. Otherwise, returns undefined.</p>
|
4544 | </div>
|
4545 |
|
4546 |
|
4547 |
|
4548 | <dl>
|
4549 | <dt>
|
4550 | Type
|
4551 | </dt>
|
4552 | <dd>
|
4553 |
|
4554 | <span class="param-type">array</span>
|
4555 | |
|
4556 |
|
4557 | <span class="param-type">undefined</span>
|
4558 |
|
4559 |
|
4560 |
|
4561 | </dd>
|
4562 | </dl>
|
4563 |
|
4564 |
|
4565 |
|
4566 |
|
4567 |
|
4568 | </dd>
|
4569 |
|
4570 |
|
4571 |
|
4572 | <hr>
|
4573 | <dt>
|
4574 | <h4 class="name" id="CB_forceString"><span class="type-signature"></span>CB_forceString<span class="signature">(element)</span><span class="type-signature"> → {string}</span></h4>
|
4575 |
|
4576 |
|
4577 | </dt>
|
4578 | <dd>
|
4579 |
|
4580 |
|
4581 | <div class="description">
|
4582 | <p>Returns back the given element if it is a string or an empty string otherwise.</p>
|
4583 | </div>
|
4584 |
|
4585 |
|
4586 |
|
4587 |
|
4588 |
|
4589 |
|
4590 |
|
4591 |
|
4592 | <h5>Parameters:</h5>
|
4593 |
|
4594 |
|
4595 | <table class="params table table-striped">
|
4596 | <thead>
|
4597 | <tr>
|
4598 |
|
4599 | <th style="width:12%; min-width:110px;">Name</th>
|
4600 |
|
4601 |
|
4602 | <th style="width:12%; min-width:110px;">Type</th>
|
4603 |
|
4604 |
|
4605 |
|
4606 |
|
4607 |
|
4608 | <th class="last" style="min-width:310px;">Description</th>
|
4609 | </tr>
|
4610 | </thead>
|
4611 |
|
4612 | <tbody>
|
4613 |
|
4614 |
|
4615 | <tr>
|
4616 |
|
4617 | <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>
|
4618 |
|
4619 |
|
4620 | <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;">
|
4621 |
|
4622 |
|
4623 | <span class="param-type">*</span>
|
4624 |
|
4625 |
|
4626 |
|
4627 |
|
4628 | </td>
|
4629 |
|
4630 |
|
4631 |
|
4632 |
|
4633 |
|
4634 | <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 element that will be checked.</p></td>
|
4635 | </tr>
|
4636 |
|
4637 |
|
4638 | </tbody>
|
4639 | </table>
|
4640 |
|
4641 |
|
4642 |
|
4643 |
|
4644 | <dl class="details">
|
4645 |
|
4646 |
|
4647 |
|
4648 |
|
4649 |
|
4650 |
|
4651 |
|
4652 |
|
4653 |
|
4654 |
|
4655 |
|
4656 |
|
4657 |
|
4658 |
|
4659 |
|
4660 |
|
4661 |
|
4662 |
|
4663 |
|
4664 |
|
4665 |
|
4666 |
|
4667 |
|
4668 |
|
4669 |
|
4670 |
|
4671 |
|
4672 |
|
4673 |
|
4674 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4675 | <dd class="tag-source">
|
4676 | <ul class="dummy">
|
4677 | <li>
|
4678 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
4679 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-238">line 238</a>
|
4680 | </li>
|
4681 | </ul>
|
4682 | </dd>
|
4683 |
|
4684 |
|
4685 |
|
4686 |
|
4687 |
|
4688 |
|
4689 |
|
4690 | </dl>
|
4691 |
|
4692 |
|
4693 |
|
4694 |
|
4695 |
|
4696 |
|
4697 |
|
4698 |
|
4699 |
|
4700 |
|
4701 |
|
4702 |
|
4703 |
|
4704 | <h5>Returns:</h5>
|
4705 |
|
4706 |
|
4707 |
|
4708 |
|
4709 | <dl>
|
4710 | <dt>
|
4711 | Type
|
4712 | </dt>
|
4713 | <dd>
|
4714 |
|
4715 | <span class="param-type">string</span>
|
4716 |
|
4717 |
|
4718 |
|
4719 | </dd>
|
4720 | </dl>
|
4721 |
|
4722 |
|
4723 |
|
4724 |
|
4725 |
|
4726 | </dd>
|
4727 |
|
4728 |
|
4729 |
|
4730 | <hr>
|
4731 | <dt>
|
4732 | <h4 class="name" id="CB_getBase64StringObject"><span class="type-signature"></span>CB_getBase64StringObject<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4>
|
4733 |
|
4734 |
|
4735 | </dt>
|
4736 | <dd>
|
4737 |
|
4738 |
|
4739 | <div class="description">
|
4740 | <p>Returns the "Base64String" object (used by the base64-string library included in <a href="http://pieroxy.net/blog/pages/lz-string/index.html">lz-string</a>), if any. Useful for compressing/decompressing base64 code.</p>
|
4741 | </div>
|
4742 |
|
4743 |
|
4744 |
|
4745 |
|
4746 |
|
4747 |
|
4748 |
|
4749 |
|
4750 |
|
4751 |
|
4752 | <dl class="details">
|
4753 |
|
4754 |
|
4755 |
|
4756 |
|
4757 |
|
4758 |
|
4759 |
|
4760 |
|
4761 |
|
4762 |
|
4763 |
|
4764 |
|
4765 |
|
4766 |
|
4767 |
|
4768 |
|
4769 |
|
4770 |
|
4771 |
|
4772 |
|
4773 |
|
4774 |
|
4775 |
|
4776 |
|
4777 |
|
4778 |
|
4779 |
|
4780 |
|
4781 |
|
4782 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4783 | <dd class="tag-source">
|
4784 | <ul class="dummy">
|
4785 | <li>
|
4786 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
4787 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-1495">line 1495</a>
|
4788 | </li>
|
4789 | </ul>
|
4790 | </dd>
|
4791 |
|
4792 |
|
4793 |
|
4794 |
|
4795 |
|
4796 |
|
4797 |
|
4798 | </dl>
|
4799 |
|
4800 |
|
4801 |
|
4802 |
|
4803 |
|
4804 |
|
4805 |
|
4806 |
|
4807 |
|
4808 |
|
4809 |
|
4810 |
|
4811 |
|
4812 | <h5>Returns:</h5>
|
4813 |
|
4814 |
|
4815 | <div class="param-desc">
|
4816 | <p>Returns the "Base64String" object (used by the base64-string library included in <a href="http://pieroxy.net/blog/pages/lz-string/index.html">lz-string</a>) if available or null otherwise.</p>
|
4817 | </div>
|
4818 |
|
4819 |
|
4820 |
|
4821 | <dl>
|
4822 | <dt>
|
4823 | Type
|
4824 | </dt>
|
4825 | <dd>
|
4826 |
|
4827 | <span class="param-type">Object</span>
|
4828 |
|
4829 |
|
4830 |
|
4831 | </dd>
|
4832 | </dl>
|
4833 |
|
4834 |
|
4835 |
|
4836 |
|
4837 |
|
4838 | </dd>
|
4839 |
|
4840 |
|
4841 |
|
4842 | <hr>
|
4843 | <dt>
|
4844 | <h4 class="name" id="CB_getCookie"><span class="type-signature"></span>CB_getCookie<span class="signature">(index)</span><span class="type-signature"> → {string|null}</span></h4>
|
4845 |
|
4846 |
|
4847 | </dt>
|
4848 | <dd>
|
4849 |
|
4850 |
|
4851 | <div class="description">
|
4852 | <p>Returns, from its index, a previous stored cookie.</p>
|
4853 | </div>
|
4854 |
|
4855 |
|
4856 |
|
4857 |
|
4858 |
|
4859 |
|
4860 |
|
4861 |
|
4862 | <h5>Parameters:</h5>
|
4863 |
|
4864 |
|
4865 | <table class="params table table-striped">
|
4866 | <thead>
|
4867 | <tr>
|
4868 |
|
4869 | <th style="width:12%; min-width:110px;">Name</th>
|
4870 |
|
4871 |
|
4872 | <th style="width:12%; min-width:110px;">Type</th>
|
4873 |
|
4874 |
|
4875 |
|
4876 |
|
4877 |
|
4878 | <th class="last" style="min-width:310px;">Description</th>
|
4879 | </tr>
|
4880 | </thead>
|
4881 |
|
4882 | <tbody>
|
4883 |
|
4884 |
|
4885 | <tr>
|
4886 |
|
4887 | <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>index</code></td>
|
4888 |
|
4889 |
|
4890 | <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;">
|
4891 |
|
4892 |
|
4893 | <span class="param-type">string</span>
|
4894 |
|
4895 |
|
4896 |
|
4897 |
|
4898 | </td>
|
4899 |
|
4900 |
|
4901 |
|
4902 |
|
4903 |
|
4904 | <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 index whose value we want to retrieve.</p></td>
|
4905 | </tr>
|
4906 |
|
4907 |
|
4908 | </tbody>
|
4909 | </table>
|
4910 |
|
4911 |
|
4912 |
|
4913 |
|
4914 | <dl class="details">
|
4915 |
|
4916 |
|
4917 |
|
4918 |
|
4919 |
|
4920 |
|
4921 |
|
4922 |
|
4923 |
|
4924 |
|
4925 |
|
4926 |
|
4927 |
|
4928 |
|
4929 |
|
4930 |
|
4931 |
|
4932 |
|
4933 |
|
4934 |
|
4935 |
|
4936 |
|
4937 |
|
4938 |
|
4939 |
|
4940 |
|
4941 |
|
4942 |
|
4943 |
|
4944 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
4945 | <dd class="tag-source">
|
4946 | <ul class="dummy">
|
4947 | <li>
|
4948 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
4949 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-809">line 809</a>
|
4950 | </li>
|
4951 | </ul>
|
4952 | </dd>
|
4953 |
|
4954 |
|
4955 |
|
4956 |
|
4957 |
|
4958 |
|
4959 |
|
4960 | </dl>
|
4961 |
|
4962 |
|
4963 |
|
4964 |
|
4965 |
|
4966 |
|
4967 |
|
4968 |
|
4969 |
|
4970 |
|
4971 |
|
4972 |
|
4973 |
|
4974 | <h5>Returns:</h5>
|
4975 |
|
4976 |
|
4977 | <div class="param-desc">
|
4978 | <p>Returns null when the value cannot be found.</p>
|
4979 | </div>
|
4980 |
|
4981 |
|
4982 |
|
4983 | <dl>
|
4984 | <dt>
|
4985 | Type
|
4986 | </dt>
|
4987 | <dd>
|
4988 |
|
4989 | <span class="param-type">string</span>
|
4990 | |
|
4991 |
|
4992 | <span class="param-type">null</span>
|
4993 |
|
4994 |
|
4995 |
|
4996 | </dd>
|
4997 | </dl>
|
4998 |
|
4999 |
|
5000 |
|
5001 |
|
5002 |
|
5003 | </dd>
|
5004 |
|
5005 |
|
5006 |
|
5007 | <hr>
|
5008 | <dt>
|
5009 | <h4 class="name" id="CB_getDatum"><span class="type-signature"></span>CB_getDatum<span class="signature">(index [, forceCookie] [, unescapeIndex])</span><span class="type-signature"> → {string|null}</span></h4>
|
5010 |
|
5011 |
|
5012 | </dt>
|
5013 | <dd>
|
5014 |
|
5015 |
|
5016 | <div class="description">
|
5017 | <p>Gets, from its index, a previous value stored. It will try to get it using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API">Web Storage API</a> (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage">localStorage</a>). It can use <a href="https://github.com/mortzdk/localStorage">localStorage</a> as a fallback or cookies instead.</p>
|
5018 | </div>
|
5019 |
|
5020 |
|
5021 |
|
5022 |
|
5023 |
|
5024 |
|
5025 |
|
5026 |
|
5027 | <h5>Parameters:</h5>
|
5028 |
|
5029 |
|
5030 | <table class="params table table-striped">
|
5031 | <thead>
|
5032 | <tr>
|
5033 |
|
5034 | <th style="width:12%; min-width:110px;">Name</th>
|
5035 |
|
5036 |
|
5037 | <th style="width:12%; min-width:110px;">Type</th>
|
5038 |
|
5039 |
|
5040 | <th style="width:12%; min-width:110px;">Argument</th>
|
5041 |
|
5042 |
|
5043 |
|
5044 | <th style="width:12%; min-width:110px;">Default</th>
|
5045 |
|
5046 |
|
5047 | <th class="last" style="min-width:310px;">Description</th>
|
5048 | </tr>
|
5049 | </thead>
|
5050 |
|
5051 | <tbody>
|
5052 |
|
5053 |
|
5054 | <tr>
|
5055 |
|
5056 | <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>index</code></td>
|
5057 |
|
5058 |
|
5059 | <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;">
|
5060 |
|
5061 |
|
5062 | <span class="param-type">string</span>
|
5063 |
|
5064 |
|
5065 |
|
5066 |
|
5067 | </td>
|
5068 |
|
5069 |
|
5070 | <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;">
|
5071 |
|
5072 |
|
5073 |
|
5074 |
|
5075 |
|
5076 | </td>
|
5077 |
|
5078 |
|
5079 |
|
5080 | <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;">
|
5081 |
|
5082 | </td>
|
5083 |
|
5084 |
|
5085 | <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 index whose value we want to retrieve.</p></td>
|
5086 | </tr>
|
5087 |
|
5088 |
|
5089 |
|
5090 | <tr>
|
5091 |
|
5092 | <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>forceCookie</code></td>
|
5093 |
|
5094 |
|
5095 | <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;">
|
5096 |
|
5097 |
|
5098 | <span class="param-type">boolean</span>
|
5099 |
|
5100 |
|
5101 |
|
5102 |
|
5103 | </td>
|
5104 |
|
5105 |
|
5106 | <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;">
|
5107 |
|
5108 | <optional><br>
|
5109 |
|
5110 |
|
5111 |
|
5112 |
|
5113 |
|
5114 | </td>
|
5115 |
|
5116 |
|
5117 |
|
5118 | <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;">
|
5119 |
|
5120 | false
|
5121 |
|
5122 | </td>
|
5123 |
|
5124 |
|
5125 | <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>Forces to use cookies instead of <a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API">Web Storage API</a> (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage">localStorage</a>).</p></td>
|
5126 | </tr>
|
5127 |
|
5128 |
|
5129 |
|
5130 | <tr>
|
5131 |
|
5132 | <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>unescapeIndex</code></td>
|
5133 |
|
5134 |
|
5135 | <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;">
|
5136 |
|
5137 |
|
5138 | <span class="param-type">boolean</span>
|
5139 |
|
5140 |
|
5141 |
|
5142 |
|
5143 | </td>
|
5144 |
|
5145 |
|
5146 | <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;">
|
5147 |
|
5148 | <optional><br>
|
5149 |
|
5150 |
|
5151 |
|
5152 |
|
5153 |
|
5154 | </td>
|
5155 |
|
5156 |
|
5157 |
|
5158 | <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;">
|
5159 |
|
5160 | false
|
5161 |
|
5162 | </td>
|
5163 |
|
5164 |
|
5165 | <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>Applies the unescape function to the value before returning it. Only applies when cookies are used.</p></td>
|
5166 | </tr>
|
5167 |
|
5168 |
|
5169 | </tbody>
|
5170 | </table>
|
5171 |
|
5172 |
|
5173 |
|
5174 |
|
5175 | <dl class="details">
|
5176 |
|
5177 |
|
5178 |
|
5179 |
|
5180 |
|
5181 |
|
5182 |
|
5183 |
|
5184 |
|
5185 |
|
5186 |
|
5187 |
|
5188 |
|
5189 |
|
5190 |
|
5191 |
|
5192 |
|
5193 |
|
5194 |
|
5195 |
|
5196 |
|
5197 |
|
5198 |
|
5199 |
|
5200 |
|
5201 |
|
5202 |
|
5203 |
|
5204 |
|
5205 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5206 | <dd class="tag-source">
|
5207 | <ul class="dummy">
|
5208 | <li>
|
5209 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
5210 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-778">line 778</a>
|
5211 | </li>
|
5212 | </ul>
|
5213 | </dd>
|
5214 |
|
5215 |
|
5216 |
|
5217 |
|
5218 |
|
5219 |
|
5220 |
|
5221 | </dl>
|
5222 |
|
5223 |
|
5224 |
|
5225 |
|
5226 |
|
5227 |
|
5228 |
|
5229 |
|
5230 |
|
5231 |
|
5232 |
|
5233 |
|
5234 |
|
5235 | <h5>Returns:</h5>
|
5236 |
|
5237 |
|
5238 | <div class="param-desc">
|
5239 | <p>Returns null when the value cannot be found.</p>
|
5240 | </div>
|
5241 |
|
5242 |
|
5243 |
|
5244 | <dl>
|
5245 | <dt>
|
5246 | Type
|
5247 | </dt>
|
5248 | <dd>
|
5249 |
|
5250 | <span class="param-type">string</span>
|
5251 | |
|
5252 |
|
5253 | <span class="param-type">null</span>
|
5254 |
|
5255 |
|
5256 |
|
5257 | </dd>
|
5258 | </dl>
|
5259 |
|
5260 |
|
5261 |
|
5262 |
|
5263 |
|
5264 | </dd>
|
5265 |
|
5266 |
|
5267 |
|
5268 | <hr>
|
5269 | <dt>
|
5270 | <h4 class="name" id="CB_getJSONPropertyValue"><span class="type-signature"></span>CB_getJSONPropertyValue<span class="signature">(JSONObject, property [, returnValueOnFail])</span><span class="type-signature"> → {*}</span></h4>
|
5271 |
|
5272 |
|
5273 | </dt>
|
5274 | <dd>
|
5275 |
|
5276 |
|
5277 | <div class="description">
|
5278 | <p>Gets the value of a desired property of a given JSON object. Uses the <a href="global.html#CB_getValueIndex"><code>CB_getValueIndex</code></a> function internally.</p>
|
5279 | </div>
|
5280 |
|
5281 |
|
5282 |
|
5283 |
|
5284 |
|
5285 |
|
5286 |
|
5287 |
|
5288 | <h5>Parameters:</h5>
|
5289 |
|
5290 |
|
5291 | <table class="params table table-striped">
|
5292 | <thead>
|
5293 | <tr>
|
5294 |
|
5295 | <th style="width:12%; min-width:110px;">Name</th>
|
5296 |
|
5297 |
|
5298 | <th style="width:12%; min-width:110px;">Type</th>
|
5299 |
|
5300 |
|
5301 | <th style="width:12%; min-width:110px;">Argument</th>
|
5302 |
|
5303 |
|
5304 |
|
5305 |
|
5306 | <th class="last" style="min-width:310px;">Description</th>
|
5307 | </tr>
|
5308 | </thead>
|
5309 |
|
5310 | <tbody>
|
5311 |
|
5312 |
|
5313 | <tr>
|
5314 |
|
5315 | <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>JSONObject</code></td>
|
5316 |
|
5317 |
|
5318 | <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;">
|
5319 |
|
5320 |
|
5321 | <span class="param-type">Object</span>
|
5322 | |
|
5323 |
|
5324 | <span class="param-type">string</span>
|
5325 |
|
5326 |
|
5327 |
|
5328 |
|
5329 | </td>
|
5330 |
|
5331 |
|
5332 | <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;">
|
5333 |
|
5334 |
|
5335 |
|
5336 |
|
5337 |
|
5338 | </td>
|
5339 |
|
5340 |
|
5341 |
|
5342 |
|
5343 | <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 JSON object from which we want to get the value. If it is a string, it will try to parse it to create a real object from it. Used as the "object" parameter when calling the <a href="global.html#CB_getValueIndex"><code>CB_getValueIndex</code></a> function internally.</p></td>
|
5344 | </tr>
|
5345 |
|
5346 |
|
5347 |
|
5348 | <tr>
|
5349 |
|
5350 | <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>property</code></td>
|
5351 |
|
5352 |
|
5353 | <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;">
|
5354 |
|
5355 |
|
5356 | <span class="param-type">string</span>
|
5357 |
|
5358 |
|
5359 |
|
5360 |
|
5361 | </td>
|
5362 |
|
5363 |
|
5364 | <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;">
|
5365 |
|
5366 |
|
5367 |
|
5368 |
|
5369 |
|
5370 | </td>
|
5371 |
|
5372 |
|
5373 |
|
5374 |
|
5375 | <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 property whose value we want to retrieve. If not provided, the given object will be returned again. Used as the "index" parameter when calling the <a href="global.html#CB_getValueIndex"><code>CB_getValueIndex</code></a> function internally.</p></td>
|
5376 | </tr>
|
5377 |
|
5378 |
|
5379 |
|
5380 | <tr>
|
5381 |
|
5382 | <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>returnValueOnFail</code></td>
|
5383 |
|
5384 |
|
5385 | <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;">
|
5386 |
|
5387 |
|
5388 | <span class="param-type">*</span>
|
5389 |
|
5390 |
|
5391 |
|
5392 |
|
5393 | </td>
|
5394 |
|
5395 |
|
5396 | <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;">
|
5397 |
|
5398 | <optional><br>
|
5399 |
|
5400 |
|
5401 |
|
5402 |
|
5403 |
|
5404 | </td>
|
5405 |
|
5406 |
|
5407 |
|
5408 |
|
5409 | <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 value we want it to return in the case it cannot be parsed. If not provided, undefined will be returned. Used as the "returnValueOnFail" parameter when calling the <a href="global.html#CB_getValueIndex"><code>CB_getValueIndex</code></a> function internally.</p></td>
|
5410 | </tr>
|
5411 |
|
5412 |
|
5413 | </tbody>
|
5414 | </table>
|
5415 |
|
5416 |
|
5417 |
|
5418 |
|
5419 | <dl class="details">
|
5420 |
|
5421 |
|
5422 |
|
5423 |
|
5424 |
|
5425 |
|
5426 |
|
5427 |
|
5428 |
|
5429 |
|
5430 |
|
5431 |
|
5432 |
|
5433 |
|
5434 |
|
5435 |
|
5436 |
|
5437 |
|
5438 |
|
5439 |
|
5440 |
|
5441 |
|
5442 |
|
5443 |
|
5444 |
|
5445 |
|
5446 |
|
5447 |
|
5448 |
|
5449 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5450 | <dd class="tag-source">
|
5451 | <ul class="dummy">
|
5452 | <li>
|
5453 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
5454 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-857">line 857</a>
|
5455 | </li>
|
5456 | </ul>
|
5457 | </dd>
|
5458 |
|
5459 |
|
5460 |
|
5461 |
|
5462 |
|
5463 |
|
5464 |
|
5465 | </dl>
|
5466 |
|
5467 |
|
5468 |
|
5469 |
|
5470 |
|
5471 |
|
5472 |
|
5473 |
|
5474 |
|
5475 |
|
5476 |
|
5477 |
|
5478 |
|
5479 | <h5>Returns:</h5>
|
5480 |
|
5481 |
|
5482 | <div class="param-desc">
|
5483 | <p>Returns the given "JSONObject" again (after trying to parse it if it was a string, if possible) if the "property" value was not given. Returns the value from the given object which belongs to the desired property or the value of "returnValueOnFail" otherwise if it cannot be found.</p>
|
5484 | </div>
|
5485 |
|
5486 |
|
5487 |
|
5488 | <dl>
|
5489 | <dt>
|
5490 | Type
|
5491 | </dt>
|
5492 | <dd>
|
5493 |
|
5494 | <span class="param-type">*</span>
|
5495 |
|
5496 |
|
5497 |
|
5498 | </dd>
|
5499 | </dl>
|
5500 |
|
5501 |
|
5502 |
|
5503 |
|
5504 |
|
5505 | </dd>
|
5506 |
|
5507 |
|
5508 |
|
5509 | <hr>
|
5510 | <dt>
|
5511 | <h4 class="name" id="CB_getLZStringObject"><span class="type-signature"></span>CB_getLZStringObject<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4>
|
5512 |
|
5513 |
|
5514 | </dt>
|
5515 | <dd>
|
5516 |
|
5517 |
|
5518 | <div class="description">
|
5519 | <p>Returns the "LZString" object (used by the <a href="http://pieroxy.net/blog/pages/lz-string/index.html">lz-string</a> library), if any. Useful for compressing/decompressing strings.</p>
|
5520 | </div>
|
5521 |
|
5522 |
|
5523 |
|
5524 |
|
5525 |
|
5526 |
|
5527 |
|
5528 |
|
5529 |
|
5530 |
|
5531 | <dl class="details">
|
5532 |
|
5533 |
|
5534 |
|
5535 |
|
5536 |
|
5537 |
|
5538 |
|
5539 |
|
5540 |
|
5541 |
|
5542 |
|
5543 |
|
5544 |
|
5545 |
|
5546 |
|
5547 |
|
5548 |
|
5549 |
|
5550 |
|
5551 |
|
5552 |
|
5553 |
|
5554 |
|
5555 |
|
5556 |
|
5557 |
|
5558 |
|
5559 |
|
5560 |
|
5561 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5562 | <dd class="tag-source">
|
5563 | <ul class="dummy">
|
5564 | <li>
|
5565 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
5566 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-1484">line 1484</a>
|
5567 | </li>
|
5568 | </ul>
|
5569 | </dd>
|
5570 |
|
5571 |
|
5572 |
|
5573 |
|
5574 |
|
5575 |
|
5576 |
|
5577 | </dl>
|
5578 |
|
5579 |
|
5580 |
|
5581 |
|
5582 |
|
5583 |
|
5584 |
|
5585 |
|
5586 |
|
5587 |
|
5588 |
|
5589 |
|
5590 |
|
5591 | <h5>Returns:</h5>
|
5592 |
|
5593 |
|
5594 | <div class="param-desc">
|
5595 | <p>Returns the "LZString" object (used by the <a href="http://pieroxy.net/blog/pages/lz-string/index.html">lz-string</a> library) if available or null otherwise.</p>
|
5596 | </div>
|
5597 |
|
5598 |
|
5599 |
|
5600 | <dl>
|
5601 | <dt>
|
5602 | Type
|
5603 | </dt>
|
5604 | <dd>
|
5605 |
|
5606 | <span class="param-type">Object</span>
|
5607 |
|
5608 |
|
5609 |
|
5610 | </dd>
|
5611 | </dl>
|
5612 |
|
5613 |
|
5614 |
|
5615 |
|
5616 |
|
5617 | </dd>
|
5618 |
|
5619 |
|
5620 |
|
5621 | <hr>
|
5622 | <dt>
|
5623 | <h4 class="name" id="CB_getValueIndex"><span class="type-signature"></span>CB_getValueIndex<span class="signature">(object, index [, returnValueOnFail])</span><span class="type-signature"> → {*}</span></h4>
|
5624 |
|
5625 |
|
5626 | </dt>
|
5627 | <dd>
|
5628 |
|
5629 |
|
5630 | <div class="description">
|
5631 | <p>Gets the value from a given object which belongs to the desired index or returns the value of "returnValueOnFail" if it cannot be found.</p>
|
5632 | </div>
|
5633 |
|
5634 |
|
5635 |
|
5636 |
|
5637 |
|
5638 |
|
5639 |
|
5640 |
|
5641 | <h5>Parameters:</h5>
|
5642 |
|
5643 |
|
5644 | <table class="params table table-striped">
|
5645 | <thead>
|
5646 | <tr>
|
5647 |
|
5648 | <th style="width:12%; min-width:110px;">Name</th>
|
5649 |
|
5650 |
|
5651 | <th style="width:12%; min-width:110px;">Type</th>
|
5652 |
|
5653 |
|
5654 | <th style="width:12%; min-width:110px;">Argument</th>
|
5655 |
|
5656 |
|
5657 |
|
5658 |
|
5659 | <th class="last" style="min-width:310px;">Description</th>
|
5660 | </tr>
|
5661 | </thead>
|
5662 |
|
5663 | <tbody>
|
5664 |
|
5665 |
|
5666 | <tr>
|
5667 |
|
5668 | <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>object</code></td>
|
5669 |
|
5670 |
|
5671 | <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;">
|
5672 |
|
5673 |
|
5674 | <span class="param-type">Object</span>
|
5675 |
|
5676 |
|
5677 |
|
5678 |
|
5679 | </td>
|
5680 |
|
5681 |
|
5682 | <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;">
|
5683 |
|
5684 |
|
5685 |
|
5686 |
|
5687 |
|
5688 | </td>
|
5689 |
|
5690 |
|
5691 |
|
5692 |
|
5693 | <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 object from which we want to get the value.</p></td>
|
5694 | </tr>
|
5695 |
|
5696 |
|
5697 |
|
5698 | <tr>
|
5699 |
|
5700 | <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>index</code></td>
|
5701 |
|
5702 |
|
5703 | <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;">
|
5704 |
|
5705 |
|
5706 | <span class="param-type">string</span>
|
5707 |
|
5708 |
|
5709 |
|
5710 |
|
5711 | </td>
|
5712 |
|
5713 |
|
5714 | <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;">
|
5715 |
|
5716 |
|
5717 |
|
5718 |
|
5719 |
|
5720 | </td>
|
5721 |
|
5722 |
|
5723 |
|
5724 |
|
5725 | <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 index whose value we want to retrieve.</p></td>
|
5726 | </tr>
|
5727 |
|
5728 |
|
5729 |
|
5730 | <tr>
|
5731 |
|
5732 | <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>returnValueOnFail</code></td>
|
5733 |
|
5734 |
|
5735 | <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;">
|
5736 |
|
5737 |
|
5738 | <span class="param-type">*</span>
|
5739 |
|
5740 |
|
5741 |
|
5742 |
|
5743 | </td>
|
5744 |
|
5745 |
|
5746 | <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;">
|
5747 |
|
5748 | <optional><br>
|
5749 |
|
5750 |
|
5751 |
|
5752 |
|
5753 |
|
5754 | </td>
|
5755 |
|
5756 |
|
5757 |
|
5758 |
|
5759 | <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 value we want it to return in the case that the property cannot be found. If not provided, undefined will be returned.</p></td>
|
5760 | </tr>
|
5761 |
|
5762 |
|
5763 | </tbody>
|
5764 | </table>
|
5765 |
|
5766 |
|
5767 |
|
5768 |
|
5769 | <dl class="details">
|
5770 |
|
5771 |
|
5772 |
|
5773 |
|
5774 |
|
5775 |
|
5776 |
|
5777 |
|
5778 |
|
5779 |
|
5780 |
|
5781 |
|
5782 |
|
5783 |
|
5784 |
|
5785 |
|
5786 |
|
5787 |
|
5788 |
|
5789 |
|
5790 |
|
5791 |
|
5792 |
|
5793 |
|
5794 |
|
5795 |
|
5796 |
|
5797 |
|
5798 |
|
5799 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
5800 | <dd class="tag-source">
|
5801 | <ul class="dummy">
|
5802 | <li>
|
5803 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
5804 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-823">line 823</a>
|
5805 | </li>
|
5806 | </ul>
|
5807 | </dd>
|
5808 |
|
5809 |
|
5810 |
|
5811 |
|
5812 |
|
5813 |
|
5814 |
|
5815 | </dl>
|
5816 |
|
5817 |
|
5818 |
|
5819 |
|
5820 |
|
5821 |
|
5822 |
|
5823 |
|
5824 |
|
5825 |
|
5826 |
|
5827 |
|
5828 |
|
5829 | <h5>Returns:</h5>
|
5830 |
|
5831 |
|
5832 | <div class="param-desc">
|
5833 | <p>Returns the value from a given object which belongs to the desired index or the value of "returnValueOnFail" otherwise if it cannot be found.</p>
|
5834 | </div>
|
5835 |
|
5836 |
|
5837 |
|
5838 | <dl>
|
5839 | <dt>
|
5840 | Type
|
5841 | </dt>
|
5842 | <dd>
|
5843 |
|
5844 | <span class="param-type">*</span>
|
5845 |
|
5846 |
|
5847 |
|
5848 | </dd>
|
5849 | </dl>
|
5850 |
|
5851 |
|
5852 |
|
5853 |
|
5854 |
|
5855 | </dd>
|
5856 |
|
5857 |
|
5858 |
|
5859 | <hr>
|
5860 | <dt>
|
5861 | <h4 class="name" id="CB_getValuePath"><span class="type-signature"></span>CB_getValuePath<span class="signature">(object, path [, splitString])</span><span class="type-signature"> → {*}</span></h4>
|
5862 |
|
5863 |
|
5864 | </dt>
|
5865 | <dd>
|
5866 |
|
5867 |
|
5868 | <div class="description">
|
5869 | <p>Returns the value of a desired path in an object or an empty string if it cannot be found.</p>
|
5870 | </div>
|
5871 |
|
5872 |
|
5873 |
|
5874 |
|
5875 |
|
5876 |
|
5877 |
|
5878 |
|
5879 | <h5>Parameters:</h5>
|
5880 |
|
5881 |
|
5882 | <table class="params table table-striped">
|
5883 | <thead>
|
5884 | <tr>
|
5885 |
|
5886 | <th style="width:12%; min-width:110px;">Name</th>
|
5887 |
|
5888 |
|
5889 | <th style="width:12%; min-width:110px;">Type</th>
|
5890 |
|
5891 |
|
5892 | <th style="width:12%; min-width:110px;">Argument</th>
|
5893 |
|
5894 |
|
5895 |
|
5896 | <th style="width:12%; min-width:110px;">Default</th>
|
5897 |
|
5898 |
|
5899 | <th class="last" style="min-width:310px;">Description</th>
|
5900 | </tr>
|
5901 | </thead>
|
5902 |
|
5903 | <tbody>
|
5904 |
|
5905 |
|
5906 | <tr>
|
5907 |
|
5908 | <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>object</code></td>
|
5909 |
|
5910 |
|
5911 | <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;">
|
5912 |
|
5913 |
|
5914 | <span class="param-type">Object</span>
|
5915 |
|
5916 |
|
5917 |
|
5918 |
|
5919 | </td>
|
5920 |
|
5921 |
|
5922 | <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;">
|
5923 |
|
5924 |
|
5925 |
|
5926 |
|
5927 |
|
5928 | </td>
|
5929 |
|
5930 |
|
5931 |
|
5932 | <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;">
|
5933 |
|
5934 | </td>
|
5935 |
|
5936 |
|
5937 | <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 object where we want to find the path.</p></td>
|
5938 | </tr>
|
5939 |
|
5940 |
|
5941 |
|
5942 | <tr>
|
5943 |
|
5944 | <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>path</code></td>
|
5945 |
|
5946 |
|
5947 | <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;">
|
5948 |
|
5949 |
|
5950 | <span class="param-type">string</span>
|
5951 |
|
5952 |
|
5953 |
|
5954 |
|
5955 | </td>
|
5956 |
|
5957 |
|
5958 | <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;">
|
5959 |
|
5960 |
|
5961 |
|
5962 |
|
5963 |
|
5964 | </td>
|
5965 |
|
5966 |
|
5967 |
|
5968 | <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;">
|
5969 |
|
5970 | </td>
|
5971 |
|
5972 |
|
5973 | <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 path that will be search in the given object to retrieve the value. It should use the string defined in the "splitString" parameter to separate items. If it is empty or not provided, it will just return the given "object" again.</p></td>
|
5974 | </tr>
|
5975 |
|
5976 |
|
5977 |
|
5978 | <tr>
|
5979 |
|
5980 | <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>splitString</code></td>
|
5981 |
|
5982 |
|
5983 | <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;">
|
5984 |
|
5985 |
|
5986 | <span class="param-type">string</span>
|
5987 |
|
5988 |
|
5989 |
|
5990 |
|
5991 | </td>
|
5992 |
|
5993 |
|
5994 | <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;">
|
5995 |
|
5996 | <optional><br>
|
5997 |
|
5998 |
|
5999 |
|
6000 |
|
6001 |
|
6002 | </td>
|
6003 |
|
6004 |
|
6005 |
|
6006 | <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;">
|
6007 |
|
6008 | "."
|
6009 |
|
6010 | </td>
|
6011 |
|
6012 |
|
6013 | <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 string that will be used to separate one item from another one. By default, it will be a dot (".") so, for example, a given "path" with a value of "hello.world" will indicate the "object.hello.world" path.</p></td>
|
6014 | </tr>
|
6015 |
|
6016 |
|
6017 | </tbody>
|
6018 | </table>
|
6019 |
|
6020 |
|
6021 |
|
6022 |
|
6023 | <dl class="details">
|
6024 |
|
6025 |
|
6026 |
|
6027 |
|
6028 |
|
6029 |
|
6030 |
|
6031 |
|
6032 |
|
6033 |
|
6034 |
|
6035 |
|
6036 |
|
6037 |
|
6038 |
|
6039 |
|
6040 |
|
6041 |
|
6042 |
|
6043 |
|
6044 |
|
6045 |
|
6046 |
|
6047 |
|
6048 |
|
6049 |
|
6050 |
|
6051 |
|
6052 |
|
6053 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
6054 | <dd class="tag-source">
|
6055 | <ul class="dummy">
|
6056 | <li>
|
6057 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
6058 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-684">line 684</a>
|
6059 | </li>
|
6060 | </ul>
|
6061 | </dd>
|
6062 |
|
6063 |
|
6064 |
|
6065 |
|
6066 |
|
6067 |
|
6068 |
|
6069 | </dl>
|
6070 |
|
6071 |
|
6072 |
|
6073 |
|
6074 |
|
6075 |
|
6076 |
|
6077 |
|
6078 |
|
6079 |
|
6080 |
|
6081 |
|
6082 |
|
6083 | <h5>Returns:</h5>
|
6084 |
|
6085 |
|
6086 | <div class="param-desc">
|
6087 | <p>Returns the value of a desired path in an object or an empty string if it cannot be found. If the "path" parameter is empty or not provided, it will just return the given "object" again.</p>
|
6088 | </div>
|
6089 |
|
6090 |
|
6091 |
|
6092 | <dl>
|
6093 | <dt>
|
6094 | Type
|
6095 | </dt>
|
6096 | <dd>
|
6097 |
|
6098 | <span class="param-type">*</span>
|
6099 |
|
6100 |
|
6101 |
|
6102 | </dd>
|
6103 | </dl>
|
6104 |
|
6105 |
|
6106 |
|
6107 |
|
6108 |
|
6109 | </dd>
|
6110 |
|
6111 |
|
6112 |
|
6113 | <hr>
|
6114 | <dt>
|
6115 | <h4 class="name" id="CB_includeJSFile"><span class="type-signature"></span>CB_includeJSFile<span class="signature">(filepath [, callbackOk] [, callbackError] [, timeoutMs] [, asynchronously] [, fileId] [, fileRequires] [, notMandatory])</span><span class="type-signature"> → {Object|null|false}</span></h4>
|
6116 |
|
6117 |
|
6118 | </dt>
|
6119 | <dd>
|
6120 |
|
6121 |
|
6122 | <div class="description">
|
6123 | <p>Includes a JavaScript file to the current document.</p>
|
6124 | </div>
|
6125 |
|
6126 |
|
6127 |
|
6128 |
|
6129 |
|
6130 |
|
6131 |
|
6132 |
|
6133 | <h5>Parameters:</h5>
|
6134 |
|
6135 |
|
6136 | <table class="params table table-striped">
|
6137 | <thead>
|
6138 | <tr>
|
6139 |
|
6140 | <th style="width:12%; min-width:110px;">Name</th>
|
6141 |
|
6142 |
|
6143 | <th style="width:12%; min-width:110px;">Type</th>
|
6144 |
|
6145 |
|
6146 | <th style="width:12%; min-width:110px;">Argument</th>
|
6147 |
|
6148 |
|
6149 |
|
6150 | <th style="width:12%; min-width:110px;">Default</th>
|
6151 |
|
6152 |
|
6153 | <th class="last" style="min-width:310px;">Description</th>
|
6154 | </tr>
|
6155 | </thead>
|
6156 |
|
6157 | <tbody>
|
6158 |
|
6159 |
|
6160 | <tr>
|
6161 |
|
6162 | <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>filepath</code></td>
|
6163 |
|
6164 |
|
6165 | <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;">
|
6166 |
|
6167 |
|
6168 | <span class="param-type">string</span>
|
6169 |
|
6170 |
|
6171 |
|
6172 |
|
6173 | </td>
|
6174 |
|
6175 |
|
6176 | <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;">
|
6177 |
|
6178 |
|
6179 |
|
6180 |
|
6181 |
|
6182 | </td>
|
6183 |
|
6184 |
|
6185 |
|
6186 | <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;">
|
6187 |
|
6188 | </td>
|
6189 |
|
6190 |
|
6191 | <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>Path to the JS file.</p></td>
|
6192 | </tr>
|
6193 |
|
6194 |
|
6195 |
|
6196 | <tr>
|
6197 |
|
6198 | <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>
|
6199 |
|
6200 |
|
6201 | <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;">
|
6202 |
|
6203 |
|
6204 | <span class="param-type"><a href="global.html#CB_includeJSFile_CALLBACK">CB_includeJSFile_CALLBACK</a></span>
|
6205 |
|
6206 |
|
6207 |
|
6208 |
|
6209 | </td>
|
6210 |
|
6211 |
|
6212 | <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;">
|
6213 |
|
6214 | <optional><br>
|
6215 |
|
6216 |
|
6217 |
|
6218 |
|
6219 |
|
6220 | </td>
|
6221 |
|
6222 |
|
6223 |
|
6224 | <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;">
|
6225 |
|
6226 | </td>
|
6227 |
|
6228 |
|
6229 | <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 for when the file is included successfully.</p></td>
|
6230 | </tr>
|
6231 |
|
6232 |
|
6233 |
|
6234 | <tr>
|
6235 |
|
6236 | <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>
|
6237 |
|
6238 |
|
6239 | <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;">
|
6240 |
|
6241 |
|
6242 | <span class="param-type"><a href="global.html#CB_includeJSFile_CALLBACK">CB_includeJSFile_CALLBACK</a></span>
|
6243 |
|
6244 |
|
6245 |
|
6246 |
|
6247 | </td>
|
6248 |
|
6249 |
|
6250 | <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;">
|
6251 |
|
6252 | <optional><br>
|
6253 |
|
6254 |
|
6255 |
|
6256 |
|
6257 |
|
6258 | </td>
|
6259 |
|
6260 |
|
6261 |
|
6262 | <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;">
|
6263 |
|
6264 | </td>
|
6265 |
|
6266 |
|
6267 | <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 for when there is any error including the file or it cannot be included after the defined timeout.</p></td>
|
6268 | </tr>
|
6269 |
|
6270 |
|
6271 |
|
6272 | <tr>
|
6273 |
|
6274 | <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>timeoutMs</code></td>
|
6275 |
|
6276 |
|
6277 | <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;">
|
6278 |
|
6279 |
|
6280 | <span class="param-type">integer</span>
|
6281 |
|
6282 |
|
6283 |
|
6284 |
|
6285 | </td>
|
6286 |
|
6287 |
|
6288 | <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;">
|
6289 |
|
6290 | <optional><br>
|
6291 |
|
6292 |
|
6293 |
|
6294 |
|
6295 |
|
6296 | </td>
|
6297 |
|
6298 |
|
6299 |
|
6300 | <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;">
|
6301 |
|
6302 | <a href="CB_Configuration.CrossBrowdy.html#.CB_includeJSFile_TIMEOUT_MS_DEFAULT"><code>CB_Configuration.CrossBrowdy.CB_includeJSFile_TIMEOUT_MS_DEFAULT</code></a>
|
6303 |
|
6304 | </td>
|
6305 |
|
6306 |
|
6307 | <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>Timeout in milliseconds to consider that the inclusion of the file has failed.</p></td>
|
6308 | </tr>
|
6309 |
|
6310 |
|
6311 |
|
6312 | <tr>
|
6313 |
|
6314 | <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>asynchronously</code></td>
|
6315 |
|
6316 |
|
6317 | <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;">
|
6318 |
|
6319 |
|
6320 | <span class="param-type">boolean</span>
|
6321 |
|
6322 |
|
6323 |
|
6324 |
|
6325 | </td>
|
6326 |
|
6327 |
|
6328 | <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;">
|
6329 |
|
6330 | <optional><br>
|
6331 |
|
6332 |
|
6333 |
|
6334 |
|
6335 |
|
6336 | </td>
|
6337 |
|
6338 |
|
6339 |
|
6340 | <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;">
|
6341 |
|
6342 | true
|
6343 |
|
6344 | </td>
|
6345 |
|
6346 |
|
6347 | <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 to load the file asynchronously or not.</p></td>
|
6348 | </tr>
|
6349 |
|
6350 |
|
6351 |
|
6352 | <tr>
|
6353 |
|
6354 | <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>fileId</code></td>
|
6355 |
|
6356 |
|
6357 | <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;">
|
6358 |
|
6359 |
|
6360 | <span class="param-type">string</span>
|
6361 |
|
6362 |
|
6363 |
|
6364 |
|
6365 | </td>
|
6366 |
|
6367 |
|
6368 | <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;">
|
6369 |
|
6370 | <optional><br>
|
6371 |
|
6372 |
|
6373 |
|
6374 |
|
6375 |
|
6376 | </td>
|
6377 |
|
6378 |
|
6379 |
|
6380 | <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;">
|
6381 |
|
6382 | </td>
|
6383 |
|
6384 |
|
6385 | <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>Internal usage recommended only.</p></td>
|
6386 | </tr>
|
6387 |
|
6388 |
|
6389 |
|
6390 | <tr>
|
6391 |
|
6392 | <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>fileRequires</code></td>
|
6393 |
|
6394 |
|
6395 | <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;">
|
6396 |
|
6397 |
|
6398 | <span class="param-type">array</span>
|
6399 |
|
6400 |
|
6401 |
|
6402 |
|
6403 | </td>
|
6404 |
|
6405 |
|
6406 | <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;">
|
6407 |
|
6408 | <optional><br>
|
6409 |
|
6410 |
|
6411 |
|
6412 |
|
6413 |
|
6414 | </td>
|
6415 |
|
6416 |
|
6417 |
|
6418 | <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;">
|
6419 |
|
6420 | </td>
|
6421 |
|
6422 |
|
6423 | <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>Internal usage recommended only.</p></td>
|
6424 | </tr>
|
6425 |
|
6426 |
|
6427 |
|
6428 | <tr>
|
6429 |
|
6430 | <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>notMandatory</code></td>
|
6431 |
|
6432 |
|
6433 | <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;">
|
6434 |
|
6435 |
|
6436 | <span class="param-type">boolean</span>
|
6437 |
|
6438 |
|
6439 |
|
6440 |
|
6441 | </td>
|
6442 |
|
6443 |
|
6444 | <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;">
|
6445 |
|
6446 | <optional><br>
|
6447 |
|
6448 |
|
6449 |
|
6450 |
|
6451 |
|
6452 | </td>
|
6453 |
|
6454 |
|
6455 |
|
6456 | <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;">
|
6457 |
|
6458 | false
|
6459 |
|
6460 | </td>
|
6461 |
|
6462 |
|
6463 | <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>Internal usage recommended only.</p></td>
|
6464 | </tr>
|
6465 |
|
6466 |
|
6467 | </tbody>
|
6468 | </table>
|
6469 |
|
6470 |
|
6471 |
|
6472 |
|
6473 | <dl class="details">
|
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 |
|
6500 |
|
6501 |
|
6502 |
|
6503 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
6504 | <dd class="tag-source">
|
6505 | <ul class="dummy">
|
6506 | <li>
|
6507 | <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
|
6508 | <a href="CrossBrowdy.js.html#sunlight-1-line-383">line 383</a>
|
6509 | </li>
|
6510 | </ul>
|
6511 | </dd>
|
6512 |
|
6513 |
|
6514 |
|
6515 |
|
6516 |
|
6517 |
|
6518 |
|
6519 | </dl>
|
6520 |
|
6521 |
|
6522 |
|
6523 |
|
6524 |
|
6525 |
|
6526 |
|
6527 |
|
6528 |
|
6529 |
|
6530 |
|
6531 |
|
6532 |
|
6533 | <h5>Returns:</h5>
|
6534 |
|
6535 |
|
6536 | <div class="param-desc">
|
6537 | <p>Returns null when the script file cannot be loaded yet as some required file has still not been loaded. Returns false when neither the 'HEAD' tag nor the document body can be found. Otherwise, returns an object whose two properties are 'scriptElement' (with the <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script">SCRIPT</a> element just created) and 'timeoutFailure' (with the <a href="https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/setTimeout">setTimeout</a> ID created to check whether the file cannot be loaded after the given time).</p>
|
6538 | </div>
|
6539 |
|
6540 |
|
6541 |
|
6542 | <dl>
|
6543 | <dt>
|
6544 | Type
|
6545 | </dt>
|
6546 | <dd>
|
6547 |
|
6548 | <span class="param-type">Object</span>
|
6549 | |
|
6550 |
|
6551 | <span class="param-type">null</span>
|
6552 | |
|
6553 |
|
6554 | <span class="param-type">false</span>
|
6555 |
|
6556 |
|
6557 |
|
6558 | </dd>
|
6559 | </dl>
|
6560 |
|
6561 |
|
6562 |
|
6563 |
|
6564 |
|
6565 | </dd>
|
6566 |
|
6567 |
|
6568 |
|
6569 | <hr>
|
6570 | <dt>
|
6571 | <h4 class="name" id="CB_indexOf"><span class="type-signature"></span>CB_indexOf<span class="signature">(array, searchElement [, fromIndex] [, extendedDOM])</span><span class="type-signature"> → {integer}</span></h4>
|
6572 |
|
6573 |
|
6574 | </dt>
|
6575 | <dd>
|
6576 |
|
6577 |
|
6578 | <div class="description">
|
6579 | <p>Implementation of <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf">Array.indexOf</a> method for arrays in browsers that do not support it natively.<br>
|
6580 | <br><br>
|
6581 | Returns the first index of a given element that exists in an array (starting from a certain index if desired) or -1 if not found.</p>
|
6582 | </div>
|
6583 |
|
6584 |
|
6585 |
|
6586 |
|
6587 |
|
6588 |
|
6589 |
|
6590 |
|
6591 | <h5>Parameters:</h5>
|
6592 |
|
6593 |
|
6594 | <table class="params table table-striped">
|
6595 | <thead>
|
6596 | <tr>
|
6597 |
|
6598 | <th style="width:12%; min-width:110px;">Name</th>
|
6599 |
|
6600 |
|
6601 | <th style="width:12%; min-width:110px;">Type</th>
|
6602 |
|
6603 |
|
6604 | <th style="width:12%; min-width:110px;">Argument</th>
|
6605 |
|
6606 |
|
6607 |
|
6608 | <th style="width:12%; min-width:110px;">Default</th>
|
6609 |
|
6610 |
|
6611 | <th class="last" style="min-width:310px;">Description</th>
|
6612 | </tr>
|
6613 | </thead>
|
6614 |
|
6615 | <tbody>
|
6616 |
|
6617 |
|
6618 | <tr>
|
6619 |
|
6620 | <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>array</code></td>
|
6621 |
|
6622 |
|
6623 | <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;">
|
6624 |
|
6625 |
|
6626 | <span class="param-type">array</span>
|
6627 |
|
6628 |
|
6629 |
|
6630 |
|
6631 | </td>
|
6632 |
|
6633 |
|
6634 | <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;">
|
6635 |
|
6636 |
|
6637 |
|
6638 |
|
6639 |
|
6640 | </td>
|
6641 |
|
6642 |
|
6643 |
|
6644 | <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;">
|
6645 |
|
6646 | </td>
|
6647 |
|
6648 |
|
6649 | <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 array.</p></td>
|
6650 | </tr>
|
6651 |
|
6652 |
|
6653 |
|
6654 | <tr>
|
6655 |
|
6656 | <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>searchElement</code></td>
|
6657 |
|
6658 |
|
6659 | <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;">
|
6660 |
|
6661 |
|
6662 | <span class="param-type">*</span>
|
6663 |
|
6664 |
|
6665 |
|
6666 |
|
6667 | </td>
|
6668 |
|
6669 |
|
6670 | <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;">
|
6671 |
|
6672 |
|
6673 |
|
6674 |
|
6675 |
|
6676 | </td>
|
6677 |
|
6678 |
|
6679 |
|
6680 | <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;">
|
6681 |
|
6682 | </td>
|
6683 |
|
6684 |
|
6685 | <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 we want to search. Note that it is type sensitive.</p></td>
|
6686 | </tr>
|
6687 |
|
6688 |
|
6689 |
|
6690 | <tr>
|
6691 |
|
6692 | <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>fromIndex</code></td>
|
6693 |
|
6694 |
|
6695 | <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;">
|
6696 |
|
6697 |
|
6698 | <span class="param-type">integer</span>
|
6699 |
|
6700 |
|
6701 |
|
6702 |
|
6703 | </td>
|
6704 |
|
6705 |
|
6706 | <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;">
|
6707 |
|
6708 | <optional><br>
|
6709 |
|
6710 |
|
6711 |
|
6712 |
|
6713 |
|
6714 | </td>
|
6715 |
|
6716 |
|
6717 |
|
6718 | <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;">
|
6719 |
|
6720 | 0
|
6721 |
|
6722 | </td>
|
6723 |
|
6724 |
|
6725 | <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>First index of the given array where the search will start.</p></td>
|
6726 | </tr>
|
6727 |
|
6728 |
|
6729 |
|
6730 | <tr>
|
6731 |
|
6732 | <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>extendedDOM</code></td>
|
6733 |
|
6734 |
|
6735 | <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;">
|
6736 |
|
6737 |
|
6738 | <span class="param-type">boolean</span>
|
6739 |
|
6740 |
|
6741 |
|
6742 |
|
6743 | </td>
|
6744 |
|
6745 |
|
6746 | <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;">
|
6747 |
|
6748 | <optional><br>
|
6749 |
|
6750 |
|
6751 |
|
6752 |
|
6753 |
|
6754 | </td>
|
6755 |
|
6756 |
|
6757 |
|
6758 | <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;">
|
6759 |
|
6760 | false
|
6761 |
|
6762 | </td>
|
6763 |
|
6764 |
|
6765 | <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 the function is being called by a native function which was extended. Internal usage recommended only.</p></td>
|
6766 | </tr>
|
6767 |
|
6768 |
|
6769 | </tbody>
|
6770 | </table>
|
6771 |
|
6772 |
|
6773 |
|
6774 |
|
6775 | <dl class="details">
|
6776 |
|
6777 |
|
6778 |
|
6779 |
|
6780 |
|
6781 |
|
6782 |
|
6783 |
|
6784 |
|
6785 |
|
6786 |
|
6787 |
|
6788 |
|
6789 |
|
6790 |
|
6791 |
|
6792 |
|
6793 |
|
6794 |
|
6795 |
|
6796 |
|
6797 |
|
6798 |
|
6799 |
|
6800 |
|
6801 |
|
6802 |
|
6803 |
|
6804 |
|
6805 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
6806 | <dd class="tag-source">
|
6807 | <ul class="dummy">
|
6808 | <li>
|
6809 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
6810 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-87">line 87</a>
|
6811 | </li>
|
6812 | </ul>
|
6813 | </dd>
|
6814 |
|
6815 |
|
6816 |
|
6817 |
|
6818 |
|
6819 |
|
6820 |
|
6821 | </dl>
|
6822 |
|
6823 |
|
6824 |
|
6825 |
|
6826 |
|
6827 |
|
6828 |
|
6829 |
|
6830 |
|
6831 |
|
6832 |
|
6833 |
|
6834 |
|
6835 | <h5>Returns:</h5>
|
6836 |
|
6837 |
|
6838 |
|
6839 |
|
6840 | <dl>
|
6841 | <dt>
|
6842 | Type
|
6843 | </dt>
|
6844 | <dd>
|
6845 |
|
6846 | <span class="param-type">integer</span>
|
6847 |
|
6848 |
|
6849 |
|
6850 | </dd>
|
6851 | </dl>
|
6852 |
|
6853 |
|
6854 |
|
6855 |
|
6856 |
|
6857 | </dd>
|
6858 |
|
6859 |
|
6860 |
|
6861 | <hr>
|
6862 | <dt>
|
6863 | <h4 class="name" id="CB_init"><span class="type-signature"></span>CB_init<span class="signature">( [mainFunction] [, scriptPath] [, onErrorLoadingFile] [, showSplashScreen])</span><span class="type-signature"></span></h4>
|
6864 |
|
6865 |
|
6866 | </dt>
|
6867 | <dd>
|
6868 |
|
6869 |
|
6870 | <div class="description">
|
6871 | <p>Starts CrossBrowdy.</p>
|
6872 | </div>
|
6873 |
|
6874 |
|
6875 |
|
6876 |
|
6877 |
|
6878 |
|
6879 |
|
6880 |
|
6881 | <h5>Parameters:</h5>
|
6882 |
|
6883 |
|
6884 | <table class="params table table-striped">
|
6885 | <thead>
|
6886 | <tr>
|
6887 |
|
6888 | <th style="width:12%; min-width:110px;">Name</th>
|
6889 |
|
6890 |
|
6891 | <th style="width:12%; min-width:110px;">Type</th>
|
6892 |
|
6893 |
|
6894 | <th style="width:12%; min-width:110px;">Argument</th>
|
6895 |
|
6896 |
|
6897 |
|
6898 | <th style="width:12%; min-width:110px;">Default</th>
|
6899 |
|
6900 |
|
6901 | <th class="last" style="min-width:310px;">Description</th>
|
6902 | </tr>
|
6903 | </thead>
|
6904 |
|
6905 | <tbody>
|
6906 |
|
6907 |
|
6908 | <tr>
|
6909 |
|
6910 | <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>mainFunction</code></td>
|
6911 |
|
6912 |
|
6913 | <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;">
|
6914 |
|
6915 |
|
6916 | <span class="param-type"><a href="global.html#CB_init_CALLBACK">CB_init_CALLBACK</a></span>
|
6917 |
|
6918 |
|
6919 |
|
6920 |
|
6921 | </td>
|
6922 |
|
6923 |
|
6924 | <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;">
|
6925 |
|
6926 | <optional><br>
|
6927 |
|
6928 |
|
6929 |
|
6930 |
|
6931 |
|
6932 | </td>
|
6933 |
|
6934 |
|
6935 |
|
6936 | <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;">
|
6937 |
|
6938 | </td>
|
6939 |
|
6940 |
|
6941 | <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 for when CrossBrowdy is loaded successfully. Recommended.</p></td>
|
6942 | </tr>
|
6943 |
|
6944 |
|
6945 |
|
6946 | <tr>
|
6947 |
|
6948 | <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>scriptPath</code></td>
|
6949 |
|
6950 |
|
6951 | <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;">
|
6952 |
|
6953 |
|
6954 | <span class="param-type">string</span>
|
6955 |
|
6956 |
|
6957 |
|
6958 |
|
6959 | </td>
|
6960 |
|
6961 |
|
6962 | <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;">
|
6963 |
|
6964 | <optional><br>
|
6965 |
|
6966 |
|
6967 |
|
6968 |
|
6969 |
|
6970 | </td>
|
6971 |
|
6972 |
|
6973 |
|
6974 | <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;">
|
6975 |
|
6976 | <a href="global.html#CB_scriptPathCalculate"><code>CB_scriptPathCalculate</code></a>()
|
6977 |
|
6978 | </td>
|
6979 |
|
6980 |
|
6981 | <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>Path where the main script is located. If not provided (it is undefined or null), it will try to calculate it calling the <a href="global.html#CB_scriptPathCalculate"><code>CB_scriptPathCalculate</code></a> function internally.</p></td>
|
6982 | </tr>
|
6983 |
|
6984 |
|
6985 |
|
6986 | <tr>
|
6987 |
|
6988 | <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>onErrorLoadingFile</code></td>
|
6989 |
|
6990 |
|
6991 | <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;">
|
6992 |
|
6993 |
|
6994 | <span class="param-type"><a href="global.html#CB_includeRequiredFileErrorCallback">CB_includeRequiredFileErrorCallback</a></span>
|
6995 |
|
6996 |
|
6997 |
|
6998 |
|
6999 | </td>
|
7000 |
|
7001 |
|
7002 | <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;">
|
7003 |
|
7004 | <optional><br>
|
7005 |
|
7006 |
|
7007 |
|
7008 |
|
7009 |
|
7010 | </td>
|
7011 |
|
7012 |
|
7013 |
|
7014 | <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;">
|
7015 |
|
7016 | </td>
|
7017 |
|
7018 |
|
7019 | <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 to call when any of the required files fails to load (because of an error or because its timeout was fired). It could be called more than once, for each file which failed loading. If a function is provided, it will be stored in the global 'CB_initOnErrorLoadingFile' variable.</p></td>
|
7020 | </tr>
|
7021 |
|
7022 |
|
7023 |
|
7024 | <tr>
|
7025 |
|
7026 | <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>showSplashScreen</code></td>
|
7027 |
|
7028 |
|
7029 | <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;">
|
7030 |
|
7031 |
|
7032 | <span class="param-type">boolean</span>
|
7033 |
|
7034 |
|
7035 |
|
7036 |
|
7037 | </td>
|
7038 |
|
7039 |
|
7040 | <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;">
|
7041 |
|
7042 | <optional><br>
|
7043 |
|
7044 |
|
7045 |
|
7046 |
|
7047 |
|
7048 | </td>
|
7049 |
|
7050 |
|
7051 |
|
7052 | <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;">
|
7053 |
|
7054 | <a href="CB_Configuration.CrossBrowdy.html#.SHOW_SPLASH_SCREEN_DEFAULT"><code>CB_Configuration.CrossBrowdy.SHOW_SPLASH_SCREEN_DEFAULT</code></a>
|
7055 |
|
7056 | </td>
|
7057 |
|
7058 |
|
7059 | <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 to show the splash screen or not.</p></td>
|
7060 | </tr>
|
7061 |
|
7062 |
|
7063 | </tbody>
|
7064 | </table>
|
7065 |
|
7066 |
|
7067 |
|
7068 |
|
7069 | <dl class="details">
|
7070 |
|
7071 |
|
7072 |
|
7073 |
|
7074 |
|
7075 |
|
7076 |
|
7077 |
|
7078 |
|
7079 |
|
7080 |
|
7081 |
|
7082 |
|
7083 |
|
7084 |
|
7085 |
|
7086 |
|
7087 |
|
7088 |
|
7089 |
|
7090 |
|
7091 |
|
7092 |
|
7093 |
|
7094 |
|
7095 |
|
7096 |
|
7097 |
|
7098 |
|
7099 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
7100 | <dd class="tag-source">
|
7101 | <ul class="dummy">
|
7102 | <li>
|
7103 | <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
|
7104 | <a href="CrossBrowdy.js.html#sunlight-1-line-1048">line 1048</a>
|
7105 | </li>
|
7106 | </ul>
|
7107 | </dd>
|
7108 |
|
7109 |
|
7110 |
|
7111 |
|
7112 |
|
7113 |
|
7114 |
|
7115 | </dl>
|
7116 |
|
7117 |
|
7118 |
|
7119 |
|
7120 |
|
7121 |
|
7122 |
|
7123 |
|
7124 |
|
7125 |
|
7126 |
|
7127 |
|
7128 |
|
7129 |
|
7130 |
|
7131 | </dd>
|
7132 |
|
7133 |
|
7134 |
|
7135 | <hr>
|
7136 | <dt>
|
7137 | <h4 class="name" id="CB_intToBase"><span class="type-signature"></span>CB_intToBase<span class="signature">(number [, baseSymbols] [, unsigned] [, minusSymbol] [, prefix])</span><span class="type-signature"> → {string}</span></h4>
|
7138 |
|
7139 |
|
7140 | </dt>
|
7141 | <dd>
|
7142 |
|
7143 |
|
7144 | <div class="description">
|
7145 | <p>Converts a given integer into a desired base.</p>
|
7146 | </div>
|
7147 |
|
7148 |
|
7149 |
|
7150 |
|
7151 |
|
7152 |
|
7153 |
|
7154 |
|
7155 | <h5>Parameters:</h5>
|
7156 |
|
7157 |
|
7158 | <table class="params table table-striped">
|
7159 | <thead>
|
7160 | <tr>
|
7161 |
|
7162 | <th style="width:12%; min-width:110px;">Name</th>
|
7163 |
|
7164 |
|
7165 | <th style="width:12%; min-width:110px;">Type</th>
|
7166 |
|
7167 |
|
7168 | <th style="width:12%; min-width:110px;">Argument</th>
|
7169 |
|
7170 |
|
7171 |
|
7172 | <th style="width:12%; min-width:110px;">Default</th>
|
7173 |
|
7174 |
|
7175 | <th class="last" style="min-width:310px;">Description</th>
|
7176 | </tr>
|
7177 | </thead>
|
7178 |
|
7179 | <tbody>
|
7180 |
|
7181 |
|
7182 | <tr>
|
7183 |
|
7184 | <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>number</code></td>
|
7185 |
|
7186 |
|
7187 | <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;">
|
7188 |
|
7189 |
|
7190 | <span class="param-type">integer</span>
|
7191 | |
|
7192 |
|
7193 | <span class="param-type">string</span>
|
7194 |
|
7195 |
|
7196 |
|
7197 |
|
7198 | </td>
|
7199 |
|
7200 |
|
7201 | <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;">
|
7202 |
|
7203 |
|
7204 |
|
7205 |
|
7206 |
|
7207 | </td>
|
7208 |
|
7209 |
|
7210 |
|
7211 | <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;">
|
7212 |
|
7213 | </td>
|
7214 |
|
7215 |
|
7216 | <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 integer that we want to convert to the desired base. For bigger numbers (up to 999999999999999934464 or even lower, depending on the client and the "baseSymbols" used), it is recommended to use a string which will allow to accept a slightly bigger number (up to 999999999999999999999999 or lower, depending on the client and the "baseSymbols" used). Really big numbers will not be codified properly even when passed as a string due to the limitations of JavaScript engines and maximum number allowed to be stored in a variable.</p></td>
|
7217 | </tr>
|
7218 |
|
7219 |
|
7220 |
|
7221 | <tr>
|
7222 |
|
7223 | <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>baseSymbols</code></td>
|
7224 |
|
7225 |
|
7226 | <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;">
|
7227 |
|
7228 |
|
7229 | <span class="param-type">array</span>
|
7230 | |
|
7231 |
|
7232 | <span class="param-type">integer</span>
|
7233 |
|
7234 |
|
7235 |
|
7236 |
|
7237 | </td>
|
7238 |
|
7239 |
|
7240 | <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;">
|
7241 |
|
7242 | <optional><br>
|
7243 |
|
7244 |
|
7245 |
|
7246 |
|
7247 |
|
7248 | </td>
|
7249 |
|
7250 |
|
7251 |
|
7252 | <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;">
|
7253 |
|
7254 | <a href="CB_baseSymbols.html#.66"><code>CB_baseSymbols.66</code></a>
|
7255 |
|
7256 | </td>
|
7257 |
|
7258 |
|
7259 | <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>Array with the desired symbols, using only one per index (their value will correspond to their index). The base (radix) will be the total number of indexes. If an integer greater or equal than 2 is provided, it will try to use it as an index of the <a href="CB_baseSymbols.html"><code>CB_baseSymbols</code></a> object and use it if found or use it as a parameter to call the <a href="CB_baseSymbols.html#.get"><code>CB_baseSymbols.get</code></a> function otherwise. If not provided or the integer is lower than 2, it will use base 66 (defined in the <a href="CB_baseSymbols.html#._66"><code>CB_baseSymbols._66</code></a> property of the <a href="CB_baseSymbols.html"><code>CB_baseSymbols</code></a> object). It is recommended not to exceed 4096 (or even lower, depending on the client, although some clients could support up to 63988 or even more). The properties of the <a href="CB_baseSymbols.html"><code>CB_baseSymbols</code></a> object or the <a href="CB_baseSymbols.html#.get"><code>CB_baseSymbols.get</code></a> function can be used for this parameter.</p></td>
|
7260 | </tr>
|
7261 |
|
7262 |
|
7263 |
|
7264 | <tr>
|
7265 |
|
7266 | <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>unsigned</code></td>
|
7267 |
|
7268 |
|
7269 | <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;">
|
7270 |
|
7271 |
|
7272 | <span class="param-type">boolean</span>
|
7273 |
|
7274 |
|
7275 |
|
7276 |
|
7277 | </td>
|
7278 |
|
7279 |
|
7280 | <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;">
|
7281 |
|
7282 | <optional><br>
|
7283 |
|
7284 |
|
7285 |
|
7286 |
|
7287 |
|
7288 | </td>
|
7289 |
|
7290 |
|
7291 |
|
7292 | <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;">
|
7293 |
|
7294 | false
|
7295 |
|
7296 | </td>
|
7297 |
|
7298 |
|
7299 | <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>Determines whether to treat the input and output numbers as unsigned or not.</p></td>
|
7300 | </tr>
|
7301 |
|
7302 |
|
7303 |
|
7304 | <tr>
|
7305 |
|
7306 | <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>minusSymbol</code></td>
|
7307 |
|
7308 |
|
7309 | <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;">
|
7310 |
|
7311 |
|
7312 | <span class="param-type">string</span>
|
7313 |
|
7314 |
|
7315 |
|
7316 |
|
7317 | </td>
|
7318 |
|
7319 |
|
7320 | <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;">
|
7321 |
|
7322 | <optional><br>
|
7323 |
|
7324 |
|
7325 |
|
7326 |
|
7327 |
|
7328 | </td>
|
7329 |
|
7330 |
|
7331 |
|
7332 | <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;">
|
7333 |
|
7334 | '-'|'0'
|
7335 |
|
7336 | </td>
|
7337 |
|
7338 |
|
7339 | <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>Determines the minus symbol or string for the output, to mark negative numbers. If not provided, it will be '-' for bases equal or lower than 16 (hexadecimal) or '0' (zero character) otherwise. This parameter is ignored if the "unsigned" parameter is set to true.</p></td>
|
7340 | </tr>
|
7341 |
|
7342 |
|
7343 |
|
7344 | <tr>
|
7345 |
|
7346 | <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>prefix</code></td>
|
7347 |
|
7348 |
|
7349 | <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;">
|
7350 |
|
7351 |
|
7352 | <span class="param-type">prefix</span>
|
7353 |
|
7354 |
|
7355 |
|
7356 |
|
7357 | </td>
|
7358 |
|
7359 |
|
7360 | <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;">
|
7361 |
|
7362 | <optional><br>
|
7363 |
|
7364 |
|
7365 |
|
7366 |
|
7367 |
|
7368 | </td>
|
7369 |
|
7370 |
|
7371 |
|
7372 | <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;">
|
7373 |
|
7374 | '0'|'0x'|''
|
7375 |
|
7376 | </td>
|
7377 |
|
7378 |
|
7379 | <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>Determines the prefix for the output. If not provided, it will be '0' (zero character) for base 8 (octal), '0x' for base 16 (hexadecimal) or nothing (empty string) for all the others. Use an empty string to avoid using anything.</p></td>
|
7380 | </tr>
|
7381 |
|
7382 |
|
7383 | </tbody>
|
7384 | </table>
|
7385 |
|
7386 |
|
7387 |
|
7388 |
|
7389 | <dl class="details">
|
7390 |
|
7391 |
|
7392 |
|
7393 |
|
7394 |
|
7395 |
|
7396 |
|
7397 |
|
7398 |
|
7399 |
|
7400 |
|
7401 |
|
7402 |
|
7403 |
|
7404 |
|
7405 |
|
7406 |
|
7407 |
|
7408 |
|
7409 |
|
7410 |
|
7411 |
|
7412 |
|
7413 |
|
7414 |
|
7415 |
|
7416 |
|
7417 |
|
7418 |
|
7419 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
7420 | <dd class="tag-source">
|
7421 | <ul class="dummy">
|
7422 | <li>
|
7423 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
7424 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-1288">line 1288</a>
|
7425 | </li>
|
7426 | </ul>
|
7427 | </dd>
|
7428 |
|
7429 |
|
7430 |
|
7431 |
|
7432 |
|
7433 |
|
7434 |
|
7435 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
7436 | <dd class="tag-todo">
|
7437 | <ul>
|
7438 | <li>Think about allowing the "number" parameter to be a very long string, for bigger numbers (to exceed the limit for integers). Internally, it would need to perform operations comparisons, divisions, remainder calculation with strings, etc.</li>
|
7439 |
|
7440 | <li>Think about allowing to specify the base for the integer (now it is 16 if it begins with "0x", 8 if it begins with "0" and it is not a string or 10 otherwise, and newer clients can support '0b' for binaries, '0o' for octals, ).</li>
|
7441 |
|
7442 | <li>Think about accepting a decimal symbol to separate decimals and support float numbers.</li>
|
7443 | </ul>
|
7444 | </dd>
|
7445 |
|
7446 | </dl>
|
7447 |
|
7448 |
|
7449 |
|
7450 |
|
7451 |
|
7452 |
|
7453 |
|
7454 |
|
7455 |
|
7456 |
|
7457 |
|
7458 |
|
7459 |
|
7460 | <h5>Returns:</h5>
|
7461 |
|
7462 |
|
7463 | <div class="param-desc">
|
7464 | <p>Returns an empty string in the case that the given number cannot be parsed as an integer. Otherwise, returns the given number in the desired base as a string.</p>
|
7465 | </div>
|
7466 |
|
7467 |
|
7468 |
|
7469 | <dl>
|
7470 | <dt>
|
7471 | Type
|
7472 | </dt>
|
7473 | <dd>
|
7474 |
|
7475 | <span class="param-type">string</span>
|
7476 |
|
7477 |
|
7478 |
|
7479 | </dd>
|
7480 | </dl>
|
7481 |
|
7482 |
|
7483 |
|
7484 |
|
7485 |
|
7486 | </dd>
|
7487 |
|
7488 |
|
7489 |
|
7490 | <hr>
|
7491 | <dt>
|
7492 | <h4 class="name" id="CB_isArray"><span class="type-signature"></span>CB_isArray<span class="signature">(element [, extendedDOM])</span><span class="type-signature"> → {boolean}</span></h4>
|
7493 |
|
7494 |
|
7495 | </dt>
|
7496 | <dd>
|
7497 |
|
7498 |
|
7499 | <div class="description">
|
7500 | <p>Implementation of <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray">Array.isArray</a> method for browsers that do not support it natively.<br>
|
7501 | <br><br>
|
7502 | Returns whether a given element is an array or not.</p>
|
7503 | </div>
|
7504 |
|
7505 |
|
7506 |
|
7507 |
|
7508 |
|
7509 |
|
7510 |
|
7511 |
|
7512 | <h5>Parameters:</h5>
|
7513 |
|
7514 |
|
7515 | <table class="params table table-striped">
|
7516 | <thead>
|
7517 | <tr>
|
7518 |
|
7519 | <th style="width:12%; min-width:110px;">Name</th>
|
7520 |
|
7521 |
|
7522 | <th style="width:12%; min-width:110px;">Type</th>
|
7523 |
|
7524 |
|
7525 | <th style="width:12%; min-width:110px;">Argument</th>
|
7526 |
|
7527 |
|
7528 |
|
7529 | <th style="width:12%; min-width:110px;">Default</th>
|
7530 |
|
7531 |
|
7532 | <th class="last" style="min-width:310px;">Description</th>
|
7533 | </tr>
|
7534 | </thead>
|
7535 |
|
7536 | <tbody>
|
7537 |
|
7538 |
|
7539 | <tr>
|
7540 |
|
7541 | <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>
|
7542 |
|
7543 |
|
7544 | <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;">
|
7545 |
|
7546 |
|
7547 | <span class="param-type">*</span>
|
7548 |
|
7549 |
|
7550 |
|
7551 |
|
7552 | </td>
|
7553 |
|
7554 |
|
7555 | <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;">
|
7556 |
|
7557 |
|
7558 |
|
7559 |
|
7560 |
|
7561 | </td>
|
7562 |
|
7563 |
|
7564 |
|
7565 | <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;">
|
7566 |
|
7567 | </td>
|
7568 |
|
7569 |
|
7570 | <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 element we want to check.</p></td>
|
7571 | </tr>
|
7572 |
|
7573 |
|
7574 |
|
7575 | <tr>
|
7576 |
|
7577 | <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>extendedDOM</code></td>
|
7578 |
|
7579 |
|
7580 | <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;">
|
7581 |
|
7582 |
|
7583 | <span class="param-type">boolean</span>
|
7584 |
|
7585 |
|
7586 |
|
7587 |
|
7588 | </td>
|
7589 |
|
7590 |
|
7591 | <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;">
|
7592 |
|
7593 | <optional><br>
|
7594 |
|
7595 |
|
7596 |
|
7597 |
|
7598 |
|
7599 | </td>
|
7600 |
|
7601 |
|
7602 |
|
7603 | <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;">
|
7604 |
|
7605 | false
|
7606 |
|
7607 | </td>
|
7608 |
|
7609 |
|
7610 | <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 the function is being called by a native function which was extended. Internal usage recommended only.</p></td>
|
7611 | </tr>
|
7612 |
|
7613 |
|
7614 | </tbody>
|
7615 | </table>
|
7616 |
|
7617 |
|
7618 |
|
7619 |
|
7620 | <dl class="details">
|
7621 |
|
7622 |
|
7623 |
|
7624 |
|
7625 |
|
7626 |
|
7627 |
|
7628 |
|
7629 |
|
7630 |
|
7631 |
|
7632 |
|
7633 |
|
7634 |
|
7635 |
|
7636 |
|
7637 |
|
7638 |
|
7639 |
|
7640 |
|
7641 |
|
7642 |
|
7643 |
|
7644 |
|
7645 |
|
7646 |
|
7647 |
|
7648 |
|
7649 |
|
7650 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
7651 | <dd class="tag-source">
|
7652 | <ul class="dummy">
|
7653 | <li>
|
7654 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
7655 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-172">line 172</a>
|
7656 | </li>
|
7657 | </ul>
|
7658 | </dd>
|
7659 |
|
7660 |
|
7661 |
|
7662 |
|
7663 |
|
7664 |
|
7665 |
|
7666 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
7667 | <dd class="tag-todo">
|
7668 | <ul>
|
7669 | <li>Think about a parameter to check whether the given array is a typed array (for example, 'Uint8Array') or not.</li>
|
7670 | </ul>
|
7671 | </dd>
|
7672 |
|
7673 | </dl>
|
7674 |
|
7675 |
|
7676 |
|
7677 |
|
7678 |
|
7679 |
|
7680 |
|
7681 |
|
7682 |
|
7683 |
|
7684 |
|
7685 |
|
7686 |
|
7687 | <h5>Returns:</h5>
|
7688 |
|
7689 |
|
7690 |
|
7691 |
|
7692 | <dl>
|
7693 | <dt>
|
7694 | Type
|
7695 | </dt>
|
7696 | <dd>
|
7697 |
|
7698 | <span class="param-type">boolean</span>
|
7699 |
|
7700 |
|
7701 |
|
7702 | </dd>
|
7703 | </dl>
|
7704 |
|
7705 |
|
7706 |
|
7707 |
|
7708 |
|
7709 | </dd>
|
7710 |
|
7711 |
|
7712 |
|
7713 | <hr>
|
7714 | <dt>
|
7715 | <h4 class="name" id="CB_isEmail"><span class="type-signature"></span>CB_isEmail<span class="signature">(email)</span><span class="type-signature"> → {boolean}</span></h4>
|
7716 |
|
7717 |
|
7718 | </dt>
|
7719 | <dd>
|
7720 |
|
7721 |
|
7722 | <div class="description">
|
7723 | <p>Tells whether a given email is valid or not. Not really precise.</p>
|
7724 | </div>
|
7725 |
|
7726 |
|
7727 |
|
7728 |
|
7729 |
|
7730 |
|
7731 |
|
7732 |
|
7733 | <h5>Parameters:</h5>
|
7734 |
|
7735 |
|
7736 | <table class="params table table-striped">
|
7737 | <thead>
|
7738 | <tr>
|
7739 |
|
7740 | <th style="width:12%; min-width:110px;">Name</th>
|
7741 |
|
7742 |
|
7743 | <th style="width:12%; min-width:110px;">Type</th>
|
7744 |
|
7745 |
|
7746 |
|
7747 |
|
7748 |
|
7749 | <th class="last" style="min-width:310px;">Description</th>
|
7750 | </tr>
|
7751 | </thead>
|
7752 |
|
7753 | <tbody>
|
7754 |
|
7755 |
|
7756 | <tr>
|
7757 |
|
7758 | <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>email</code></td>
|
7759 |
|
7760 |
|
7761 | <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;">
|
7762 |
|
7763 |
|
7764 | <span class="param-type">string</span>
|
7765 |
|
7766 |
|
7767 |
|
7768 |
|
7769 | </td>
|
7770 |
|
7771 |
|
7772 |
|
7773 |
|
7774 |
|
7775 | <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>Possible email that we want to validate.</p></td>
|
7776 | </tr>
|
7777 |
|
7778 |
|
7779 | </tbody>
|
7780 | </table>
|
7781 |
|
7782 |
|
7783 |
|
7784 |
|
7785 | <dl class="details">
|
7786 |
|
7787 |
|
7788 |
|
7789 |
|
7790 |
|
7791 |
|
7792 |
|
7793 |
|
7794 |
|
7795 |
|
7796 |
|
7797 |
|
7798 |
|
7799 |
|
7800 |
|
7801 |
|
7802 |
|
7803 |
|
7804 |
|
7805 |
|
7806 |
|
7807 |
|
7808 |
|
7809 |
|
7810 |
|
7811 |
|
7812 |
|
7813 |
|
7814 |
|
7815 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
7816 | <dd class="tag-source">
|
7817 | <ul class="dummy">
|
7818 | <li>
|
7819 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
7820 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-552">line 552</a>
|
7821 | </li>
|
7822 | </ul>
|
7823 | </dd>
|
7824 |
|
7825 |
|
7826 |
|
7827 |
|
7828 |
|
7829 |
|
7830 |
|
7831 | </dl>
|
7832 |
|
7833 |
|
7834 |
|
7835 |
|
7836 |
|
7837 |
|
7838 |
|
7839 |
|
7840 |
|
7841 |
|
7842 |
|
7843 |
|
7844 |
|
7845 | <h5>Returns:</h5>
|
7846 |
|
7847 |
|
7848 |
|
7849 |
|
7850 | <dl>
|
7851 | <dt>
|
7852 | Type
|
7853 | </dt>
|
7854 | <dd>
|
7855 |
|
7856 | <span class="param-type">boolean</span>
|
7857 |
|
7858 |
|
7859 |
|
7860 | </dd>
|
7861 | </dl>
|
7862 |
|
7863 |
|
7864 |
|
7865 |
|
7866 |
|
7867 | </dd>
|
7868 |
|
7869 |
|
7870 |
|
7871 | <hr>
|
7872 | <dt>
|
7873 | <h4 class="name" id="CB_isFileLocal"><span class="type-signature"></span>CB_isFileLocal<span class="signature">(filePath)</span><span class="type-signature"> → {boolean}</span></h4>
|
7874 |
|
7875 |
|
7876 | </dt>
|
7877 | <dd>
|
7878 |
|
7879 |
|
7880 | <div class="description">
|
7881 | <p>Tries to guess whether a given file path (absolute or relative) is a local address or not. It will be assumed as local if the path<br>
|
7882 | uses the "file:" protocol or the current script is running locally and the path does not use the "http:", "https:" or "ftp:" protocols.</p>
|
7883 | </div>
|
7884 |
|
7885 |
|
7886 |
|
7887 |
|
7888 |
|
7889 |
|
7890 |
|
7891 |
|
7892 | <h5>Parameters:</h5>
|
7893 |
|
7894 |
|
7895 | <table class="params table table-striped">
|
7896 | <thead>
|
7897 | <tr>
|
7898 |
|
7899 | <th style="width:12%; min-width:110px;">Name</th>
|
7900 |
|
7901 |
|
7902 | <th style="width:12%; min-width:110px;">Type</th>
|
7903 |
|
7904 |
|
7905 |
|
7906 |
|
7907 |
|
7908 | <th class="last" style="min-width:310px;">Description</th>
|
7909 | </tr>
|
7910 | </thead>
|
7911 |
|
7912 | <tbody>
|
7913 |
|
7914 |
|
7915 | <tr>
|
7916 |
|
7917 | <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>filePath</code></td>
|
7918 |
|
7919 |
|
7920 | <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;">
|
7921 |
|
7922 |
|
7923 | <span class="param-type">string</span>
|
7924 |
|
7925 |
|
7926 |
|
7927 |
|
7928 | </td>
|
7929 |
|
7930 |
|
7931 |
|
7932 |
|
7933 |
|
7934 | <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 file path we want to check.</p></td>
|
7935 | </tr>
|
7936 |
|
7937 |
|
7938 | </tbody>
|
7939 | </table>
|
7940 |
|
7941 |
|
7942 |
|
7943 |
|
7944 | <dl class="details">
|
7945 |
|
7946 |
|
7947 |
|
7948 |
|
7949 |
|
7950 |
|
7951 |
|
7952 |
|
7953 |
|
7954 |
|
7955 |
|
7956 |
|
7957 |
|
7958 |
|
7959 |
|
7960 |
|
7961 |
|
7962 |
|
7963 |
|
7964 |
|
7965 |
|
7966 |
|
7967 |
|
7968 |
|
7969 |
|
7970 |
|
7971 |
|
7972 |
|
7973 |
|
7974 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
7975 | <dd class="tag-source">
|
7976 | <ul class="dummy">
|
7977 | <li>
|
7978 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
7979 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-466">line 466</a>
|
7980 | </li>
|
7981 | </ul>
|
7982 | </dd>
|
7983 |
|
7984 |
|
7985 |
|
7986 |
|
7987 |
|
7988 |
|
7989 |
|
7990 | </dl>
|
7991 |
|
7992 |
|
7993 |
|
7994 |
|
7995 |
|
7996 |
|
7997 |
|
7998 |
|
7999 |
|
8000 |
|
8001 |
|
8002 |
|
8003 |
|
8004 | <h5>Returns:</h5>
|
8005 |
|
8006 |
|
8007 | <div class="param-desc">
|
8008 | <p>Returns whether the given file path is a local address or not.</p>
|
8009 | </div>
|
8010 |
|
8011 |
|
8012 |
|
8013 | <dl>
|
8014 | <dt>
|
8015 | Type
|
8016 | </dt>
|
8017 | <dd>
|
8018 |
|
8019 | <span class="param-type">boolean</span>
|
8020 |
|
8021 |
|
8022 |
|
8023 | </dd>
|
8024 | </dl>
|
8025 |
|
8026 |
|
8027 |
|
8028 |
|
8029 |
|
8030 | </dd>
|
8031 |
|
8032 |
|
8033 |
|
8034 | <hr>
|
8035 | <dt>
|
8036 | <h4 class="name" id="CB_isString"><span class="type-signature"></span>CB_isString<span class="signature">(element)</span><span class="type-signature"> → {boolean}</span></h4>
|
8037 |
|
8038 |
|
8039 | </dt>
|
8040 | <dd>
|
8041 |
|
8042 |
|
8043 | <div class="description">
|
8044 | <p>Returns whether a given element is a string or not.</p>
|
8045 | </div>
|
8046 |
|
8047 |
|
8048 |
|
8049 |
|
8050 |
|
8051 |
|
8052 |
|
8053 |
|
8054 | <h5>Parameters:</h5>
|
8055 |
|
8056 |
|
8057 | <table class="params table table-striped">
|
8058 | <thead>
|
8059 | <tr>
|
8060 |
|
8061 | <th style="width:12%; min-width:110px;">Name</th>
|
8062 |
|
8063 |
|
8064 | <th style="width:12%; min-width:110px;">Type</th>
|
8065 |
|
8066 |
|
8067 |
|
8068 |
|
8069 |
|
8070 | <th class="last" style="min-width:310px;">Description</th>
|
8071 | </tr>
|
8072 | </thead>
|
8073 |
|
8074 | <tbody>
|
8075 |
|
8076 |
|
8077 | <tr>
|
8078 |
|
8079 | <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>
|
8080 |
|
8081 |
|
8082 | <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;">
|
8083 |
|
8084 |
|
8085 | <span class="param-type">*</span>
|
8086 |
|
8087 |
|
8088 |
|
8089 |
|
8090 | </td>
|
8091 |
|
8092 |
|
8093 |
|
8094 |
|
8095 |
|
8096 | <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 element we want to check.</p></td>
|
8097 | </tr>
|
8098 |
|
8099 |
|
8100 | </tbody>
|
8101 | </table>
|
8102 |
|
8103 |
|
8104 |
|
8105 |
|
8106 | <dl class="details">
|
8107 |
|
8108 |
|
8109 |
|
8110 |
|
8111 |
|
8112 |
|
8113 |
|
8114 |
|
8115 |
|
8116 |
|
8117 |
|
8118 |
|
8119 |
|
8120 |
|
8121 |
|
8122 |
|
8123 |
|
8124 |
|
8125 |
|
8126 |
|
8127 |
|
8128 |
|
8129 |
|
8130 |
|
8131 |
|
8132 |
|
8133 |
|
8134 |
|
8135 |
|
8136 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
8137 | <dd class="tag-source">
|
8138 | <ul class="dummy">
|
8139 | <li>
|
8140 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
8141 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-226">line 226</a>
|
8142 | </li>
|
8143 | </ul>
|
8144 | </dd>
|
8145 |
|
8146 |
|
8147 |
|
8148 |
|
8149 |
|
8150 |
|
8151 |
|
8152 | </dl>
|
8153 |
|
8154 |
|
8155 |
|
8156 |
|
8157 |
|
8158 |
|
8159 |
|
8160 |
|
8161 |
|
8162 |
|
8163 |
|
8164 |
|
8165 |
|
8166 | <h5>Returns:</h5>
|
8167 |
|
8168 |
|
8169 |
|
8170 |
|
8171 | <dl>
|
8172 | <dt>
|
8173 | Type
|
8174 | </dt>
|
8175 | <dd>
|
8176 |
|
8177 | <span class="param-type">boolean</span>
|
8178 |
|
8179 |
|
8180 |
|
8181 | </dd>
|
8182 | </dl>
|
8183 |
|
8184 |
|
8185 |
|
8186 |
|
8187 |
|
8188 | </dd>
|
8189 |
|
8190 |
|
8191 |
|
8192 | <hr>
|
8193 | <dt>
|
8194 | <h4 class="name" id="CB_lastIndexOf"><span class="type-signature"></span>CB_lastIndexOf<span class="signature">(array, searchElement [, fromIndex] [, extendedDOM])</span><span class="type-signature"> → {integer}</span></h4>
|
8195 |
|
8196 |
|
8197 | </dt>
|
8198 | <dd>
|
8199 |
|
8200 |
|
8201 | <div class="description">
|
8202 | <p>Implementation of <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/lastIndexOf">Array.lastIndexOf</a> method for browsers that do not support it natively.<br>
|
8203 | <br><br>
|
8204 | Returns the last index of a given element that exists in an array (starting from a certain index if desired) or -1 if not found.</p>
|
8205 | </div>
|
8206 |
|
8207 |
|
8208 |
|
8209 |
|
8210 |
|
8211 |
|
8212 |
|
8213 |
|
8214 | <h5>Parameters:</h5>
|
8215 |
|
8216 |
|
8217 | <table class="params table table-striped">
|
8218 | <thead>
|
8219 | <tr>
|
8220 |
|
8221 | <th style="width:12%; min-width:110px;">Name</th>
|
8222 |
|
8223 |
|
8224 | <th style="width:12%; min-width:110px;">Type</th>
|
8225 |
|
8226 |
|
8227 | <th style="width:12%; min-width:110px;">Argument</th>
|
8228 |
|
8229 |
|
8230 |
|
8231 | <th style="width:12%; min-width:110px;">Default</th>
|
8232 |
|
8233 |
|
8234 | <th class="last" style="min-width:310px;">Description</th>
|
8235 | </tr>
|
8236 | </thead>
|
8237 |
|
8238 | <tbody>
|
8239 |
|
8240 |
|
8241 | <tr>
|
8242 |
|
8243 | <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>array</code></td>
|
8244 |
|
8245 |
|
8246 | <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;">
|
8247 |
|
8248 |
|
8249 | <span class="param-type">array</span>
|
8250 |
|
8251 |
|
8252 |
|
8253 |
|
8254 | </td>
|
8255 |
|
8256 |
|
8257 | <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;">
|
8258 |
|
8259 |
|
8260 |
|
8261 |
|
8262 |
|
8263 | </td>
|
8264 |
|
8265 |
|
8266 |
|
8267 | <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;">
|
8268 |
|
8269 | </td>
|
8270 |
|
8271 |
|
8272 | <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 array.</p></td>
|
8273 | </tr>
|
8274 |
|
8275 |
|
8276 |
|
8277 | <tr>
|
8278 |
|
8279 | <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>searchElement</code></td>
|
8280 |
|
8281 |
|
8282 | <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;">
|
8283 |
|
8284 |
|
8285 | <span class="param-type">*</span>
|
8286 |
|
8287 |
|
8288 |
|
8289 |
|
8290 | </td>
|
8291 |
|
8292 |
|
8293 | <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;">
|
8294 |
|
8295 |
|
8296 |
|
8297 |
|
8298 |
|
8299 | </td>
|
8300 |
|
8301 |
|
8302 |
|
8303 | <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;">
|
8304 |
|
8305 | </td>
|
8306 |
|
8307 |
|
8308 | <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 we want to search. Note that it is type sensitive.</p></td>
|
8309 | </tr>
|
8310 |
|
8311 |
|
8312 |
|
8313 | <tr>
|
8314 |
|
8315 | <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>fromIndex</code></td>
|
8316 |
|
8317 |
|
8318 | <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;">
|
8319 |
|
8320 |
|
8321 | <span class="param-type">integer</span>
|
8322 |
|
8323 |
|
8324 |
|
8325 |
|
8326 | </td>
|
8327 |
|
8328 |
|
8329 | <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;">
|
8330 |
|
8331 | <optional><br>
|
8332 |
|
8333 |
|
8334 |
|
8335 |
|
8336 |
|
8337 | </td>
|
8338 |
|
8339 |
|
8340 |
|
8341 | <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;">
|
8342 |
|
8343 | array.length - 1
|
8344 |
|
8345 | </td>
|
8346 |
|
8347 |
|
8348 | <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>First index of the given array where the search will start.</p></td>
|
8349 | </tr>
|
8350 |
|
8351 |
|
8352 |
|
8353 | <tr>
|
8354 |
|
8355 | <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>extendedDOM</code></td>
|
8356 |
|
8357 |
|
8358 | <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;">
|
8359 |
|
8360 |
|
8361 | <span class="param-type">boolean</span>
|
8362 |
|
8363 |
|
8364 |
|
8365 |
|
8366 | </td>
|
8367 |
|
8368 |
|
8369 | <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;">
|
8370 |
|
8371 | <optional><br>
|
8372 |
|
8373 |
|
8374 |
|
8375 |
|
8376 |
|
8377 | </td>
|
8378 |
|
8379 |
|
8380 |
|
8381 | <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;">
|
8382 |
|
8383 | false
|
8384 |
|
8385 | </td>
|
8386 |
|
8387 |
|
8388 | <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 the function is being called by a native function which was extended. Internal usage recommended only.</p></td>
|
8389 | </tr>
|
8390 |
|
8391 |
|
8392 | </tbody>
|
8393 | </table>
|
8394 |
|
8395 |
|
8396 |
|
8397 |
|
8398 | <dl class="details">
|
8399 |
|
8400 |
|
8401 |
|
8402 |
|
8403 |
|
8404 |
|
8405 |
|
8406 |
|
8407 |
|
8408 |
|
8409 |
|
8410 |
|
8411 |
|
8412 |
|
8413 |
|
8414 |
|
8415 |
|
8416 |
|
8417 |
|
8418 |
|
8419 |
|
8420 |
|
8421 |
|
8422 |
|
8423 |
|
8424 |
|
8425 |
|
8426 |
|
8427 |
|
8428 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
8429 | <dd class="tag-source">
|
8430 | <ul class="dummy">
|
8431 | <li>
|
8432 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
8433 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-38">line 38</a>
|
8434 | </li>
|
8435 | </ul>
|
8436 | </dd>
|
8437 |
|
8438 |
|
8439 |
|
8440 |
|
8441 |
|
8442 |
|
8443 |
|
8444 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
8445 | <dd class="tag-todo">
|
8446 | <ul>
|
8447 | <li>Implement the "fromIndex" in the polyfill.</li>
|
8448 | </ul>
|
8449 | </dd>
|
8450 |
|
8451 | </dl>
|
8452 |
|
8453 |
|
8454 |
|
8455 |
|
8456 |
|
8457 |
|
8458 |
|
8459 |
|
8460 |
|
8461 |
|
8462 |
|
8463 |
|
8464 |
|
8465 | <h5>Returns:</h5>
|
8466 |
|
8467 |
|
8468 |
|
8469 |
|
8470 | <dl>
|
8471 | <dt>
|
8472 | Type
|
8473 | </dt>
|
8474 | <dd>
|
8475 |
|
8476 | <span class="param-type">integer</span>
|
8477 |
|
8478 |
|
8479 |
|
8480 | </dd>
|
8481 | </dl>
|
8482 |
|
8483 |
|
8484 |
|
8485 |
|
8486 |
|
8487 | </dd>
|
8488 |
|
8489 |
|
8490 |
|
8491 | <hr>
|
8492 | <dt>
|
8493 | <h4 class="name" id="CB_ltrim"><span class="type-signature"></span>CB_ltrim<span class="signature">(element [, undesiredStrings])</span><span class="type-signature"> → {string|array}</span></h4>
|
8494 |
|
8495 |
|
8496 | </dt>
|
8497 | <dd>
|
8498 |
|
8499 |
|
8500 | <div class="description">
|
8501 | <p>Trims the left side of a given string or array of strings (modifying the given array), taking off the desired strings or otherwise trimming spaces, tabs ("\t"), new lines ("\n") and carriage returns ("\r"). Case sensitive.</p>
|
8502 | </div>
|
8503 |
|
8504 |
|
8505 |
|
8506 |
|
8507 |
|
8508 |
|
8509 |
|
8510 |
|
8511 | <h5>Parameters:</h5>
|
8512 |
|
8513 |
|
8514 | <table class="params table table-striped">
|
8515 | <thead>
|
8516 | <tr>
|
8517 |
|
8518 | <th style="width:12%; min-width:110px;">Name</th>
|
8519 |
|
8520 |
|
8521 | <th style="width:12%; min-width:110px;">Type</th>
|
8522 |
|
8523 |
|
8524 | <th style="width:12%; min-width:110px;">Argument</th>
|
8525 |
|
8526 |
|
8527 |
|
8528 | <th style="width:12%; min-width:110px;">Default</th>
|
8529 |
|
8530 |
|
8531 | <th class="last" style="min-width:310px;">Description</th>
|
8532 | </tr>
|
8533 | </thead>
|
8534 |
|
8535 | <tbody>
|
8536 |
|
8537 |
|
8538 | <tr>
|
8539 |
|
8540 | <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>
|
8541 |
|
8542 |
|
8543 | <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;">
|
8544 |
|
8545 |
|
8546 | <span class="param-type">string</span>
|
8547 | |
|
8548 |
|
8549 | <span class="param-type">array</span>
|
8550 |
|
8551 |
|
8552 |
|
8553 |
|
8554 | </td>
|
8555 |
|
8556 |
|
8557 | <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;">
|
8558 |
|
8559 |
|
8560 |
|
8561 |
|
8562 |
|
8563 | </td>
|
8564 |
|
8565 |
|
8566 |
|
8567 | <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;">
|
8568 |
|
8569 | </td>
|
8570 |
|
8571 |
|
8572 | <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 element that will be trimmed. It should be either a string or an array of strings.</p></td>
|
8573 | </tr>
|
8574 |
|
8575 |
|
8576 |
|
8577 | <tr>
|
8578 |
|
8579 | <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>undesiredStrings</code></td>
|
8580 |
|
8581 |
|
8582 | <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;">
|
8583 |
|
8584 |
|
8585 | <span class="param-type">string</span>
|
8586 | |
|
8587 |
|
8588 | <span class="param-type">array</span>
|
8589 |
|
8590 |
|
8591 |
|
8592 |
|
8593 | </td>
|
8594 |
|
8595 |
|
8596 | <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;">
|
8597 |
|
8598 | <optional><br>
|
8599 |
|
8600 |
|
8601 |
|
8602 |
|
8603 |
|
8604 | </td>
|
8605 |
|
8606 |
|
8607 |
|
8608 | <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;">
|
8609 |
|
8610 | [ " ", "\n", "\r", "\t" ]
|
8611 |
|
8612 | </td>
|
8613 |
|
8614 |
|
8615 | <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>String or an array with the strings that we want to trim off the given element.</p></td>
|
8616 | </tr>
|
8617 |
|
8618 |
|
8619 | </tbody>
|
8620 | </table>
|
8621 |
|
8622 |
|
8623 |
|
8624 |
|
8625 | <dl class="details">
|
8626 |
|
8627 |
|
8628 |
|
8629 |
|
8630 |
|
8631 |
|
8632 |
|
8633 |
|
8634 |
|
8635 |
|
8636 |
|
8637 |
|
8638 |
|
8639 |
|
8640 |
|
8641 |
|
8642 |
|
8643 |
|
8644 |
|
8645 |
|
8646 |
|
8647 |
|
8648 |
|
8649 |
|
8650 |
|
8651 |
|
8652 |
|
8653 |
|
8654 |
|
8655 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
8656 | <dd class="tag-source">
|
8657 | <ul class="dummy">
|
8658 | <li>
|
8659 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
8660 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-362">line 362</a>
|
8661 | </li>
|
8662 | </ul>
|
8663 | </dd>
|
8664 |
|
8665 |
|
8666 |
|
8667 |
|
8668 |
|
8669 |
|
8670 |
|
8671 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
8672 | <dd class="tag-todo">
|
8673 | <ul>
|
8674 | <li>Accept a "recursive" parameter (boolean) to affect multiple levels (array of arrays of strings, etc.).</li>
|
8675 |
|
8676 | <li>Consider accepting objects instead of arrays in the "element" parameter.</li>
|
8677 |
|
8678 | <li>Think about optimizing (using a counter for the number of occurrences in the loop and trim all the occurrences when finished).</li>
|
8679 | </ul>
|
8680 | </dd>
|
8681 |
|
8682 | </dl>
|
8683 |
|
8684 |
|
8685 |
|
8686 |
|
8687 |
|
8688 |
|
8689 |
|
8690 |
|
8691 |
|
8692 |
|
8693 |
|
8694 |
|
8695 |
|
8696 | <h5>Returns:</h5>
|
8697 |
|
8698 |
|
8699 | <div class="param-desc">
|
8700 | <p>Returns the given element again if it was an string, a number (it will be casted to a string) or an array of strings, trimmed if it has been possible. If it was another type, returns an empty string.</p>
|
8701 | </div>
|
8702 |
|
8703 |
|
8704 |
|
8705 | <dl>
|
8706 | <dt>
|
8707 | Type
|
8708 | </dt>
|
8709 | <dd>
|
8710 |
|
8711 | <span class="param-type">string</span>
|
8712 | |
|
8713 |
|
8714 | <span class="param-type">array</span>
|
8715 |
|
8716 |
|
8717 |
|
8718 | </dd>
|
8719 | </dl>
|
8720 |
|
8721 |
|
8722 |
|
8723 |
|
8724 |
|
8725 | </dd>
|
8726 |
|
8727 |
|
8728 |
|
8729 | <hr>
|
8730 | <dt>
|
8731 | <h4 class="name" id="CB_nl2br"><span class="type-signature"></span>CB_nl2br<span class="signature">(string)</span><span class="type-signature"> → {string}</span></h4>
|
8732 |
|
8733 |
|
8734 | </dt>
|
8735 | <dd>
|
8736 |
|
8737 |
|
8738 | <div class="description">
|
8739 | <p>Changes new lines (\n) for <br />'s in a given string.</p>
|
8740 | </div>
|
8741 |
|
8742 |
|
8743 |
|
8744 |
|
8745 |
|
8746 |
|
8747 |
|
8748 |
|
8749 | <h5>Parameters:</h5>
|
8750 |
|
8751 |
|
8752 | <table class="params table table-striped">
|
8753 | <thead>
|
8754 | <tr>
|
8755 |
|
8756 | <th style="width:12%; min-width:110px;">Name</th>
|
8757 |
|
8758 |
|
8759 | <th style="width:12%; min-width:110px;">Type</th>
|
8760 |
|
8761 |
|
8762 |
|
8763 |
|
8764 |
|
8765 | <th class="last" style="min-width:310px;">Description</th>
|
8766 | </tr>
|
8767 | </thead>
|
8768 |
|
8769 | <tbody>
|
8770 |
|
8771 |
|
8772 | <tr>
|
8773 |
|
8774 | <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>string</code></td>
|
8775 |
|
8776 |
|
8777 | <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;">
|
8778 |
|
8779 |
|
8780 | <span class="param-type">string</span>
|
8781 |
|
8782 |
|
8783 |
|
8784 |
|
8785 | </td>
|
8786 |
|
8787 |
|
8788 |
|
8789 |
|
8790 |
|
8791 | <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 string we want to modify.</p></td>
|
8792 | </tr>
|
8793 |
|
8794 |
|
8795 | </tbody>
|
8796 | </table>
|
8797 |
|
8798 |
|
8799 |
|
8800 |
|
8801 | <dl class="details">
|
8802 |
|
8803 |
|
8804 |
|
8805 |
|
8806 |
|
8807 |
|
8808 |
|
8809 |
|
8810 |
|
8811 |
|
8812 |
|
8813 |
|
8814 |
|
8815 |
|
8816 |
|
8817 |
|
8818 |
|
8819 |
|
8820 |
|
8821 |
|
8822 |
|
8823 |
|
8824 |
|
8825 |
|
8826 |
|
8827 |
|
8828 |
|
8829 |
|
8830 |
|
8831 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
8832 | <dd class="tag-source">
|
8833 | <ul class="dummy">
|
8834 | <li>
|
8835 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
8836 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-416">line 416</a>
|
8837 | </li>
|
8838 | </ul>
|
8839 | </dd>
|
8840 |
|
8841 |
|
8842 |
|
8843 |
|
8844 |
|
8845 |
|
8846 |
|
8847 | </dl>
|
8848 |
|
8849 |
|
8850 |
|
8851 |
|
8852 |
|
8853 |
|
8854 |
|
8855 |
|
8856 |
|
8857 |
|
8858 |
|
8859 |
|
8860 |
|
8861 | <h5>Returns:</h5>
|
8862 |
|
8863 |
|
8864 | <div class="param-desc">
|
8865 | <p>Returns the string with all the occurrences replaced or an empty string if the element given was not a string.</p>
|
8866 | </div>
|
8867 |
|
8868 |
|
8869 |
|
8870 | <dl>
|
8871 | <dt>
|
8872 | Type
|
8873 | </dt>
|
8874 | <dd>
|
8875 |
|
8876 | <span class="param-type">string</span>
|
8877 |
|
8878 |
|
8879 |
|
8880 | </dd>
|
8881 | </dl>
|
8882 |
|
8883 |
|
8884 |
|
8885 |
|
8886 |
|
8887 | </dd>
|
8888 |
|
8889 |
|
8890 |
|
8891 | <hr>
|
8892 | <dt>
|
8893 | <h4 class="name" id="CB_nlToBr"><span class="type-signature"></span>CB_nlToBr<span class="signature">()</span><span class="type-signature"></span></h4>
|
8894 |
|
8895 |
|
8896 | </dt>
|
8897 | <dd>
|
8898 |
|
8899 |
|
8900 | <div class="description">
|
8901 | <p>Alias for <a href="global.html#CB_nl2br"><code>CB_nl2br</code></a>.</p>
|
8902 | </div>
|
8903 |
|
8904 |
|
8905 |
|
8906 |
|
8907 |
|
8908 |
|
8909 |
|
8910 |
|
8911 |
|
8912 |
|
8913 | <dl class="details">
|
8914 |
|
8915 |
|
8916 |
|
8917 |
|
8918 |
|
8919 |
|
8920 |
|
8921 |
|
8922 |
|
8923 |
|
8924 |
|
8925 |
|
8926 |
|
8927 |
|
8928 |
|
8929 |
|
8930 |
|
8931 |
|
8932 |
|
8933 |
|
8934 |
|
8935 |
|
8936 |
|
8937 |
|
8938 |
|
8939 |
|
8940 |
|
8941 |
|
8942 |
|
8943 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
8944 | <dd class="tag-source">
|
8945 | <ul class="dummy">
|
8946 | <li>
|
8947 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
8948 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-405">line 405</a>
|
8949 | </li>
|
8950 | </ul>
|
8951 | </dd>
|
8952 |
|
8953 |
|
8954 |
|
8955 |
|
8956 |
|
8957 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
8958 | <dd class="tag-see">
|
8959 | <ul>
|
8960 | <li><a href="global.html#CB_nl2br"><code>CB_nl2br</code></a></li>
|
8961 | </ul>
|
8962 | </dd>
|
8963 |
|
8964 |
|
8965 |
|
8966 | </dl>
|
8967 |
|
8968 |
|
8969 |
|
8970 |
|
8971 |
|
8972 |
|
8973 |
|
8974 |
|
8975 |
|
8976 |
|
8977 |
|
8978 |
|
8979 |
|
8980 |
|
8981 |
|
8982 | </dd>
|
8983 |
|
8984 |
|
8985 |
|
8986 | <hr>
|
8987 | <dt>
|
8988 | <h4 class="name" id="CB_numberFormat"><span class="type-signature"></span>CB_numberFormat<span class="signature">(number [, decimals] [, stringify])</span><span class="type-signature"> → {integer|float|string}</span></h4>
|
8989 |
|
8990 |
|
8991 | </dt>
|
8992 | <dd>
|
8993 |
|
8994 |
|
8995 | <div class="description">
|
8996 | <p>Returns the given number with the desired decimals and make it a string if we want to (so it will be able to have trailing zeros). Uses decimal numeral system only. It will perform ceiling round automatically if needed.</p>
|
8997 | </div>
|
8998 |
|
8999 |
|
9000 |
|
9001 |
|
9002 |
|
9003 |
|
9004 |
|
9005 |
|
9006 | <h5>Parameters:</h5>
|
9007 |
|
9008 |
|
9009 | <table class="params table table-striped">
|
9010 | <thead>
|
9011 | <tr>
|
9012 |
|
9013 | <th style="width:12%; min-width:110px;">Name</th>
|
9014 |
|
9015 |
|
9016 | <th style="width:12%; min-width:110px;">Type</th>
|
9017 |
|
9018 |
|
9019 | <th style="width:12%; min-width:110px;">Argument</th>
|
9020 |
|
9021 |
|
9022 |
|
9023 | <th style="width:12%; min-width:110px;">Default</th>
|
9024 |
|
9025 |
|
9026 | <th class="last" style="min-width:310px;">Description</th>
|
9027 | </tr>
|
9028 | </thead>
|
9029 |
|
9030 | <tbody>
|
9031 |
|
9032 |
|
9033 | <tr>
|
9034 |
|
9035 | <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>number</code></td>
|
9036 |
|
9037 |
|
9038 | <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;">
|
9039 |
|
9040 |
|
9041 | <span class="param-type">integer</span>
|
9042 | |
|
9043 |
|
9044 | <span class="param-type">float</span>
|
9045 | |
|
9046 |
|
9047 | <span class="param-type">string</span>
|
9048 |
|
9049 |
|
9050 |
|
9051 |
|
9052 | </td>
|
9053 |
|
9054 |
|
9055 | <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;">
|
9056 |
|
9057 |
|
9058 |
|
9059 |
|
9060 |
|
9061 | </td>
|
9062 |
|
9063 |
|
9064 |
|
9065 | <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;">
|
9066 |
|
9067 | </td>
|
9068 |
|
9069 |
|
9070 | <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 number that we want to format. It can be a string.</p></td>
|
9071 | </tr>
|
9072 |
|
9073 |
|
9074 |
|
9075 | <tr>
|
9076 |
|
9077 | <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>decimals</code></td>
|
9078 |
|
9079 |
|
9080 | <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;">
|
9081 |
|
9082 |
|
9083 | <span class="param-type">integer</span>
|
9084 |
|
9085 |
|
9086 |
|
9087 |
|
9088 | </td>
|
9089 |
|
9090 |
|
9091 | <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;">
|
9092 |
|
9093 | <optional><br>
|
9094 |
|
9095 |
|
9096 |
|
9097 |
|
9098 |
|
9099 | </td>
|
9100 |
|
9101 |
|
9102 |
|
9103 | <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;">
|
9104 |
|
9105 | 2
|
9106 |
|
9107 | </td>
|
9108 |
|
9109 |
|
9110 | <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 number of decimals we want to allow.</p></td>
|
9111 | </tr>
|
9112 |
|
9113 |
|
9114 |
|
9115 | <tr>
|
9116 |
|
9117 | <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>stringify</code></td>
|
9118 |
|
9119 |
|
9120 | <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;">
|
9121 |
|
9122 |
|
9123 | <span class="param-type">boolean</span>
|
9124 |
|
9125 |
|
9126 |
|
9127 |
|
9128 | </td>
|
9129 |
|
9130 |
|
9131 | <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;">
|
9132 |
|
9133 | <optional><br>
|
9134 |
|
9135 |
|
9136 |
|
9137 |
|
9138 |
|
9139 | </td>
|
9140 |
|
9141 |
|
9142 |
|
9143 | <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;">
|
9144 |
|
9145 | false
|
9146 |
|
9147 | </td>
|
9148 |
|
9149 |
|
9150 | <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>Set to true if we want it to return a string (filled with trailing zeros to reach the desired number of decimals).</p></td>
|
9151 | </tr>
|
9152 |
|
9153 |
|
9154 | </tbody>
|
9155 | </table>
|
9156 |
|
9157 |
|
9158 |
|
9159 |
|
9160 | <dl class="details">
|
9161 |
|
9162 |
|
9163 |
|
9164 |
|
9165 |
|
9166 |
|
9167 |
|
9168 |
|
9169 |
|
9170 |
|
9171 |
|
9172 |
|
9173 |
|
9174 |
|
9175 |
|
9176 |
|
9177 |
|
9178 |
|
9179 |
|
9180 |
|
9181 |
|
9182 |
|
9183 |
|
9184 |
|
9185 |
|
9186 |
|
9187 |
|
9188 |
|
9189 |
|
9190 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
9191 | <dd class="tag-source">
|
9192 | <ul class="dummy">
|
9193 | <li>
|
9194 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
9195 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-567">line 567</a>
|
9196 | </li>
|
9197 | </ul>
|
9198 | </dd>
|
9199 |
|
9200 |
|
9201 |
|
9202 |
|
9203 |
|
9204 |
|
9205 |
|
9206 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
9207 | <dd class="tag-todo">
|
9208 | <ul>
|
9209 | <li>Allow to define a minimum length for the integer part of the "number" parameter, so it will fill with leading zeros if needed (when "stringify" is set to true). Think about allowing to define a maximum too.</li>
|
9210 | </ul>
|
9211 | </dd>
|
9212 |
|
9213 | </dl>
|
9214 |
|
9215 |
|
9216 |
|
9217 |
|
9218 |
|
9219 |
|
9220 |
|
9221 |
|
9222 |
|
9223 |
|
9224 |
|
9225 |
|
9226 |
|
9227 | <h5>Returns:</h5>
|
9228 |
|
9229 |
|
9230 | <div class="param-desc">
|
9231 | <p>Returns zero in the case a non-valid number has been provided.</p>
|
9232 | </div>
|
9233 |
|
9234 |
|
9235 |
|
9236 | <dl>
|
9237 | <dt>
|
9238 | Type
|
9239 | </dt>
|
9240 | <dd>
|
9241 |
|
9242 | <span class="param-type">integer</span>
|
9243 | |
|
9244 |
|
9245 | <span class="param-type">float</span>
|
9246 | |
|
9247 |
|
9248 | <span class="param-type">string</span>
|
9249 |
|
9250 |
|
9251 |
|
9252 | </dd>
|
9253 | </dl>
|
9254 |
|
9255 |
|
9256 |
|
9257 |
|
9258 |
|
9259 | </dd>
|
9260 |
|
9261 |
|
9262 |
|
9263 | <hr>
|
9264 | <dt>
|
9265 | <h4 class="name" id="CB_numberOfDecimalDigits"><span class="type-signature"></span>CB_numberOfDecimalDigits<span class="signature">()</span><span class="type-signature"></span></h4>
|
9266 |
|
9267 |
|
9268 | </dt>
|
9269 | <dd>
|
9270 |
|
9271 |
|
9272 | <div class="description">
|
9273 | <p>Alias for <a href="global.html#CB_countDecimalPart"><code>CB_countDecimalPart</code></a>.</p>
|
9274 | </div>
|
9275 |
|
9276 |
|
9277 |
|
9278 |
|
9279 |
|
9280 |
|
9281 |
|
9282 |
|
9283 |
|
9284 |
|
9285 | <dl class="details">
|
9286 |
|
9287 |
|
9288 |
|
9289 |
|
9290 |
|
9291 |
|
9292 |
|
9293 |
|
9294 |
|
9295 |
|
9296 |
|
9297 |
|
9298 |
|
9299 |
|
9300 |
|
9301 |
|
9302 |
|
9303 |
|
9304 |
|
9305 |
|
9306 |
|
9307 |
|
9308 |
|
9309 |
|
9310 |
|
9311 |
|
9312 |
|
9313 |
|
9314 |
|
9315 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
9316 | <dd class="tag-source">
|
9317 | <ul class="dummy">
|
9318 | <li>
|
9319 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
9320 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-608">line 608</a>
|
9321 | </li>
|
9322 | </ul>
|
9323 | </dd>
|
9324 |
|
9325 |
|
9326 |
|
9327 |
|
9328 |
|
9329 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
9330 | <dd class="tag-see">
|
9331 | <ul>
|
9332 | <li><a href="global.html#CB_countDecimalPart"><code>CB_countDecimalPart</code></a></li>
|
9333 | </ul>
|
9334 | </dd>
|
9335 |
|
9336 |
|
9337 |
|
9338 | </dl>
|
9339 |
|
9340 |
|
9341 |
|
9342 |
|
9343 |
|
9344 |
|
9345 |
|
9346 |
|
9347 |
|
9348 |
|
9349 |
|
9350 |
|
9351 |
|
9352 |
|
9353 |
|
9354 | </dd>
|
9355 |
|
9356 |
|
9357 |
|
9358 | <hr>
|
9359 | <dt>
|
9360 | <h4 class="name" id="CB_numberOfDecimals"><span class="type-signature"></span>CB_numberOfDecimals<span class="signature">()</span><span class="type-signature"></span></h4>
|
9361 |
|
9362 |
|
9363 | </dt>
|
9364 | <dd>
|
9365 |
|
9366 |
|
9367 | <div class="description">
|
9368 | <p>Alias for <a href="global.html#CB_countDecimalPart"><code>CB_countDecimalPart</code></a>.</p>
|
9369 | </div>
|
9370 |
|
9371 |
|
9372 |
|
9373 |
|
9374 |
|
9375 |
|
9376 |
|
9377 |
|
9378 |
|
9379 |
|
9380 | <dl class="details">
|
9381 |
|
9382 |
|
9383 |
|
9384 |
|
9385 |
|
9386 |
|
9387 |
|
9388 |
|
9389 |
|
9390 |
|
9391 |
|
9392 |
|
9393 |
|
9394 |
|
9395 |
|
9396 |
|
9397 |
|
9398 |
|
9399 |
|
9400 |
|
9401 |
|
9402 |
|
9403 |
|
9404 |
|
9405 |
|
9406 |
|
9407 |
|
9408 |
|
9409 |
|
9410 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
9411 | <dd class="tag-source">
|
9412 | <ul class="dummy">
|
9413 | <li>
|
9414 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
9415 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-603">line 603</a>
|
9416 | </li>
|
9417 | </ul>
|
9418 | </dd>
|
9419 |
|
9420 |
|
9421 |
|
9422 |
|
9423 |
|
9424 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
9425 | <dd class="tag-see">
|
9426 | <ul>
|
9427 | <li><a href="global.html#CB_countDecimalPart"><code>CB_countDecimalPart</code></a></li>
|
9428 | </ul>
|
9429 | </dd>
|
9430 |
|
9431 |
|
9432 |
|
9433 | </dl>
|
9434 |
|
9435 |
|
9436 |
|
9437 |
|
9438 |
|
9439 |
|
9440 |
|
9441 |
|
9442 |
|
9443 |
|
9444 |
|
9445 |
|
9446 |
|
9447 |
|
9448 |
|
9449 | </dd>
|
9450 |
|
9451 |
|
9452 |
|
9453 | <hr>
|
9454 | <dt>
|
9455 | <h4 class="name" id="CB_numberOfIntegerDigits"><span class="type-signature"></span>CB_numberOfIntegerDigits<span class="signature">()</span><span class="type-signature"></span></h4>
|
9456 |
|
9457 |
|
9458 | </dt>
|
9459 | <dd>
|
9460 |
|
9461 |
|
9462 | <div class="description">
|
9463 | <p>Alias for <a href="global.html#CB_countIntegerPart"><code>CB_countIntegerPart</code></a>.</p>
|
9464 | </div>
|
9465 |
|
9466 |
|
9467 |
|
9468 |
|
9469 |
|
9470 |
|
9471 |
|
9472 |
|
9473 |
|
9474 |
|
9475 | <dl class="details">
|
9476 |
|
9477 |
|
9478 |
|
9479 |
|
9480 |
|
9481 |
|
9482 |
|
9483 |
|
9484 |
|
9485 |
|
9486 |
|
9487 |
|
9488 |
|
9489 |
|
9490 |
|
9491 |
|
9492 |
|
9493 |
|
9494 |
|
9495 |
|
9496 |
|
9497 |
|
9498 |
|
9499 |
|
9500 |
|
9501 |
|
9502 |
|
9503 |
|
9504 |
|
9505 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
9506 | <dd class="tag-source">
|
9507 | <ul class="dummy">
|
9508 | <li>
|
9509 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
9510 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-639">line 639</a>
|
9511 | </li>
|
9512 | </ul>
|
9513 | </dd>
|
9514 |
|
9515 |
|
9516 |
|
9517 |
|
9518 |
|
9519 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
9520 | <dd class="tag-see">
|
9521 | <ul>
|
9522 | <li><a href="global.html#CB_countIntegerPart"><code>CB_countIntegerPart</code></a></li>
|
9523 | </ul>
|
9524 | </dd>
|
9525 |
|
9526 |
|
9527 |
|
9528 | </dl>
|
9529 |
|
9530 |
|
9531 |
|
9532 |
|
9533 |
|
9534 |
|
9535 |
|
9536 |
|
9537 |
|
9538 |
|
9539 |
|
9540 |
|
9541 |
|
9542 |
|
9543 |
|
9544 | </dd>
|
9545 |
|
9546 |
|
9547 |
|
9548 | <hr>
|
9549 | <dt>
|
9550 | <h4 class="name" id="CB_parseJSON"><span class="type-signature"></span>CB_parseJSON<span class="signature">(objectString [, reviver] [, returnValueOnFail] [, acceptUndefinedOrNull] [, onError])</span><span class="type-signature"> → {*}</span></h4>
|
9551 |
|
9552 |
|
9553 | </dt>
|
9554 | <dd>
|
9555 |
|
9556 |
|
9557 | <div class="description">
|
9558 | <p>Tries to parse a given string to convert it into a JSON object. Internally it will use the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse">JSON.parse</a> method or otherwise use <a href="https://bestiejs.github.io/json3/">JSON 3</a> instead.</p>
|
9559 | </div>
|
9560 |
|
9561 |
|
9562 |
|
9563 |
|
9564 |
|
9565 |
|
9566 |
|
9567 |
|
9568 | <h5>Parameters:</h5>
|
9569 |
|
9570 |
|
9571 | <table class="params table table-striped">
|
9572 | <thead>
|
9573 | <tr>
|
9574 |
|
9575 | <th style="width:12%; min-width:110px;">Name</th>
|
9576 |
|
9577 |
|
9578 | <th style="width:12%; min-width:110px;">Type</th>
|
9579 |
|
9580 |
|
9581 | <th style="width:12%; min-width:110px;">Argument</th>
|
9582 |
|
9583 |
|
9584 |
|
9585 | <th style="width:12%; min-width:110px;">Default</th>
|
9586 |
|
9587 |
|
9588 | <th class="last" style="min-width:310px;">Description</th>
|
9589 | </tr>
|
9590 | </thead>
|
9591 |
|
9592 | <tbody>
|
9593 |
|
9594 |
|
9595 | <tr>
|
9596 |
|
9597 | <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>objectString</code></td>
|
9598 |
|
9599 |
|
9600 | <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;">
|
9601 |
|
9602 |
|
9603 | <span class="param-type">string</span>
|
9604 |
|
9605 |
|
9606 |
|
9607 |
|
9608 | </td>
|
9609 |
|
9610 |
|
9611 | <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;">
|
9612 |
|
9613 |
|
9614 |
|
9615 |
|
9616 |
|
9617 | </td>
|
9618 |
|
9619 |
|
9620 |
|
9621 | <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;">
|
9622 |
|
9623 | </td>
|
9624 |
|
9625 |
|
9626 | <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 JSON object we want to parse, in string format. First parameter when calling the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse">JSON.parse</a> method (or equivalent)</p></td>
|
9627 | </tr>
|
9628 |
|
9629 |
|
9630 |
|
9631 | <tr>
|
9632 |
|
9633 | <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>reviver</code></td>
|
9634 |
|
9635 |
|
9636 | <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;">
|
9637 |
|
9638 |
|
9639 | <span class="param-type">function</span>
|
9640 |
|
9641 |
|
9642 |
|
9643 |
|
9644 | </td>
|
9645 |
|
9646 |
|
9647 | <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;">
|
9648 |
|
9649 | <optional><br>
|
9650 |
|
9651 |
|
9652 |
|
9653 |
|
9654 |
|
9655 | </td>
|
9656 |
|
9657 |
|
9658 |
|
9659 | <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;">
|
9660 |
|
9661 | </td>
|
9662 |
|
9663 |
|
9664 | <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>Second parameter when calling the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse">JSON.parse</a> method (or equivalent).</p></td>
|
9665 | </tr>
|
9666 |
|
9667 |
|
9668 |
|
9669 | <tr>
|
9670 |
|
9671 | <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>returnValueOnFail</code></td>
|
9672 |
|
9673 |
|
9674 | <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;">
|
9675 |
|
9676 |
|
9677 | <span class="param-type">*</span>
|
9678 |
|
9679 |
|
9680 |
|
9681 |
|
9682 | </td>
|
9683 |
|
9684 |
|
9685 | <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;">
|
9686 |
|
9687 | <optional><br>
|
9688 |
|
9689 |
|
9690 |
|
9691 |
|
9692 |
|
9693 | </td>
|
9694 |
|
9695 |
|
9696 |
|
9697 | <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;">
|
9698 |
|
9699 | </td>
|
9700 |
|
9701 |
|
9702 | <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 value we want it to return in the case it cannot be parsed. If not provided, undefined will be returned.</p></td>
|
9703 | </tr>
|
9704 |
|
9705 |
|
9706 |
|
9707 | <tr>
|
9708 |
|
9709 | <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>acceptUndefinedOrNull</code></td>
|
9710 |
|
9711 |
|
9712 | <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;">
|
9713 |
|
9714 |
|
9715 | <span class="param-type">boolean</span>
|
9716 |
|
9717 |
|
9718 |
|
9719 |
|
9720 | </td>
|
9721 |
|
9722 |
|
9723 | <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;">
|
9724 |
|
9725 | <optional><br>
|
9726 |
|
9727 |
|
9728 |
|
9729 |
|
9730 |
|
9731 | </td>
|
9732 |
|
9733 |
|
9734 |
|
9735 | <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;">
|
9736 |
|
9737 | false
|
9738 |
|
9739 | </td>
|
9740 |
|
9741 |
|
9742 | <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 it is set to true and the given objectString is undefined or null, an empty object ({}) will be used as the objectString.</p></td>
|
9743 | </tr>
|
9744 |
|
9745 |
|
9746 |
|
9747 | <tr>
|
9748 |
|
9749 | <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>
|
9750 |
|
9751 |
|
9752 | <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;">
|
9753 |
|
9754 |
|
9755 | <span class="param-type">function</span>
|
9756 |
|
9757 |
|
9758 |
|
9759 |
|
9760 | </td>
|
9761 |
|
9762 |
|
9763 | <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;">
|
9764 |
|
9765 | <optional><br>
|
9766 |
|
9767 |
|
9768 |
|
9769 |
|
9770 |
|
9771 | </td>
|
9772 |
|
9773 |
|
9774 |
|
9775 | <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;">
|
9776 |
|
9777 | </td>
|
9778 |
|
9779 |
|
9780 | <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 which will be called if it failed to be parsed (it will receive the "objectString" as the unique parameter).</p></td>
|
9781 | </tr>
|
9782 |
|
9783 |
|
9784 | </tbody>
|
9785 | </table>
|
9786 |
|
9787 |
|
9788 |
|
9789 |
|
9790 | <dl class="details">
|
9791 |
|
9792 |
|
9793 |
|
9794 |
|
9795 |
|
9796 |
|
9797 |
|
9798 |
|
9799 |
|
9800 |
|
9801 |
|
9802 |
|
9803 |
|
9804 |
|
9805 |
|
9806 |
|
9807 |
|
9808 |
|
9809 |
|
9810 |
|
9811 |
|
9812 |
|
9813 |
|
9814 |
|
9815 |
|
9816 |
|
9817 |
|
9818 |
|
9819 |
|
9820 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
9821 | <dd class="tag-source">
|
9822 | <ul class="dummy">
|
9823 | <li>
|
9824 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
9825 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-889">line 889</a>
|
9826 | </li>
|
9827 | </ul>
|
9828 | </dd>
|
9829 |
|
9830 |
|
9831 |
|
9832 |
|
9833 |
|
9834 |
|
9835 |
|
9836 | </dl>
|
9837 |
|
9838 |
|
9839 |
|
9840 |
|
9841 |
|
9842 |
|
9843 |
|
9844 |
|
9845 |
|
9846 |
|
9847 |
|
9848 |
|
9849 |
|
9850 | <h5>Returns:</h5>
|
9851 |
|
9852 |
|
9853 | <div class="param-desc">
|
9854 | <p>Returns the object parsed from the given string or the value of "returnValueOnFail" otherwise (which will be undefined if not provided).</p>
|
9855 | </div>
|
9856 |
|
9857 |
|
9858 |
|
9859 | <dl>
|
9860 | <dt>
|
9861 | Type
|
9862 | </dt>
|
9863 | <dd>
|
9864 |
|
9865 | <span class="param-type">*</span>
|
9866 |
|
9867 |
|
9868 |
|
9869 | </dd>
|
9870 | </dl>
|
9871 |
|
9872 |
|
9873 |
|
9874 |
|
9875 |
|
9876 | </dd>
|
9877 |
|
9878 |
|
9879 |
|
9880 | <hr>
|
9881 | <dt>
|
9882 | <h4 class="name" id="CB_parseString"><span class="type-signature"></span>CB_parseString<span class="signature">(element)</span><span class="type-signature"> → {string}</span></h4>
|
9883 |
|
9884 |
|
9885 | </dt>
|
9886 | <dd>
|
9887 |
|
9888 |
|
9889 | <div class="description">
|
9890 | <p>Returns back the given element as a string if it could be parsed or an empty string otherwise.</p>
|
9891 | </div>
|
9892 |
|
9893 |
|
9894 |
|
9895 |
|
9896 |
|
9897 |
|
9898 |
|
9899 |
|
9900 | <h5>Parameters:</h5>
|
9901 |
|
9902 |
|
9903 | <table class="params table table-striped">
|
9904 | <thead>
|
9905 | <tr>
|
9906 |
|
9907 | <th style="width:12%; min-width:110px;">Name</th>
|
9908 |
|
9909 |
|
9910 | <th style="width:12%; min-width:110px;">Type</th>
|
9911 |
|
9912 |
|
9913 |
|
9914 |
|
9915 |
|
9916 | <th class="last" style="min-width:310px;">Description</th>
|
9917 | </tr>
|
9918 | </thead>
|
9919 |
|
9920 | <tbody>
|
9921 |
|
9922 |
|
9923 | <tr>
|
9924 |
|
9925 | <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>
|
9926 |
|
9927 |
|
9928 | <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;">
|
9929 |
|
9930 |
|
9931 | <span class="param-type">*</span>
|
9932 |
|
9933 |
|
9934 |
|
9935 |
|
9936 | </td>
|
9937 |
|
9938 |
|
9939 |
|
9940 |
|
9941 |
|
9942 | <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 element that will be checked.</p></td>
|
9943 | </tr>
|
9944 |
|
9945 |
|
9946 | </tbody>
|
9947 | </table>
|
9948 |
|
9949 |
|
9950 |
|
9951 |
|
9952 | <dl class="details">
|
9953 |
|
9954 |
|
9955 |
|
9956 |
|
9957 |
|
9958 |
|
9959 |
|
9960 |
|
9961 |
|
9962 |
|
9963 |
|
9964 |
|
9965 |
|
9966 |
|
9967 |
|
9968 |
|
9969 |
|
9970 |
|
9971 |
|
9972 |
|
9973 |
|
9974 |
|
9975 |
|
9976 |
|
9977 |
|
9978 |
|
9979 |
|
9980 |
|
9981 |
|
9982 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
9983 | <dd class="tag-source">
|
9984 | <ul class="dummy">
|
9985 | <li>
|
9986 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
9987 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-251">line 251</a>
|
9988 | </li>
|
9989 | </ul>
|
9990 | </dd>
|
9991 |
|
9992 |
|
9993 |
|
9994 |
|
9995 |
|
9996 |
|
9997 |
|
9998 | </dl>
|
9999 |
|
10000 |
|
10001 |
|
10002 |
|
10003 |
|
10004 |
|
10005 |
|
10006 |
|
10007 |
|
10008 |
|
10009 |
|
10010 |
|
10011 |
|
10012 | <h5>Returns:</h5>
|
10013 |
|
10014 |
|
10015 |
|
10016 |
|
10017 | <dl>
|
10018 | <dt>
|
10019 | Type
|
10020 | </dt>
|
10021 | <dd>
|
10022 |
|
10023 | <span class="param-type">string</span>
|
10024 |
|
10025 |
|
10026 |
|
10027 | </dd>
|
10028 | </dl>
|
10029 |
|
10030 |
|
10031 |
|
10032 |
|
10033 |
|
10034 | </dd>
|
10035 |
|
10036 |
|
10037 |
|
10038 | <hr>
|
10039 | <dt>
|
10040 | <h4 class="name" id="CB_regularExpressionString"><span class="type-signature"></span>CB_regularExpressionString<span class="signature">(string [, allOccurrences] [, caseInsensitive])</span><span class="type-signature"> → {RegExp}</span></h4>
|
10041 |
|
10042 |
|
10043 | </dt>
|
10044 | <dd>
|
10045 |
|
10046 |
|
10047 | <div class="description">
|
10048 | <p>Returns a desired regular expression (escaping the string) using the native JavaScript's <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp">RegExp</a> from a given string.</p>
|
10049 | </div>
|
10050 |
|
10051 |
|
10052 |
|
10053 |
|
10054 |
|
10055 |
|
10056 |
|
10057 |
|
10058 | <h5>Parameters:</h5>
|
10059 |
|
10060 |
|
10061 | <table class="params table table-striped">
|
10062 | <thead>
|
10063 | <tr>
|
10064 |
|
10065 | <th style="width:12%; min-width:110px;">Name</th>
|
10066 |
|
10067 |
|
10068 | <th style="width:12%; min-width:110px;">Type</th>
|
10069 |
|
10070 |
|
10071 | <th style="width:12%; min-width:110px;">Argument</th>
|
10072 |
|
10073 |
|
10074 |
|
10075 | <th style="width:12%; min-width:110px;">Default</th>
|
10076 |
|
10077 |
|
10078 | <th class="last" style="min-width:310px;">Description</th>
|
10079 | </tr>
|
10080 | </thead>
|
10081 |
|
10082 | <tbody>
|
10083 |
|
10084 |
|
10085 | <tr>
|
10086 |
|
10087 | <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>string</code></td>
|
10088 |
|
10089 |
|
10090 | <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;">
|
10091 |
|
10092 |
|
10093 | <span class="param-type">string</span>
|
10094 |
|
10095 |
|
10096 |
|
10097 |
|
10098 | </td>
|
10099 |
|
10100 |
|
10101 | <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;">
|
10102 |
|
10103 |
|
10104 |
|
10105 |
|
10106 |
|
10107 | </td>
|
10108 |
|
10109 |
|
10110 |
|
10111 | <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;">
|
10112 |
|
10113 | </td>
|
10114 |
|
10115 |
|
10116 | <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 string (not a regular expression) that we want to use (special characters will be escaped).</p></td>
|
10117 | </tr>
|
10118 |
|
10119 |
|
10120 |
|
10121 | <tr>
|
10122 |
|
10123 | <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>allOccurrences</code></td>
|
10124 |
|
10125 |
|
10126 | <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;">
|
10127 |
|
10128 |
|
10129 | <span class="param-type">boolean</span>
|
10130 |
|
10131 |
|
10132 |
|
10133 |
|
10134 | </td>
|
10135 |
|
10136 |
|
10137 | <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;">
|
10138 |
|
10139 | <optional><br>
|
10140 |
|
10141 |
|
10142 |
|
10143 |
|
10144 |
|
10145 | </td>
|
10146 |
|
10147 |
|
10148 |
|
10149 | <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;">
|
10150 |
|
10151 | false
|
10152 |
|
10153 | </td>
|
10154 |
|
10155 |
|
10156 | <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 the regular expression returned to match all occurrences of the given string or only first found.</p></td>
|
10157 | </tr>
|
10158 |
|
10159 |
|
10160 |
|
10161 | <tr>
|
10162 |
|
10163 | <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>caseInsensitive</code></td>
|
10164 |
|
10165 |
|
10166 | <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;">
|
10167 |
|
10168 |
|
10169 | <span class="param-type">boolean</span>
|
10170 |
|
10171 |
|
10172 |
|
10173 |
|
10174 | </td>
|
10175 |
|
10176 |
|
10177 | <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;">
|
10178 |
|
10179 | <optional><br>
|
10180 |
|
10181 |
|
10182 |
|
10183 |
|
10184 |
|
10185 | </td>
|
10186 |
|
10187 |
|
10188 |
|
10189 | <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;">
|
10190 |
|
10191 | false
|
10192 |
|
10193 | </td>
|
10194 |
|
10195 |
|
10196 | <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 the regular expression returned to be case insensitive or not.</p></td>
|
10197 | </tr>
|
10198 |
|
10199 |
|
10200 | </tbody>
|
10201 | </table>
|
10202 |
|
10203 |
|
10204 |
|
10205 |
|
10206 | <dl class="details">
|
10207 |
|
10208 |
|
10209 |
|
10210 |
|
10211 |
|
10212 |
|
10213 |
|
10214 |
|
10215 |
|
10216 |
|
10217 |
|
10218 |
|
10219 |
|
10220 |
|
10221 |
|
10222 |
|
10223 |
|
10224 |
|
10225 |
|
10226 |
|
10227 |
|
10228 |
|
10229 |
|
10230 |
|
10231 |
|
10232 |
|
10233 |
|
10234 |
|
10235 |
|
10236 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
10237 | <dd class="tag-source">
|
10238 | <ul class="dummy">
|
10239 | <li>
|
10240 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
10241 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-1470">line 1470</a>
|
10242 | </li>
|
10243 | </ul>
|
10244 | </dd>
|
10245 |
|
10246 |
|
10247 |
|
10248 |
|
10249 |
|
10250 |
|
10251 |
|
10252 | </dl>
|
10253 |
|
10254 |
|
10255 |
|
10256 |
|
10257 |
|
10258 |
|
10259 |
|
10260 |
|
10261 |
|
10262 |
|
10263 |
|
10264 |
|
10265 |
|
10266 | <h5>Returns:</h5>
|
10267 |
|
10268 |
|
10269 | <div class="param-desc">
|
10270 | <p>Returns the desired regular expression (escaping the string) using the native JavaScript's <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp">RegExp</a> from a given string.</p>
|
10271 | </div>
|
10272 |
|
10273 |
|
10274 |
|
10275 | <dl>
|
10276 | <dt>
|
10277 | Type
|
10278 | </dt>
|
10279 | <dd>
|
10280 |
|
10281 | <span class="param-type">RegExp</span>
|
10282 |
|
10283 |
|
10284 |
|
10285 | </dd>
|
10286 | </dl>
|
10287 |
|
10288 |
|
10289 |
|
10290 |
|
10291 |
|
10292 | </dd>
|
10293 |
|
10294 |
|
10295 |
|
10296 | <hr>
|
10297 | <dt>
|
10298 | <h4 class="name" id="CB_renderString"><span class="type-signature"></span>CB_renderString<span class="signature">(str [, JSONObject] [, forceVanilla] [, depthLevelMax])</span><span class="type-signature"> → {str}</span></h4>
|
10299 |
|
10300 |
|
10301 | </dt>
|
10302 | <dd>
|
10303 |
|
10304 |
|
10305 | <div class="description">
|
10306 | <p>Processes a given string as a template and returns it rendered (if possible) with the values of the given JSON object.<br>
|
10307 | Tries to use <a href="https://handlebarsjs.com/">Handlebars</a> as the first choice but if is is not available it will just replace all occurrences with<br>
|
10308 | vanilla JavaScript.</p>
|
10309 | </div>
|
10310 |
|
10311 |
|
10312 |
|
10313 |
|
10314 |
|
10315 |
|
10316 |
|
10317 |
|
10318 | <h5>Parameters:</h5>
|
10319 |
|
10320 |
|
10321 | <table class="params table table-striped">
|
10322 | <thead>
|
10323 | <tr>
|
10324 |
|
10325 | <th style="width:12%; min-width:110px;">Name</th>
|
10326 |
|
10327 |
|
10328 | <th style="width:12%; min-width:110px;">Type</th>
|
10329 |
|
10330 |
|
10331 | <th style="width:12%; min-width:110px;">Argument</th>
|
10332 |
|
10333 |
|
10334 |
|
10335 | <th style="width:12%; min-width:110px;">Default</th>
|
10336 |
|
10337 |
|
10338 | <th class="last" style="min-width:310px;">Description</th>
|
10339 | </tr>
|
10340 | </thead>
|
10341 |
|
10342 | <tbody>
|
10343 |
|
10344 |
|
10345 | <tr>
|
10346 |
|
10347 | <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>str</code></td>
|
10348 |
|
10349 |
|
10350 | <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;">
|
10351 |
|
10352 |
|
10353 | <span class="param-type">string</span>
|
10354 |
|
10355 |
|
10356 |
|
10357 |
|
10358 | </td>
|
10359 |
|
10360 |
|
10361 | <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;">
|
10362 |
|
10363 |
|
10364 |
|
10365 |
|
10366 |
|
10367 | </td>
|
10368 |
|
10369 |
|
10370 |
|
10371 | <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;">
|
10372 |
|
10373 | </td>
|
10374 |
|
10375 |
|
10376 | <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 string we want to render.</p></td>
|
10377 | </tr>
|
10378 |
|
10379 |
|
10380 |
|
10381 | <tr>
|
10382 |
|
10383 | <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>JSONObject</code></td>
|
10384 |
|
10385 |
|
10386 | <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;">
|
10387 |
|
10388 |
|
10389 | <span class="param-type">Object</span>
|
10390 |
|
10391 |
|
10392 |
|
10393 |
|
10394 | </td>
|
10395 |
|
10396 |
|
10397 | <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;">
|
10398 |
|
10399 | <optional><br>
|
10400 |
|
10401 |
|
10402 |
|
10403 |
|
10404 |
|
10405 | </td>
|
10406 |
|
10407 |
|
10408 |
|
10409 | <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;">
|
10410 |
|
10411 | CB_JSONData
|
10412 |
|
10413 | </td>
|
10414 |
|
10415 |
|
10416 | <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 JSON object which contains the values. If not provided, it will try to use the global CB_JSONData object in the case it exists.</p></td>
|
10417 | </tr>
|
10418 |
|
10419 |
|
10420 |
|
10421 | <tr>
|
10422 |
|
10423 | <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>forceVanilla</code></td>
|
10424 |
|
10425 |
|
10426 | <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;">
|
10427 |
|
10428 |
|
10429 | <span class="param-type">boolean</span>
|
10430 |
|
10431 |
|
10432 |
|
10433 |
|
10434 | </td>
|
10435 |
|
10436 |
|
10437 | <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;">
|
10438 |
|
10439 | <optional><br>
|
10440 |
|
10441 |
|
10442 |
|
10443 |
|
10444 |
|
10445 | </td>
|
10446 |
|
10447 |
|
10448 |
|
10449 | <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;">
|
10450 |
|
10451 | false
|
10452 |
|
10453 | </td>
|
10454 |
|
10455 |
|
10456 | <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>Forces vanilla JavaScript rendering instead of using <a href="https://handlebarsjs.com/">Handlebars</a>.</p></td>
|
10457 | </tr>
|
10458 |
|
10459 |
|
10460 |
|
10461 | <tr>
|
10462 |
|
10463 | <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>depthLevelMax</code></td>
|
10464 |
|
10465 |
|
10466 | <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;">
|
10467 |
|
10468 |
|
10469 | <span class="param-type">integer</span>
|
10470 |
|
10471 |
|
10472 |
|
10473 |
|
10474 | </td>
|
10475 |
|
10476 |
|
10477 | <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;">
|
10478 |
|
10479 | <optional><br>
|
10480 |
|
10481 |
|
10482 |
|
10483 |
|
10484 |
|
10485 | </td>
|
10486 |
|
10487 |
|
10488 |
|
10489 | <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;">
|
10490 |
|
10491 | 10
|
10492 |
|
10493 | </td>
|
10494 |
|
10495 |
|
10496 | <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>Maximum depth level allowed to read the object to render the string. Only applies when it is rendered by vanilla JavaScript. For performance purposes.</p></td>
|
10497 | </tr>
|
10498 |
|
10499 |
|
10500 | </tbody>
|
10501 | </table>
|
10502 |
|
10503 |
|
10504 |
|
10505 |
|
10506 | <dl class="details">
|
10507 |
|
10508 |
|
10509 |
|
10510 |
|
10511 |
|
10512 |
|
10513 |
|
10514 |
|
10515 |
|
10516 |
|
10517 |
|
10518 |
|
10519 |
|
10520 |
|
10521 |
|
10522 |
|
10523 |
|
10524 |
|
10525 |
|
10526 |
|
10527 |
|
10528 |
|
10529 |
|
10530 |
|
10531 |
|
10532 |
|
10533 |
|
10534 |
|
10535 |
|
10536 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
10537 | <dd class="tag-source">
|
10538 | <ul class="dummy">
|
10539 | <li>
|
10540 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
10541 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-495">line 495</a>
|
10542 | </li>
|
10543 | </ul>
|
10544 | </dd>
|
10545 |
|
10546 |
|
10547 |
|
10548 |
|
10549 |
|
10550 |
|
10551 |
|
10552 | </dl>
|
10553 |
|
10554 |
|
10555 |
|
10556 |
|
10557 |
|
10558 |
|
10559 |
|
10560 |
|
10561 |
|
10562 |
|
10563 |
|
10564 |
|
10565 |
|
10566 | <h5>Returns:</h5>
|
10567 |
|
10568 |
|
10569 |
|
10570 |
|
10571 | <dl>
|
10572 | <dt>
|
10573 | Type
|
10574 | </dt>
|
10575 | <dd>
|
10576 |
|
10577 | <span class="param-type">str</span>
|
10578 |
|
10579 |
|
10580 |
|
10581 | </dd>
|
10582 | </dl>
|
10583 |
|
10584 |
|
10585 |
|
10586 |
|
10587 |
|
10588 | </dd>
|
10589 |
|
10590 |
|
10591 |
|
10592 | <hr>
|
10593 | <dt>
|
10594 | <h4 class="name" id="CB_replaceAll"><span class="type-signature"></span>CB_replaceAll<span class="signature">(stringOrArray, stringOrArrayFind [, stringReplace] [, caseInsensitive])</span><span class="type-signature"> → {string|array}</span></h4>
|
10595 |
|
10596 |
|
10597 | </dt>
|
10598 | <dd>
|
10599 |
|
10600 |
|
10601 | <div class="description">
|
10602 | <p>Returns the string or array of strings with all the desired occurrences replaced. Calls itself recursively and calls the <a href="global.html#CB_regularExpressionString"><code>CB_regularExpressionString</code></a> function internally.</p>
|
10603 | </div>
|
10604 |
|
10605 |
|
10606 |
|
10607 |
|
10608 |
|
10609 |
|
10610 |
|
10611 |
|
10612 | <h5>Parameters:</h5>
|
10613 |
|
10614 |
|
10615 | <table class="params table table-striped">
|
10616 | <thead>
|
10617 | <tr>
|
10618 |
|
10619 | <th style="width:12%; min-width:110px;">Name</th>
|
10620 |
|
10621 |
|
10622 | <th style="width:12%; min-width:110px;">Type</th>
|
10623 |
|
10624 |
|
10625 | <th style="width:12%; min-width:110px;">Argument</th>
|
10626 |
|
10627 |
|
10628 |
|
10629 | <th style="width:12%; min-width:110px;">Default</th>
|
10630 |
|
10631 |
|
10632 | <th class="last" style="min-width:310px;">Description</th>
|
10633 | </tr>
|
10634 | </thead>
|
10635 |
|
10636 | <tbody>
|
10637 |
|
10638 |
|
10639 | <tr>
|
10640 |
|
10641 | <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>stringOrArray</code></td>
|
10642 |
|
10643 |
|
10644 | <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;">
|
10645 |
|
10646 |
|
10647 | <span class="param-type">string</span>
|
10648 | |
|
10649 |
|
10650 | <span class="param-type">array</span>
|
10651 |
|
10652 |
|
10653 |
|
10654 |
|
10655 | </td>
|
10656 |
|
10657 |
|
10658 | <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;">
|
10659 |
|
10660 |
|
10661 |
|
10662 |
|
10663 |
|
10664 | </td>
|
10665 |
|
10666 |
|
10667 |
|
10668 | <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;">
|
10669 |
|
10670 | </td>
|
10671 |
|
10672 |
|
10673 | <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>An string or an array of strings whose content we want to replace. It can also be an array of arrays of strings (as many levels as you wish). If an array is given, it will not be modified and a copy from it will be generated and returned with the occurrences replaced.</p></td>
|
10674 | </tr>
|
10675 |
|
10676 |
|
10677 |
|
10678 | <tr>
|
10679 |
|
10680 | <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>stringOrArrayFind</code></td>
|
10681 |
|
10682 |
|
10683 | <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;">
|
10684 |
|
10685 |
|
10686 | <span class="param-type">string</span>
|
10687 | |
|
10688 |
|
10689 | <span class="param-type">array</span>
|
10690 |
|
10691 |
|
10692 |
|
10693 |
|
10694 | </td>
|
10695 |
|
10696 |
|
10697 | <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;">
|
10698 |
|
10699 |
|
10700 |
|
10701 |
|
10702 |
|
10703 | </td>
|
10704 |
|
10705 |
|
10706 |
|
10707 | <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;">
|
10708 |
|
10709 | </td>
|
10710 |
|
10711 |
|
10712 | <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>An string or an array of strings (not a regular expressions) that we want to find to be replaced (special characters will be escaped).</p></td>
|
10713 | </tr>
|
10714 |
|
10715 |
|
10716 |
|
10717 | <tr>
|
10718 |
|
10719 | <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>stringReplace</code></td>
|
10720 |
|
10721 |
|
10722 | <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;">
|
10723 |
|
10724 |
|
10725 | <span class="param-type">string</span>
|
10726 |
|
10727 |
|
10728 |
|
10729 |
|
10730 | </td>
|
10731 |
|
10732 |
|
10733 | <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;">
|
10734 |
|
10735 | <optional><br>
|
10736 |
|
10737 |
|
10738 |
|
10739 |
|
10740 |
|
10741 | </td>
|
10742 |
|
10743 |
|
10744 |
|
10745 | <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;">
|
10746 |
|
10747 | ""
|
10748 |
|
10749 | </td>
|
10750 |
|
10751 |
|
10752 | <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 string that will replace "stringFind". If not provided, it will be replaced as an empty string (it will just remove the occurrences found).</p></td>
|
10753 | </tr>
|
10754 |
|
10755 |
|
10756 |
|
10757 | <tr>
|
10758 |
|
10759 | <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>caseInsensitive</code></td>
|
10760 |
|
10761 |
|
10762 | <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;">
|
10763 |
|
10764 |
|
10765 | <span class="param-type">boolean</span>
|
10766 |
|
10767 |
|
10768 |
|
10769 |
|
10770 | </td>
|
10771 |
|
10772 |
|
10773 | <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;">
|
10774 |
|
10775 | <optional><br>
|
10776 |
|
10777 |
|
10778 |
|
10779 |
|
10780 |
|
10781 | </td>
|
10782 |
|
10783 |
|
10784 |
|
10785 | <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;">
|
10786 |
|
10787 | false
|
10788 |
|
10789 | </td>
|
10790 |
|
10791 |
|
10792 | <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 be case insensitive or not.</p></td>
|
10793 | </tr>
|
10794 |
|
10795 |
|
10796 | </tbody>
|
10797 | </table>
|
10798 |
|
10799 |
|
10800 |
|
10801 |
|
10802 | <dl class="details">
|
10803 |
|
10804 |
|
10805 |
|
10806 |
|
10807 |
|
10808 |
|
10809 |
|
10810 |
|
10811 |
|
10812 |
|
10813 |
|
10814 |
|
10815 |
|
10816 |
|
10817 |
|
10818 |
|
10819 |
|
10820 |
|
10821 |
|
10822 |
|
10823 |
|
10824 |
|
10825 |
|
10826 |
|
10827 |
|
10828 |
|
10829 |
|
10830 |
|
10831 |
|
10832 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
10833 | <dd class="tag-source">
|
10834 | <ul class="dummy">
|
10835 | <li>
|
10836 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
10837 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-1437">line 1437</a>
|
10838 | </li>
|
10839 | </ul>
|
10840 | </dd>
|
10841 |
|
10842 |
|
10843 |
|
10844 |
|
10845 |
|
10846 |
|
10847 |
|
10848 | </dl>
|
10849 |
|
10850 |
|
10851 |
|
10852 |
|
10853 |
|
10854 |
|
10855 |
|
10856 |
|
10857 |
|
10858 |
|
10859 |
|
10860 |
|
10861 |
|
10862 | <h5>Returns:</h5>
|
10863 |
|
10864 |
|
10865 | <div class="param-desc">
|
10866 | <p>Returns the "stringOrArray" given with occurrences replaced. If the "stringOrArray" given was neither a string nor an array, it will be returned without being modified.</p>
|
10867 | </div>
|
10868 |
|
10869 |
|
10870 |
|
10871 | <dl>
|
10872 | <dt>
|
10873 | Type
|
10874 | </dt>
|
10875 | <dd>
|
10876 |
|
10877 | <span class="param-type">string</span>
|
10878 | |
|
10879 |
|
10880 | <span class="param-type">array</span>
|
10881 |
|
10882 |
|
10883 |
|
10884 | </dd>
|
10885 | </dl>
|
10886 |
|
10887 |
|
10888 |
|
10889 |
|
10890 |
|
10891 | </dd>
|
10892 |
|
10893 |
|
10894 |
|
10895 | <hr>
|
10896 | <dt>
|
10897 | <h4 class="name" id="CB_rtrim"><span class="type-signature"></span>CB_rtrim<span class="signature">(element [, undesiredStrings])</span><span class="type-signature"> → {string|array}</span></h4>
|
10898 |
|
10899 |
|
10900 | </dt>
|
10901 | <dd>
|
10902 |
|
10903 |
|
10904 | <div class="description">
|
10905 | <p>Trims the right side of a given string or array of strings (modifying the given array), taking off the desired strings or otherwise trimming spaces, tabs ("\t"), new lines ("\n") and carriage returns ("\r"). Case sensitive.</p>
|
10906 | </div>
|
10907 |
|
10908 |
|
10909 |
|
10910 |
|
10911 |
|
10912 |
|
10913 |
|
10914 |
|
10915 | <h5>Parameters:</h5>
|
10916 |
|
10917 |
|
10918 | <table class="params table table-striped">
|
10919 | <thead>
|
10920 | <tr>
|
10921 |
|
10922 | <th style="width:12%; min-width:110px;">Name</th>
|
10923 |
|
10924 |
|
10925 | <th style="width:12%; min-width:110px;">Type</th>
|
10926 |
|
10927 |
|
10928 | <th style="width:12%; min-width:110px;">Argument</th>
|
10929 |
|
10930 |
|
10931 |
|
10932 | <th style="width:12%; min-width:110px;">Default</th>
|
10933 |
|
10934 |
|
10935 | <th class="last" style="min-width:310px;">Description</th>
|
10936 | </tr>
|
10937 | </thead>
|
10938 |
|
10939 | <tbody>
|
10940 |
|
10941 |
|
10942 | <tr>
|
10943 |
|
10944 | <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>
|
10945 |
|
10946 |
|
10947 | <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;">
|
10948 |
|
10949 |
|
10950 | <span class="param-type">string</span>
|
10951 | |
|
10952 |
|
10953 | <span class="param-type">array</span>
|
10954 |
|
10955 |
|
10956 |
|
10957 |
|
10958 | </td>
|
10959 |
|
10960 |
|
10961 | <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;">
|
10962 |
|
10963 |
|
10964 |
|
10965 |
|
10966 |
|
10967 | </td>
|
10968 |
|
10969 |
|
10970 |
|
10971 | <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;">
|
10972 |
|
10973 | </td>
|
10974 |
|
10975 |
|
10976 | <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 element that will be trimmed. It should be either a string or an array of strings.</p></td>
|
10977 | </tr>
|
10978 |
|
10979 |
|
10980 |
|
10981 | <tr>
|
10982 |
|
10983 | <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>undesiredStrings</code></td>
|
10984 |
|
10985 |
|
10986 | <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;">
|
10987 |
|
10988 |
|
10989 | <span class="param-type">string</span>
|
10990 | |
|
10991 |
|
10992 | <span class="param-type">array</span>
|
10993 |
|
10994 |
|
10995 |
|
10996 |
|
10997 | </td>
|
10998 |
|
10999 |
|
11000 | <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;">
|
11001 |
|
11002 | <optional><br>
|
11003 |
|
11004 |
|
11005 |
|
11006 |
|
11007 |
|
11008 | </td>
|
11009 |
|
11010 |
|
11011 |
|
11012 | <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;">
|
11013 |
|
11014 | [ " ", "\n", "\r", "\t" ]
|
11015 |
|
11016 | </td>
|
11017 |
|
11018 |
|
11019 | <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>String or an array with the strings that we want to trim off the given element.</p></td>
|
11020 | </tr>
|
11021 |
|
11022 |
|
11023 | </tbody>
|
11024 | </table>
|
11025 |
|
11026 |
|
11027 |
|
11028 |
|
11029 | <dl class="details">
|
11030 |
|
11031 |
|
11032 |
|
11033 |
|
11034 |
|
11035 |
|
11036 |
|
11037 |
|
11038 |
|
11039 |
|
11040 |
|
11041 |
|
11042 |
|
11043 |
|
11044 |
|
11045 |
|
11046 |
|
11047 |
|
11048 |
|
11049 |
|
11050 |
|
11051 |
|
11052 |
|
11053 |
|
11054 |
|
11055 |
|
11056 |
|
11057 |
|
11058 |
|
11059 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
11060 | <dd class="tag-source">
|
11061 | <ul class="dummy">
|
11062 | <li>
|
11063 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
11064 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-309">line 309</a>
|
11065 | </li>
|
11066 | </ul>
|
11067 | </dd>
|
11068 |
|
11069 |
|
11070 |
|
11071 |
|
11072 |
|
11073 |
|
11074 |
|
11075 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
11076 | <dd class="tag-todo">
|
11077 | <ul>
|
11078 | <li>Accept a "recursive" parameter (boolean) to affect multiple levels (array of arrays of strings, etc.).</li>
|
11079 |
|
11080 | <li>Consider accepting objects instead of arrays in the "element" parameter.</li>
|
11081 |
|
11082 | <li>Think about optimizing (using a counter for the number of occurrences in the loop and trim all the occurrences when finished).</li>
|
11083 | </ul>
|
11084 | </dd>
|
11085 |
|
11086 | </dl>
|
11087 |
|
11088 |
|
11089 |
|
11090 |
|
11091 |
|
11092 |
|
11093 |
|
11094 |
|
11095 |
|
11096 |
|
11097 |
|
11098 |
|
11099 |
|
11100 | <h5>Returns:</h5>
|
11101 |
|
11102 |
|
11103 | <div class="param-desc">
|
11104 | <p>Returns the given element again if it was an string, a number (it will be casted to a string) or an array of strings, trimmed if it has been possible. If it was another type, returns an empty string.</p>
|
11105 | </div>
|
11106 |
|
11107 |
|
11108 |
|
11109 | <dl>
|
11110 | <dt>
|
11111 | Type
|
11112 | </dt>
|
11113 | <dd>
|
11114 |
|
11115 | <span class="param-type">string</span>
|
11116 | |
|
11117 |
|
11118 | <span class="param-type">array</span>
|
11119 |
|
11120 |
|
11121 |
|
11122 | </dd>
|
11123 | </dl>
|
11124 |
|
11125 |
|
11126 |
|
11127 |
|
11128 |
|
11129 | </dd>
|
11130 |
|
11131 |
|
11132 |
|
11133 | <hr>
|
11134 | <dt>
|
11135 | <h4 class="name" id="CB_scriptPathCalculate"><span class="type-signature"></span>CB_scriptPathCalculate<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
|
11136 |
|
11137 |
|
11138 | </dt>
|
11139 | <dd>
|
11140 |
|
11141 |
|
11142 | <div class="description">
|
11143 | <p>Tries to calculate and returns the path where the script is located.</p>
|
11144 | </div>
|
11145 |
|
11146 |
|
11147 |
|
11148 |
|
11149 |
|
11150 |
|
11151 |
|
11152 |
|
11153 |
|
11154 |
|
11155 | <dl class="details">
|
11156 |
|
11157 |
|
11158 |
|
11159 |
|
11160 |
|
11161 |
|
11162 |
|
11163 |
|
11164 |
|
11165 |
|
11166 |
|
11167 |
|
11168 |
|
11169 |
|
11170 |
|
11171 |
|
11172 |
|
11173 |
|
11174 |
|
11175 |
|
11176 |
|
11177 |
|
11178 |
|
11179 |
|
11180 |
|
11181 |
|
11182 |
|
11183 |
|
11184 |
|
11185 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
11186 | <dd class="tag-source">
|
11187 | <ul class="dummy">
|
11188 | <li>
|
11189 | <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
|
11190 | <a href="CrossBrowdy.js.html#sunlight-1-line-1004">line 1004</a>
|
11191 | </li>
|
11192 | </ul>
|
11193 | </dd>
|
11194 |
|
11195 |
|
11196 |
|
11197 |
|
11198 |
|
11199 |
|
11200 |
|
11201 | </dl>
|
11202 |
|
11203 |
|
11204 |
|
11205 |
|
11206 |
|
11207 |
|
11208 |
|
11209 |
|
11210 |
|
11211 |
|
11212 |
|
11213 |
|
11214 |
|
11215 | <h5>Returns:</h5>
|
11216 |
|
11217 |
|
11218 | <div class="param-desc">
|
11219 | <p>If it cannot be calculated, it will returns the value of <code>CB_Configuration[CB_NAME].SCRIPT_PATH_DEFAULT</code>.</p>
|
11220 | </div>
|
11221 |
|
11222 |
|
11223 |
|
11224 | <dl>
|
11225 | <dt>
|
11226 | Type
|
11227 | </dt>
|
11228 | <dd>
|
11229 |
|
11230 | <span class="param-type">string</span>
|
11231 |
|
11232 |
|
11233 |
|
11234 | </dd>
|
11235 | </dl>
|
11236 |
|
11237 |
|
11238 |
|
11239 |
|
11240 |
|
11241 | </dd>
|
11242 |
|
11243 |
|
11244 |
|
11245 | <hr>
|
11246 | <dt>
|
11247 | <h4 class="name" id="CB_setCookie"><span class="type-signature"></span>CB_setCookie<span class="signature">(index, value [, days] [, path])</span><span class="type-signature"> → {boolean}</span></h4>
|
11248 |
|
11249 |
|
11250 | </dt>
|
11251 | <dd>
|
11252 |
|
11253 |
|
11254 | <div class="description">
|
11255 | <p>Stores a cookie.</p>
|
11256 | </div>
|
11257 |
|
11258 |
|
11259 |
|
11260 |
|
11261 |
|
11262 |
|
11263 |
|
11264 |
|
11265 | <h5>Parameters:</h5>
|
11266 |
|
11267 |
|
11268 | <table class="params table table-striped">
|
11269 | <thead>
|
11270 | <tr>
|
11271 |
|
11272 | <th style="width:12%; min-width:110px;">Name</th>
|
11273 |
|
11274 |
|
11275 | <th style="width:12%; min-width:110px;">Type</th>
|
11276 |
|
11277 |
|
11278 | <th style="width:12%; min-width:110px;">Argument</th>
|
11279 |
|
11280 |
|
11281 |
|
11282 |
|
11283 | <th class="last" style="min-width:310px;">Description</th>
|
11284 | </tr>
|
11285 | </thead>
|
11286 |
|
11287 | <tbody>
|
11288 |
|
11289 |
|
11290 | <tr>
|
11291 |
|
11292 | <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>index</code></td>
|
11293 |
|
11294 |
|
11295 | <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;">
|
11296 |
|
11297 |
|
11298 | <span class="param-type">string</span>
|
11299 | |
|
11300 |
|
11301 | <span class="param-type">number</span>
|
11302 |
|
11303 |
|
11304 |
|
11305 |
|
11306 | </td>
|
11307 |
|
11308 |
|
11309 | <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;">
|
11310 |
|
11311 |
|
11312 |
|
11313 |
|
11314 |
|
11315 | </td>
|
11316 |
|
11317 |
|
11318 |
|
11319 |
|
11320 | <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 index where the value given will be stored.</p></td>
|
11321 | </tr>
|
11322 |
|
11323 |
|
11324 |
|
11325 | <tr>
|
11326 |
|
11327 | <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>value</code></td>
|
11328 |
|
11329 |
|
11330 | <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;">
|
11331 |
|
11332 |
|
11333 | <span class="param-type">string</span>
|
11334 | |
|
11335 |
|
11336 | <span class="param-type">number</span>
|
11337 |
|
11338 |
|
11339 |
|
11340 |
|
11341 | </td>
|
11342 |
|
11343 |
|
11344 | <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;">
|
11345 |
|
11346 |
|
11347 |
|
11348 |
|
11349 |
|
11350 | </td>
|
11351 |
|
11352 |
|
11353 |
|
11354 |
|
11355 | <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 value we want to store. It should be a string or a number.</p></td>
|
11356 | </tr>
|
11357 |
|
11358 |
|
11359 |
|
11360 | <tr>
|
11361 |
|
11362 | <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>days</code></td>
|
11363 |
|
11364 |
|
11365 | <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;">
|
11366 |
|
11367 |
|
11368 | <span class="param-type">integer</span>
|
11369 |
|
11370 |
|
11371 |
|
11372 |
|
11373 | </td>
|
11374 |
|
11375 |
|
11376 | <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;">
|
11377 |
|
11378 | <optional><br>
|
11379 |
|
11380 |
|
11381 |
|
11382 |
|
11383 |
|
11384 | </td>
|
11385 |
|
11386 |
|
11387 |
|
11388 |
|
11389 | <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 number of days after which the cookie will expire. It belongs to the "expires=" parameter of the cookie. If not provided, the parameter will not be used at all.</p></td>
|
11390 | </tr>
|
11391 |
|
11392 |
|
11393 |
|
11394 | <tr>
|
11395 |
|
11396 | <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>path</code></td>
|
11397 |
|
11398 |
|
11399 | <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;">
|
11400 |
|
11401 |
|
11402 | <span class="param-type">string</span>
|
11403 |
|
11404 |
|
11405 |
|
11406 |
|
11407 | </td>
|
11408 |
|
11409 |
|
11410 | <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;">
|
11411 |
|
11412 | <optional><br>
|
11413 |
|
11414 |
|
11415 |
|
11416 |
|
11417 |
|
11418 | </td>
|
11419 |
|
11420 |
|
11421 |
|
11422 |
|
11423 | <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 path where the cookie will be stored. It belongs to the "path=" parameter of the cookie. If not provided, the parameter will not be used at all.</p></td>
|
11424 | </tr>
|
11425 |
|
11426 |
|
11427 | </tbody>
|
11428 | </table>
|
11429 |
|
11430 |
|
11431 |
|
11432 |
|
11433 | <dl class="details">
|
11434 |
|
11435 |
|
11436 |
|
11437 |
|
11438 |
|
11439 |
|
11440 |
|
11441 |
|
11442 |
|
11443 |
|
11444 |
|
11445 |
|
11446 |
|
11447 |
|
11448 |
|
11449 |
|
11450 |
|
11451 |
|
11452 |
|
11453 |
|
11454 |
|
11455 |
|
11456 |
|
11457 |
|
11458 |
|
11459 |
|
11460 |
|
11461 |
|
11462 |
|
11463 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
11464 | <dd class="tag-source">
|
11465 | <ul class="dummy">
|
11466 | <li>
|
11467 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
11468 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-764">line 764</a>
|
11469 | </li>
|
11470 | </ul>
|
11471 | </dd>
|
11472 |
|
11473 |
|
11474 |
|
11475 |
|
11476 |
|
11477 |
|
11478 |
|
11479 | </dl>
|
11480 |
|
11481 |
|
11482 |
|
11483 |
|
11484 |
|
11485 |
|
11486 |
|
11487 |
|
11488 |
|
11489 |
|
11490 |
|
11491 |
|
11492 |
|
11493 | <h5>Returns:</h5>
|
11494 |
|
11495 |
|
11496 | <div class="param-desc">
|
11497 | <p>Returns true if the value has been stored successfully (not totally reliable, it should be checked with <a href="global.html#CB_getCookie"><code>CB_getCookie</code></a> after a while).</p>
|
11498 | </div>
|
11499 |
|
11500 |
|
11501 |
|
11502 | <dl>
|
11503 | <dt>
|
11504 | Type
|
11505 | </dt>
|
11506 | <dd>
|
11507 |
|
11508 | <span class="param-type">boolean</span>
|
11509 |
|
11510 |
|
11511 |
|
11512 | </dd>
|
11513 | </dl>
|
11514 |
|
11515 |
|
11516 |
|
11517 |
|
11518 |
|
11519 | </dd>
|
11520 |
|
11521 |
|
11522 |
|
11523 | <hr>
|
11524 | <dt>
|
11525 | <h4 class="name" id="CB_setDatum"><span class="type-signature"></span>CB_setDatum<span class="signature">(index, value [, days] [, path] [, forceCookie])</span><span class="type-signature"> → {boolean}</span></h4>
|
11526 |
|
11527 |
|
11528 | </dt>
|
11529 | <dd>
|
11530 |
|
11531 |
|
11532 | <div class="description">
|
11533 | <p>Stores a value using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API">Web Storage API</a> (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage">localStorage</a>). It can use <a href="https://github.com/mortzdk/localStorage">localStorage</a> as a fallback or cookies instead.</p>
|
11534 | </div>
|
11535 |
|
11536 |
|
11537 |
|
11538 |
|
11539 |
|
11540 |
|
11541 |
|
11542 |
|
11543 | <h5>Parameters:</h5>
|
11544 |
|
11545 |
|
11546 | <table class="params table table-striped">
|
11547 | <thead>
|
11548 | <tr>
|
11549 |
|
11550 | <th style="width:12%; min-width:110px;">Name</th>
|
11551 |
|
11552 |
|
11553 | <th style="width:12%; min-width:110px;">Type</th>
|
11554 |
|
11555 |
|
11556 | <th style="width:12%; min-width:110px;">Argument</th>
|
11557 |
|
11558 |
|
11559 |
|
11560 | <th style="width:12%; min-width:110px;">Default</th>
|
11561 |
|
11562 |
|
11563 | <th class="last" style="min-width:310px;">Description</th>
|
11564 | </tr>
|
11565 | </thead>
|
11566 |
|
11567 | <tbody>
|
11568 |
|
11569 |
|
11570 | <tr>
|
11571 |
|
11572 | <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>index</code></td>
|
11573 |
|
11574 |
|
11575 | <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;">
|
11576 |
|
11577 |
|
11578 | <span class="param-type">string</span>
|
11579 | |
|
11580 |
|
11581 | <span class="param-type">number</span>
|
11582 |
|
11583 |
|
11584 |
|
11585 |
|
11586 | </td>
|
11587 |
|
11588 |
|
11589 | <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;">
|
11590 |
|
11591 |
|
11592 |
|
11593 |
|
11594 |
|
11595 | </td>
|
11596 |
|
11597 |
|
11598 |
|
11599 | <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;">
|
11600 |
|
11601 | </td>
|
11602 |
|
11603 |
|
11604 | <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 index where the value given will be stored.</p></td>
|
11605 | </tr>
|
11606 |
|
11607 |
|
11608 |
|
11609 | <tr>
|
11610 |
|
11611 | <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>value</code></td>
|
11612 |
|
11613 |
|
11614 | <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;">
|
11615 |
|
11616 |
|
11617 | <span class="param-type">string</span>
|
11618 | |
|
11619 |
|
11620 | <span class="param-type">number</span>
|
11621 |
|
11622 |
|
11623 |
|
11624 |
|
11625 | </td>
|
11626 |
|
11627 |
|
11628 | <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;">
|
11629 |
|
11630 |
|
11631 |
|
11632 |
|
11633 |
|
11634 | </td>
|
11635 |
|
11636 |
|
11637 |
|
11638 | <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;">
|
11639 |
|
11640 | </td>
|
11641 |
|
11642 |
|
11643 | <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 value we want to store. It should be a string or a number.</p></td>
|
11644 | </tr>
|
11645 |
|
11646 |
|
11647 |
|
11648 | <tr>
|
11649 |
|
11650 | <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>days</code></td>
|
11651 |
|
11652 |
|
11653 | <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;">
|
11654 |
|
11655 |
|
11656 | <span class="param-type">integer</span>
|
11657 |
|
11658 |
|
11659 |
|
11660 |
|
11661 | </td>
|
11662 |
|
11663 |
|
11664 | <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;">
|
11665 |
|
11666 | <optional><br>
|
11667 |
|
11668 |
|
11669 |
|
11670 |
|
11671 |
|
11672 | </td>
|
11673 |
|
11674 |
|
11675 |
|
11676 | <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;">
|
11677 |
|
11678 | </td>
|
11679 |
|
11680 |
|
11681 | <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 number of days after which the cookie will expire (in the case that cookies are used). It belongs to the "expires=" parameter of the cookie. If not provided, the parameter will not be used at all.</p></td>
|
11682 | </tr>
|
11683 |
|
11684 |
|
11685 |
|
11686 | <tr>
|
11687 |
|
11688 | <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>path</code></td>
|
11689 |
|
11690 |
|
11691 | <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;">
|
11692 |
|
11693 |
|
11694 | <span class="param-type">string</span>
|
11695 |
|
11696 |
|
11697 |
|
11698 |
|
11699 | </td>
|
11700 |
|
11701 |
|
11702 | <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;">
|
11703 |
|
11704 | <optional><br>
|
11705 |
|
11706 |
|
11707 |
|
11708 |
|
11709 |
|
11710 | </td>
|
11711 |
|
11712 |
|
11713 |
|
11714 | <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;">
|
11715 |
|
11716 | </td>
|
11717 |
|
11718 |
|
11719 | <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 path where the cookie will be stored (in the case that cookies are used). It belongs to the "path=" parameter of the cookie. If not provided, the parameter will not be used at all.</p></td>
|
11720 | </tr>
|
11721 |
|
11722 |
|
11723 |
|
11724 | <tr>
|
11725 |
|
11726 | <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>forceCookie</code></td>
|
11727 |
|
11728 |
|
11729 | <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;">
|
11730 |
|
11731 |
|
11732 | <span class="param-type">boolean</span>
|
11733 |
|
11734 |
|
11735 |
|
11736 |
|
11737 | </td>
|
11738 |
|
11739 |
|
11740 | <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;">
|
11741 |
|
11742 | <optional><br>
|
11743 |
|
11744 |
|
11745 |
|
11746 |
|
11747 |
|
11748 | </td>
|
11749 |
|
11750 |
|
11751 |
|
11752 | <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;">
|
11753 |
|
11754 | false
|
11755 |
|
11756 | </td>
|
11757 |
|
11758 |
|
11759 | <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>Forces to use cookies instead of <a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API">Web Storage API</a> (<a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage">localStorage</a>).</p></td>
|
11760 | </tr>
|
11761 |
|
11762 |
|
11763 | </tbody>
|
11764 | </table>
|
11765 |
|
11766 |
|
11767 |
|
11768 |
|
11769 | <dl class="details">
|
11770 |
|
11771 |
|
11772 |
|
11773 |
|
11774 |
|
11775 |
|
11776 |
|
11777 |
|
11778 |
|
11779 |
|
11780 |
|
11781 |
|
11782 |
|
11783 |
|
11784 |
|
11785 |
|
11786 |
|
11787 |
|
11788 |
|
11789 |
|
11790 |
|
11791 |
|
11792 |
|
11793 |
|
11794 |
|
11795 |
|
11796 |
|
11797 |
|
11798 |
|
11799 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
11800 | <dd class="tag-source">
|
11801 | <ul class="dummy">
|
11802 | <li>
|
11803 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
11804 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-718">line 718</a>
|
11805 | </li>
|
11806 | </ul>
|
11807 | </dd>
|
11808 |
|
11809 |
|
11810 |
|
11811 |
|
11812 |
|
11813 |
|
11814 |
|
11815 | </dl>
|
11816 |
|
11817 |
|
11818 |
|
11819 |
|
11820 |
|
11821 |
|
11822 |
|
11823 |
|
11824 |
|
11825 |
|
11826 |
|
11827 |
|
11828 |
|
11829 | <h5>Returns:</h5>
|
11830 |
|
11831 |
|
11832 | <div class="param-desc">
|
11833 | <p>Returns true if the value has been stored successfully (not totally reliable, it should be checked with <a href="global.html#CB_getDatum"><code>CB_getDatum</code></a> after a while).</p>
|
11834 | </div>
|
11835 |
|
11836 |
|
11837 |
|
11838 | <dl>
|
11839 | <dt>
|
11840 | Type
|
11841 | </dt>
|
11842 | <dd>
|
11843 |
|
11844 | <span class="param-type">boolean</span>
|
11845 |
|
11846 |
|
11847 |
|
11848 | </dd>
|
11849 | </dl>
|
11850 |
|
11851 |
|
11852 |
|
11853 |
|
11854 |
|
11855 | </dd>
|
11856 |
|
11857 |
|
11858 |
|
11859 | <hr>
|
11860 | <dt>
|
11861 | <h4 class="name" id="CB_sizeOf"><span class="type-signature"></span>CB_sizeOf<span class="signature">(element [, onlyOwn])</span><span class="type-signature"> → {integer}</span></h4>
|
11862 |
|
11863 |
|
11864 | </dt>
|
11865 | <dd>
|
11866 |
|
11867 |
|
11868 | <div class="description">
|
11869 | <p>Returns the size of an object or array.</p>
|
11870 | </div>
|
11871 |
|
11872 |
|
11873 |
|
11874 |
|
11875 |
|
11876 |
|
11877 |
|
11878 |
|
11879 | <h5>Parameters:</h5>
|
11880 |
|
11881 |
|
11882 | <table class="params table table-striped">
|
11883 | <thead>
|
11884 | <tr>
|
11885 |
|
11886 | <th style="width:12%; min-width:110px;">Name</th>
|
11887 |
|
11888 |
|
11889 | <th style="width:12%; min-width:110px;">Type</th>
|
11890 |
|
11891 |
|
11892 | <th style="width:12%; min-width:110px;">Argument</th>
|
11893 |
|
11894 |
|
11895 |
|
11896 | <th style="width:12%; min-width:110px;">Default</th>
|
11897 |
|
11898 |
|
11899 | <th class="last" style="min-width:310px;">Description</th>
|
11900 | </tr>
|
11901 | </thead>
|
11902 |
|
11903 | <tbody>
|
11904 |
|
11905 |
|
11906 | <tr>
|
11907 |
|
11908 | <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>
|
11909 |
|
11910 |
|
11911 | <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;">
|
11912 |
|
11913 |
|
11914 | <span class="param-type">Object</span>
|
11915 | |
|
11916 |
|
11917 | <span class="param-type">array</span>
|
11918 |
|
11919 |
|
11920 |
|
11921 |
|
11922 | </td>
|
11923 |
|
11924 |
|
11925 | <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;">
|
11926 |
|
11927 |
|
11928 |
|
11929 |
|
11930 |
|
11931 | </td>
|
11932 |
|
11933 |
|
11934 |
|
11935 | <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;">
|
11936 |
|
11937 | </td>
|
11938 |
|
11939 |
|
11940 | <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 element whose size we want to know. It should be an object or an array.</p></td>
|
11941 | </tr>
|
11942 |
|
11943 |
|
11944 |
|
11945 | <tr>
|
11946 |
|
11947 | <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>onlyOwn</code></td>
|
11948 |
|
11949 |
|
11950 | <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;">
|
11951 |
|
11952 |
|
11953 | <span class="param-type">boolean</span>
|
11954 |
|
11955 |
|
11956 |
|
11957 |
|
11958 | </td>
|
11959 |
|
11960 |
|
11961 | <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;">
|
11962 |
|
11963 | <optional><br>
|
11964 |
|
11965 |
|
11966 |
|
11967 |
|
11968 |
|
11969 | </td>
|
11970 |
|
11971 |
|
11972 |
|
11973 | <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;">
|
11974 |
|
11975 | false
|
11976 |
|
11977 | </td>
|
11978 |
|
11979 |
|
11980 | <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 the "element" given is not an object, this parameter will be ignored. Otherwise, if it is set to true, it will only have into account the properties which the object has as their own property and have not been inherited (using the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty">Object.hasOwnProperty</a> method).</p></td>
|
11981 | </tr>
|
11982 |
|
11983 |
|
11984 | </tbody>
|
11985 | </table>
|
11986 |
|
11987 |
|
11988 |
|
11989 |
|
11990 | <dl class="details">
|
11991 |
|
11992 |
|
11993 |
|
11994 |
|
11995 |
|
11996 |
|
11997 |
|
11998 |
|
11999 |
|
12000 |
|
12001 |
|
12002 |
|
12003 |
|
12004 |
|
12005 |
|
12006 |
|
12007 |
|
12008 |
|
12009 |
|
12010 |
|
12011 |
|
12012 |
|
12013 |
|
12014 |
|
12015 |
|
12016 |
|
12017 |
|
12018 |
|
12019 |
|
12020 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
12021 | <dd class="tag-source">
|
12022 | <ul class="dummy">
|
12023 | <li>
|
12024 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
12025 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-207">line 207</a>
|
12026 | </li>
|
12027 | </ul>
|
12028 | </dd>
|
12029 |
|
12030 |
|
12031 |
|
12032 |
|
12033 |
|
12034 |
|
12035 |
|
12036 | </dl>
|
12037 |
|
12038 |
|
12039 |
|
12040 |
|
12041 |
|
12042 |
|
12043 |
|
12044 |
|
12045 |
|
12046 |
|
12047 |
|
12048 |
|
12049 |
|
12050 | <h5>Returns:</h5>
|
12051 |
|
12052 |
|
12053 | <div class="param-desc">
|
12054 | <p>If an object is provided, the size will be the number of its properties. Otherwise, if an array is given, the size will be the numbers of its indexes (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/length">Array.length</a> property).</p>
|
12055 | </div>
|
12056 |
|
12057 |
|
12058 |
|
12059 | <dl>
|
12060 | <dt>
|
12061 | Type
|
12062 | </dt>
|
12063 | <dd>
|
12064 |
|
12065 | <span class="param-type">integer</span>
|
12066 |
|
12067 |
|
12068 |
|
12069 | </dd>
|
12070 | </dl>
|
12071 |
|
12072 |
|
12073 |
|
12074 |
|
12075 |
|
12076 | </dd>
|
12077 |
|
12078 |
|
12079 |
|
12080 | <hr>
|
12081 | <dt>
|
12082 | <h4 class="name" id="CB_sizeof"><span class="type-signature"></span>CB_sizeof<span class="signature">()</span><span class="type-signature"></span></h4>
|
12083 |
|
12084 |
|
12085 | </dt>
|
12086 | <dd>
|
12087 |
|
12088 |
|
12089 | <div class="description">
|
12090 | <p>Alias for <a href="global.html#CB_sizeOf"><code>CB_sizeOf</code></a>.</p>
|
12091 | </div>
|
12092 |
|
12093 |
|
12094 |
|
12095 |
|
12096 |
|
12097 |
|
12098 |
|
12099 |
|
12100 |
|
12101 |
|
12102 | <dl class="details">
|
12103 |
|
12104 |
|
12105 |
|
12106 |
|
12107 |
|
12108 |
|
12109 |
|
12110 |
|
12111 |
|
12112 |
|
12113 |
|
12114 |
|
12115 |
|
12116 |
|
12117 |
|
12118 |
|
12119 |
|
12120 |
|
12121 |
|
12122 |
|
12123 |
|
12124 |
|
12125 |
|
12126 |
|
12127 |
|
12128 |
|
12129 |
|
12130 |
|
12131 |
|
12132 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
12133 | <dd class="tag-source">
|
12134 | <ul class="dummy">
|
12135 | <li>
|
12136 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
12137 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-195">line 195</a>
|
12138 | </li>
|
12139 | </ul>
|
12140 | </dd>
|
12141 |
|
12142 |
|
12143 |
|
12144 |
|
12145 |
|
12146 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
12147 | <dd class="tag-see">
|
12148 | <ul>
|
12149 | <li><a href="global.html#CB_sizeOf"><code>CB_sizeOf</code></a></li>
|
12150 | </ul>
|
12151 | </dd>
|
12152 |
|
12153 |
|
12154 |
|
12155 | </dl>
|
12156 |
|
12157 |
|
12158 |
|
12159 |
|
12160 |
|
12161 |
|
12162 |
|
12163 |
|
12164 |
|
12165 |
|
12166 |
|
12167 |
|
12168 |
|
12169 |
|
12170 |
|
12171 | </dd>
|
12172 |
|
12173 |
|
12174 |
|
12175 | <hr>
|
12176 | <dt>
|
12177 | <h4 class="name" id="CB_stringifyJSON"><span class="type-signature"></span>CB_stringifyJSON<span class="signature">(objectOrValue [, replacer] [, space] [, returnValueOnFail] [, failIfUndefinedOrNull] [, onError])</span><span class="type-signature"> → {string}</span></h4>
|
12178 |
|
12179 |
|
12180 | </dt>
|
12181 | <dd>
|
12182 |
|
12183 |
|
12184 | <div class="description">
|
12185 | <p>Tries to create a JSON valid string from a given JSON object or value. Internally it will use the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify">JSON.stringify</a> method or otherwise use <a href="https://bestiejs.github.io/json3/">JSON 3</a> instead.</p>
|
12186 | </div>
|
12187 |
|
12188 |
|
12189 |
|
12190 |
|
12191 |
|
12192 |
|
12193 |
|
12194 |
|
12195 | <h5>Parameters:</h5>
|
12196 |
|
12197 |
|
12198 | <table class="params table table-striped">
|
12199 | <thead>
|
12200 | <tr>
|
12201 |
|
12202 | <th style="width:12%; min-width:110px;">Name</th>
|
12203 |
|
12204 |
|
12205 | <th style="width:12%; min-width:110px;">Type</th>
|
12206 |
|
12207 |
|
12208 | <th style="width:12%; min-width:110px;">Argument</th>
|
12209 |
|
12210 |
|
12211 |
|
12212 | <th style="width:12%; min-width:110px;">Default</th>
|
12213 |
|
12214 |
|
12215 | <th class="last" style="min-width:310px;">Description</th>
|
12216 | </tr>
|
12217 | </thead>
|
12218 |
|
12219 | <tbody>
|
12220 |
|
12221 |
|
12222 | <tr>
|
12223 |
|
12224 | <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>objectOrValue</code></td>
|
12225 |
|
12226 |
|
12227 | <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;">
|
12228 |
|
12229 |
|
12230 | <span class="param-type">*</span>
|
12231 |
|
12232 |
|
12233 |
|
12234 |
|
12235 | </td>
|
12236 |
|
12237 |
|
12238 | <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;">
|
12239 |
|
12240 |
|
12241 |
|
12242 |
|
12243 |
|
12244 | </td>
|
12245 |
|
12246 |
|
12247 |
|
12248 | <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;">
|
12249 |
|
12250 | </td>
|
12251 |
|
12252 |
|
12253 | <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 object or value that we want to stringify. First parameter when calling the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify">JSON.stringify</a> method (or equivalent).</p></td>
|
12254 | </tr>
|
12255 |
|
12256 |
|
12257 |
|
12258 | <tr>
|
12259 |
|
12260 | <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>replacer</code></td>
|
12261 |
|
12262 |
|
12263 | <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;">
|
12264 |
|
12265 |
|
12266 | <span class="param-type">function</span>
|
12267 |
|
12268 |
|
12269 |
|
12270 |
|
12271 | </td>
|
12272 |
|
12273 |
|
12274 | <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;">
|
12275 |
|
12276 | <optional><br>
|
12277 |
|
12278 |
|
12279 |
|
12280 |
|
12281 |
|
12282 | </td>
|
12283 |
|
12284 |
|
12285 |
|
12286 | <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;">
|
12287 |
|
12288 | </td>
|
12289 |
|
12290 |
|
12291 | <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>Second parameter when calling the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify">JSON.stringify</a> method (or equivalent).</p></td>
|
12292 | </tr>
|
12293 |
|
12294 |
|
12295 |
|
12296 | <tr>
|
12297 |
|
12298 | <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>space</code></td>
|
12299 |
|
12300 |
|
12301 | <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;">
|
12302 |
|
12303 |
|
12304 | <span class="param-type">string</span>
|
12305 | |
|
12306 |
|
12307 | <span class="param-type">integer</span>
|
12308 |
|
12309 |
|
12310 |
|
12311 |
|
12312 | </td>
|
12313 |
|
12314 |
|
12315 | <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;">
|
12316 |
|
12317 | <optional><br>
|
12318 |
|
12319 |
|
12320 |
|
12321 |
|
12322 |
|
12323 | </td>
|
12324 |
|
12325 |
|
12326 |
|
12327 | <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;">
|
12328 |
|
12329 | </td>
|
12330 |
|
12331 |
|
12332 | <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>Third parameter when calling the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify">JSON.stringify</a> method (or equivalent).</p></td>
|
12333 | </tr>
|
12334 |
|
12335 |
|
12336 |
|
12337 | <tr>
|
12338 |
|
12339 | <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>returnValueOnFail</code></td>
|
12340 |
|
12341 |
|
12342 | <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;">
|
12343 |
|
12344 |
|
12345 | <span class="param-type">*</span>
|
12346 |
|
12347 |
|
12348 |
|
12349 |
|
12350 | </td>
|
12351 |
|
12352 |
|
12353 | <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;">
|
12354 |
|
12355 | <optional><br>
|
12356 |
|
12357 |
|
12358 |
|
12359 |
|
12360 |
|
12361 | </td>
|
12362 |
|
12363 |
|
12364 |
|
12365 | <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;">
|
12366 |
|
12367 | </td>
|
12368 |
|
12369 |
|
12370 | <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 value we want it to return in the case it cannot be stringify. If not provided, undefined will be returned.</p></td>
|
12371 | </tr>
|
12372 |
|
12373 |
|
12374 |
|
12375 | <tr>
|
12376 |
|
12377 | <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>failIfUndefinedOrNull</code></td>
|
12378 |
|
12379 |
|
12380 | <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;">
|
12381 |
|
12382 |
|
12383 | <span class="param-type">boolean</span>
|
12384 |
|
12385 |
|
12386 |
|
12387 |
|
12388 | </td>
|
12389 |
|
12390 |
|
12391 | <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;">
|
12392 |
|
12393 | <optional><br>
|
12394 |
|
12395 |
|
12396 |
|
12397 |
|
12398 |
|
12399 | </td>
|
12400 |
|
12401 |
|
12402 |
|
12403 | <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;">
|
12404 |
|
12405 | false
|
12406 |
|
12407 | </td>
|
12408 |
|
12409 |
|
12410 | <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 it is set to true and the returning value is undefined or null, the value of "returnValueOnFail" will be returned.</p></td>
|
12411 | </tr>
|
12412 |
|
12413 |
|
12414 |
|
12415 | <tr>
|
12416 |
|
12417 | <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>
|
12418 |
|
12419 |
|
12420 | <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;">
|
12421 |
|
12422 |
|
12423 | <span class="param-type">function</span>
|
12424 |
|
12425 |
|
12426 |
|
12427 |
|
12428 | </td>
|
12429 |
|
12430 |
|
12431 | <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;">
|
12432 |
|
12433 | <optional><br>
|
12434 |
|
12435 |
|
12436 |
|
12437 |
|
12438 |
|
12439 | </td>
|
12440 |
|
12441 |
|
12442 |
|
12443 | <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;">
|
12444 |
|
12445 | </td>
|
12446 |
|
12447 |
|
12448 | <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 which will be called if it failed to be stringified (it will receive the "objectOrValue" as the unique parameter).</p></td>
|
12449 | </tr>
|
12450 |
|
12451 |
|
12452 | </tbody>
|
12453 | </table>
|
12454 |
|
12455 |
|
12456 |
|
12457 |
|
12458 | <dl class="details">
|
12459 |
|
12460 |
|
12461 |
|
12462 |
|
12463 |
|
12464 |
|
12465 |
|
12466 |
|
12467 |
|
12468 |
|
12469 |
|
12470 |
|
12471 |
|
12472 |
|
12473 |
|
12474 |
|
12475 |
|
12476 |
|
12477 |
|
12478 |
|
12479 |
|
12480 |
|
12481 |
|
12482 |
|
12483 |
|
12484 |
|
12485 |
|
12486 |
|
12487 |
|
12488 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
12489 | <dd class="tag-source">
|
12490 | <ul class="dummy">
|
12491 | <li>
|
12492 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
12493 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-917">line 917</a>
|
12494 | </li>
|
12495 | </ul>
|
12496 | </dd>
|
12497 |
|
12498 |
|
12499 |
|
12500 |
|
12501 |
|
12502 |
|
12503 |
|
12504 | </dl>
|
12505 |
|
12506 |
|
12507 |
|
12508 |
|
12509 |
|
12510 |
|
12511 |
|
12512 |
|
12513 |
|
12514 |
|
12515 |
|
12516 |
|
12517 |
|
12518 | <h5>Returns:</h5>
|
12519 |
|
12520 |
|
12521 | <div class="param-desc">
|
12522 | <p>Returns the object stringified from the given object or value if possible or the value of "returnValueOnFail" otherwise (which will be undefined if not provided). Avoids returning undefined or null if "failIfUndefinedOrNull" is set to true, returning the value of "returnValueOnFail" instead.</p>
|
12523 | </div>
|
12524 |
|
12525 |
|
12526 |
|
12527 | <dl>
|
12528 | <dt>
|
12529 | Type
|
12530 | </dt>
|
12531 | <dd>
|
12532 |
|
12533 | <span class="param-type">string</span>
|
12534 |
|
12535 |
|
12536 |
|
12537 | </dd>
|
12538 | </dl>
|
12539 |
|
12540 |
|
12541 |
|
12542 |
|
12543 |
|
12544 | </dd>
|
12545 |
|
12546 |
|
12547 |
|
12548 | <hr>
|
12549 | <dt>
|
12550 | <h4 class="name" id="CB_symmetricCall"><span class="type-signature"></span>CB_symmetricCall<span class="signature">(callbackFunction, timeMs [, id])</span><span class="type-signature"> → {number|null}</span></h4>
|
12551 |
|
12552 |
|
12553 | </dt>
|
12554 | <dd>
|
12555 |
|
12556 |
|
12557 | <div class="description">
|
12558 | <p>Calls the given function once through the native <a href="https://developer.mozilla.org/docs/Web/API/WindowOrWorkerGlobalScope/setTimeout">setTimeout</a> function internally but having in mind the time taken when the function was called previously so it can be called multiple times and respect a symmetric interval between each call (simulates <a href="https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame">requestAnimationFrame</a>).</p>
|
12559 | </div>
|
12560 |
|
12561 |
|
12562 |
|
12563 |
|
12564 |
|
12565 |
|
12566 |
|
12567 |
|
12568 | <h5>Parameters:</h5>
|
12569 |
|
12570 |
|
12571 | <table class="params table table-striped">
|
12572 | <thead>
|
12573 | <tr>
|
12574 |
|
12575 | <th style="width:12%; min-width:110px;">Name</th>
|
12576 |
|
12577 |
|
12578 | <th style="width:12%; min-width:110px;">Type</th>
|
12579 |
|
12580 |
|
12581 | <th style="width:12%; min-width:110px;">Argument</th>
|
12582 |
|
12583 |
|
12584 |
|
12585 | <th style="width:12%; min-width:110px;">Default</th>
|
12586 |
|
12587 |
|
12588 | <th class="last" style="min-width:310px;">Description</th>
|
12589 | </tr>
|
12590 | </thead>
|
12591 |
|
12592 | <tbody>
|
12593 |
|
12594 |
|
12595 | <tr>
|
12596 |
|
12597 | <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>
|
12598 |
|
12599 |
|
12600 | <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;">
|
12601 |
|
12602 |
|
12603 | <span class="param-type"><a href="global.html#CB_symmetricCall_CALLBACK">CB_symmetricCall_CALLBACK</a></span>
|
12604 |
|
12605 |
|
12606 |
|
12607 |
|
12608 | </td>
|
12609 |
|
12610 |
|
12611 | <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;">
|
12612 |
|
12613 |
|
12614 |
|
12615 |
|
12616 |
|
12617 | </td>
|
12618 |
|
12619 |
|
12620 |
|
12621 | <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;">
|
12622 |
|
12623 | </td>
|
12624 |
|
12625 |
|
12626 | <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 every time, receiving as the unique parameter the time (timestamp in milliseconds returned by the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Performance/now">performance.now</a> method, which could have been polyfilled automatically by CrossBrowdy) when it is called, being "this" the same "this" of the scope where it was called.</p></td>
|
12627 | </tr>
|
12628 |
|
12629 |
|
12630 |
|
12631 | <tr>
|
12632 |
|
12633 | <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>timeMs</code></td>
|
12634 |
|
12635 |
|
12636 | <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;">
|
12637 |
|
12638 |
|
12639 | <span class="param-type">integer</span>
|
12640 |
|
12641 |
|
12642 |
|
12643 |
|
12644 | </td>
|
12645 |
|
12646 |
|
12647 | <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;">
|
12648 |
|
12649 |
|
12650 |
|
12651 |
|
12652 |
|
12653 | </td>
|
12654 |
|
12655 |
|
12656 |
|
12657 | <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;">
|
12658 |
|
12659 | </td>
|
12660 |
|
12661 |
|
12662 | <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>Milliseconds between one call to the function and the next one. The accuracy will depend on many factors as the platform used, code performance, etc.</p></td>
|
12663 | </tr>
|
12664 |
|
12665 |
|
12666 |
|
12667 | <tr>
|
12668 |
|
12669 | <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>id</code></td>
|
12670 |
|
12671 |
|
12672 | <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;">
|
12673 |
|
12674 |
|
12675 | <span class="param-type">string</span>
|
12676 |
|
12677 |
|
12678 |
|
12679 |
|
12680 | </td>
|
12681 |
|
12682 |
|
12683 | <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;">
|
12684 |
|
12685 | <optional><br>
|
12686 |
|
12687 |
|
12688 |
|
12689 |
|
12690 |
|
12691 | </td>
|
12692 |
|
12693 |
|
12694 |
|
12695 | <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;">
|
12696 |
|
12697 | callbackFunction.toString()
|
12698 |
|
12699 | </td>
|
12700 |
|
12701 |
|
12702 | <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>String that will identify this symmetric interval. Recommended to avoid possible problems.</p></td>
|
12703 | </tr>
|
12704 |
|
12705 |
|
12706 | </tbody>
|
12707 | </table>
|
12708 |
|
12709 |
|
12710 |
|
12711 |
|
12712 | <dl class="details">
|
12713 |
|
12714 |
|
12715 |
|
12716 |
|
12717 |
|
12718 |
|
12719 |
|
12720 |
|
12721 |
|
12722 |
|
12723 |
|
12724 |
|
12725 |
|
12726 |
|
12727 |
|
12728 |
|
12729 |
|
12730 |
|
12731 |
|
12732 |
|
12733 |
|
12734 |
|
12735 |
|
12736 |
|
12737 |
|
12738 |
|
12739 |
|
12740 |
|
12741 |
|
12742 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
12743 | <dd class="tag-source">
|
12744 | <ul class="dummy">
|
12745 | <li>
|
12746 | <a href="CrossBase_general_CB_others.js.html">CrossBase/general/CB_others.js</a>,
|
12747 | <a href="CrossBase_general_CB_others.js.html#sunlight-1-line-25">line 25</a>
|
12748 | </li>
|
12749 | </ul>
|
12750 | </dd>
|
12751 |
|
12752 |
|
12753 |
|
12754 |
|
12755 |
|
12756 |
|
12757 |
|
12758 | </dl>
|
12759 |
|
12760 |
|
12761 |
|
12762 |
|
12763 |
|
12764 |
|
12765 |
|
12766 |
|
12767 |
|
12768 |
|
12769 |
|
12770 |
|
12771 |
|
12772 | <h5>Returns:</h5>
|
12773 |
|
12774 |
|
12775 | <div class="param-desc">
|
12776 | <p>Returns a numeric identifier generated by an internal call to the native <a href="https://developer.mozilla.org/docs/Web/API/WindowOrWorkerGlobalScope/setTimeout">setTimeout</a> function (can be cleared/cancelled with <a href="https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/clearTimeout">clearTimeout</a>). Returns null if the given "callbackFunction" is not a valid function.</p>
|
12777 | </div>
|
12778 |
|
12779 |
|
12780 |
|
12781 | <dl>
|
12782 | <dt>
|
12783 | Type
|
12784 | </dt>
|
12785 | <dd>
|
12786 |
|
12787 | <span class="param-type">number</span>
|
12788 | |
|
12789 |
|
12790 | <span class="param-type">null</span>
|
12791 |
|
12792 |
|
12793 |
|
12794 | </dd>
|
12795 | </dl>
|
12796 |
|
12797 |
|
12798 |
|
12799 |
|
12800 |
|
12801 | </dd>
|
12802 |
|
12803 |
|
12804 |
|
12805 | <hr>
|
12806 | <dt>
|
12807 | <h4 class="name" id="CB_symmetricCallClear"><span class="type-signature"></span>CB_symmetricCallClear<span class="signature">(id)</span><span class="type-signature"> → {boolean|null}</span></h4>
|
12808 |
|
12809 |
|
12810 | </dt>
|
12811 | <dd>
|
12812 |
|
12813 |
|
12814 | <div class="description">
|
12815 | <p>Clears the stored last time used by <a href="global.html#CB_symmetricCall"><code>CB_symmetricCall</code></a> for a given symmetric interval identifier.</p>
|
12816 | </div>
|
12817 |
|
12818 |
|
12819 |
|
12820 |
|
12821 |
|
12822 |
|
12823 |
|
12824 |
|
12825 | <h5>Parameters:</h5>
|
12826 |
|
12827 |
|
12828 | <table class="params table table-striped">
|
12829 | <thead>
|
12830 | <tr>
|
12831 |
|
12832 | <th style="width:12%; min-width:110px;">Name</th>
|
12833 |
|
12834 |
|
12835 | <th style="width:12%; min-width:110px;">Type</th>
|
12836 |
|
12837 |
|
12838 |
|
12839 |
|
12840 |
|
12841 | <th class="last" style="min-width:310px;">Description</th>
|
12842 | </tr>
|
12843 | </thead>
|
12844 |
|
12845 | <tbody>
|
12846 |
|
12847 |
|
12848 | <tr>
|
12849 |
|
12850 | <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>id</code></td>
|
12851 |
|
12852 |
|
12853 | <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;">
|
12854 |
|
12855 |
|
12856 | <span class="param-type">string</span>
|
12857 |
|
12858 |
|
12859 |
|
12860 |
|
12861 | </td>
|
12862 |
|
12863 |
|
12864 |
|
12865 |
|
12866 |
|
12867 | <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>String that identifies this symmetric interval.</p></td>
|
12868 | </tr>
|
12869 |
|
12870 |
|
12871 | </tbody>
|
12872 | </table>
|
12873 |
|
12874 |
|
12875 |
|
12876 |
|
12877 | <dl class="details">
|
12878 |
|
12879 |
|
12880 |
|
12881 |
|
12882 |
|
12883 |
|
12884 |
|
12885 |
|
12886 |
|
12887 |
|
12888 |
|
12889 |
|
12890 |
|
12891 |
|
12892 |
|
12893 |
|
12894 |
|
12895 |
|
12896 |
|
12897 |
|
12898 |
|
12899 |
|
12900 |
|
12901 |
|
12902 |
|
12903 |
|
12904 |
|
12905 |
|
12906 |
|
12907 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
12908 | <dd class="tag-source">
|
12909 | <ul class="dummy">
|
12910 | <li>
|
12911 | <a href="CrossBase_general_CB_others.js.html">CrossBase/general/CB_others.js</a>,
|
12912 | <a href="CrossBase_general_CB_others.js.html#sunlight-1-line-73">line 73</a>
|
12913 | </li>
|
12914 | </ul>
|
12915 | </dd>
|
12916 |
|
12917 |
|
12918 |
|
12919 |
|
12920 |
|
12921 |
|
12922 |
|
12923 | </dl>
|
12924 |
|
12925 |
|
12926 |
|
12927 |
|
12928 |
|
12929 |
|
12930 |
|
12931 |
|
12932 |
|
12933 |
|
12934 |
|
12935 |
|
12936 |
|
12937 | <h5>Returns:</h5>
|
12938 |
|
12939 |
|
12940 | <div class="param-desc">
|
12941 | <p>Returns null if the given "id" is not a valid string. Returns false if the stored time did not exist for the given "id" or it was cleared already. Returns true otherwise, after clearing it.</p>
|
12942 | </div>
|
12943 |
|
12944 |
|
12945 |
|
12946 | <dl>
|
12947 | <dt>
|
12948 | Type
|
12949 | </dt>
|
12950 | <dd>
|
12951 |
|
12952 | <span class="param-type">boolean</span>
|
12953 | |
|
12954 |
|
12955 | <span class="param-type">null</span>
|
12956 |
|
12957 |
|
12958 |
|
12959 | </dd>
|
12960 | </dl>
|
12961 |
|
12962 |
|
12963 |
|
12964 |
|
12965 |
|
12966 | </dd>
|
12967 |
|
12968 |
|
12969 |
|
12970 | <hr>
|
12971 | <dt>
|
12972 | <h4 class="name" id="CB_trim"><span class="type-signature"></span>CB_trim<span class="signature">(element [, undesiredStrings])</span><span class="type-signature"> → {string|array}</span></h4>
|
12973 |
|
12974 |
|
12975 | </dt>
|
12976 | <dd>
|
12977 |
|
12978 |
|
12979 | <div class="description">
|
12980 | <p>Trims a given string or array of strings (modifying the given array), taking off the desired strings or otherwise trimming spaces, tabs ("\t"), new lines ("\n") and carriage returns ("\r"). Case sensitive.</p>
|
12981 | </div>
|
12982 |
|
12983 |
|
12984 |
|
12985 |
|
12986 |
|
12987 |
|
12988 |
|
12989 |
|
12990 | <h5>Parameters:</h5>
|
12991 |
|
12992 |
|
12993 | <table class="params table table-striped">
|
12994 | <thead>
|
12995 | <tr>
|
12996 |
|
12997 | <th style="width:12%; min-width:110px;">Name</th>
|
12998 |
|
12999 |
|
13000 | <th style="width:12%; min-width:110px;">Type</th>
|
13001 |
|
13002 |
|
13003 | <th style="width:12%; min-width:110px;">Argument</th>
|
13004 |
|
13005 |
|
13006 |
|
13007 | <th style="width:12%; min-width:110px;">Default</th>
|
13008 |
|
13009 |
|
13010 | <th class="last" style="min-width:310px;">Description</th>
|
13011 | </tr>
|
13012 | </thead>
|
13013 |
|
13014 | <tbody>
|
13015 |
|
13016 |
|
13017 | <tr>
|
13018 |
|
13019 | <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>
|
13020 |
|
13021 |
|
13022 | <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;">
|
13023 |
|
13024 |
|
13025 | <span class="param-type">string</span>
|
13026 | |
|
13027 |
|
13028 | <span class="param-type">array</span>
|
13029 |
|
13030 |
|
13031 |
|
13032 |
|
13033 | </td>
|
13034 |
|
13035 |
|
13036 | <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;">
|
13037 |
|
13038 |
|
13039 |
|
13040 |
|
13041 |
|
13042 | </td>
|
13043 |
|
13044 |
|
13045 |
|
13046 | <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;">
|
13047 |
|
13048 | </td>
|
13049 |
|
13050 |
|
13051 | <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 element that will be trimmed. It should be either a string or an array of strings.</p></td>
|
13052 | </tr>
|
13053 |
|
13054 |
|
13055 |
|
13056 | <tr>
|
13057 |
|
13058 | <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>undesiredStrings</code></td>
|
13059 |
|
13060 |
|
13061 | <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;">
|
13062 |
|
13063 |
|
13064 | <span class="param-type">string</span>
|
13065 | |
|
13066 |
|
13067 | <span class="param-type">array</span>
|
13068 |
|
13069 |
|
13070 |
|
13071 |
|
13072 | </td>
|
13073 |
|
13074 |
|
13075 | <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;">
|
13076 |
|
13077 | <optional><br>
|
13078 |
|
13079 |
|
13080 |
|
13081 |
|
13082 |
|
13083 | </td>
|
13084 |
|
13085 |
|
13086 |
|
13087 | <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;">
|
13088 |
|
13089 | [ " ", "\n", "\r", "\t" ]
|
13090 |
|
13091 | </td>
|
13092 |
|
13093 |
|
13094 | <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>String or an array with the strings that we want to trim off the given element.</p></td>
|
13095 | </tr>
|
13096 |
|
13097 |
|
13098 | </tbody>
|
13099 | </table>
|
13100 |
|
13101 |
|
13102 |
|
13103 |
|
13104 | <dl class="details">
|
13105 |
|
13106 |
|
13107 |
|
13108 |
|
13109 |
|
13110 |
|
13111 |
|
13112 |
|
13113 |
|
13114 |
|
13115 |
|
13116 |
|
13117 |
|
13118 |
|
13119 |
|
13120 |
|
13121 |
|
13122 |
|
13123 |
|
13124 |
|
13125 |
|
13126 |
|
13127 |
|
13128 |
|
13129 |
|
13130 |
|
13131 |
|
13132 |
|
13133 |
|
13134 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
13135 | <dd class="tag-source">
|
13136 | <ul class="dummy">
|
13137 | <li>
|
13138 | <a href="CrossBase_general_CB_data.js.html">CrossBase/general/CB_data.js</a>,
|
13139 | <a href="CrossBase_general_CB_data.js.html#sunlight-1-line-267">line 267</a>
|
13140 | </li>
|
13141 | </ul>
|
13142 | </dd>
|
13143 |
|
13144 |
|
13145 |
|
13146 |
|
13147 |
|
13148 |
|
13149 |
|
13150 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
13151 | <dd class="tag-todo">
|
13152 | <ul>
|
13153 | <li>Accept a "recursive" parameter (boolean) to affect multiple levels (array of arrays of strings, etc.).</li>
|
13154 |
|
13155 | <li>Consider accepting objects instead of arrays in the "element" parameter.</li>
|
13156 | </ul>
|
13157 | </dd>
|
13158 |
|
13159 | </dl>
|
13160 |
|
13161 |
|
13162 |
|
13163 |
|
13164 |
|
13165 |
|
13166 |
|
13167 |
|
13168 |
|
13169 |
|
13170 |
|
13171 |
|
13172 |
|
13173 | <h5>Returns:</h5>
|
13174 |
|
13175 |
|
13176 | <div class="param-desc">
|
13177 | <p>Returns the given element again if it was an string, a number (it will be casted to a string) or an array of strings, trimmed if it has been possible. If it was another type, returns an empty string.</p>
|
13178 | </div>
|
13179 |
|
13180 |
|
13181 |
|
13182 | <dl>
|
13183 | <dt>
|
13184 | Type
|
13185 | </dt>
|
13186 | <dd>
|
13187 |
|
13188 | <span class="param-type">string</span>
|
13189 | |
|
13190 |
|
13191 | <span class="param-type">array</span>
|
13192 |
|
13193 |
|
13194 |
|
13195 | </dd>
|
13196 | </dl>
|
13197 |
|
13198 |
|
13199 |
|
13200 |
|
13201 |
|
13202 | </dd>
|
13203 |
|
13204 | </dl>
|
13205 |
|
13206 |
|
13207 |
|
13208 | <h3 class="subsection-title">Type Definitions</h3>
|
13209 |
|
13210 | <dl>
|
13211 |
|
13212 | <hr>
|
13213 | <dt>
|
13214 | <h4 class="name" id="CB_includeJSFile_CALLBACK"><span class="type-signature"></span>CB_includeJSFile_CALLBACK<span class="signature">(filepath, callbackOk, callbackError, timeoutMs, asynchronously)</span><span class="type-signature"></span></h4>
|
13215 |
|
13216 |
|
13217 | </dt>
|
13218 | <dd>
|
13219 |
|
13220 |
|
13221 | <div class="description">
|
13222 | <p>Callback for when the file is included successfully or fails to load.</p>
|
13223 | </div>
|
13224 |
|
13225 |
|
13226 |
|
13227 |
|
13228 |
|
13229 |
|
13230 |
|
13231 |
|
13232 | <h5>Parameters:</h5>
|
13233 |
|
13234 |
|
13235 | <table class="params table table-striped">
|
13236 | <thead>
|
13237 | <tr>
|
13238 |
|
13239 | <th style="width:12%; min-width:110px;">Name</th>
|
13240 |
|
13241 |
|
13242 | <th style="width:12%; min-width:110px;">Type</th>
|
13243 |
|
13244 |
|
13245 |
|
13246 |
|
13247 |
|
13248 | <th class="last" style="min-width:310px;">Description</th>
|
13249 | </tr>
|
13250 | </thead>
|
13251 |
|
13252 | <tbody>
|
13253 |
|
13254 |
|
13255 | <tr>
|
13256 |
|
13257 | <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>filepath</code></td>
|
13258 |
|
13259 |
|
13260 | <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;">
|
13261 |
|
13262 |
|
13263 | <span class="param-type">string</span>
|
13264 |
|
13265 |
|
13266 |
|
13267 |
|
13268 | </td>
|
13269 |
|
13270 |
|
13271 |
|
13272 |
|
13273 |
|
13274 | <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 'filepath' parameter when <a href="global.html#CB_includeJSFile"><code>CB_includeJSFile</code></a> was called (if any).</p></td>
|
13275 | </tr>
|
13276 |
|
13277 |
|
13278 |
|
13279 | <tr>
|
13280 |
|
13281 | <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>
|
13282 |
|
13283 |
|
13284 | <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;">
|
13285 |
|
13286 |
|
13287 | <span class="param-type"><a href="global.html#CB_includeJSFile_CALLBACK">CB_includeJSFile_CALLBACK</a></span>
|
13288 |
|
13289 |
|
13290 |
|
13291 |
|
13292 | </td>
|
13293 |
|
13294 |
|
13295 |
|
13296 |
|
13297 |
|
13298 | <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 'callbackOk' parameter when <a href="global.html#CB_includeJSFile"><code>CB_includeJSFile</code></a> was called (if any).</p></td>
|
13299 | </tr>
|
13300 |
|
13301 |
|
13302 |
|
13303 | <tr>
|
13304 |
|
13305 | <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>
|
13306 |
|
13307 |
|
13308 | <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;">
|
13309 |
|
13310 |
|
13311 | <span class="param-type"><a href="global.html#CB_includeJSFile_CALLBACK">CB_includeJSFile_CALLBACK</a></span>
|
13312 |
|
13313 |
|
13314 |
|
13315 |
|
13316 | </td>
|
13317 |
|
13318 |
|
13319 |
|
13320 |
|
13321 |
|
13322 | <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 'callbackError' parameter when <a href="global.html#CB_includeJSFile"><code>CB_includeJSFile</code></a> was called (if any).</p></td>
|
13323 | </tr>
|
13324 |
|
13325 |
|
13326 |
|
13327 | <tr>
|
13328 |
|
13329 | <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>timeoutMs</code></td>
|
13330 |
|
13331 |
|
13332 | <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;">
|
13333 |
|
13334 |
|
13335 | <span class="param-type">integer</span>
|
13336 |
|
13337 |
|
13338 |
|
13339 |
|
13340 | </td>
|
13341 |
|
13342 |
|
13343 |
|
13344 |
|
13345 |
|
13346 | <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 'timeoutMs' parameter when <a href="global.html#CB_includeJSFile"><code>CB_includeJSFile</code></a> was called (if any).</p></td>
|
13347 | </tr>
|
13348 |
|
13349 |
|
13350 |
|
13351 | <tr>
|
13352 |
|
13353 | <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>asynchronously</code></td>
|
13354 |
|
13355 |
|
13356 | <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;">
|
13357 |
|
13358 |
|
13359 | <span class="param-type">boolean</span>
|
13360 |
|
13361 |
|
13362 |
|
13363 |
|
13364 | </td>
|
13365 |
|
13366 |
|
13367 |
|
13368 |
|
13369 |
|
13370 | <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 'asynchronously' parameter when <a href="global.html#CB_includeJSFile"><code>CB_includeJSFile</code></a> was called (if any).</p></td>
|
13371 | </tr>
|
13372 |
|
13373 |
|
13374 | </tbody>
|
13375 | </table>
|
13376 |
|
13377 |
|
13378 |
|
13379 |
|
13380 | <dl class="details">
|
13381 |
|
13382 |
|
13383 |
|
13384 |
|
13385 |
|
13386 |
|
13387 |
|
13388 |
|
13389 |
|
13390 |
|
13391 |
|
13392 |
|
13393 |
|
13394 |
|
13395 |
|
13396 |
|
13397 |
|
13398 |
|
13399 |
|
13400 |
|
13401 |
|
13402 |
|
13403 |
|
13404 |
|
13405 |
|
13406 |
|
13407 |
|
13408 |
|
13409 |
|
13410 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
13411 | <dd class="tag-source">
|
13412 | <ul class="dummy">
|
13413 | <li>
|
13414 | <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
|
13415 | <a href="CrossBrowdy.js.html#sunlight-1-line-360">line 360</a>
|
13416 | </li>
|
13417 | </ul>
|
13418 | </dd>
|
13419 |
|
13420 |
|
13421 |
|
13422 |
|
13423 |
|
13424 |
|
13425 |
|
13426 | </dl>
|
13427 |
|
13428 |
|
13429 |
|
13430 |
|
13431 |
|
13432 |
|
13433 |
|
13434 |
|
13435 |
|
13436 |
|
13437 |
|
13438 |
|
13439 |
|
13440 |
|
13441 |
|
13442 | </dd>
|
13443 |
|
13444 |
|
13445 |
|
13446 | <hr>
|
13447 | <dt>
|
13448 | <h4 class="name" id="CB_includeRequiredFileErrorCallback"><span class="type-signature"></span>CB_includeRequiredFileErrorCallback<span class="signature">(filepath, callbackOk, callbackError, timeoutMs, asynchronously, filesRequested, filesLoaded)</span><span class="type-signature"></span></h4>
|
13449 |
|
13450 |
|
13451 | </dt>
|
13452 | <dd>
|
13453 |
|
13454 |
|
13455 | <div class="description">
|
13456 | <p>Callback for when the script is loaded successfully. Without parameters.</p>
|
13457 | </div>
|
13458 |
|
13459 |
|
13460 |
|
13461 |
|
13462 |
|
13463 |
|
13464 |
|
13465 |
|
13466 | <h5>Parameters:</h5>
|
13467 |
|
13468 |
|
13469 | <table class="params table table-striped">
|
13470 | <thead>
|
13471 | <tr>
|
13472 |
|
13473 | <th style="width:12%; min-width:110px;">Name</th>
|
13474 |
|
13475 |
|
13476 | <th style="width:12%; min-width:110px;">Type</th>
|
13477 |
|
13478 |
|
13479 |
|
13480 |
|
13481 |
|
13482 | <th class="last" style="min-width:310px;">Description</th>
|
13483 | </tr>
|
13484 | </thead>
|
13485 |
|
13486 | <tbody>
|
13487 |
|
13488 |
|
13489 | <tr>
|
13490 |
|
13491 | <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>filepath</code></td>
|
13492 |
|
13493 |
|
13494 | <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;">
|
13495 |
|
13496 |
|
13497 | <span class="param-type">string</span>
|
13498 |
|
13499 |
|
13500 |
|
13501 |
|
13502 | </td>
|
13503 |
|
13504 |
|
13505 |
|
13506 |
|
13507 |
|
13508 | <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 'filepath' parameter when <a href="global.html#CB_includeJSFile"><code>CB_includeJSFile</code></a> was called internally (if any).</p></td>
|
13509 | </tr>
|
13510 |
|
13511 |
|
13512 |
|
13513 | <tr>
|
13514 |
|
13515 | <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>
|
13516 |
|
13517 |
|
13518 | <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;">
|
13519 |
|
13520 |
|
13521 | <span class="param-type"><a href="global.html#CB_includeJSFile_CALLBACK">CB_includeJSFile_CALLBACK</a></span>
|
13522 |
|
13523 |
|
13524 |
|
13525 |
|
13526 | </td>
|
13527 |
|
13528 |
|
13529 |
|
13530 |
|
13531 |
|
13532 | <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 'callbackOk' parameter when <a href="global.html#CB_includeJSFile"><code>CB_includeJSFile</code></a> was called internally (if any).</p></td>
|
13533 | </tr>
|
13534 |
|
13535 |
|
13536 |
|
13537 | <tr>
|
13538 |
|
13539 | <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>
|
13540 |
|
13541 |
|
13542 | <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;">
|
13543 |
|
13544 |
|
13545 | <span class="param-type"><a href="global.html#CB_includeJSFile_CALLBACK">CB_includeJSFile_CALLBACK</a></span>
|
13546 |
|
13547 |
|
13548 |
|
13549 |
|
13550 | </td>
|
13551 |
|
13552 |
|
13553 |
|
13554 |
|
13555 |
|
13556 | <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 'callbackError' parameter when <a href="global.html#CB_includeJSFile"><code>CB_includeJSFile</code></a> was called internally (if any).</p></td>
|
13557 | </tr>
|
13558 |
|
13559 |
|
13560 |
|
13561 | <tr>
|
13562 |
|
13563 | <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>timeoutMs</code></td>
|
13564 |
|
13565 |
|
13566 | <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;">
|
13567 |
|
13568 |
|
13569 | <span class="param-type">integer</span>
|
13570 |
|
13571 |
|
13572 |
|
13573 |
|
13574 | </td>
|
13575 |
|
13576 |
|
13577 |
|
13578 |
|
13579 |
|
13580 | <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 'timeoutMs' parameter when <a href="global.html#CB_includeJSFile"><code>CB_includeJSFile</code></a> was called internally (if any).</p></td>
|
13581 | </tr>
|
13582 |
|
13583 |
|
13584 |
|
13585 | <tr>
|
13586 |
|
13587 | <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>asynchronously</code></td>
|
13588 |
|
13589 |
|
13590 | <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;">
|
13591 |
|
13592 |
|
13593 | <span class="param-type">boolean</span>
|
13594 |
|
13595 |
|
13596 |
|
13597 |
|
13598 | </td>
|
13599 |
|
13600 |
|
13601 |
|
13602 |
|
13603 |
|
13604 | <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 'asynchronously' parameter when <a href="global.html#CB_includeJSFile"><code>CB_includeJSFile</code></a> was called (if any).</p></td>
|
13605 | </tr>
|
13606 |
|
13607 |
|
13608 |
|
13609 | <tr>
|
13610 |
|
13611 | <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>filesRequested</code></td>
|
13612 |
|
13613 |
|
13614 | <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;">
|
13615 |
|
13616 |
|
13617 | <span class="param-type">object</span>
|
13618 |
|
13619 |
|
13620 |
|
13621 |
|
13622 | </td>
|
13623 |
|
13624 |
|
13625 |
|
13626 |
|
13627 |
|
13628 | <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>Object whose indexes are all the filepaths of the script files requested so far and the value is true when the file is still loading (or to be loaded in the future), false if it was loaded successfully (the most likely) or null if it failed to load.</p></td>
|
13629 | </tr>
|
13630 |
|
13631 |
|
13632 |
|
13633 | <tr>
|
13634 |
|
13635 | <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>filesLoaded</code></td>
|
13636 |
|
13637 |
|
13638 | <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;">
|
13639 |
|
13640 |
|
13641 | <span class="param-type">array</span>
|
13642 |
|
13643 |
|
13644 |
|
13645 |
|
13646 | </td>
|
13647 |
|
13648 |
|
13649 |
|
13650 |
|
13651 |
|
13652 | <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>Numeric array whose values are the filepaths of the script files loaded successfully so far.</p></td>
|
13653 | </tr>
|
13654 |
|
13655 |
|
13656 | </tbody>
|
13657 | </table>
|
13658 |
|
13659 |
|
13660 |
|
13661 |
|
13662 | <dl class="details">
|
13663 |
|
13664 |
|
13665 |
|
13666 |
|
13667 |
|
13668 |
|
13669 |
|
13670 |
|
13671 |
|
13672 |
|
13673 |
|
13674 |
|
13675 |
|
13676 |
|
13677 |
|
13678 |
|
13679 |
|
13680 |
|
13681 |
|
13682 |
|
13683 |
|
13684 |
|
13685 |
|
13686 |
|
13687 |
|
13688 |
|
13689 |
|
13690 |
|
13691 |
|
13692 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
13693 | <dd class="tag-source">
|
13694 | <ul class="dummy">
|
13695 | <li>
|
13696 | <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
|
13697 | <a href="CrossBrowdy.js.html#sunlight-1-line-485">line 485</a>
|
13698 | </li>
|
13699 | </ul>
|
13700 | </dd>
|
13701 |
|
13702 |
|
13703 |
|
13704 |
|
13705 |
|
13706 |
|
13707 |
|
13708 | </dl>
|
13709 |
|
13710 |
|
13711 |
|
13712 |
|
13713 |
|
13714 |
|
13715 |
|
13716 |
|
13717 |
|
13718 |
|
13719 |
|
13720 |
|
13721 |
|
13722 |
|
13723 |
|
13724 | </dd>
|
13725 |
|
13726 |
|
13727 |
|
13728 | <hr>
|
13729 | <dt>
|
13730 | <h4 class="name" id="CB_init_CALLBACK"><span class="type-signature"></span>CB_init_CALLBACK<span class="signature">()</span><span class="type-signature"></span></h4>
|
13731 |
|
13732 |
|
13733 | </dt>
|
13734 | <dd>
|
13735 |
|
13736 |
|
13737 | <div class="description">
|
13738 | <p>Callback for when the script is loaded successfully. Without parameters.</p>
|
13739 | </div>
|
13740 |
|
13741 |
|
13742 |
|
13743 |
|
13744 |
|
13745 |
|
13746 |
|
13747 |
|
13748 |
|
13749 |
|
13750 | <dl class="details">
|
13751 |
|
13752 |
|
13753 |
|
13754 |
|
13755 |
|
13756 |
|
13757 |
|
13758 |
|
13759 |
|
13760 |
|
13761 |
|
13762 |
|
13763 |
|
13764 |
|
13765 |
|
13766 |
|
13767 |
|
13768 |
|
13769 |
|
13770 |
|
13771 |
|
13772 |
|
13773 |
|
13774 |
|
13775 |
|
13776 |
|
13777 |
|
13778 |
|
13779 |
|
13780 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
13781 | <dd class="tag-source">
|
13782 | <ul class="dummy">
|
13783 | <li>
|
13784 | <a href="CrossBrowdy.js.html">CrossBrowdy.js</a>,
|
13785 | <a href="CrossBrowdy.js.html#sunlight-1-line-1035">line 1035</a>
|
13786 | </li>
|
13787 | </ul>
|
13788 | </dd>
|
13789 |
|
13790 |
|
13791 |
|
13792 |
|
13793 |
|
13794 |
|
13795 |
|
13796 | </dl>
|
13797 |
|
13798 |
|
13799 |
|
13800 |
|
13801 |
|
13802 |
|
13803 |
|
13804 |
|
13805 |
|
13806 |
|
13807 |
|
13808 |
|
13809 |
|
13810 |
|
13811 |
|
13812 | </dd>
|
13813 |
|
13814 |
|
13815 |
|
13816 | <hr>
|
13817 | <dt>
|
13818 | <h4 class="name" id="CB_symmetricCall_CALLBACK"><span class="type-signature"></span>CB_symmetricCall_CALLBACK<span class="signature">(expectedCallingTime)</span><span class="type-signature"></span></h4>
|
13819 |
|
13820 |
|
13821 | </dt>
|
13822 | <dd>
|
13823 |
|
13824 |
|
13825 | <div class="description">
|
13826 | <p>Callback that is called by <a href="global.html#CB_symmetricCall"><code>CB_symmetricCall</code></a>.</p>
|
13827 | </div>
|
13828 |
|
13829 |
|
13830 |
|
13831 |
|
13832 |
|
13833 |
|
13834 |
|
13835 |
|
13836 | <h5>Parameters:</h5>
|
13837 |
|
13838 |
|
13839 | <table class="params table table-striped">
|
13840 | <thead>
|
13841 | <tr>
|
13842 |
|
13843 | <th style="width:12%; min-width:110px;">Name</th>
|
13844 |
|
13845 |
|
13846 | <th style="width:12%; min-width:110px;">Type</th>
|
13847 |
|
13848 |
|
13849 |
|
13850 |
|
13851 |
|
13852 | <th class="last" style="min-width:310px;">Description</th>
|
13853 | </tr>
|
13854 | </thead>
|
13855 |
|
13856 | <tbody>
|
13857 |
|
13858 |
|
13859 | <tr>
|
13860 |
|
13861 | <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>expectedCallingTime</code></td>
|
13862 |
|
13863 |
|
13864 | <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;">
|
13865 |
|
13866 |
|
13867 | <span class="param-type">integer</span>
|
13868 |
|
13869 |
|
13870 |
|
13871 |
|
13872 | </td>
|
13873 |
|
13874 |
|
13875 |
|
13876 |
|
13877 |
|
13878 | <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 timestamp in milliseconds that represents when the callback should have been called (it will be more or less accurate depending on many factors as the platform used, code performance, etc.).</p></td>
|
13879 | </tr>
|
13880 |
|
13881 |
|
13882 | </tbody>
|
13883 | </table>
|
13884 |
|
13885 |
|
13886 |
|
13887 |
|
13888 | <dl class="details">
|
13889 |
|
13890 |
|
13891 |
|
13892 |
|
13893 |
|
13894 |
|
13895 |
|
13896 |
|
13897 |
|
13898 |
|
13899 |
|
13900 |
|
13901 |
|
13902 |
|
13903 |
|
13904 |
|
13905 |
|
13906 |
|
13907 |
|
13908 |
|
13909 |
|
13910 |
|
13911 |
|
13912 |
|
13913 |
|
13914 |
|
13915 |
|
13916 |
|
13917 |
|
13918 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
13919 | <dd class="tag-source">
|
13920 | <ul class="dummy">
|
13921 | <li>
|
13922 | <a href="CrossBase_general_CB_others.js.html">CrossBase/general/CB_others.js</a>,
|
13923 | <a href="CrossBase_general_CB_others.js.html#sunlight-1-line-9">line 9</a>
|
13924 | </li>
|
13925 | </ul>
|
13926 | </dd>
|
13927 |
|
13928 |
|
13929 |
|
13930 |
|
13931 |
|
13932 |
|
13933 |
|
13934 | </dl>
|
13935 |
|
13936 |
|
13937 |
|
13938 |
|
13939 |
|
13940 |
|
13941 |
|
13942 |
|
13943 |
|
13944 |
|
13945 |
|
13946 |
|
13947 |
|
13948 |
|
13949 |
|
13950 | </dd>
|
13951 |
|
13952 | </dl>
|
13953 |
|
13954 |
|
13955 |
|
13956 | </article>
|
13957 |
|
13958 | </section>
|
13959 |
|
13960 |
|
13961 |
|
13962 |
|
13963 | </div>
|
13964 | </div>
|
13965 |
|
13966 | <div class="clearfix"></div>
|
13967 |
|
13968 |
|
13969 | <div class="col-md-3">
|
13970 | <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md" style="display:none; visibility:hidden;"></div>
|
13971 | </div>
|
13972 |
|
13973 |
|
13974 | </div>
|
13975 | </div>
|
13976 |
|
13977 |
|
13978 | <div class="modal fade" id="searchResults">
|
13979 | <div class="modal-dialog">
|
13980 | <div class="modal-content">
|
13981 | <div class="modal-header">
|
13982 | <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
13983 | <h4 class="modal-title">Search results</h4>
|
13984 | </div>
|
13985 | <div class="modal-body"></div>
|
13986 | <div class="modal-footer">
|
13987 | <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
13988 | </div>
|
13989 | </div>
|
13990 | </div>
|
13991 | </div>
|
13992 |
|
13993 |
|
13994 | <footer>
|
13995 |
|
13996 |
|
13997 | <span class="copyright">
|
13998 | <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>
|
13999 | </span>
|
14000 |
|
14001 | <span class="jsdoc-message">
|
14002 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
|
14003 |
|
14004 | on Wed Mar 22nd 2023
|
14005 |
|
14006 | using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
|
14007 | </span>
|
14008 | </footer>
|
14009 |
|
14010 | <script src="scripts/docstrap.lib.js"></script>
|
14011 | <script src="scripts/toc.js"></script>
|
14012 |
|
14013 | <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
|
14014 |
|
14015 |
|
14016 | <script>
|
14017 | $( function () {
|
14018 | $( "[id*='$']" ).each( function () {
|
14019 | var $this = $( this );
|
14020 |
|
14021 | $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
|
14022 | } );
|
14023 |
|
14024 | $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
|
14025 | var $this = $( this );
|
14026 |
|
14027 | var example = $this.find( "code" );
|
14028 | exampleText = example.html();
|
14029 | var lang = /{@lang (.*?)}/.exec( exampleText );
|
14030 | if ( lang && lang[1] ) {
|
14031 | exampleText = exampleText.replace( lang[0], "" );
|
14032 | example.html( exampleText );
|
14033 | lang = lang[1];
|
14034 | } else {
|
14035 | var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
|
14036 | lang = langClassMatch ? langClassMatch[1] : "javascript";
|
14037 | }
|
14038 |
|
14039 | if ( lang ) {
|
14040 |
|
14041 | $this
|
14042 | .addClass( "sunlight-highlight-" + lang )
|
14043 | .addClass( "linenums" )
|
14044 | .html( example.html() );
|
14045 |
|
14046 | }
|
14047 | } );
|
14048 |
|
14049 | Sunlight.highlightAll( {
|
14050 | lineNumbers : true,
|
14051 | showMenu : true,
|
14052 | enableDoclinks : true
|
14053 | } );
|
14054 |
|
14055 | $.catchAnchorLinks( {
|
14056 | navbarOffset: 10
|
14057 | } );
|
14058 | $( "#toc" ).toc( {
|
14059 | anchorName : function ( i, heading, prefix ) {
|
14060 | return $( heading ).attr( "id" ) || ( prefix + i );
|
14061 | },
|
14062 | selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
|
14063 | showAndHide : false,
|
14064 | smoothScrolling: true
|
14065 | } );
|
14066 |
|
14067 | $( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
14068 | $( '.dropdown-toggle' ).dropdown();
|
14069 |
|
14070 | $( "table" ).each( function () {
|
14071 | var $this = $( this );
|
14072 | $this.addClass('table');
|
14073 | } );
|
14074 |
|
14075 | } );
|
14076 | </script>
|
14077 |
|
14078 |
|
14079 |
|
14080 |
|
14081 |
|
14082 |
|
14083 |
|
14084 |
|
14085 |
|
14086 |
|
14087 | <script type="text/javascript">
|
14088 | $(document).ready(function() {
|
14089 | SearcherDisplay.init();
|
14090 | });
|
14091 | </script>
|
14092 |
|
14093 |
|
14094 | </body>
|
14095 | </html> |
\ | No newline at end of file |