1 | <!DOCTYPE html>
|
---|
2 | <html>
|
---|
3 | <head>
|
---|
4 | <meta charset="UTF-8">
|
---|
5 | <title>PaperScript</title>
|
---|
6 | <base target="class-frame">
|
---|
7 | <link href="../assets/css/docs.css" rel="stylesheet" type="text/css">
|
---|
8 | <script src="../assets/js/paper.js"></script>
|
---|
9 | <script src="../assets/js/jquery.js"></script>
|
---|
10 | <script src="../assets/js/codemirror.js"></script>
|
---|
11 | <script src="../assets/js/docs.js"></script>
|
---|
12 | </head>
|
---|
13 | <body class="reference">
|
---|
14 | <div class="reference-class">
|
---|
15 | <h1>PaperScript</h1>
|
---|
16 |
|
---|
17 |
|
---|
18 |
|
---|
19 | </div>
|
---|
20 |
|
---|
21 |
|
---|
22 |
|
---|
23 |
|
---|
24 |
|
---|
25 |
|
---|
26 |
|
---|
27 |
|
---|
28 | <div class="reference-members"><h2>Static Methods</h2>
|
---|
29 |
|
---|
30 |
|
---|
31 | <div id="compile-code" class="member">
|
---|
32 | <div class="member-link">
|
---|
33 | <a name="compile-code" href="#compile-code"><tt><b>PaperScript.compile</b>(code)</tt></a>
|
---|
34 | </div>
|
---|
35 | <div class="member-description hidden">
|
---|
36 | <div class="member-text">
|
---|
37 | <p>Compiles PaperScript code into JavaScript code.</p>
|
---|
38 |
|
---|
39 | <ul><b>Parameters:</b>
|
---|
40 |
|
---|
41 | <li>
|
---|
42 | <tt>code:</tt>
|
---|
43 | <tt>String</tt>
|
---|
44 | — The PaperScript code
|
---|
45 |
|
---|
46 | </li>
|
---|
47 |
|
---|
48 | </ul>
|
---|
49 |
|
---|
50 |
|
---|
51 | <ul><b>Returns:</b>
|
---|
52 |
|
---|
53 | <li>
|
---|
54 | <tt><tt>String</tt></tt> — the compiled PaperScript as JavaScript code
|
---|
55 | </li>
|
---|
56 |
|
---|
57 | </ul>
|
---|
58 |
|
---|
59 |
|
---|
60 |
|
---|
61 | </div>
|
---|
62 | </div>
|
---|
63 | </div>
|
---|
64 |
|
---|
65 |
|
---|
66 | <div id="evaluate-code-scope" class="member">
|
---|
67 | <div class="member-link">
|
---|
68 | <a name="evaluate-code-scope" href="#evaluate-code-scope"><tt><b>PaperScript.evaluate</b>(code, scope)</tt></a>
|
---|
69 | </div>
|
---|
70 | <div class="member-description hidden">
|
---|
71 | <div class="member-text">
|
---|
72 | <p>Evaluates parsed PaperScript code in the passed <a href="../classes/PaperScope.html"><tt>PaperScope</tt></a>
|
---|
73 | object. It also installs handlers automatically for us.</p>
|
---|
74 |
|
---|
75 | <ul><b>Parameters:</b>
|
---|
76 |
|
---|
77 | <li>
|
---|
78 | <tt>code:</tt>
|
---|
79 | <tt>String</tt>
|
---|
80 | — The PaperScript code
|
---|
81 |
|
---|
82 | </li>
|
---|
83 |
|
---|
84 | <li>
|
---|
85 | <tt>scope:</tt>
|
---|
86 | <a href="../classes/PaperScript.html"><tt>PaperScript</tt></a>
|
---|
87 | — The scope in which the code is executed
|
---|
88 |
|
---|
89 | </li>
|
---|
90 |
|
---|
91 | </ul>
|
---|
92 |
|
---|
93 |
|
---|
94 | <ul><b>Returns:</b>
|
---|
95 |
|
---|
96 | <li>
|
---|
97 | <tt><tt>Object</tt></tt> — the result of the code evaluation
|
---|
98 | </li>
|
---|
99 |
|
---|
100 | </ul>
|
---|
101 |
|
---|
102 |
|
---|
103 |
|
---|
104 | </div>
|
---|
105 | </div>
|
---|
106 | </div>
|
---|
107 |
|
---|
108 | </div>
|
---|
109 |
|
---|
110 |
|
---|
111 |
|
---|
112 | <!-- =========================== copyright notice ========================= -->
|
---|
113 | <p class="footer">Copyright © 2011 <a href="http://www.lehni.org" target="_blank">Jürg Lehni</a> & <a href="http://www.jonathanpuckey.com" target="_blank">Jonathan Puckey</a>. All Rights Reserved.</p>
|
---|
114 | <div class="content-end"></div>
|
---|
115 |
|
---|
116 | </body> |
---|