-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathindex.d.ts
More file actions
2886 lines (2444 loc) · 103 KB
/
Copy pathindex.d.ts
File metadata and controls
2886 lines (2444 loc) · 103 KB
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
/**
* filename: index.d.ts
* version : 4.2.52
* Copyright Syncfusion Inc. 2001 - 2018. All rights reserved.
* Use of this code is subject to the terms of our license.
* A copy of the current license can be obtained at any time by e-mailing
* licensing@syncfusion.com. Any infringement will be prosecuted under
* applicable laws.
*/
declare namespace ej {
const dataUtil: DataUtil;
function isMobile(): boolean;
function isIOS(): boolean;
function isAndroid(): boolean;
function isFlat(): boolean;
function isWindows(): boolean;
function isCssCalc(): boolean;
function getCurrentPage(): JQuery;
function isLowerResolution(): boolean;
function browserInfo(): BrowserInfoOptions;
function isTouchDevice(): boolean;
function addPrefix(style: string): string;
function animationEndEvent(): string;
function blockDefaultActions(e: any): void;
function buildTag(tag: string, innerHtml?: string, styles?: any, attrs?: any): JQuery;
function cancelEvent(): string;
function copyObject(): string;
function createObject(nameSpace: string, value: any, initIn: any): JQuery;
function createObject(element: any, eventEmitter: any, model: any): any;
function setCulture(culture: string): void;
function getObject(element: string, model: any): any;
function getObject(nameSpace: string, fromdata?: any): any;
function defineClass(className: string, constr: any, proto: any, replace: boolean): any;
function destroyWidgets(element: any): void;
function endEvent(): string;
function event(type: string, data: any, eventProp: any): any;
function getAndroidVersion(): any;
function getAttrVal(ele: any, val: string, option: any): any;
function getBooleanVal(ele: any, val: string, option: any): any;
function getClearString(): string;
function getDimension(element: any, method: string): any;
function getFontString(fontObj: any): string;
function getFontStyle(style: string): string;
function getMaxZindex(): number;
function getNameSpace(className: string): string;
function getOffset(ele: string): any;
function getRenderMode(): string;
function getScrollableParents(element: any): JQuery;
function getTheme(): string;
function getZindexPartial(element: any, popupEle: string): number;
function hasRenderMode(element: string): void;
function hasStyle(prop: string): boolean;
function hasTheme(element: string): string;
function hexFromRGB(color: string): string;
function ieClearRemover(element: string): void;
function isAndroidWebView(): string;
function isDevice(): boolean;
function isIOS7(): boolean;
function isIOSWebView(): boolean;
function isLowerAndroid(): boolean;
function isNullOrUndefined(value: any): boolean;
function isPlainObject(): JQuery;
function isPortrait(): any;
function isTablet(): boolean;
function isWindowsWebView(): string;
function listenEvents(selectors: any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void;
function listenTouchEvent(selectors: any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void;
function logBase(val: string, base: string): number;
function measureText(text: string, maxwidth: number, font: string): string;
function moveEvent(): string;
function print(element: string, printWindow: any): void;
function proxy(fn: any, context?: string, arg?: string): any;
function round(value: string, div: string, up: string): any;
function sendAjaxRequest(ajaxOptions: any): void;
function setCaretToPos(nput: string, pos1: string, pos2: string): void;
function setRenderMode(element: string): void;
function setTheme(): any;
function startEvent(): string;
function tapEvent(): string;
function tapHoldEvent(): string;
function throwError(): any;
function transitionEndEvent(): any;
function userAgent(): boolean;
function widget(pluginName: string, className: string, proto: any): any;
function avg(json: any, filedName: string): any;
function getGuid(prefix: string): number;
function group(jsonArray: any, field: string, agg: string, level: number, groupDs: string): any;
function isJSON(jsonData: string): string;
function max(jsonArray: any, fieldName?: string, comparer?: string): any;
function min(jsonArray: any, fieldName: string, comparer: string): any;
function merge(first: string, second: string): any;
function mergeshort(jsonArray: any, fieldName: string, comparer: string): any;
function parseJSON(jsonText: string): string;
function parseTable(table: number, headerOption: string, headerRowIndex: string): any;
function select(jsonArray: any, fields: string): any;
function setTransition(): boolean;
function sum(json: string, fieldName: string): string;
function swap(array: any, x: string, y: string): any;
const cssUA: string;
const serverTimezoneOffset: number;
const transform: string;
const transformOrigin: string;
const transformStyle: string;
const transition: string;
const transitionDelay: string;
const transitionDuration: string;
const transitionProperty: string;
const transitionTimingFunction: string;
const template: any;
const util: {
valueFunction(val: string): any;
};
export namespace device {
function isAndroid(): boolean;
function isIOS(): boolean;
function isFlat(): boolean;
function isIOS7(): boolean;
function isWindows(): boolean;
}
export namespace widget {
const autoInit: boolean;
const registeredInstances: any[];
const registeredWidgets: any[];
function register(pluginName: string, className: string, prototype: any): void;
function destroyAll(elements: Element): void;
function init(element: Element): void;
function registerInstance(element: Element, pluginName: string, className: string, prototype: any): void;
}
interface BrowserInfoOptions {
name: string;
version: string;
culture: any;
isMSPointerEnabled: boolean;
}
class WidgetBase {
public destroy(): void;
public element: JQuery;
public setModel(options: any, forceSet?: boolean): any;
public option(prop?: any, value?: any, forceSet?: boolean): any;
public _trigger(eventName?: string, eventProp?: any): any;
public _on(element: JQuery, eventType?: string, handler?: (eventObject: JQueryEventObject) => any): any;
public _on(element: JQuery, eventType?: string, selector?: string, handler?: (eventObject: JQueryEventObject) => any): any;
public _off(element: JQuery, eventName: string, handler?: (eventObject: JQueryEventObject) => any): any;
public _off(element: JQuery, eventType?: string, selector?: string, handler?: (eventObject: JQueryEventObject) => any): any;
public persistState(): void;
public restoreState(silent: boolean): void;
}
class Widget extends WidgetBase {
constructor(pluginName: string, className: string, proto: any);
public static fn: Widget;
public static extend(widget: Widget): any;
public register(pluginName: string, className: string, prototype: any): void;
public destroyAll(elements: Element): void;
public model: any;
}
interface BaseEvent {
cancel: boolean;
type: string;
}
class DataManager {
constructor(dataSource?: any, query?: ej.Query, adaptor?: any);
public setDefaultQuery(query: ej.Query): void;
public executeQuery(query?: ej.Query, done?: any, fail?: any, always?: any): JQueryPromise<any>;
public executeLocal(query?: ej.Query): ej.DataManager;
public saveChanges(changes?: Changes, key?: string, tableName?: string): JQueryDeferred<any>;
public insert(data: any, tableName?: string): JQueryPromise<any>;
public remove(keyField: string, value: any, tableName?: string): any;
public publicupdate(keyField: string, value: any, tableName?: string): any;
}
class Query {
constructor();
public static fn: Query;
public static extend(prototype: any): Query;
public key(field: string): ej.Query;
public using(dataManager: ej.DataManager): ej.Query;
public execute(dataManager: ej.DataManager, done: any, fail?: string, always?: string): any;
public executeLocal(dataManager: ej.DataManager): ej.DataManager;
public clone(): ej.Query;
public from(tableName: any): ej.Query;
public addParams(key: string, value: string): ej.Query;
public expand(tables: any): ej.Query;
public where(fieldName: string, operator: ej.FilterOperators, value: any, ignoreCase?: boolean, ignoreAccent?: boolean): ej.Query;
public where(predicate: ej.Predicate): ej.Query;
public search(searchKey: any, fieldNames?: any, operator?: string, ignoreCase?: boolean, ignoreAccent?: boolean): ej.Query;
public sortBy(fieldName: string, comparer?: ej.SortOrder, isFromGroup?: boolean): ej.Query;
public sortByDesc(fieldName: string): ej.Query;
public group(fieldName: string): ej.Query;
public page(pageIndex: number, pageSize: number): ej.Query;
public take(nos: number): ej.Query;
public skip(nos: number): ej.Query;
public select(fieldNames: any): ej.Query;
public hierarchy(query: ej.Query, selectorFn: any): ej.Query;
public foreignKey(key: string): ej.Query;
public requiresCount(): ej.Query;
public range(start: number, end: number): ej.Query;
}
class Adaptor {
constructor(ds: any);
public pvt: any;
public type: ej.Adaptor;
public options: AdaptorOptions;
public extend(overrides: any): ej.Adaptor;
public processQuery(dm: ej.DataManager, query: ej.Query): any;
public processResponse(data: any, ds: any, query: ej.Query, xhr: JQueryXHR, request?: any, changes?: Changes): any;
public convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam;
}
interface AdaptorOptions {
from?: string;
requestType?: string;
sortBy?: string;
select?: string;
skip?: string;
group?: string;
take?: string;
search?: string;
count?: string;
where?: string;
aggregates?: string;
}
class UrlAdaptor extends ej.Adaptor {
constructor();
public processQuery(dm: ej.DataManager, query: ej.Query, hierarchyFilters?: any): {
type: string; url: string; ejPvtData: any; contentType?: string; data?: any;
};
public convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam;
public processResponse(data: any, ds: any, query: ej.Query, xhr: JQueryXHR, request?: any, changes?: Changes): any;
public onGroup(e: any): void;
public onAggregates(e: any): void;
public batchRequest(dm: ej.DataManager, changes: Changes, e: any): void;
public beforeSend(dm: ej.DataManager, request: any, settings?: any): void;
public insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any };
public remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data?: any };
public update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data: any };
public getFiltersFrom(data: any, query: ej.Query): ej.Predicate;
}
class WebMethodAdaptor extends ej.UrlAdaptor {
constructor();
public processQuery(dm: ej.DataManager, query: ej.Query, hierarchyFilters?: any): {
type: string; url: string; ejPvtData: any; contentType?: string; data?: any;
};
}
class CacheAdaptor extends ej.UrlAdaptor {
constructor();
public init(adaptor: any, timeStamp: number, pageSize: number): void;
public generateKey(url: string, query: ej.Query): string;
public processQuery(dm: ej.DataManager, query: ej.Query, hierarchyFilters?: any): any;
public processResponse(data: any, ds: any, query: ej.Query, xhr: JQueryXHR, request?: any, changes?: Changes): any;
public insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any };
public remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data?: any };
public update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data: any };
public batchRequest(dm: ej.DataManager, changes: Changes, e: any): { url: string; type: string; data: any; contentType: string };
}
class ODataAdaptor extends ej.UrlAdaptor {
constructor();
public options: UrlAdaptorOptions;
public onEachWhere(filter: any, requiresCast: boolean): any;
public onPredicate(pred: ej.Predicate, query: ej.Query, requiresCast: boolean): string;
public onComplexPredicate(pred: ej.Predicate, requiresCast: boolean): string;
public onWhere(filters: string[]): string;
public onEachSearch(e: any): void;
public onSearch(e: any): string;
public onEachSort(e: any): string;
public onSortBy(e: any): string;
public onGroup(e: any): string;
public onSelect(e: any): string;
public onAggregates(e: any): string;
public onCount(e: any): string;
public beforeSend(dm: ej.DataManager, request: any, settings?: any): void;
public processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): {
result: any; count: number
};
public convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam;
public insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any; };
public remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { url: string; type: string; };
// tslint:disable-next-line:max-line-length
public update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { url: string; type: string; data: any; accept: string; };
public batchRequest(dm: ej.DataManager, changes: Changes, e: any): { url: string; type: string; data: any; contentType: string; };
public generateDeleteRequest(arr: any[], e: any): string;
public generateInsertRequest(arr: any[], e: any): string;
public generateUpdateRequest(arr: any[], e: any): string;
}
interface UrlAdaptorOptions {
requestType?: string;
accept?: string;
multipartAccept?: string;
sortBy?: string;
select?: string;
skip?: string;
take?: string;
count?: string;
where?: string;
expand?: string;
batch?: string;
changeSet?: string;
batchPre?: string;
contentId?: string;
batchContent?: string;
changeSetContent?: string;
batchChangeSetContentType?: string;
}
class WebApiAdaptor extends ej.ODataAdaptor {
constructor();
public insert(dm: ej.DataManager, data: any, tableName?: string): { url: string; type: string; data: any; };
public remove(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: any; };
// tslint:disable-next-line:max-line-length
public update(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: any; accept: string; };
public processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): {
result: any; count: number
};
}
class ODataV4Adaptor extends ej.ODataAdaptor {
constructor();
public options: ODataAdaptorOptions;
public onCount(e: any): string;
public onEachSearch(e: any): void;
public onSearch(e: any): string;
public beforeSend(dm: ej.DataManager, request: any, settings?: any): void;
public processQuery(ds: any, query: ej.Query): {
type: string; url: string; ejPvtData: any; contentType?: string; data?: any;
};
public processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): {
result: any; count: number
};
}
interface ODataAdaptorOptions {
requestType?: string;
accept?: string;
multipartAccept?: string;
sortBy?: string;
select?: string;
skip?: string;
take?: string;
count?: string;
search?: string;
where?: string;
expand?: string;
batch?: string;
changeSet?: string;
batchPre?: string;
contentId?: string;
batchContent?: string;
changeSetContent?: string;
batchChangeSetContentType?: string;
}
class JsonAdaptor extends ej.Adaptor {
constructor();
public processQuery(ds: any, query: ej.Query): string;
public batchRequest(dm: ej.DataManager, changes: Changes, e: any): Changes;
public onWhere(ds: any, e: any): any;
public onAggregates(ds: any, e: any): any;
public onSearch(ds: any, e: any): any;
public onSortBy(ds: any, e: any, query: ej.Query): any;
public onGroup(ds: any, e: any, query: ej.Query): any;
public onPage(ds: any, e: any, query: ej.Query): any;
public onRange(ds: any, e: any): any;
public onTake(ds: any, e: any): any;
public onSkip(ds: any, e: any): any;
public onSelect(ds: any, e: any): any;
public insert(dm: ej.DataManager, data: any, tableName?: string): any;
public remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): any;
public update(dm: ej.DataManager, keyField: string, value: any, tableName: string): any;
}
class ForeignKeyAdaptor extends ej.JsonAdaptor {
constructor(data: any, type: string);
public processQuery(ds: any, query: ej.Query): any;
public insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any };
public update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { url: string; type: string; data: any };
}
class RemoteSaveAdaptor extends ej.UrlAdaptor {
constructor();
public batchRequest(dm: ej.DataManager, changes: Changes, e: any): void;
public beforeSend(dm: ej.DataManager, request: any, settings?: any): void;
public insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any };
public remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data?: any };
public update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data: any };
}
class TableModel {
constructor(name: string, jsonArray: any[], dataManager: ej.DataManager, modelComputed: any);
public on(eventName: string, handler: any): void;
public off(eventName: string, handler: any): void;
public setDataManager(dataManager: DataManager): void;
public saveChanges(): void;
public rejectChanges(): void;
public insert(json: any): void;
public update(value: any): void;
public remove(key: string): void;
public isDirty(): boolean;
public getChanges(): Changes;
public toArray(): any[];
public setDirty(dirty: any, model: any): void;
public get(index: number): void;
public length(): number;
public bindTo(element: any): void;
}
class Model {
constructor(json: any, table: string, name: string);
public formElements: string[];
public computes(value: any): void;
public on(eventName: string, handler: any): void;
public off(eventName: string, handler: any): void;
public set(field: string, value: any): void;
public get(field: string): any;
public revert(suspendEvent: any): void;
public save(dm: ej.DataManager, key: string): void;
public markCommit(): void;
public markDelete(): void;
public changeState(state: boolean, args: any): void;
public properties(): any;
public bindTo(element: any): void;
public unbind(element: any): void;
}
interface Changes {
changed?: any[];
added?: any[];
deleted?: any[];
}
class Predicate {
constructor();
constructor(field: string, operator: ej.FilterOperators, value: any, ignoreCase: boolean, ignoreAccent?: boolean);
public and(field: string, operator: any, value: any, ignoreCase: boolean, ignoreAccent?: boolean): ej.Predicate;
public or(field: string, operator: any, value: any, ignoreCase: boolean, ignoreAccent?: boolean): ej.Predicate;
public or(predicate: any[]): any;
public validate(record: any): boolean;
public toJSON(): {
isComplex: boolean;
field: string;
operator: string;
value: any;
ignoreCase: boolean;
condition: string;
predicates: any;
};
}
interface DataUtil {
swap(array: any[], x: number, y: number): void;
mergeSort(jsonArray: any[], fieldName?: string, comparer?: any): any[];
max(jsonArray: any[], fieldName?: string, comparer?: string): any[];
min(jsonArray: any[], fieldName: string, comparer: string): any[];
distinct(jsonArray: any[], fieldName?: string, requiresCompleteRecord?: any): any[];
sum(json: any, fieldName: string): number;
avg(json: any, fieldName: string): number;
select(jsonArray: any[], fieldName: string, fields: string): any[];
group(jsonArray: any[], field: string, /* internal */ level: number): any[];
parseTable(table: string, headerOption: ej.headerOption, headerRowIndex: number): any;
}
interface AjaxSettings {
type?: string;
cache: boolean;
data?: any;
dataType?: string;
contentType?: any;
async?: boolean;
}
enum FilterOperators {
contains,
endsWith,
equal,
greaterThan,
greaterThanOrEqual,
lessThan,
lessThanOrEqual,
notEqual,
startsWith
}
enum MatrixDefaults {
m11,
m12,
m21,
m22,
offsetX,
offsetY,
type
}
enum MatrixTypes {
Identity,
Scaling,
Translation,
Unknown
}
enum Orientation {
Horizontal,
Vertical
}
enum SliderType {
Default,
MinRange,
Range
}
enum eventType {
click,
mouseDown,
mouseLeave,
mouseMove,
mouseUp
}
enum headerOption {
row,
tHead
}
enum filterType {
StartsWith,
Contains,
EndsWith,
LessThan,
GreaterThan,
LessThanOrEqual,
GreaterThanOrEqual,
Equal,
NotEqual
}
enum Animation {
Fade,
None,
Slide
}
enum Type {
Overlay,
Slide
}
enum SortOrder {
Ascending,
Descending
}
const globalize: Globalize;
const cultures: Culture;
function addCulture(name: string, culture?: any): void;
function preferredCulture(culture?: string): Culture;
function format(value: any, format: string, culture?: string): string;
function parseInt(value: string, radix?: any, culture?: string): number;
function parseFloat(value: string, radix?: any, culture?: string): number;
function parseDate(value: string, format: string, culture?: string): Date;
function getLocalizedConstants(controlName: string, culture?: string): any;
function findCulture(culture?: string): Culture;
interface Globalize {
addCulture(name: string, culture?: any): void;
preferredCulture(culture?: string): Culture;
format(value: any, format: string, culture?: string): string;
parseInt(value: string, radix?: any, culture?: string): number;
parseFloat(value: string, radix?: any, culture?: string): number;
parseDate(value: string, format: string, culture?: string): Date;
getLocalizedConstants(controlName: string, culture?: string): any;
findCulture(culture?: string): Culture;
}
interface Culture {
name?: string;
englishName?: string;
namtiveName?: string;
language?: string;
isRTL: boolean;
numberFormat?: FormatSettings;
calendars?: CalendarsSettings;
}
interface FormatSettings {
pattern: string[];
decimals: number;
groupSizes: number[];
percent: PercentSettings;
currency: CurrencySettings;
}
interface PercentSettings {
pattern: string[];
decimals: number;
groupSizes: number[];
symbol: string;
}
interface CurrencySettings {
pattern: string[];
decimals: number;
groupSizes: number[];
symbol: string;
}
interface CalendarsSettings {
standard: StandardSettings;
}
interface StandardSettings {
firstDay: number;
days: DaySettings;
months: MonthSettings;
AM: string[];
PM: string[];
twoDigitYearMax: number;
patterns: PatternSettings;
}
interface DaySettings {
names: string[];
namesAbbr: string[];
namesShort: string[];
}
interface MonthSettings {
names: string[];
namesAbbr: string[];
}
interface PatternSettings {
d: string;
D: string;
t: string;
T: string;
f: string;
F: string;
M: string;
Y: string;
S: string;
}
class ReportDesigner extends ej.Widget {
public static fn: ReportDesigner;
constructor(element: JQuery | Element, options?: ReportDesigner.Model);
public static locale: any;
public model: ReportDesigner.Model;
public defaults: ReportDesigner.Model;
/** Add a dataset to the report at runtime.
* @param {any} a JSON to define a connection properties for dataset
* @returns {void}
*/
public addDataSet(dataset: any): void;
/** Add a datasource to the report at runtime.
* @param {any} a JSON to define a connection properties for datasource
* @returns {void}
*/
public addDataSource(datasource: any): void;
/** Add a report item to the report at runtime.
* @param {any} JSON for the new report item to be added.
* @returns {void}
*/
public addItem(item: any): void;
/** Add a parameter to the report at runtime.
* @param {any} JSON for the new parameter to be added in the report
* @returns {void}
*/
public addParameter(reportParameter: any): void;
/** Visually move the selected report item over its closest intersected report items.
* @returns {void}
*/
public bringForward(): void;
/** Visually move the selected report item over all other intersected report items.
* @returns {void}
*/
public bringToFront(): void;
/** Determines whether a copy operation is possible.
* @returns {boolean}
*/
public canCopy(): boolean;
/** Determines whether a cut operation is possible.
* @returns {boolean}
*/
public canCut(): boolean;
/** Determines whether a paste operation is possible.
* @returns {boolean}
*/
public canPaste(): boolean;
/** Returns the boolean value indicating whether the user can redo the previous action in the report.
* @returns {boolean}
*/
public canRedo(): boolean;
/** Determines whether a delete operation is possible.
* @returns {boolean}
*/
public canRemove(): boolean;
/** Returns a boolean value indicating whether the user can undo the previous action in the report.
* @returns {boolean}
*/
public canUndo(): boolean;
/** Clone the existing dataset in the report at runtime.
* @param {string} Name of the existing dataset in report
* @returns {void}
*/
public cloneDataSet(name: string): void;
/** Clone the existing datasource in the report at runtime.
* @param {string} Name of the existing datasource in report
* @returns {void}
*/
public cloneDataSource(name: string): void;
/** Copies the selected report item from design panel to the Report Designer internal clipboard.
* @returns {void}
*/
public copy(): void;
/** Cuts the selected report item from design panel to the Report Designer internal clipboard.
* @returns {void}
*/
public cut(): void;
/** Get the list of datasets from the report.
* @returns {void}
*/
public getDataSets(): void;
/** Get the list of datasources from the report.
* @returns {void}
*/
public getDataSources(): void;
/** Get the list of parameters from the report.
* @returns {void}
*/
public getParameters(): void;
/** Returns the boolean value that specifies whether the report has changes or not.
* @returns {boolean}
*/
public hasReportChanges(): boolean;
/** Returns the boolean value that specifies whether the currently processing report is a new report or not.
* @returns {boolean}
*/
public isNewReport(): boolean;
/** Returns the boolean value that specifies whether the currently processing report is a new server report or not.
* @returns {boolean}
*/
public isNewServerReport(): boolean;
/** Returns the boolean value that specifies whether the currently processing report is obtained from the server or local.
* @returns {boolean}
*/
public isServerReport(): boolean;
/** To create a new report.
* @param {string} Name of the new report
* @param {string} Name of the shared dataset
* @returns {void}
*/
public newReport(name: string, dataSetPath: string): void;
/** To create a new report in the report server.
* @param {string} Name of the new report
* @param {string} Name of the shared dataset
* @returns {void}
*/
public newServerReport(name: string, dataSetPath: string): void;
/** This method opens the report from the report server.
* @param {string} Path of the report server report
* @param {string} Reports server URL
* @returns {void}
*/
public openReport(reportPath: string, serverUrl: string): void;
/** This method opens the report using raw report data.
* @param {any} Provide the report definition in the JSON or string or XML format
* @returns {void}
*/
public openReportDefinition(rdlData: any): void;
/** Opens the client browse dialog to browse the report.
* @returns {void}
*/
public openReportFromDevice(): void;
/** Opens the report designer browse dialog to browse the available reports in the report server.
* @returns {void}
*/
public openServerReportDialog(): void;
/** Pastes the selected report item from the Report Designer internal clipboard to design panel.
* @returns {void}
*/
public paste(): void;
/** Reverses the action of the last Undo command.
* @returns {void}
*/
public redo(): void;
/** Deletes the selected report item from the report.
* @returns {void}
*/
public remove(): void;
/** Remove a dataset from the report at runtime.
* @param {string} Name of the dataset
* @returns {void}
*/
public removeDataSet(dataset: string): void;
/** Remove a datasource from the report at runtime.
* @param {string} Name of the datasource
* @returns {void}
*/
public removeDatasource(datasource: string): void;
/** Remove the given report item from the report.
* @param {string} Name of the report item to be removed from the report
* @returns {void}
*/
public removeItem(itemName: string): void;
/** Remove a parameter from the report at runtime.
* @param {string} Name of the existing report parameter
* @returns {void}
*/
public removeParameter(reportParameterName: string): void;
/** This method saves the report into the report server.
* @param {string} Path of the report server report
* @returns {void}
*/
public saveReport(reportPath: string): void;
/** This method returns the report in JSON or XML format.
* @param {Function} Callback method to return the report data.
* @param {ej.ReportDesigner.DataFormat} Specify the format as JSON or XML to save the report.
* @returns {void}
*/
public saveReportDefinition(callback: Function, type: ej.ReportDesigner.DataFormat | string): void;
/** Opens the report designer browse dialog to save the report into report server.
* @returns {void}
*/
public saveServerReportDialog(): void;
/** To download the designed report.
* @returns {void}
*/
public saveToDevice(): void;
/** Update the selection to report item at runtime.
* @param {any[]} Name of the report items
* @returns {void}
*/
public selectItems(itemNames: any[]): void;
/** Visually move the selected report item behind its closest intersected report item.
* @returns {void}
*/
public sendBackward(): void;
/** Visually move the selected report item behind all other intersected report items.
* @returns {void}
*/
public sendToBack(): void;
/** Performs switch action from viewer to designer at runtime.
* @returns {void}
*/
public showDesign(): void;
/** Opens the new report dialog.
* @param {Function} Callback method of new report dialog actions
* @returns {void}
*/
public showNewReportDialog(callback: Function): void;
/** Opens the report designer browse dialog to open/save reports in the report server.
* @param {ej.ReportDesigner.BrowseType} Mention the type as Open to perform open report action, otherwise Save.
* @param {Function} Callback method of open/save dialog actions.
* @param {string} Name of the report to save.
* @returns {void}
*/
public showOpenSaveReportDialog(browseType: ej.ReportDesigner.BrowseType | string, callback: Function, reportName: string): void;
/** Performs switch action from designer to viewer at runtime.
* @returns {void}
*/
public showPreview(): void;
/** Reverses the last action that was performed.
* @returns {void}
*/
public undo(): void;
/** Updates the existing dataset in the report at runtime.
* @param {string} Name of the existing dataset
* @param {any} a JSON to define a connection properties for dataset
* @returns {void}
*/
public updateDataset(datasetName: string, dataset: any): void;
/** Updates the existing datasource in the report at runtime.
* @param {string} Name of the existing datasource
* @param {any} a JSON to define a connection properties for datasource
* @returns {void}
*/
public updateDatasource(datasourceName: string, datasource: any): void;
/** Updates the existing parameter in the report at runtime.
* @param {string} Name of the existing report parameter
* @param {any} JSON for the new parameter to be added in the report
* @returns {void}
*/
public updateParameter(reportParameterName: string, reportParameter: any): void;
}
export namespace ReportDesigner {
export interface Model {
/** Shows or hides the items of configuration pane in ReportDesigner control.
*/
configurePaneSettings?: ConfigurePaneSettings;
/** Set the property as true to disable the code module configuration in RDL reports.
* @Default {false}
*/
disableCodeModule?: boolean;
/** Enable or Disable Impersonate option for report designer datasources
* @Default {false}
*/
enableImpersonate?: boolean;
/** Set the property as true to load images as blob in GET ajax calls.
* @Default {false}
*/
enableImageBlobing?: boolean;
/** Gets or sets the data connectors name as array of strings to filter data connectors in data panel.
* @Default {[ ]}
*/
filterDataConnectors?: any[];
/** Gets or sets the report items name as array of strings to filter report items in item panel.
* @Default {[ ]}
*/
filterReportItems?: any[];
/** Gets or sets the list of custom font names.
* @Default {[ ]}
*/
fontNames?: any[];
/** Specifies the locale for report designer.
* @Default {en-US}
*/
locale?: string;
/** Shows or hides the create, edit, and delete options in data source and dataset panels.
*/
permissionSettings?: PermissionSettings;
/** Gets or sets the properties, events and methods of Report Viewer component for report preview action from Report Designer.
*/
previewOptions?: PreviewOptions;
/** Gets or sets the list of custom data extension items.
* @Default {[ ]}
*/
reportDataExtensions?: ReportDataExtension[];
/** Gets or sets the list of custom report items.
* @Default {[ ]}
*/
reportItemExtensions?: ReportItemExtension[];
/** Gets or sets the report path of server.
* @Default {null}
*/
reportPath?: string;
/** Gets or sets the schema version of the report.
* @Default {2016}
*/
reportVersion?: string;
/** Gets or sets the report type.
* @Default {ej.ReportDesigner.ReportType.RDL}
*/
reportType?: ej.ReportDesigner.ReportType | string;
/** Gets or sets the reports server URL.
* @Default {null}
*/
reportServerUrl?: string;
/** Gets or sets the service authorization token to access the Report Server API services.
* @Default {empty}
*/
serviceAuthorizationToken?: string;
/** Gets or sets the URL of the WebAPI service; it will be used for processing the report.