fix docs add optvalues
[roojs1] / docs / symbols / Roo.bootstrap.Graph.json
1 {
2   "name" : "Roo.bootstrap.Graph",
3   "augments" : [
4     "Roo.bootstrap.Component",
5     "Roo.Component",
6     "Roo.util.Observable"
7   ],
8   "childClasses" : {  },
9   "tree_children" : [],
10   "tree_parent" : [],
11   "desc" : "Bootstrap Graph class\n> Prameters\n -sm {number} sm 4\n -md {number} md 5",
12   "isSingleton" : false,
13   "isStatic" : false,
14   "isBuiltin" : false,
15   "isAbstract" : false,
16   "isBuilderTop" : false,
17   "memberOf" : "Graph",
18   "example" : "",
19   "deprecated" : "",
20   "since" : "",
21   "see" : "",
22   "params" : [
23     {
24       "name" : "config",
25       "type" : "Object",
26       "desc" : "The config object",
27       "isOptional" : false
28     }
29   ],
30   "returns" : [],
31   "throws" : "",
32   "requires" : "",
33   "config" : [
34     {
35       "name" : "g_y",
36       "type" : "number",
37       "desc" : "coodinator | centre y (pie)",
38       "memberOf" : "",
39       "isOptional" : false,
40       "optvalues" : []
41     },
42     {
43       "name" : "g_height",
44       "type" : "number",
45       "desc" : "height of the chart (respected by all elements in the set)",
46       "memberOf" : "",
47       "isOptional" : false,
48       "optvalues" : []
49     },
50     {
51       "name" : "listeners",
52       "type" : "Object",
53       "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  </code></pre>",
54       "memberOf" : "Roo.util.Observable",
55       "isOptional" : false,
56       "optvalues" : []
57     },
58     {
59       "name" : "tooltip",
60       "type" : "string",
61       "desc" : "Text for the tooltip",
62       "memberOf" : "Roo.bootstrap.Component",
63       "isOptional" : false,
64       "optvalues" : []
65     },
66     {
67       "name" : "container_method",
68       "type" : "string",
69       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
70       "memberOf" : "Roo.bootstrap.Component",
71       "isOptional" : false,
72       "optvalues" : []
73     },
74     {
75       "name" : "visibilityEl",
76       "type" : "string|object",
77       "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
78       "memberOf" : "Roo.bootstrap.Component",
79       "isOptional" : false,
80       "optvalues" : [
81         "el",
82         "parent"
83       ]
84     },
85     {
86       "name" : "can_build_overlaid",
87       "type" : "Boolean",
88       "desc" : "True if element can be rebuild from a HTML page",
89       "memberOf" : "Roo.bootstrap.Component",
90       "isOptional" : false,
91       "optvalues" : []
92     },
93     {
94       "name" : "hideMode",
95       "type" : "String",
96       "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
97       "memberOf" : "Roo.Component",
98       "isOptional" : false,
99       "optvalues" : [
100         "display",
101         "visibility"
102       ]
103     },
104     {
105       "name" : "g_r",
106       "type" : "number",
107       "desc" : "radius (pie)",
108       "memberOf" : "",
109       "isOptional" : false,
110       "optvalues" : []
111     },
112     {
113       "name" : "title",
114       "type" : "Object",
115       "desc" : "The title of the chart\n    \n -{Array}  values\n -opts (object) options for the chart \n     o {\n     o type (string) type of endings of the bar. Default: 'square'. Other options are: 'round', 'sharp', 'soft'.\n     o gutter (number)(string) default '20%' (WHAT DOES IT DO?)\n     o vgutter (number)\n     o colors (array) colors be used repeatedly to plot the bars. If multicolumn bar is used each sequence of bars with use a different color.\n     o stacked (boolean) whether or not to tread values as in a stacked bar chart\n     o to\n     o stretch (boolean)\n     o }\n -opts (object) options for the pie\n     o{\n     o cut\n     o startAngle (number)\n     o endAngle (number)\n     }",
116       "memberOf" : "",
117       "isOptional" : false,
118       "optvalues" : []
119     },
120     {
121       "name" : "style",
122       "type" : "String",
123       "desc" : "any extra css",
124       "memberOf" : "Roo.bootstrap.Component",
125       "isOptional" : false,
126       "optvalues" : []
127     },
128     {
129       "name" : "allowDomMove",
130       "type" : "Boolean",
131       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
132       "memberOf" : "Roo.Component",
133       "isOptional" : false,
134       "optvalues" : []
135     },
136     {
137       "name" : "graphtype",
138       "type" : "String",
139       "desc" : "bar | vbar | pie",
140       "memberOf" : "",
141       "isOptional" : false,
142       "optvalues" : []
143     },
144     {
145       "name" : "cls",
146       "type" : "String",
147       "desc" : "css class",
148       "memberOf" : "Roo.bootstrap.Component",
149       "isOptional" : false,
150       "optvalues" : []
151     },
152     {
153       "name" : "xattr",
154       "type" : "Object",
155       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
156       "memberOf" : "Roo.bootstrap.Component",
157       "isOptional" : false,
158       "optvalues" : []
159     },
160     {
161       "name" : "actionMode",
162       "type" : "String",
163       "desc" : "which property holds the element that used for  hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
164       "memberOf" : "Roo.Component",
165       "isOptional" : false,
166       "optvalues" : []
167     },
168     {
169       "name" : "dataId",
170       "type" : "string",
171       "desc" : "cutomer id",
172       "memberOf" : "Roo.bootstrap.Component",
173       "isOptional" : false,
174       "optvalues" : []
175     },
176     {
177       "name" : "g_width",
178       "type" : "number",
179       "desc" : "width of the chart (respected by all elements in the set)",
180       "memberOf" : "",
181       "isOptional" : false,
182       "optvalues" : []
183     },
184     {
185       "name" : "name",
186       "type" : "string",
187       "desc" : "Specifies name attribute",
188       "memberOf" : "Roo.bootstrap.Component",
189       "isOptional" : false,
190       "optvalues" : []
191     },
192     {
193       "name" : "disableClass",
194       "type" : "String",
195       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
196       "memberOf" : "Roo.Component",
197       "isOptional" : false,
198       "optvalues" : []
199     },
200     {
201       "name" : "g_x",
202       "type" : "number",
203       "desc" : "coodinator | centre x (pie)",
204       "memberOf" : "",
205       "isOptional" : false,
206       "optvalues" : []
207     }
208   ],
209   "methods" : [
210     {
211       "name" : "tooltipEl",
212       "type" : "function",
213       "desc" : "Fetch the element to display the tooltip on.",
214       "sig" : "()\n{\n\n}",
215       "static" : false,
216       "memberOf" : "Roo.bootstrap.Component",
217       "isStatic" : false,
218       "isConstructor" : false,
219       "isPrivate" : false,
220       "example" : "",
221       "deprecated" : "",
222       "since" : "",
223       "see" : "",
224       "exceptions" : "",
225       "requires" : "",
226       "params" : [],
227       "returns" : [
228         {
229           "name" : "",
230           "type" : "Roo.Element",
231           "desc" : "defaults to this.el"
232         }
233       ]
234     },
235     {
236       "name" : "hide",
237       "type" : "function",
238       "desc" : "Hide a component - adds 'hidden' class",
239       "sig" : "()\n{\n\n}",
240       "static" : false,
241       "memberOf" : "Roo.bootstrap.Component",
242       "isStatic" : false,
243       "isConstructor" : false,
244       "isPrivate" : false,
245       "example" : "",
246       "deprecated" : "",
247       "since" : "",
248       "see" : "",
249       "exceptions" : "",
250       "requires" : "",
251       "params" : [],
252       "returns" : []
253     },
254     {
255       "name" : "show",
256       "type" : "function",
257       "desc" : "Show a component - removes 'hidden' class",
258       "sig" : "()\n{\n\n}",
259       "static" : false,
260       "memberOf" : "Roo.bootstrap.Component",
261       "isStatic" : false,
262       "isConstructor" : false,
263       "isPrivate" : false,
264       "example" : "",
265       "deprecated" : "",
266       "since" : "",
267       "see" : "",
268       "exceptions" : "",
269       "requires" : "",
270       "params" : [],
271       "returns" : []
272     },
273     {
274       "name" : "setVisibilityEl",
275       "type" : "function",
276       "desc" : "Set the element that will be used to show or hide",
277       "sig" : "()\n{\n\n}",
278       "static" : false,
279       "memberOf" : "Roo.bootstrap.Component",
280       "isStatic" : false,
281       "isConstructor" : false,
282       "isPrivate" : false,
283       "example" : "",
284       "deprecated" : "",
285       "since" : "",
286       "see" : "",
287       "exceptions" : "",
288       "requires" : "",
289       "params" : [],
290       "returns" : []
291     },
292     {
293       "name" : "getVisibilityEl",
294       "type" : "function",
295       "desc" : "Get the element that will be used to show or hide",
296       "sig" : "()\n{\n\n}",
297       "static" : false,
298       "memberOf" : "Roo.bootstrap.Component",
299       "isStatic" : false,
300       "isConstructor" : false,
301       "isPrivate" : false,
302       "example" : "",
303       "deprecated" : "",
304       "since" : "",
305       "see" : "",
306       "exceptions" : "",
307       "requires" : "",
308       "params" : [],
309       "returns" : []
310     },
311     {
312       "name" : "initEvents",
313       "type" : "function",
314       "desc" : "Initialize Events for the element",
315       "sig" : "()\n{\n\n}",
316       "static" : false,
317       "memberOf" : "Roo.bootstrap.Component",
318       "isStatic" : false,
319       "isConstructor" : false,
320       "isPrivate" : false,
321       "example" : "",
322       "deprecated" : "",
323       "since" : "",
324       "see" : "",
325       "exceptions" : "",
326       "requires" : "",
327       "params" : [],
328       "returns" : []
329     },
330     {
331       "name" : "getChildContainer",
332       "type" : "function",
333       "desc" : "Fetch the element to add children to",
334       "sig" : "()\n{\n\n}",
335       "static" : false,
336       "memberOf" : "Roo.bootstrap.Component",
337       "isStatic" : false,
338       "isConstructor" : false,
339       "isPrivate" : false,
340       "example" : "",
341       "deprecated" : "",
342       "since" : "",
343       "see" : "",
344       "exceptions" : "",
345       "requires" : "",
346       "params" : [],
347       "returns" : [
348         {
349           "name" : "",
350           "type" : "Roo.Element",
351           "desc" : "defaults to this.el"
352         }
353       ]
354     },
355     {
356       "name" : "getId",
357       "type" : "function",
358       "desc" : "Returns the id of this component.",
359       "sig" : "()\n{\n\n}",
360       "static" : false,
361       "memberOf" : "Roo.Component",
362       "isStatic" : false,
363       "isConstructor" : false,
364       "isPrivate" : false,
365       "example" : "",
366       "deprecated" : "",
367       "since" : "",
368       "see" : "",
369       "exceptions" : "",
370       "requires" : "",
371       "params" : [],
372       "returns" : [
373         {
374           "name" : "",
375           "type" : "String",
376           "desc" : ""
377         }
378       ]
379     },
380     {
381       "name" : "render",
382       "type" : "function",
383       "desc" : "If this is a lazy rendering component, render it to its container element.",
384       "sig" : "(container)",
385       "static" : false,
386       "memberOf" : "Roo.Component",
387       "isStatic" : false,
388       "isConstructor" : false,
389       "isPrivate" : false,
390       "example" : "",
391       "deprecated" : "",
392       "since" : "",
393       "see" : "",
394       "exceptions" : "",
395       "requires" : "",
396       "params" : [
397         {
398           "name" : "container",
399           "type" : "String/HTMLElement/Element",
400           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
401           "isOptional" : false
402         }
403       ],
404       "returns" : []
405     },
406     {
407       "name" : "destroy",
408       "type" : "function",
409       "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
410       "sig" : "()\n{\n\n}",
411       "static" : false,
412       "memberOf" : "Roo.Component",
413       "isStatic" : false,
414       "isConstructor" : false,
415       "isPrivate" : false,
416       "example" : "",
417       "deprecated" : "",
418       "since" : "",
419       "see" : "",
420       "exceptions" : "",
421       "requires" : "",
422       "params" : [],
423       "returns" : []
424     },
425     {
426       "name" : "isVisible",
427       "type" : "function",
428       "desc" : "Returns true if this component is visible.",
429       "sig" : "()\n{\n\n}",
430       "static" : false,
431       "memberOf" : "Roo.Component",
432       "isStatic" : false,
433       "isConstructor" : false,
434       "isPrivate" : false,
435       "example" : "",
436       "deprecated" : "",
437       "since" : "",
438       "see" : "",
439       "exceptions" : "",
440       "requires" : "",
441       "params" : [],
442       "returns" : []
443     },
444     {
445       "name" : "setDisabled",
446       "type" : "function",
447       "desc" : "Convenience function for setting disabled/enabled by boolean.",
448       "sig" : "(disabled)",
449       "static" : false,
450       "memberOf" : "Roo.Component",
451       "isStatic" : false,
452       "isConstructor" : false,
453       "isPrivate" : false,
454       "example" : "",
455       "deprecated" : "",
456       "since" : "",
457       "see" : "",
458       "exceptions" : "",
459       "requires" : "",
460       "params" : [
461         {
462           "name" : "disabled",
463           "type" : "Boolean",
464           "desc" : "",
465           "isOptional" : false
466         }
467       ],
468       "returns" : []
469     },
470     {
471       "name" : "focus",
472       "type" : "function",
473       "desc" : "Try to focus this component.",
474       "sig" : "(selectText)",
475       "static" : false,
476       "memberOf" : "Roo.Component",
477       "isStatic" : false,
478       "isConstructor" : false,
479       "isPrivate" : false,
480       "example" : "",
481       "deprecated" : "",
482       "since" : "",
483       "see" : "",
484       "exceptions" : "",
485       "requires" : "",
486       "params" : [
487         {
488           "name" : "selectText",
489           "type" : "Boolean",
490           "desc" : "True to also select the text in this component (if applicable)",
491           "isOptional" : false
492         }
493       ],
494       "returns" : [
495         {
496           "name" : "",
497           "type" : "Roo.Component",
498           "desc" : "this"
499         }
500       ]
501     },
502     {
503       "name" : "enable",
504       "type" : "function",
505       "desc" : "Enable this component.",
506       "sig" : "()\n{\n\n}",
507       "static" : false,
508       "memberOf" : "Roo.Component",
509       "isStatic" : false,
510       "isConstructor" : false,
511       "isPrivate" : false,
512       "example" : "",
513       "deprecated" : "",
514       "since" : "",
515       "see" : "",
516       "exceptions" : "",
517       "requires" : "",
518       "params" : [],
519       "returns" : [
520         {
521           "name" : "",
522           "type" : "Roo.Component",
523           "desc" : "this"
524         }
525       ]
526     },
527     {
528       "name" : "setVisible",
529       "type" : "function",
530       "desc" : "Convenience function to hide or show this component by boolean.",
531       "sig" : "(visible)",
532       "static" : false,
533       "memberOf" : "Roo.Component",
534       "isStatic" : false,
535       "isConstructor" : false,
536       "isPrivate" : false,
537       "example" : "",
538       "deprecated" : "",
539       "since" : "",
540       "see" : "",
541       "exceptions" : "",
542       "requires" : "",
543       "params" : [
544         {
545           "name" : "visible",
546           "type" : "Boolean",
547           "desc" : "True to show, false to hide",
548           "isOptional" : false
549         }
550       ],
551       "returns" : [
552         {
553           "name" : "",
554           "type" : "Roo.Component",
555           "desc" : "this"
556         }
557       ]
558     },
559     {
560       "name" : "disable",
561       "type" : "function",
562       "desc" : "Disable this component.",
563       "sig" : "()\n{\n\n}",
564       "static" : false,
565       "memberOf" : "Roo.Component",
566       "isStatic" : false,
567       "isConstructor" : false,
568       "isPrivate" : false,
569       "example" : "",
570       "deprecated" : "",
571       "since" : "",
572       "see" : "",
573       "exceptions" : "",
574       "requires" : "",
575       "params" : [],
576       "returns" : [
577         {
578           "name" : "",
579           "type" : "Roo.Component",
580           "desc" : "this"
581         }
582       ]
583     },
584     {
585       "name" : "getEl",
586       "type" : "function",
587       "desc" : "Returns the underlying {@link Roo.Element}.",
588       "sig" : "()\n{\n\n}",
589       "static" : false,
590       "memberOf" : "Roo.Component",
591       "isStatic" : false,
592       "isConstructor" : false,
593       "isPrivate" : false,
594       "example" : "",
595       "deprecated" : "",
596       "since" : "",
597       "see" : "",
598       "exceptions" : "",
599       "requires" : "",
600       "params" : [],
601       "returns" : [
602         {
603           "name" : "",
604           "type" : "Roo.Element",
605           "desc" : "The element"
606         }
607       ]
608     },
609     {
610       "name" : "purgeListeners",
611       "type" : "function",
612       "desc" : "Removes all listeners for this object",
613       "sig" : "()\n{\n\n}",
614       "static" : false,
615       "memberOf" : "Roo.util.Observable",
616       "isStatic" : false,
617       "isConstructor" : false,
618       "isPrivate" : false,
619       "example" : "",
620       "deprecated" : "",
621       "since" : "",
622       "see" : "",
623       "exceptions" : "",
624       "requires" : "",
625       "params" : [],
626       "returns" : []
627     },
628     {
629       "name" : "on",
630       "type" : "function",
631       "desc" : "Appends an event handler to this element (shorthand for addListener)",
632       "sig" : "(eventName, handler, scope, options)",
633       "static" : false,
634       "memberOf" : "Roo.util.Observable",
635       "isStatic" : false,
636       "isConstructor" : false,
637       "isPrivate" : false,
638       "example" : "",
639       "deprecated" : "",
640       "since" : "",
641       "see" : "",
642       "exceptions" : "",
643       "requires" : "",
644       "params" : [
645         {
646           "name" : "eventName",
647           "type" : "String",
648           "desc" : "The type of event to listen for",
649           "isOptional" : false
650         },
651         {
652           "name" : "handler",
653           "type" : "Function",
654           "desc" : "The method the event invokes",
655           "isOptional" : false
656         },
657         {
658           "name" : "scope",
659           "type" : "Object",
660           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
661           "isOptional" : false
662         },
663         {
664           "name" : "options",
665           "type" : "Object",
666           "desc" : "(optional)",
667           "isOptional" : false
668         }
669       ],
670       "returns" : []
671     },
672     {
673       "name" : "un",
674       "type" : "function",
675       "desc" : "Removes a listener (shorthand for removeListener)",
676       "sig" : "(eventName, handler, scope)",
677       "static" : false,
678       "memberOf" : "Roo.util.Observable",
679       "isStatic" : false,
680       "isConstructor" : false,
681       "isPrivate" : false,
682       "example" : "",
683       "deprecated" : "",
684       "since" : "",
685       "see" : "",
686       "exceptions" : "",
687       "requires" : "",
688       "params" : [
689         {
690           "name" : "eventName",
691           "type" : "String",
692           "desc" : "The type of event to listen for",
693           "isOptional" : false
694         },
695         {
696           "name" : "handler",
697           "type" : "Function",
698           "desc" : "The handler to remove",
699           "isOptional" : false
700         },
701         {
702           "name" : "scope",
703           "type" : "Object",
704           "desc" : "(optional) The scope (this object) for the handler",
705           "isOptional" : false
706         }
707       ],
708       "returns" : []
709     },
710     {
711       "name" : "addEvents",
712       "type" : "function",
713       "desc" : "Used to define events on this Observable",
714       "sig" : "(object)",
715       "static" : false,
716       "memberOf" : "Roo.util.Observable",
717       "isStatic" : false,
718       "isConstructor" : false,
719       "isPrivate" : false,
720       "example" : "",
721       "deprecated" : "",
722       "since" : "",
723       "see" : "",
724       "exceptions" : "",
725       "requires" : "",
726       "params" : [
727         {
728           "name" : "object",
729           "type" : "Object",
730           "desc" : "The object with the events defined",
731           "isOptional" : false
732         }
733       ],
734       "returns" : []
735     },
736     {
737       "name" : "releaseCapture",
738       "type" : "function",
739       "desc" : "Removes <b>all</b> added captures from the Observable.",
740       "sig" : "(o)",
741       "static" : true,
742       "memberOf" : "Roo.util.Observable",
743       "isStatic" : true,
744       "isConstructor" : false,
745       "isPrivate" : false,
746       "example" : "",
747       "deprecated" : "",
748       "since" : "",
749       "see" : "",
750       "exceptions" : "",
751       "requires" : "",
752       "params" : [
753         {
754           "name" : "o",
755           "type" : "Observable",
756           "desc" : "The Observable to release",
757           "isOptional" : false
758         }
759       ],
760       "returns" : []
761     },
762     {
763       "name" : "removeListener",
764       "type" : "function",
765       "desc" : "Removes a listener",
766       "sig" : "(eventName, handler, scope)",
767       "static" : false,
768       "memberOf" : "Roo.util.Observable",
769       "isStatic" : false,
770       "isConstructor" : false,
771       "isPrivate" : false,
772       "example" : "",
773       "deprecated" : "",
774       "since" : "",
775       "see" : "",
776       "exceptions" : "",
777       "requires" : "",
778       "params" : [
779         {
780           "name" : "eventName",
781           "type" : "String",
782           "desc" : "The type of event to listen for",
783           "isOptional" : false
784         },
785         {
786           "name" : "handler",
787           "type" : "Function",
788           "desc" : "The handler to remove",
789           "isOptional" : false
790         },
791         {
792           "name" : "scope",
793           "type" : "Object",
794           "desc" : "(optional) The scope (this object) for the handler",
795           "isOptional" : false
796         }
797       ],
798       "returns" : []
799     },
800     {
801       "name" : "fireEvent",
802       "type" : "function",
803       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
804       "sig" : "(eventName, args)",
805       "static" : false,
806       "memberOf" : "Roo.util.Observable",
807       "isStatic" : false,
808       "isConstructor" : false,
809       "isPrivate" : false,
810       "example" : "",
811       "deprecated" : "",
812       "since" : "",
813       "see" : "",
814       "exceptions" : "",
815       "requires" : "",
816       "params" : [
817         {
818           "name" : "eventName",
819           "type" : "String",
820           "desc" : "",
821           "isOptional" : false
822         },
823         {
824           "name" : "args",
825           "type" : "Object...",
826           "desc" : "Variable number of parameters are passed to handlers",
827           "isOptional" : false
828         }
829       ],
830       "returns" : [
831         {
832           "name" : "",
833           "type" : "Boolean",
834           "desc" : "returns false if any of the handlers return false otherwise it returns true"
835         }
836       ]
837     },
838     {
839       "name" : "hasListener",
840       "type" : "function",
841       "desc" : "Checks to see if this object has any listeners for a specified event",
842       "sig" : "(eventName)",
843       "static" : false,
844       "memberOf" : "Roo.util.Observable",
845       "isStatic" : false,
846       "isConstructor" : false,
847       "isPrivate" : false,
848       "example" : "",
849       "deprecated" : "",
850       "since" : "",
851       "see" : "",
852       "exceptions" : "",
853       "requires" : "",
854       "params" : [
855         {
856           "name" : "eventName",
857           "type" : "String",
858           "desc" : "The name of the event to check for",
859           "isOptional" : false
860         }
861       ],
862       "returns" : [
863         {
864           "name" : "",
865           "type" : "Boolean",
866           "desc" : "True if the event is being listened for, else false"
867         }
868       ]
869     },
870     {
871       "name" : "capture",
872       "type" : "function",
873       "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
874       "sig" : "(o, fn, scope)",
875       "static" : true,
876       "memberOf" : "Roo.util.Observable",
877       "isStatic" : true,
878       "isConstructor" : false,
879       "isPrivate" : false,
880       "example" : "",
881       "deprecated" : "",
882       "since" : "",
883       "see" : "",
884       "exceptions" : "",
885       "requires" : "",
886       "params" : [
887         {
888           "name" : "o",
889           "type" : "Observable",
890           "desc" : "The Observable to capture",
891           "isOptional" : false
892         },
893         {
894           "name" : "fn",
895           "type" : "Function",
896           "desc" : "The function to call",
897           "isOptional" : false
898         },
899         {
900           "name" : "scope",
901           "type" : "Object",
902           "desc" : "(optional) The scope (this object) for the fn",
903           "isOptional" : false
904         }
905       ],
906       "returns" : []
907     },
908     {
909       "name" : "addListener",
910       "type" : "function",
911       "desc" : "Appends an event handler to this component",
912       "sig" : "(eventName, handler, scope, options)",
913       "static" : false,
914       "memberOf" : "Roo.util.Observable",
915       "isStatic" : false,
916       "isConstructor" : false,
917       "isPrivate" : false,
918       "example" : "",
919       "deprecated" : "",
920       "since" : "",
921       "see" : "",
922       "exceptions" : "",
923       "requires" : "",
924       "params" : [
925         {
926           "name" : "eventName",
927           "type" : "String",
928           "desc" : "The type of event to listen for",
929           "isOptional" : false
930         },
931         {
932           "name" : "handler",
933           "type" : "Function",
934           "desc" : "The method the event invokes",
935           "isOptional" : false
936         },
937         {
938           "name" : "scope",
939           "type" : "Object",
940           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
941           "isOptional" : false
942         },
943         {
944           "name" : "options",
945           "type" : "Object",
946           "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n     \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t</code></pre>",
947           "isOptional" : false
948         }
949       ],
950       "returns" : []
951     }
952   ],
953   "events" : [
954     {
955       "name" : "click",
956       "type" : "function",
957       "desc" : "The img click event for the img.",
958       "sig" : "function (e)\n{\n\n}",
959       "memberOf" : "",
960       "example" : "",
961       "deprecated" : "",
962       "since" : "",
963       "see" : "",
964       "params" : [
965         {
966           "name" : "e",
967           "type" : "Roo.EventObject",
968           "desc" : "",
969           "isOptional" : false
970         }
971       ],
972       "returns" : []
973     },
974     {
975       "name" : "childrenrendered",
976       "type" : "function",
977       "desc" : "Fires when the children have been rendered..",
978       "sig" : "function (_self)\n{\n\n}",
979       "memberOf" : "Roo.bootstrap.Component",
980       "example" : "",
981       "deprecated" : "",
982       "since" : "",
983       "see" : "",
984       "params" : [
985         {
986           "name" : "this",
987           "type" : "Roo.bootstrap.Component",
988           "desc" : "",
989           "isOptional" : false
990         }
991       ],
992       "returns" : []
993     },
994     {
995       "name" : "beforerender",
996       "type" : "function",
997       "desc" : "Fires before the component is rendered. Return false to stop the render.",
998       "sig" : "function (_self)\n{\n\n}",
999       "memberOf" : "Roo.Component",
1000       "example" : "",
1001       "deprecated" : "",
1002       "since" : "",
1003       "see" : "",
1004       "params" : [
1005         {
1006           "name" : "this",
1007           "type" : "Roo.Component",
1008           "desc" : "",
1009           "isOptional" : false
1010         }
1011       ],
1012       "returns" : []
1013     },
1014     {
1015       "name" : "disable",
1016       "type" : "function",
1017       "desc" : "Fires after the component is disabled.",
1018       "sig" : "function (_self)\n{\n\n}",
1019       "memberOf" : "Roo.Component",
1020       "example" : "",
1021       "deprecated" : "",
1022       "since" : "",
1023       "see" : "",
1024       "params" : [
1025         {
1026           "name" : "this",
1027           "type" : "Roo.Component",
1028           "desc" : "",
1029           "isOptional" : false
1030         }
1031       ],
1032       "returns" : []
1033     },
1034     {
1035       "name" : "render",
1036       "type" : "function",
1037       "desc" : "Fires after the component is rendered.",
1038       "sig" : "function (_self)\n{\n\n}",
1039       "memberOf" : "Roo.Component",
1040       "example" : "",
1041       "deprecated" : "",
1042       "since" : "",
1043       "see" : "",
1044       "params" : [
1045         {
1046           "name" : "this",
1047           "type" : "Roo.Component",
1048           "desc" : "",
1049           "isOptional" : false
1050         }
1051       ],
1052       "returns" : []
1053     },
1054     {
1055       "name" : "destroy",
1056       "type" : "function",
1057       "desc" : "Fires after the component is destroyed.",
1058       "sig" : "function (_self)\n{\n\n}",
1059       "memberOf" : "Roo.Component",
1060       "example" : "",
1061       "deprecated" : "",
1062       "since" : "",
1063       "see" : "",
1064       "params" : [
1065         {
1066           "name" : "this",
1067           "type" : "Roo.Component",
1068           "desc" : "",
1069           "isOptional" : false
1070         }
1071       ],
1072       "returns" : []
1073     },
1074     {
1075       "name" : "hide",
1076       "type" : "function",
1077       "desc" : "Fires after the component is hidden.",
1078       "sig" : "function (_self)\n{\n\n}",
1079       "memberOf" : "Roo.Component",
1080       "example" : "",
1081       "deprecated" : "",
1082       "since" : "",
1083       "see" : "",
1084       "params" : [
1085         {
1086           "name" : "this",
1087           "type" : "Roo.Component",
1088           "desc" : "",
1089           "isOptional" : false
1090         }
1091       ],
1092       "returns" : []
1093     },
1094     {
1095       "name" : "beforehide",
1096       "type" : "function",
1097       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1098       "sig" : "function (_self)\n{\n\n}",
1099       "memberOf" : "Roo.Component",
1100       "example" : "",
1101       "deprecated" : "",
1102       "since" : "",
1103       "see" : "",
1104       "params" : [
1105         {
1106           "name" : "this",
1107           "type" : "Roo.Component",
1108           "desc" : "",
1109           "isOptional" : false
1110         }
1111       ],
1112       "returns" : []
1113     },
1114     {
1115       "name" : "show",
1116       "type" : "function",
1117       "desc" : "Fires after the component is shown.",
1118       "sig" : "function (_self)\n{\n\n}",
1119       "memberOf" : "Roo.Component",
1120       "example" : "",
1121       "deprecated" : "",
1122       "since" : "",
1123       "see" : "",
1124       "params" : [
1125         {
1126           "name" : "this",
1127           "type" : "Roo.Component",
1128           "desc" : "",
1129           "isOptional" : false
1130         }
1131       ],
1132       "returns" : []
1133     },
1134     {
1135       "name" : "beforeshow",
1136       "type" : "function",
1137       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1138       "sig" : "function (_self)\n{\n\n}",
1139       "memberOf" : "Roo.Component",
1140       "example" : "",
1141       "deprecated" : "",
1142       "since" : "",
1143       "see" : "",
1144       "params" : [
1145         {
1146           "name" : "this",
1147           "type" : "Roo.Component",
1148           "desc" : "",
1149           "isOptional" : false
1150         }
1151       ],
1152       "returns" : []
1153     },
1154     {
1155       "name" : "enable",
1156       "type" : "function",
1157       "desc" : "Fires after the component is enabled.",
1158       "sig" : "function (_self)\n{\n\n}",
1159       "memberOf" : "Roo.Component",
1160       "example" : "",
1161       "deprecated" : "",
1162       "since" : "",
1163       "see" : "",
1164       "params" : [
1165         {
1166           "name" : "this",
1167           "type" : "Roo.Component",
1168           "desc" : "",
1169           "isOptional" : false
1170         }
1171       ],
1172       "returns" : []
1173     },
1174     {
1175       "name" : "beforedestroy",
1176       "type" : "function",
1177       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1178       "sig" : "function (_self)\n{\n\n}",
1179       "memberOf" : "Roo.Component",
1180       "example" : "",
1181       "deprecated" : "",
1182       "since" : "",
1183       "see" : "",
1184       "params" : [
1185         {
1186           "name" : "this",
1187           "type" : "Roo.Component",
1188           "desc" : "",
1189           "isOptional" : false
1190         }
1191       ],
1192       "returns" : []
1193     }
1194   ]
1195 }