major doc changes
[roojs1] / docs / symbols / Array.json
1 {
2   "name" : "Array",
3   "augments" : [],
4   "childClasses" : {  },
5   "tree_children" : [],
6   "tree_parent" : [],
7   "desc" : "",
8   "isSingleton" : false,
9   "isStatic" : false,
10   "isBuiltin" : true,
11   "isAbstract" : false,
12   "isBuilderTop" : false,
13   "memberOf" : "Array",
14   "example" : "",
15   "deprecated" : "",
16   "since" : "",
17   "see" : "",
18   "params" : [],
19   "returns" : [],
20   "throws" : "",
21   "requires" : "",
22   "config" : [],
23   "methods" : [
24     {
25       "name" : "indexOf",
26       "type" : "function",
27       "desc" : "Checks whether or not the specified object exists in the array.",
28       "sig" : "(o)",
29       "static" : false,
30       "memberOf" : "",
31       "isStatic" : false,
32       "isConstructor" : false,
33       "isPrivate" : false,
34       "example" : "",
35       "deprecated" : "",
36       "since" : "",
37       "see" : "",
38       "exceptions" : "",
39       "requires" : "",
40       "params" : [
41         {
42           "name" : "o",
43           "type" : "Object",
44           "desc" : "The object to check for",
45           "isOptional" : false
46         }
47       ],
48       "returns" : [
49         {
50           "name" : "",
51           "type" : "Number",
52           "desc" : "The index of o in the array (or -1 if it is not found)"
53         }
54       ]
55     },
56     {
57       "name" : "map",
58       "type" : "function",
59       "desc" : "Map (JS 1.6 compatibility)",
60       "sig" : "(function() {\n\n})",
61       "static" : false,
62       "memberOf" : "",
63       "isStatic" : false,
64       "isConstructor" : false,
65       "isPrivate" : false,
66       "example" : "",
67       "deprecated" : "",
68       "since" : "",
69       "see" : "",
70       "exceptions" : "",
71       "requires" : "",
72       "params" : [
73         {
74           "name" : "function",
75           "type" : "Function",
76           "desc" : "to call",
77           "isOptional" : false
78         }
79       ],
80       "returns" : []
81     },
82     {
83       "name" : "remove",
84       "type" : "function",
85       "desc" : "Removes the specified object from the array.  If the object is not found nothing happens.",
86       "sig" : "(o)",
87       "static" : false,
88       "memberOf" : "",
89       "isStatic" : false,
90       "isConstructor" : false,
91       "isPrivate" : false,
92       "example" : "",
93       "deprecated" : "",
94       "since" : "",
95       "see" : "",
96       "exceptions" : "",
97       "requires" : "",
98       "params" : [
99         {
100           "name" : "o",
101           "type" : "Object",
102           "desc" : "The object to remove",
103           "isOptional" : false
104         }
105       ],
106       "returns" : []
107     },
108     {
109       "name" : "equals",
110       "type" : "function",
111       "desc" : "equals",
112       "sig" : "(o)",
113       "static" : false,
114       "memberOf" : "",
115       "isStatic" : false,
116       "isConstructor" : false,
117       "isPrivate" : false,
118       "example" : "",
119       "deprecated" : "",
120       "since" : "",
121       "see" : "",
122       "exceptions" : "",
123       "requires" : "",
124       "params" : [
125         {
126           "name" : "o",
127           "type" : "Array",
128           "desc" : "The array to compare to",
129           "isOptional" : false
130         }
131       ],
132       "returns" : []
133     }
134   ],
135   "events" : []
136 }