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