forked from DefinitelyTyped/DefinitelyTyped
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdojox.NodeList.d.ts
1162 lines (1157 loc) · 64.4 KB
/
dojox.NodeList.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
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
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
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
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
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
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
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
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
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
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
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
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Type definitions for Dojo v1.9
// Project: http://dojotoolkit.org
// Definitions by: Michael Van Sickle <https://github.com/vansimke>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/// <reference path="dojo.d.ts" />
declare namespace dojox {
namespace NodeList {
/**
* Permalink: http://dojotoolkit.org/api/1.9/dojox/NodeList/delegate.html
*
* Array-like object which adds syntactic
* sugar for chaining, common iteration operations, animation, and
* node manipulation. NodeLists are most often returned as the
* result of dojo/query() calls.
* NodeList instances provide many utilities that reflect
* core Dojo APIs for Array iteration and manipulation, DOM
* manipulation, and event handling. Instead of needing to dig up
* functions in the dojo package, NodeLists generally make the
* full power of Dojo available for DOM manipulation tasks in a
* simple, chainable way.
*
* @param array
*/
interface delegate{(array: any): void}
namespace delegate {
/**
*
*/
var events: any[]
/**
* adds the specified class to every node in the list
*
* @param className A String class name to add, or several space-separated class names,or an array of class names.
*/
interface addClass{(className: String): void}
/**
* adds the specified class to every node in the list
*
* @param className A String class name to add, or several space-separated class names,or an array of class names.
*/
interface addClass{(className: any[]): void}
/**
* Animate the effects of adding a class to all nodes in this list.
* see dojox.fx.addClass
*
* @param cssClass
* @param args
*/
interface addClassFx{(cssClass: any, args: any): {type:Function;value:any}}
/**
* add a node, NodeList or some HTML as a string to every item in the
* list. Returns the original list.
* a copy of the HTML content is added to each item in the
* list, with an optional position argument. If no position
* argument is provided, the content is appended to the end of
* each item.
*
* @param content the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
* @param position Optionalcan be one of:"last"||"end" (default)"first||"start""before""after""replace" (replaces nodes in this NodeList with new content)"only" (removes other children of the nodes so new content is the only child)or an offset in the childNodes property
*/
interface addContent{(content: String, position: String): Function}
/**
* add a node, NodeList or some HTML as a string to every item in the
* list. Returns the original list.
* a copy of the HTML content is added to each item in the
* list, with an optional position argument. If no position
* argument is provided, the content is appended to the end of
* each item.
*
* @param content the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
* @param position Optionalcan be one of:"last"||"end" (default)"first||"start""before""after""replace" (replaces nodes in this NodeList with new content)"only" (removes other children of the nodes so new content is the only child)or an offset in the childNodes property
*/
interface addContent{(content: HTMLElement, position: String): Function}
/**
* add a node, NodeList or some HTML as a string to every item in the
* list. Returns the original list.
* a copy of the HTML content is added to each item in the
* list, with an optional position argument. If no position
* argument is provided, the content is appended to the end of
* each item.
*
* @param content the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
* @param position Optionalcan be one of:"last"||"end" (default)"first||"start""before""after""replace" (replaces nodes in this NodeList with new content)"only" (removes other children of the nodes so new content is the only child)or an offset in the childNodes property
*/
interface addContent{(content: Object, position: String): Function}
/**
* add a node, NodeList or some HTML as a string to every item in the
* list. Returns the original list.
* a copy of the HTML content is added to each item in the
* list, with an optional position argument. If no position
* argument is provided, the content is appended to the end of
* each item.
*
* @param content the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
* @param position Optionalcan be one of:"last"||"end" (default)"first||"start""before""after""replace" (replaces nodes in this NodeList with new content)"only" (removes other children of the nodes so new content is the only child)or an offset in the childNodes property
*/
interface addContent{(content: dojo.NodeList, position: String): Function}
/**
* add a node, NodeList or some HTML as a string to every item in the
* list. Returns the original list.
* a copy of the HTML content is added to each item in the
* list, with an optional position argument. If no position
* argument is provided, the content is appended to the end of
* each item.
*
* @param content the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
* @param position Optionalcan be one of:"last"||"end" (default)"first||"start""before""after""replace" (replaces nodes in this NodeList with new content)"only" (removes other children of the nodes so new content is the only child)or an offset in the childNodes property
*/
interface addContent{(content: String, position: number): Function}
/**
* add a node, NodeList or some HTML as a string to every item in the
* list. Returns the original list.
* a copy of the HTML content is added to each item in the
* list, with an optional position argument. If no position
* argument is provided, the content is appended to the end of
* each item.
*
* @param content the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
* @param position Optionalcan be one of:"last"||"end" (default)"first||"start""before""after""replace" (replaces nodes in this NodeList with new content)"only" (removes other children of the nodes so new content is the only child)or an offset in the childNodes property
*/
interface addContent{(content: HTMLElement, position: number): Function}
/**
* add a node, NodeList or some HTML as a string to every item in the
* list. Returns the original list.
* a copy of the HTML content is added to each item in the
* list, with an optional position argument. If no position
* argument is provided, the content is appended to the end of
* each item.
*
* @param content the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
* @param position Optionalcan be one of:"last"||"end" (default)"first||"start""before""after""replace" (replaces nodes in this NodeList with new content)"only" (removes other children of the nodes so new content is the only child)or an offset in the childNodes property
*/
interface addContent{(content: Object, position: number): Function}
/**
* add a node, NodeList or some HTML as a string to every item in the
* list. Returns the original list.
* a copy of the HTML content is added to each item in the
* list, with an optional position argument. If no position
* argument is provided, the content is appended to the end of
* each item.
*
* @param content the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
* @param position Optionalcan be one of:"last"||"end" (default)"first||"start""before""after""replace" (replaces nodes in this NodeList with new content)"only" (removes other children of the nodes so new content is the only child)or an offset in the childNodes property
*/
interface addContent{(content: dojo.NodeList, position: number): Function}
/**
* places any/all elements in queryOrListOrNode at a
* position relative to the first element in this list.
* Returns a dojo/NodeList of the adopted elements.
*
* @param queryOrListOrNode a DOM node or a query string or a query result.Represents the nodes to be adopted relative to thefirst element of this NodeList.
* @param position Optionalcan be one of:"last" (default)"first""before""after""only""replace"or an offset in the childNodes property
*/
interface adopt{(queryOrListOrNode: String, position: String): any}
/**
* places any/all elements in queryOrListOrNode at a
* position relative to the first element in this list.
* Returns a dojo/NodeList of the adopted elements.
*
* @param queryOrListOrNode a DOM node or a query string or a query result.Represents the nodes to be adopted relative to thefirst element of this NodeList.
* @param position Optionalcan be one of:"last" (default)"first""before""after""only""replace"or an offset in the childNodes property
*/
interface adopt{(queryOrListOrNode: any[], position: String): any}
/**
* places any/all elements in queryOrListOrNode at a
* position relative to the first element in this list.
* Returns a dojo/NodeList of the adopted elements.
*
* @param queryOrListOrNode a DOM node or a query string or a query result.Represents the nodes to be adopted relative to thefirst element of this NodeList.
* @param position Optionalcan be one of:"last" (default)"first""before""after""only""replace"or an offset in the childNodes property
*/
interface adopt{(queryOrListOrNode: HTMLElement, position: String): any}
/**
* Places the content after every node in the NodeList.
* The content will be cloned if the length of NodeList
* is greater than 1. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param content
*/
interface after{(content: String): any}
/**
* Places the content after every node in the NodeList.
* The content will be cloned if the length of NodeList
* is greater than 1. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param content
*/
interface after{(content: HTMLElement): any}
/**
* Places the content after every node in the NodeList.
* The content will be cloned if the length of NodeList
* is greater than 1. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param content
*/
interface after{(content: NodeList): any}
/**
* Adds the nodes from the previous dojo/NodeList to the current dojo/NodeList.
* .end() can be used on the returned dojo/NodeList to get back to the
* original dojo/NodeList.
*
*/
interface andSelf{(): any}
/**
* Animate one or more CSS properties for all nodes in this list.
* The returned animation object will already be playing when it
* is returned. See the docs for dojo.anim for full details.
*
* @param properties the properties to animate. does NOT support the auto parameter like otherNodeList-fx methods.
* @param duration OptionalOptional. The time to run the animations for
* @param easing OptionalOptional. The easing function to use.
* @param onEnd OptionalA function to be called when the animation ends
* @param delay Optionalhow long to delay playing the returned animation
*/
interface anim{(properties: Object, duration: number, easing: Function, onEnd: Function, delay: number): any}
/**
* Animate all elements of this NodeList across the properties specified.
* syntax identical to dojo.animateProperty
*
* @param args OptionalAdditional dojo/_base/fx.Animation arguments to mix into this set with the addition ofan auto parameter.
*/
interface animateProperty{(args: Object): any}
/**
* appends the content to every node in the NodeList.
* The content will be cloned if the length of NodeList
* is greater than 1. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param content
*/
interface append{(content: String): any}
/**
* appends the content to every node in the NodeList.
* The content will be cloned if the length of NodeList
* is greater than 1. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param content
*/
interface append{(content: HTMLElement): any}
/**
* appends the content to every node in the NodeList.
* The content will be cloned if the length of NodeList
* is greater than 1. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param content
*/
interface append{(content: NodeList): any}
/**
* appends nodes in this NodeList to the nodes matched by
* the query passed to appendTo.
* The nodes in this NodeList will be cloned if the query
* matches more than one element. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param query
*/
interface appendTo{(query: String): any}
/**
* Returns a new NodeList comprised of items in this NodeList
* at the given index or indices.
*
* @param index One or more 0-based indices of items in the currentNodeList. A negative index will start at the end of thelist and go backwards.
*/
interface at{(index: number[]): any}
/**
* gets or sets the DOM attribute for every element in the
* NodeList. See also dojo/dom-attr
*
* @param property the attribute to get/set
* @param value Optionaloptional. The value to set the property to
*/
interface attr{(property: String, value: String): any}
/**
* Places the content before every node in the NodeList.
* The content will be cloned if the length of NodeList
* is greater than 1. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param content
*/
interface before{(content: String): any}
/**
* Places the content before every node in the NodeList.
* The content will be cloned if the length of NodeList
* is greater than 1. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param content
*/
interface before{(content: HTMLElement): any}
/**
* Places the content before every node in the NodeList.
* The content will be cloned if the length of NodeList
* is greater than 1. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param content
*/
interface before{(content: NodeList): any}
/**
* Returns all immediate child elements for nodes in this dojo/NodeList.
* Optionally takes a query to filter the child elements.
* .end() can be used on the returned dojo/NodeList to get back to the
* original dojo/NodeList.
*
* @param query Optionala CSS selector.
*/
interface children{(query: String): any}
/**
* Clones all the nodes in this NodeList and returns them as a new NodeList.
* Only the DOM nodes are cloned, not any attached event handlers.
*
*/
interface clone{(): any}
/**
* Returns closest parent that matches query, including current node in this
* dojo/NodeList if it matches the query.
* .end() can be used on the returned dojo/NodeList to get back to the
* original dojo/NodeList.
*
* @param query a CSS selector.
* @param root OptionalIf specified, query is relative to "root" rather than document body.
*/
interface closest{(query: String, root: String): any}
/**
* Returns closest parent that matches query, including current node in this
* dojo/NodeList if it matches the query.
* .end() can be used on the returned dojo/NodeList to get back to the
* original dojo/NodeList.
*
* @param query a CSS selector.
* @param root OptionalIf specified, query is relative to "root" rather than document body.
*/
interface closest{(query: String, root: HTMLElement): any}
/**
* Returns a new NodeList comprised of items in this NodeList
* as well as items passed in as parameters
* This method behaves exactly like the Array.concat method
* with the caveat that it returns a NodeList and not a
* raw Array. For more details, see the Array.concat
* docs
*
* @param item OptionalAny number of optional parameters may be passed in to bespliced into the NodeList
*/
interface concat{(item: Object): any}
/**
* Attach event handlers to every item of the NodeList. Uses dojo.connect()
* so event properties are normalized.
*
* Application must manually require() "dojo/_base/connect" before using this method.
*
* @param methodName the name of the method to attach to. For DOM events, this should bethe lower-case name of the event
* @param objOrFunc if 2 arguments are passed (methodName, objOrFunc), objOrFunc shouldreference a function or be the name of the function in the globalnamespace to attach. If 3 arguments are provided(methodName, objOrFunc, funcName), objOrFunc must be the scope tolocate the bound function in
* @param funcName Optionaloptional. A string naming the function in objOrFunc to bind to theevent. May also be a function reference.
*/
interface connect{(methodName: String, objOrFunc: Object, funcName: String): void}
/**
* Attach event handlers to every item of the NodeList. Uses dojo.connect()
* so event properties are normalized.
*
* Application must manually require() "dojo/_base/connect" before using this method.
*
* @param methodName the name of the method to attach to. For DOM events, this should bethe lower-case name of the event
* @param objOrFunc if 2 arguments are passed (methodName, objOrFunc), objOrFunc shouldreference a function or be the name of the function in the globalnamespace to attach. If 3 arguments are provided(methodName, objOrFunc, funcName), objOrFunc must be the scope tolocate the bound function in
* @param funcName Optionaloptional. A string naming the function in objOrFunc to bind to theevent. May also be a function reference.
*/
interface connect{(methodName: String, objOrFunc: Function, funcName: String): void}
/**
* Attach event handlers to every item of the NodeList. Uses dojo.connect()
* so event properties are normalized.
*
* Application must manually require() "dojo/_base/connect" before using this method.
*
* @param methodName the name of the method to attach to. For DOM events, this should bethe lower-case name of the event
* @param objOrFunc if 2 arguments are passed (methodName, objOrFunc), objOrFunc shouldreference a function or be the name of the function in the globalnamespace to attach. If 3 arguments are provided(methodName, objOrFunc, funcName), objOrFunc must be the scope tolocate the bound function in
* @param funcName Optionaloptional. A string naming the function in objOrFunc to bind to theevent. May also be a function reference.
*/
interface connect{(methodName: String, objOrFunc: String, funcName: String): void}
/**
* Deprecated: Use position() for border-box x/y/w/h
* or marginBox() for margin-box w/h/l/t.
* Returns the box objects of all elements in a node list as
* an Array (not a NodeList). Acts like domGeom.coords, though assumes
* the node passed is each node in this list.
*
*/
interface coords{(): void}
/**
* stash or get some arbitrary data on/from these nodes.
* Stash or get some arbitrary data on/from these nodes. This private _data function is
* exposed publicly on dojo/NodeList, eg: as the result of a dojo/query call.
* DIFFERS from jQuery.data in that when used as a getter, the entire list is ALWAYS
* returned. EVEN WHEN THE LIST IS length == 1.
*
* A single-node version of this function is provided as dojo._nodeData, which follows
* the same signature, though expects a String ID or DomNode reference in the first
* position, before key/value arguments.
*
* @param key OptionalIf an object, act as a setter and iterate over said object setting data items as defined.If a string, and value present, set the data for defined key to valueIf a string, and value absent, act as a getter, returning the data associated with said key
* @param value OptionalThe value to set for said key, provided key is a string (and not an object)
*/
interface data{(key: Object, value: any): any}
/**
* stash or get some arbitrary data on/from these nodes.
* Stash or get some arbitrary data on/from these nodes. This private _data function is
* exposed publicly on dojo/NodeList, eg: as the result of a dojo/query call.
* DIFFERS from jQuery.data in that when used as a getter, the entire list is ALWAYS
* returned. EVEN WHEN THE LIST IS length == 1.
*
* A single-node version of this function is provided as dojo._nodeData, which follows
* the same signature, though expects a String ID or DomNode reference in the first
* position, before key/value arguments.
*
* @param key OptionalIf an object, act as a setter and iterate over said object setting data items as defined.If a string, and value present, set the data for defined key to valueIf a string, and value absent, act as a getter, returning the data associated with said key
* @param value OptionalThe value to set for said key, provided key is a string (and not an object)
*/
interface data{(key: String, value: any): any}
/**
* Monitor nodes in this NodeList for [bubbled] events on nodes that match selector.
* Calls fn(evt) for those events, where (inside of fn()), this == the node
* that matches the selector.
* Sets up event handlers that can catch events on any subnodes matching a given selector,
* including nodes created after delegate() has been called.
*
* This allows an app to setup a single event handler on a high level node, rather than many
* event handlers on subnodes. For example, one onclick handler for a Tree widget, rather than separate
* handlers for each node in the tree.
* Since setting up many event handlers is expensive, this can increase performance.
*
* Note that delegate() will not work for events that don't bubble, like focus.
* onmouseenter/onmouseleave also don't currently work.
*
* @param selector CSS selector valid to dojo.query, like ".foo" or "div > span". Theselector is relative to the nodes in this NodeList, not the document root.For example myNodeList.delegate("> a", "onclick", ...) will catch events onanchor nodes which are (immediate) children of the nodes in myNodeList.
* @param eventName Standard event name used as an argument to dojo.connect, like "onclick".
* @param fn Callback function passed the event object, and where this == the node that matches the selector.That means that for example, after setting up a handler viadojo.query("body").delegate("fieldset", "onclick", ...)clicking on a fieldset or any nodes inside of a fieldset will be reportedas a click on the fieldset itself.
*/
interface delegate{(selector: String, eventName: String, fn: Function): any}
/**
* Renders the specified template in each of the NodeList entries.
*
* @param template The template string or location
* @param context The context object or location
*/
interface dtl{(template: String, context: Object): Function}
/**
* clears all content from each node in the list. Effectively
* equivalent to removing all child nodes from every item in
* the list.
*
*/
interface empty{(): any}
/**
* Ends use of the current NodeList by returning the previous NodeList
* that generated the current NodeList.
* Returns the NodeList that generated the current NodeList. If there
* is no parent NodeList, an empty NodeList is returned.
*
*/
interface end{(): any}
/**
* Returns the even nodes in this dojo/NodeList as a dojo/NodeList.
* .end() can be used on the returned dojo/NodeList to get back to the
* original dojo/NodeList.
*
*/
interface even{(): any}
/**
* see dojo/_base/array.every() and the Array.every
* docs.
* Takes the same structure of arguments and returns as
* dojo/_base/array.every() with the caveat that the passed array is
* implicitly this NodeList
*
* @param callback the callback
* @param thisObject Optionalthe context
*/
interface every{(callback: Function, thisObject: Object): any}
/**
* fade in all elements of this NodeList via dojo.fadeIn
*
* @param args OptionalAdditional dojo/_base/fx.Animation arguments to mix into this set with the addition ofan auto parameter.
*/
interface fadeIn{(args: Object): any}
/**
* fade out all elements of this NodeList via dojo.fadeOut
*
* @param args OptionalAdditional dojo/_base/fx.Animation arguments to mix into this set with the addition ofan auto parameter.
*/
interface fadeOut{(args: Object): any}
/**
* "masks" the built-in javascript filter() method (supported
* in Dojo via dojo.filter) to support passing a simple
* string filter in addition to supporting filtering function
* objects.
*
* @param filter If a string, a CSS rule like ".thinger" or "div > span".
*/
interface filter{(filter: String): any}
/**
* "masks" the built-in javascript filter() method (supported
* in Dojo via dojo.filter) to support passing a simple
* string filter in addition to supporting filtering function
* objects.
*
* @param filter If a string, a CSS rule like ".thinger" or "div > span".
*/
interface filter{(filter: Function): any}
/**
* Returns the first node in this dojo/NodeList as a dojo/NodeList.
* .end() can be used on the returned dojo/NodeList to get back to the
* original dojo/NodeList.
*
*/
interface first{(): any}
/**
* see dojo/_base/array.forEach(). The primary difference is that the acted-on
* array is implicitly this NodeList. If you want the option to break out
* of the forEach loop, use every() or some() instead.
*
* @param callback
* @param thisObj
*/
interface forEach{(callback: any, thisObj: any): Function}
/**
* allows setting the innerHTML of each node in the NodeList,
* if there is a value passed in, otherwise, reads the innerHTML value of the first node.
* This method is simpler than the dojo/NodeList.html() method provided by
* dojo/NodeList-html. This method just does proper innerHTML insertion of HTML fragments,
* and it allows for the innerHTML to be read for the first node in the node list.
* Since dojo/NodeList-html already took the "html" name, this method is called
* "innerHTML". However, if dojo/NodeList-html has not been loaded yet, this
* module will define an "html" method that can be used instead. Be careful if you
* are working in an environment where it is possible that dojo/NodeList-html could
* have been loaded, since its definition of "html" will take precedence.
* The nodes represented by the value argument will be cloned if more than one
* node is in this NodeList. The nodes in this NodeList are returned in the "set"
* usage of this method, not the HTML that was inserted.
*
* @param value Optional
*/
interface html{(value: String): any}
/**
* allows setting the innerHTML of each node in the NodeList,
* if there is a value passed in, otherwise, reads the innerHTML value of the first node.
* This method is simpler than the dojo/NodeList.html() method provided by
* dojo/NodeList-html. This method just does proper innerHTML insertion of HTML fragments,
* and it allows for the innerHTML to be read for the first node in the node list.
* Since dojo/NodeList-html already took the "html" name, this method is called
* "innerHTML". However, if dojo/NodeList-html has not been loaded yet, this
* module will define an "html" method that can be used instead. Be careful if you
* are working in an environment where it is possible that dojo/NodeList-html could
* have been loaded, since its definition of "html" will take precedence.
* The nodes represented by the value argument will be cloned if more than one
* node is in this NodeList. The nodes in this NodeList are returned in the "set"
* usage of this method, not the HTML that was inserted.
*
* @param value Optional
*/
interface html{(value: HTMLElement): any}
/**
* allows setting the innerHTML of each node in the NodeList,
* if there is a value passed in, otherwise, reads the innerHTML value of the first node.
* This method is simpler than the dojo/NodeList.html() method provided by
* dojo/NodeList-html. This method just does proper innerHTML insertion of HTML fragments,
* and it allows for the innerHTML to be read for the first node in the node list.
* Since dojo/NodeList-html already took the "html" name, this method is called
* "innerHTML". However, if dojo/NodeList-html has not been loaded yet, this
* module will define an "html" method that can be used instead. Be careful if you
* are working in an environment where it is possible that dojo/NodeList-html could
* have been loaded, since its definition of "html" will take precedence.
* The nodes represented by the value argument will be cloned if more than one
* node is in this NodeList. The nodes in this NodeList are returned in the "set"
* usage of this method, not the HTML that was inserted.
*
* @param value Optional
*/
interface html{(value: NodeList): any}
/**
* see dojo/_base/array.indexOf(). The primary difference is that the acted-on
* array is implicitly this NodeList
* For more details on the behavior of indexOf, see Mozilla's
* indexOf
* docs
*
* @param value The value to search for.
* @param fromIndex OptionalThe location to start searching from. Optional. Defaults to 0.
*/
interface indexOf{(value: Object, fromIndex: number): any}
/**
* allows setting the innerHTML of each node in the NodeList,
* if there is a value passed in, otherwise, reads the innerHTML value of the first node.
* This method is simpler than the dojo/NodeList.html() method provided by
* dojo/NodeList-html. This method just does proper innerHTML insertion of HTML fragments,
* and it allows for the innerHTML to be read for the first node in the node list.
* Since dojo/NodeList-html already took the "html" name, this method is called
* "innerHTML". However, if dojo/NodeList-html has not been loaded yet, this
* module will define an "html" method that can be used instead. Be careful if you
* are working in an environment where it is possible that dojo/NodeList-html could
* have been loaded, since its definition of "html" will take precedence.
* The nodes represented by the value argument will be cloned if more than one
* node is in this NodeList. The nodes in this NodeList are returned in the "set"
* usage of this method, not the HTML that was inserted.
*
* @param value Optional
*/
interface innerHTML{(value: String): any}
/**
* allows setting the innerHTML of each node in the NodeList,
* if there is a value passed in, otherwise, reads the innerHTML value of the first node.
* This method is simpler than the dojo/NodeList.html() method provided by
* dojo/NodeList-html. This method just does proper innerHTML insertion of HTML fragments,
* and it allows for the innerHTML to be read for the first node in the node list.
* Since dojo/NodeList-html already took the "html" name, this method is called
* "innerHTML". However, if dojo/NodeList-html has not been loaded yet, this
* module will define an "html" method that can be used instead. Be careful if you
* are working in an environment where it is possible that dojo/NodeList-html could
* have been loaded, since its definition of "html" will take precedence.
* The nodes represented by the value argument will be cloned if more than one
* node is in this NodeList. The nodes in this NodeList are returned in the "set"
* usage of this method, not the HTML that was inserted.
*
* @param value Optional
*/
interface innerHTML{(value: HTMLElement): any}
/**
* allows setting the innerHTML of each node in the NodeList,
* if there is a value passed in, otherwise, reads the innerHTML value of the first node.
* This method is simpler than the dojo/NodeList.html() method provided by
* dojo/NodeList-html. This method just does proper innerHTML insertion of HTML fragments,
* and it allows for the innerHTML to be read for the first node in the node list.
* Since dojo/NodeList-html already took the "html" name, this method is called
* "innerHTML". However, if dojo/NodeList-html has not been loaded yet, this
* module will define an "html" method that can be used instead. Be careful if you
* are working in an environment where it is possible that dojo/NodeList-html could
* have been loaded, since its definition of "html" will take precedence.
* The nodes represented by the value argument will be cloned if more than one
* node is in this NodeList. The nodes in this NodeList are returned in the "set"
* usage of this method, not the HTML that was inserted.
*
* @param value Optional
*/
interface innerHTML{(value: NodeList): any}
/**
* The nodes in this NodeList will be placed after the nodes
* matched by the query passed to insertAfter.
* The nodes in this NodeList will be cloned if the query
* matches more than one element. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param query
*/
interface insertAfter{(query: String): any}
/**
* The nodes in this NodeList will be placed after the nodes
* matched by the query passed to insertAfter.
* The nodes in this NodeList will be cloned if the query
* matches more than one element. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param query
*/
interface insertBefore{(query: String): any}
/**
* Create a new instance of a specified class, using the
* specified properties and each node in the NodeList as a
* srcNodeRef.
*
* @param declaredClass
* @param properties Optional
*/
interface instantiate{(declaredClass: String, properties: Object): any}
/**
* Create a new instance of a specified class, using the
* specified properties and each node in the NodeList as a
* srcNodeRef.
*
* @param declaredClass
* @param properties Optional
*/
interface instantiate{(declaredClass: Object, properties: Object): any}
/**
* Returns the last node in this dojo/NodeList as a dojo/NodeList.
* .end() can be used on the returned dojo/NodeList to get back to the
* original dojo/NodeList.
*
*/
interface last{(): any}
/**
* see dojo/_base/array.lastIndexOf(). The primary difference is that the
* acted-on array is implicitly this NodeList
* For more details on the behavior of lastIndexOf, see
* Mozilla's lastIndexOf
* docs
*
* @param value The value to search for.
* @param fromIndex OptionalThe location to start searching from. Optional. Defaults to 0.
*/
interface lastIndexOf{(value: Object, fromIndex: number): any}
/**
* see dojo/_base/array.map(). The primary difference is that the acted-on
* array is implicitly this NodeList and the return is a
* NodeList (a subclass of Array)
*
* @param func
* @param obj Optional
*/
interface map{(func: Function, obj: Function): any}
/**
* Returns margin-box size of nodes
*
*/
interface marginBox{(): void}
/**
* Returns the next element for nodes in this dojo/NodeList.
* Optionally takes a query to filter the next elements.
* .end() can be used on the returned dojo/NodeList to get back to the
* original dojo/NodeList.
*
* @param query Optionala CSS selector.
*/
interface next{(query: String): any}
/**
* Returns all sibling elements that come after the nodes in this dojo/NodeList.
* Optionally takes a query to filter the sibling elements.
* .end() can be used on the returned dojo/NodeList to get back to the
* original dojo/NodeList.
*
* @param query Optionala CSS selector.
*/
interface nextAll{(query: String): any}
/**
* Returns the odd nodes in this dojo/NodeList as a dojo/NodeList.
* .end() can be used on the returned dojo/NodeList to get back to the
* original dojo/NodeList.
*
*/
interface odd{(): any}
/**
* Listen for events on the nodes in the NodeList. Basic usage is:
*
* @param eventName
* @param listener
*/
interface on{(eventName: any, listener: any): any}
/**
* removes elements in this list that match the filter
* from their parents and returns them as a new NodeList.
*
* @param filter OptionalCSS selector like ".foo" or "div > span"
*/
interface orphan{(filter: String): any}
/**
* Returns immediate parent elements for nodes in this dojo/NodeList.
* Optionally takes a query to filter the parent elements.
* .end() can be used on the returned dojo/NodeList to get back to the
* original dojo/NodeList.
*
* @param query Optionala CSS selector.
*/
interface parent{(query: String): any}
/**
* Returns all parent elements for nodes in this dojo/NodeList.
* Optionally takes a query to filter the child elements.
* .end() can be used on the returned dojo/NodeList to get back to the
* original dojo/NodeList.
*
* @param query Optionala CSS selector.
*/
interface parents{(query: String): any}
/**
* places elements of this node list relative to the first element matched
* by queryOrNode. Returns the original NodeList. See: dojo/dom-construct.place
*
* @param queryOrNode may be a string representing any valid CSS3 selector or a DOM node.In the selector case, only the first matching element will be usedfor relative positioning.
* @param position can be one of:"last" (default)"first""before""after""only""replace"or an offset in the childNodes property
*/
interface place{(queryOrNode: String, position: String): any}
/**
* places elements of this node list relative to the first element matched
* by queryOrNode. Returns the original NodeList. See: dojo/dom-construct.place
*
* @param queryOrNode may be a string representing any valid CSS3 selector or a DOM node.In the selector case, only the first matching element will be usedfor relative positioning.
* @param position can be one of:"last" (default)"first""before""after""only""replace"or an offset in the childNodes property
*/
interface place{(queryOrNode: HTMLElement, position: String): any}
/**
* Returns border-box objects (x/y/w/h) of all elements in a node list
* as an Array (not a NodeList). Acts like dojo/dom-geometry-position, though
* assumes the node passed is each node in this list.
*
*/
interface position{(): any}
/**
* prepends the content to every node in the NodeList.
* The content will be cloned if the length of NodeList
* is greater than 1. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param content
*/
interface prepend{(content: String): any}
/**
* prepends the content to every node in the NodeList.
* The content will be cloned if the length of NodeList
* is greater than 1. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param content
*/
interface prepend{(content: HTMLElement): any}
/**
* prepends the content to every node in the NodeList.
* The content will be cloned if the length of NodeList
* is greater than 1. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param content
*/
interface prepend{(content: NodeList): any}
/**
* prepends nodes in this NodeList to the nodes matched by
* the query passed to prependTo.
* The nodes in this NodeList will be cloned if the query
* matches more than one element. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param query
*/
interface prependTo{(query: String): any}
/**
* Returns the previous element for nodes in this dojo/NodeList.
* Optionally takes a query to filter the previous elements.
* .end() can be used on the returned dojo/NodeList to get back to the
* original dojo/NodeList.
*
* @param query Optionala CSS selector.
*/
interface prev{(query: String): any}
/**
* Returns all sibling elements that come before the nodes in this dojo/NodeList.
* Optionally takes a query to filter the sibling elements.
* The returned nodes will be in reverse DOM order -- the first node in the list will
* be the node closest to the original node/NodeList.
* .end() can be used on the returned dojo/NodeList to get back to the
* original dojo/NodeList.
*
* @param query Optionala CSS selector.
*/
interface prevAll{(query: String): any}
/**
* Returns a new list whose members match the passed query,
* assuming elements of the current NodeList as the root for
* each search.
*
* @param queryStr
*/
interface query{(queryStr: String): any}
/**
* removes elements in this list that match the filter
* from their parents and returns them as a new NodeList.
*
* @param filter OptionalCSS selector like ".foo" or "div > span"
*/
interface remove{(filter: String): any}
/**
* Removes an attribute from each node in the list.
*
* @param name the name of the attribute to remove
*/
interface removeAttr{(name: String): void}
/**
* removes the specified class from every node in the list
*
* @param className OptionalAn optional String class name to remove, or several space-separatedclass names, or an array of class names. If omitted, all class nameswill be deleted.
*/
interface removeClass{(className: String): any}
/**
* removes the specified class from every node in the list
*
* @param className OptionalAn optional String class name to remove, or several space-separatedclass names, or an array of class names. If omitted, all class nameswill be deleted.
*/
interface removeClass{(className: any[]): any}
/**
* Animate the effect of removing a class to all nodes in this list.
* see dojox.fx.removeClass
*
* @param cssClass
* @param args
*/
interface removeClassFx{(cssClass: any, args: any): {type:Function;value:any}}
/**
* Remove the data associated with these nodes.
*
* @param key OptionalIf omitted, clean all data for this node.If passed, remove the data item found at key
*/
interface removeData{(key: String): void}
/**
* replaces nodes matched by the query passed to replaceAll with the nodes
* in this NodeList.
* The nodes in this NodeList will be cloned if the query
* matches more than one element. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param query
*/
interface replaceAll{(query: String): any}
/**
* Replaces one or more classes on a node if not present.
* Operates more quickly than calling removeClass() and addClass()
*
* @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
* @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
*/
interface replaceClass{(addClassStr: String, removeClassStr: String): void}
/**
* Replaces one or more classes on a node if not present.
* Operates more quickly than calling removeClass() and addClass()
*
* @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
* @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
*/
interface replaceClass{(addClassStr: any[], removeClassStr: String): void}
/**
* Replaces one or more classes on a node if not present.
* Operates more quickly than calling removeClass() and addClass()
*
* @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
* @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
*/
interface replaceClass{(addClassStr: String, removeClassStr: any[]): void}
/**
* Replaces one or more classes on a node if not present.
* Operates more quickly than calling removeClass() and addClass()
*
* @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
* @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
*/
interface replaceClass{(addClassStr: any[], removeClassStr: any[]): void}
/**
* Replaces each node in ths NodeList with the content passed to replaceWith.
* The content will be cloned if the length of NodeList
* is greater than 1. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param content
*/
interface replaceWith{(content: String): any}
/**
* Replaces each node in ths NodeList with the content passed to replaceWith.
* The content will be cloned if the length of NodeList
* is greater than 1. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param content
*/
interface replaceWith{(content: HTMLElement): any}
/**
* Replaces each node in ths NodeList with the content passed to replaceWith.
* The content will be cloned if the length of NodeList
* is greater than 1. Only the DOM nodes are cloned, not
* any attached event handlers.
*
* @param content
*/
interface replaceWith{(content: NodeList): any}
/**
* Returns all sibling elements for nodes in this dojo/NodeList.
* Optionally takes a query to filter the sibling elements.
* .end() can be used on the returned dojo/NodeList to get back to the
* original dojo/NodeList.
*
* @param query Optionala CSS selector.
*/
interface siblings{(query: String): any}
/**
* Returns a new NodeList, maintaining this one in place
* This method behaves exactly like the Array.slice method
* with the caveat that it returns a dojo/NodeList and not a
* raw Array. For more details, see Mozilla's slice
* documentation
*
* @param begin Can be a positive or negative integer, with positiveintegers noting the offset to begin at, and negativeintegers denoting an offset from the end (i.e., to the leftof the end)
* @param end OptionalOptional parameter to describe what position relative tothe NodeList's zero index to end the slice at. Like begin,can be positive or negative.
*/
interface slice{(begin: number, end: number): any}
/**
* slide all elements of the node list to the specified place via dojo/fx.slideTo()
*
* @param args OptionalAdditional dojo/_base/fx.Animation arguments to mix into this set with the addition ofan auto parameter.
*/
interface slideTo{(args: Object): any}
/**
* Takes the same structure of arguments and returns as