| 1 | <!DOCTYPE html>
|
| 2 | <html lang="en">
|
| 3 | <head>
|
| 4 | <meta charset="utf-8">
|
| 5 | <title>JSDoc: Class: GMP</title>
|
| 6 |
|
| 7 | <script src="scripts/prettify/prettify.js"> </script>
|
| 8 | <script src="scripts/prettify/lang-css.js"> </script>
|
| 9 | |
| 10 | |
| 11 |
|
| 12 | <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
| 13 | <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
| 14 | </head>
|
| 15 |
|
| 16 | <body>
|
| 17 |
|
| 18 | <div id="main">
|
| 19 |
|
| 20 | <h1 class="page-title">Class: GMP</h1>
|
| 21 |
|
| 22 |
|
| 23 |
|
| 24 |
|
| 25 |
|
| 26 |
|
| 27 | <section>
|
| 28 |
|
| 29 | <header>
|
| 30 |
|
| 31 | <h2>GMP</h2>
|
| 32 |
|
| 33 | <div class="class-description"><p>aaa</p></div>
|
| 34 |
|
| 35 |
|
| 36 | </header>
|
| 37 |
|
| 38 | <article>
|
| 39 | <div class="container-overview">
|
| 40 |
|
| 41 |
|
| 42 |
|
| 43 |
|
| 44 | <h2>Constructor</h2>
|
| 45 |
|
| 46 |
|
| 47 | <h4 class="name" id="GMP"><span class="type-signature"></span>new GMP<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
|
| 48 |
|
| 49 |
|
| 50 |
|
| 51 |
|
| 52 |
|
| 53 | <div class="description">
|
| 54 | <p>The exposed GMP constructor.</p>
|
| 55 | </div>
|
| 56 |
|
| 57 |
|
| 58 |
|
| 59 |
|
| 60 |
|
| 61 |
|
| 62 |
|
| 63 |
|
| 64 |
|
| 65 | <h5>Parameters:</h5>
|
| 66 |
|
| 67 |
|
| 68 | <table class="params">
|
| 69 | <thead>
|
| 70 | <tr>
|
| 71 |
|
| 72 | <th>Name</th>
|
| 73 |
|
| 74 |
|
| 75 | <th>Type</th>
|
| 76 |
|
| 77 |
|
| 78 | <th>Attributes</th>
|
| 79 |
|
| 80 |
|
| 81 |
|
| 82 |
|
| 83 | <th class="last">Description</th>
|
| 84 | </tr>
|
| 85 | </thead>
|
| 86 |
|
| 87 | <tbody>
|
| 88 |
|
| 89 |
|
| 90 | <tr>
|
| 91 |
|
| 92 | <td class="name"><code>options</code></td>
|
| 93 |
|
| 94 |
|
| 95 | <td class="type">
|
| 96 |
|
| 97 |
|
| 98 | <span class="param-type">Object</span>
|
| 99 |
|
| 100 |
|
| 101 |
|
| 102 | </td>
|
| 103 |
|
| 104 |
|
| 105 | <td class="attributes">
|
| 106 |
|
| 107 | <optional><br>
|
| 108 |
|
| 109 |
|
| 110 |
|
| 111 |
|
| 112 |
|
| 113 | </td>
|
| 114 |
|
| 115 |
|
| 116 |
|
| 117 |
|
| 118 | <td class="description last"></td>
|
| 119 | </tr>
|
| 120 |
|
| 121 |
|
| 122 | </tbody>
|
| 123 | </table>
|
| 124 |
|
| 125 |
|
| 126 |
|
| 127 |
|
| 128 |
|
| 129 |
|
| 130 | <dl class="details">
|
| 131 |
|
| 132 |
|
| 133 |
|
| 134 |
|
| 135 |
|
| 136 |
|
| 137 |
|
| 138 |
|
| 139 |
|
| 140 |
|
| 141 |
|
| 142 |
|
| 143 |
|
| 144 |
|
| 145 |
|
| 146 |
|
| 147 |
|
| 148 |
|
| 149 | <dt class="tag-author">Author:</dt>
|
| 150 | <dd class="tag-author">
|
| 151 | <ul>
|
| 152 | <li>zeromike</li>
|
| 153 | </ul>
|
| 154 | </dd>
|
| 155 |
|
| 156 |
|
| 157 |
|
| 158 |
|
| 159 |
|
| 160 |
|
| 161 |
|
| 162 |
|
| 163 |
|
| 164 | <dt class="tag-source">Source:</dt>
|
| 165 | <dd class="tag-source"><ul class="dummy"><li>
|
| 166 | <a href="gmp.js.html">gmp.js</a>, <a href="gmp.js.html#line30">line 30</a>
|
| 167 | </li></ul></dd>
|
| 168 |
|
| 169 |
|
| 170 |
|
| 171 |
|
| 172 |
|
| 173 |
|
| 174 |
|
| 175 | </dl>
|
| 176 |
|
| 177 |
|
| 178 |
|
| 179 |
|
| 180 |
|
| 181 |
|
| 182 |
|
| 183 |
|
| 184 |
|
| 185 |
|
| 186 |
|
| 187 |
|
| 188 |
|
| 189 |
|
| 190 |
|
| 191 | <h5>Example</h5>
|
| 192 |
|
| 193 | <pre class="prettyprint"><code>new GMP({
|
| 194 | data: '123',
|
| 195 | methods: {
|
| 196 | login: function () {
|
| 197 |
|
| 198 | }
|
| 199 | }
|
| 200 | })</code></pre>
|
| 201 |
|
| 202 |
|
| 203 |
|
| 204 |
|
| 205 | </div>
|
| 206 |
|
| 207 |
|
| 208 |
|
| 209 |
|
| 210 |
|
| 211 |
|
| 212 |
|
| 213 |
|
| 214 |
|
| 215 |
|
| 216 |
|
| 217 |
|
| 218 |
|
| 219 |
|
| 220 | <h3 class="subsection-title">Methods</h3>
|
| 221 |
|
| 222 |
|
| 223 |
|
| 224 |
|
| 225 |
|
| 226 |
|
| 227 | <h4 class="name" id="_init"><span class="type-signature"></span>_init<span class="signature">(options)</span><span class="type-signature"></span></h4>
|
| 228 |
|
| 229 |
|
| 230 |
|
| 231 |
|
| 232 |
|
| 233 | <div class="description">
|
| 234 | <p>The main init sequence. This is called for every
|
| 235 | instance, including ones that are created from extended
|
| 236 | constructors.</p>
|
| 237 | </div>
|
| 238 |
|
| 239 |
|
| 240 |
|
| 241 |
|
| 242 |
|
| 243 |
|
| 244 |
|
| 245 |
|
| 246 |
|
| 247 | <h5>Parameters:</h5>
|
| 248 |
|
| 249 |
|
| 250 | <table class="params">
|
| 251 | <thead>
|
| 252 | <tr>
|
| 253 |
|
| 254 | <th>Name</th>
|
| 255 |
|
| 256 |
|
| 257 | <th>Type</th>
|
| 258 |
|
| 259 |
|
| 260 |
|
| 261 |
|
| 262 |
|
| 263 | <th class="last">Description</th>
|
| 264 | </tr>
|
| 265 | </thead>
|
| 266 |
|
| 267 | <tbody>
|
| 268 |
|
| 269 |
|
| 270 | <tr>
|
| 271 |
|
| 272 | <td class="name"><code>options</code></td>
|
| 273 |
|
| 274 |
|
| 275 | <td class="type">
|
| 276 |
|
| 277 |
|
| 278 | <span class="param-type">Object</span>
|
| 279 |
|
| 280 |
|
| 281 |
|
| 282 | </td>
|
| 283 |
|
| 284 |
|
| 285 |
|
| 286 |
|
| 287 |
|
| 288 | <td class="description last"><p>this options object should be
|
| 289 | the result of merging class
|
| 290 | options and the options passed
|
| 291 | in to the constructor.</p></td>
|
| 292 | </tr>
|
| 293 |
|
| 294 |
|
| 295 | </tbody>
|
| 296 | </table>
|
| 297 |
|
| 298 |
|
| 299 |
|
| 300 |
|
| 301 |
|
| 302 |
|
| 303 | <dl class="details">
|
| 304 |
|
| 305 |
|
| 306 |
|
| 307 |
|
| 308 |
|
| 309 |
|
| 310 |
|
| 311 |
|
| 312 |
|
| 313 |
|
| 314 |
|
| 315 |
|
| 316 |
|
| 317 |
|
| 318 |
|
| 319 |
|
| 320 |
|
| 321 |
|
| 322 |
|
| 323 |
|
| 324 |
|
| 325 |
|
| 326 |
|
| 327 |
|
| 328 |
|
| 329 |
|
| 330 | <dt class="tag-source">Source:</dt>
|
| 331 | <dd class="tag-source"><ul class="dummy"><li>
|
| 332 | <a href="internal_init.js.html">internal/init.js</a>, <a href="internal_init.js.html#line17">line 17</a>
|
| 333 | </li></ul></dd>
|
| 334 |
|
| 335 |
|
| 336 |
|
| 337 |
|
| 338 |
|
| 339 |
|
| 340 |
|
| 341 | </dl>
|
| 342 |
|
| 343 |
|
| 344 |
|
| 345 |
|
| 346 |
|
| 347 |
|
| 348 |
|
| 349 |
|
| 350 |
|
| 351 |
|
| 352 |
|
| 353 |
|
| 354 |
|
| 355 |
|
| 356 |
|
| 357 |
|
| 358 |
|
| 359 |
|
| 360 |
|
| 361 |
|
| 362 |
|
| 363 | <h4 class="name" id="_initEvents"><span class="type-signature"></span>_initEvents<span class="signature">()</span><span class="type-signature"></span></h4>
|
| 364 |
|
| 365 |
|
| 366 |
|
| 367 |
|
| 368 |
|
| 369 | <div class="description">
|
| 370 | <p>Setup the instance's option events.
|
| 371 | If the value is a string, we pull it from the
|
| 372 | instance's methods by name.</p>
|
| 373 | </div>
|
| 374 |
|
| 375 |
|
| 376 |
|
| 377 |
|
| 378 |
|
| 379 |
|
| 380 |
|
| 381 |
|
| 382 |
|
| 383 |
|
| 384 |
|
| 385 |
|
| 386 |
|
| 387 | <dl class="details">
|
| 388 |
|
| 389 |
|
| 390 |
|
| 391 |
|
| 392 |
|
| 393 |
|
| 394 |
|
| 395 |
|
| 396 |
|
| 397 |
|
| 398 |
|
| 399 |
|
| 400 |
|
| 401 |
|
| 402 |
|
| 403 |
|
| 404 |
|
| 405 |
|
| 406 |
|
| 407 |
|
| 408 |
|
| 409 |
|
| 410 |
|
| 411 |
|
| 412 |
|
| 413 |
|
| 414 | <dt class="tag-source">Source:</dt>
|
| 415 | <dd class="tag-source"><ul class="dummy"><li>
|
| 416 | <a href="internal_events.js.html">internal/events.js</a>, <a href="internal_events.js.html#line11">line 11</a>
|
| 417 | </li></ul></dd>
|
| 418 |
|
| 419 |
|
| 420 |
|
| 421 |
|
| 422 |
|
| 423 |
|
| 424 |
|
| 425 | </dl>
|
| 426 |
|
| 427 |
|
| 428 |
|
| 429 |
|
| 430 |
|
| 431 |
|
| 432 |
|
| 433 |
|
| 434 |
|
| 435 |
|
| 436 |
|
| 437 |
|
| 438 |
|
| 439 |
|
| 440 |
|
| 441 |
|
| 442 |
|
| 443 |
|
| 444 |
|
| 445 |
|
| 446 |
|
| 447 | <h4 class="name" id="_initState"><span class="type-signature"></span>_initState<span class="signature">()</span><span class="type-signature"></span></h4>
|
| 448 |
|
| 449 |
|
| 450 |
|
| 451 |
|
| 452 |
|
| 453 | <div class="description">
|
| 454 | <p>Setup the scope of an instance, which contains:</p>
|
| 455 | <ul>
|
| 456 | <li>observed data</li>
|
| 457 | </ul>
|
| 458 | </div>
|
| 459 |
|
| 460 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 464 |
|
| 465 |
|
| 466 |
|
| 467 |
|
| 468 |
|
| 469 |
|
| 470 |
|
| 471 |
|
| 472 | <dl class="details">
|
| 473 |
|
| 474 |
|
| 475 |
|
| 476 |
|
| 477 |
|
| 478 |
|
| 479 |
|
| 480 |
|
| 481 |
|
| 482 |
|
| 483 |
|
| 484 |
|
| 485 |
|
| 486 |
|
| 487 |
|
| 488 |
|
| 489 |
|
| 490 |
|
| 491 |
|
| 492 |
|
| 493 |
|
| 494 |
|
| 495 |
|
| 496 |
|
| 497 |
|
| 498 |
|
| 499 | <dt class="tag-source">Source:</dt>
|
| 500 | <dd class="tag-source"><ul class="dummy"><li>
|
| 501 | <a href="internal_state.js.html">internal/state.js</a>, <a href="internal_state.js.html#line10">line 10</a>
|
| 502 | </li></ul></dd>
|
| 503 |
|
| 504 |
|
| 505 |
|
| 506 |
|
| 507 |
|
| 508 |
|
| 509 |
|
| 510 | </dl>
|
| 511 |
|
| 512 |
|
| 513 |
|
| 514 |
|
| 515 |
|
| 516 |
|
| 517 |
|
| 518 |
|
| 519 |
|
| 520 |
|
| 521 |
|
| 522 |
|
| 523 |
|
| 524 |
|
| 525 |
|
| 526 |
|
| 527 |
|
| 528 |
|
| 529 |
|
| 530 |
|
| 531 |
|
| 532 |
|
| 533 | </article>
|
| 534 |
|
| 535 | </section>
|
| 536 |
|
| 537 |
|
| 538 |
|
| 539 |
|
| 540 | </div>
|
| 541 |
|
| 542 | <nav>
|
| 543 | <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GMP.html">GMP</a></li></ul><h3>Global</h3><ul><li><a href="global.html#delegateEventSplitter">delegateEventSplitter</a></li><li><a href="global.html#uid">uid</a></li></ul>
|
| 544 | </nav>
|
| 545 |
|
| 546 | <br class="clear">
|
| 547 |
|
| 548 | <footer>
|
| 549 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.2</a> on Wed Oct 19 2016 10:19:24 GMT+0800 (CST)
|
| 550 | </footer>
|
| 551 |
|
| 552 | <script> prettyPrint(); </script>
|
| 553 | <script src="scripts/linenumber.js"> </script>
|
| 554 | </body>
|
| 555 | </html> |
| \ | No newline at end of file |