-
Notifications
You must be signed in to change notification settings - Fork 155
/
Copy pathquery-builder.d.ts
1160 lines (1160 loc) · 32.7 KB
/
query-builder.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
/**
* Query Builder Source
*/
import { Component, INotifyPropertyChanged, ModuleDeclaration } from '@syncfusion/ej2-base';
import { ChildProperty } from '@syncfusion/ej2-base';
import { QueryBuilderModel, ShowButtonsModel, ColumnsModel, RuleModel, ValueModel } from './query-builder-model';
import { RadioButtonModel } from '@syncfusion/ej2-buttons';
import { DropDownTreeModel } from '@syncfusion/ej2-dropdowns';
import { MultiSelectModel, DropDownListModel } from '@syncfusion/ej2-dropdowns';
import { EmitType, BaseEventArgs } from '@syncfusion/ej2-base';
import { Query, Predicate, DataManager } from '@syncfusion/ej2-data';
import { TextBoxModel, NumericTextBoxModel } from '@syncfusion/ej2-inputs';
import { DatePickerModel } from '@syncfusion/ej2-calendars';
/**
* Defines the Columns of Query Builder
*/
export declare class Columns extends ChildProperty<Columns> {
/**
* Specifies the fields in columns.
*
* @default null
*/
field: string;
/**
* Specifies the labels name in columns.
*
* @default null
*/
label: string;
/**
* Specifies the types in columns field.
*
* @default null
*/
type: string;
/**
* Specifies the values in columns or bind the values from sub controls.
*
* @default null
*/
values: string[] | number[] | boolean[];
/**
* Specifies the operators in columns.
*
* @default null
*/
operators: {
[key: string]: Object;
}[];
/**
* Specifies the rule template for the field with any other widgets.
*
* @default null
* @aspType string
*/
ruleTemplate: string | Function;
/**
* Specifies the template for value field such as slider or any other widgets.
*
* @default null
*/
template: TemplateColumn | string | Function;
/**
* Specifies the validation for columns (text, number and date).
*
* @default { isRequired: true , min: 0, max: Number.MAX_VALUE }
*/
validation: Validation;
/**
* Specifies the date format for columns.
*
* @aspType string
* @blazorType string
* @default null
*/
format: string | FormatObject;
/**
* Specifies the step value(numeric textbox) for columns.
*
* @default null
*/
step: number;
/**
* Specifies the default value for columns.
*
* @default null
*/
value: string[] | number[] | string | number | boolean | Date;
/**
* Specifies the category for columns.
*
* @default null
*/
category: string;
/**
* Specifies the sub fields in columns.
*
* @default null
*/
columns: ColumnsModel[];
}
/**
* Defines the rule of Query Builder
*/
export declare class Rule extends ChildProperty<Rule> {
/**
* Specifies the condition value in group.
*
* @default null
*/
condition: string;
/**
* Specifies the rules in group.
*
* @default []
*/
rules: RuleModel[];
/**
* Specifies the field value in group.
*
* @default null
*/
field: string;
/**
* Specifies the label value in group.
*
* @default null
*/
label: string;
/**
* Specifies the type value in group.
*
* @default null
*/
type: string;
/**
* Specifies the operator value in group.
*
* @default null
*/
operator: string;
/**
* Specifies the sub controls value in group.
*
* @default null
*/
value: string[] | number[] | string | number | boolean;
/**
* Specifies whether not condition is true/false.
*
* @default false
*/
not: boolean;
/**
* Specifies whether rule is locked or not.
*
* @default null
*/
isLocked: boolean;
}
/**
* Defines the property for value.
*/
export declare class Value extends ChildProperty<Value> {
/**
* Specifies the property for NumericTextBox value.
*
* @default null
*/
numericTextBoxModel: NumericTextBoxModel;
/**
* Specifies the property for MultiSelect value.
*
* @default null
*/
multiSelectModel: MultiSelectModel;
/**
* Specifies the property for DatePicker value.
*
* @default null
*/
datePickerModel: DatePickerModel;
/**
* Specifies the TextBox value.
*
* @default null
*/
textBoxModel: TextBoxModel;
/**
* Specifies the RadioButton value.
*
* @default null
*/
radioButtonModel: RadioButtonModel;
}
/**
* Defines the ruleDelete, groupInsert, and groupDelete options of Query Builder.
*/
export declare class ShowButtons extends ChildProperty<ShowButtons> {
/**
* Specifies the boolean value in ruleDelete that the enable/disable the buttons in rule.
*
* @default false
*/
cloneRule: boolean;
/**
* Specifies the boolean value in ruleDelete that the enable/disable the buttons in rule.
*
* @default false
*/
cloneGroup: boolean;
/**
* Specifies the boolean value in ruleDelete that the enable/disable the buttons in rule.
*
* @default false
*/
lockRule: boolean;
/**
* Specifies the boolean value in ruleDelete that the enable/disable the buttons in rule.
*
* @default false
*/
lockGroup: boolean;
/**
* Specifies the boolean value in ruleDelete that the enable/disable the buttons in rule.
*
* @default true
*/
ruleDelete: boolean;
/**
* Specifies the boolean value in groupInsert that the enable/disable the buttons in group.
*
* @default true
*/
groupInsert: boolean;
/**
* Specifies the boolean value in groupDelete that the enable/disable the buttons in group.
*
* @default true
*/
groupDelete: boolean;
}
export interface FormatObject {
/**
* Specifies the format in which the date format will process
*/
skeleton?: string;
}
/**
* Defines the fieldMode of Dropdown control.
* ```props
* Default :- To Specifies the fieldMode as DropDownList.
* DropdownTree :- To Specifies the fieldMode as DropdownTree.
* ```
*/
export declare type FieldMode =
/** Display the DropdownList */
'Default' |
/** Display the DropdownTree */
'DropdownTree';
/**
* Defines the display mode of the control.
* ```props
* Horizontal :- To display the control in a horizontal UI.
* Vertical :- To display the control in a vertical UI.
* ```
*/
export declare type DisplayMode =
/** Display the Horizontal UI */
'Horizontal' |
/** Display the Vertical UI */
'Vertical';
/**
* Defines the sorting direction of the field names in a control.
* ```props
* Default :- Specifies the field names in default sorting order.
* Ascending :- Specifies the field names in ascending order.
* Descending :- Specifies the field names in descending order.
* ```
*/
export declare type SortDirection =
/** Show the field names in default */
'Default' |
/** Show the field names in Ascending */
'Ascending' |
/** Show the field names in Descending */
'Descending';
export declare class QueryBuilder extends Component<HTMLDivElement> implements INotifyPropertyChanged {
private groupIdCounter;
private ruleIdCounter;
private subFilterCounter;
private btnGroupId;
private levelColl;
private isImportRules;
private isPublic;
private parser;
private defaultLocale;
private l10n;
private intl;
private items;
private customOperators;
private operators;
private sqlOperators;
private ruleElem;
private groupElem;
private dataColl;
private dataManager;
private selectedColumn;
private previousColumn;
private actionButton;
private isInitialLoad;
private timer;
private isReadonly;
private fields;
private columnTemplateFn;
private target;
private updatedRule;
private ruleTemplateFn;
private isLocale;
private isRefreshed;
private headerFn;
private subFieldElem;
private selectedRule;
private isNotified;
private isAddSuccess;
private isNotValueChange;
private isRoot;
private prevItemData;
private isFieldChange;
private isFieldClose;
private isDestroy;
private isGetNestedData;
private isCustomOprCols;
private dummyDropdownTreeDs;
private groupCounter;
private lockItems;
private groupIndex;
private ruleIndex;
private isLastGroup;
private cloneGrpBtnClick;
private isMiddleGroup;
private cloneRuleBtnClick;
private isNumInput;
private draggable;
private draggedRule;
private dragElement;
private prvtEvtTgrDaD;
private isDragEventPrevent;
private isValueEmpty;
private ddTree;
/**
* Triggers when the component is created.
*
* @event created
* @blazorProperty 'Created'
*/
created: EmitType<Event>;
/**
* Triggers when field, operator, value is change.
*
* @event actionBegin
* @blazorProperty 'OnActionBegin'
*/
actionBegin: EmitType<ActionEventArgs>;
/**
* Triggers before the condition (And/Or), field, operator, value is changed.
*
* @event beforeChange
* @blazorProperty 'OnValueChange'
*/
beforeChange: EmitType<ChangeEventArgs>;
/**
* Triggers when changing the condition(AND/OR), field, value, operator is changed.
*
* @event change
* @blazorProperty 'Changed'
*/
change: EmitType<ChangeEventArgs>;
/**
* Triggers when dataBound to the Query Builder.
*
* @event dataBound
* @blazorProperty 'dataBound'
*/
dataBound: EmitType<Object>;
/**
* Triggers when changing the condition(AND/OR), field, value, operator is changed
*
* @event ruleChange
* @blazorProperty 'RuleChanged'
*/
ruleChange: EmitType<RuleChangeEventArgs>;
/**
* Triggers when rule/ group dragging starts.
*
*
*/
dragStart: EmitType<DragEventArgs>;
/**
* Triggers when rule/ group are dragged (moved) continuously.
*
*
*/
drag: EmitType<DragEventArgs>;
/**
* Triggers when rule/ group are dropped on to the target rule/ group.
*
*
*/
drop: EmitType<DropEventArgs>;
/**
* Specifies the showButtons settings of the query builder component.
* The showButtons can be enable Enables or disables the ruleDelete, groupInsert, and groupDelete buttons.
*
* @default { ruleDelete: true , groupInsert: true, groupDelete: true }
*/
showButtons: ShowButtonsModel;
/**
* Shows or hides the filtered query.
*
* @default false
*/
summaryView: boolean;
/**
* Enables or disables the validation.
*
* @default false
*/
allowValidation: boolean;
/**
* Specifies the fieldMode as DropDownList or DropDownTree.
*
* @default 'Default'
*/
fieldMode: FieldMode;
/**
* Specifies columns to create filters.
*
* @default {}
*/
columns: ColumnsModel[];
/**
* Specifies the property for field.
*
* @default null
*/
fieldModel: DropDownListModel | DropDownTreeModel;
/**
* Specifies the property for operator.
*
* @default null
*/
operatorModel: DropDownListModel;
/**
* Specifies the property for value.
*
* @default null
*/
valueModel: ValueModel;
/**
* Specifies the template for the header with any other widgets.
*
* @default null
* @aspType string
*/
headerTemplate: string | Function;
/**
* Defines class or multiple classes, which are separated by a space in the QueryBuilder element.
* You can add custom styles to the QueryBuilder using the cssClass property.
*
* @default ''
*/
cssClass: string;
/**
* Binds the column name from data source in query-builder.
* The `dataSource` is an array of JavaScript objects.
*
* @default []
*/
dataSource: Object[] | Object | DataManager;
/**
* Specifies the displayMode as Horizontal or Vertical.
*
* @default 'Horizontal'
*/
displayMode: DisplayMode;
/**
* Enable or disable persisting component's state between page reloads.
* If enabled, filter states will be persisted.
*
* @default false.
*/
enablePersistence: boolean;
/**
* Specifies the sort direction of the field names.
*
* @default 'Default'
*/
sortDirection: SortDirection;
/**
* Specifies the maximum group count or restricts the group count.
*
* @default 5
*/
maxGroupCount: number;
/**
* Specifies the height of the query builder.
*
* @default 'auto'
*/
height: string;
/**
* Specifies the width of the query builder.
*
* @default 'auto'
*/
width: string;
/**
* If match case is set to true, the grid filters the records with exact match.
* if false, it filters case insensitive records (uppercase and lowercase letters treated the same).
*
* @default false
*/
matchCase: boolean;
/**
* If immediateModeDelay is set by particular number, the rule Change event is triggered after that period.
*
* @default 0
*/
immediateModeDelay: number;
/**
* Enables/Disables the not group condition in query builder.
*
* @default false
*/
enableNotCondition: boolean;
/**
* When set to true, the user interactions on the component are disabled.
*
* @default false
*/
readonly: boolean;
/**
* Specifies a boolean value whether enable / disable the new rule adding while adding new groups.
*
* @remarks
* If this property is true, the empty rule is inserted while inserting new group.
* If set to false, the group is inserted without any rule.
* @default true
*/
addRuleToNewGroups: boolean;
/**
* Specifies a boolean value whether enable / disable the auto selection with the first value for the field.
*
* @remarks
* If this property is true, the field dropdown list will render with the first value of the dropdown list.
* If set to false, the dropdown list render with placeholder.
* @default false
*/
autoSelectField: boolean;
/**
* Specifies a boolean value whether enable / disable the auto selection with the first value for the operator.
*
* @remarks
* If this property is true, the operator dropdown list will render with the first value of the dropdown list.
* If set to false, the dropdown list render with placeholder.
* @default true
*/
autoSelectOperator: boolean;
/**
* Specifies the separator string for column.
*
* @default ''
*/
separator: string;
/**
* Specifies whether to enable separate connectors between rules/groups.
*
* @remarks
* When this property is set to true, each rule/group will have its own connector, allowing them to be connected independently with different connectors.
* When set to false, will result in connectors being shared between rules/groups, possibly connecting them with the same connector.
*
* @default false
*
*/
enableSeparateConnector: boolean;
/**
* Defines rules in the QueryBuilder.
* Specifies the initial rule, which is JSON data.
*
* @default {}
*/
rule: RuleModel;
/**
* Specifies a boolean value whether to enable / disable the drag and drop support to move the rules/ groups.
*
* @remarks
* If this property is true, the drag handle will be rendered in front of the rule/ group element to perform, drag and drop.
* If set to false, the drag handle element is not rendered.
* @default false
*/
allowDragAndDrop: boolean;
constructor(options?: QueryBuilderModel, element?: string | HTMLDivElement);
protected getPersistData(): string;
/**
* Clears the rules without root rule.
*
* @returns {void}.
*/
reset(): void;
private getWrapper;
protected getModuleName(): string;
requiredModules(): ModuleDeclaration[];
private GetRootColumnName;
private initialize;
private updateSubFieldsFromColumns;
private updateSubFields;
private updateCustomOperator;
private focusEventHandler;
private clickEventHandler;
private beforeSuccessCallBack;
private selectBtn;
private appendRuleElem;
private addRuleElement;
private addRuleSuccessCallBack;
private dropdownTreeFiltering;
private changeDataSource;
private nestedChildFilter;
private isMatchedNode;
private dropdownTreeClose;
private updateDropdowntreeDS;
private updateAddedRule;
private changeRuleTemplate;
private renderToolTip;
/**
* Validate the conditions and it display errors for invalid fields.
*
* @returns {boolean} - Validation
*/
validateFields(): boolean;
private refreshLevelColl;
private refreshLevel;
private groupTemplate;
private ruleTemplate;
private addGroupElement;
private addGroupSuccess;
private setMultiConnector;
private addHeaderDiv;
private headerTemplateFn;
private enableSeparateConnectorInitialRule;
/**
* Notify the changes to component.
*
* @param {string | number | boolean | Date | string[] | number[] | Date[]} value - 'value' to be passed to update the rule value.
* @param {Element} element - 'element' to be passed to update the rule.
* @param {string} type - 'type' to be passed to update the rule .
* @returns {void}.
*/
notifyChange(value: string | number | boolean | Date | string[] | number[] | Date[], element: Element, type?: string): void;
private templateChange;
private changeValue;
private filterValue;
private changeValueSuccessCallBack;
private fieldClose;
private changeField;
private changeRule;
private changeFilter;
private changeOperator;
private fieldChangeSuccess;
private destroySubFields;
private createSubFields;
private operatorChangeSuccess;
private changeRuleValues;
private popupOpen;
private destroyControls;
private templateDestroy;
/**
* Return values bound to the column.
*
* @param {string} field - 'field' to be passed to get the field values.
* @returns {object[]} - Values bound to the column
*/
getValues(field: string): object[];
private createNestedObject;
private getDistinctValues;
private renderMultiSelect;
private multiSelectOpen;
private bindMultiSelectData;
private getMultiSelectData;
private createSpinner;
private closePopup;
private processTemplate;
private getItemData;
private setDefaultValue;
private renderStringValue;
private renderNumberValue;
private processValueString;
private parseDate;
private renderControls;
private processBoolValues;
private getOperatorIndex;
private getPreviousItemData;
private renderValues;
private setColumnTemplate;
private actionBeginSuccessCallBack;
private updateValues;
private updateRules;
private filterRules;
private ruleValueUpdate;
private validateValue;
private getFormat;
private findGroupByIdx;
/**
* Removes the component from the DOM and detaches all its related event handlers.
* Also it maintains the initial input element from the DOM.
*
* @method destroy
* @returns {void}
*/
destroy(): void;
/**
* Adds single or multiple rules.
*
* @param {RuleModel[]} rule - 'rule collection' to be passed to add the rules.
* @param {string} groupID - 'group id' to be passed to add the rule in groups.
* @returns {void}.
*/
addRules(rule: RuleModel[], groupID: string): void;
/**
* Adds single or multiple groups, which contains the collection of rules.
*
* @param {RuleModel[]} groups - 'group collection' to be passed to add the groups.
* @param {string} groupID - 'group id' to be passed to add the groups.
* @returns {void}.
*/
addGroups(groups: RuleModel[], groupID: string): void;
private initWrapper;
private renderSummary;
private renderSummaryCollapse;
private columnSort;
private onChangeNotGroup;
private notGroupRtl;
private checkNotGroup;
onPropertyChanged(newProp: QueryBuilderModel, oldProp: QueryBuilderModel): void;
protected preRender(): void;
protected render(): void;
private initializeDrag;
private helper;
private dragStartHandler;
private dragHandler;
private dragStopHandler;
private templateParser;
private executeDataManager;
private initControl;
protected wireEvents(): void;
protected unWireEvents(): void;
private getParentGroup;
/**
* Delete the Group
*
* @param {Element | string} target - 'target' to be passed to delete the group.
* @returns {void}
*/
deleteGroup(target: Element | string): void;
private deleteGroupSuccessCallBack;
private isPlatformTemplate;
private deleteRule;
private deleteRuleSuccessCallBack;
private setGroupRules;
private keyBoardHandler;
private clearQBTemplate;
private disableRuleCondition;
/**
* Get the valid rule or rules collection.
*
* @param {RuleModel} currentRule - 'currentRule' to be passed to get the valid rules.
* @returns {RuleModel} - Valid rule or rules collection
*/
getValidRules(currentRule?: RuleModel): RuleModel;
private getRuleCollection;
/**
* Set the rule or rules collection.
*
* @param {RuleModel} rule - 'rule' to be passed to set rules.
* @returns {void}.
*/
setRules(rule: RuleModel): void;
/**
* Gets the rule or rule collection.
*
* @returns {object} - Rule or rule collection
*/
getRules(): RuleModel;
/**
* Gets the rule.
*
* @param {string | HTMLElement} elem - 'elem' to be passed to get rule.
* @returns {object} - Rule
*/
getRule(elem: string | HTMLElement): RuleModel;
/**
* Gets the group.
*
* @param {string | Element} target - 'target' to be passed to get group.
* @returns {object} -Group
*/
getGroup(target: Element | string): RuleModel;
/**
* Deletes the group or groups based on the group ID.
*
* @param {string[]} groupIdColl - 'groupIdColl' to be passed to delete groups.
* @returns {void}
*/
deleteGroups(groupIdColl: string[]): void;
/**
* Return the Query from current rules collection.
*
* @returns {Promise} - Query from current rules collection
* @blazorType object
*/
getFilteredRecords(): Promise<Object> | object;
/**
* Deletes the rule or rules based on the rule ID.
*
* @param {string[]} ruleIdColl - 'ruleIdColl' to be passed to delete rules.
* @returns {void}.
*/
deleteRules(ruleIdColl: string[]): void;
/**
* Gets the query for Data Manager.
*
* @param {RuleModel} rule - 'rule' to be passed to get query.
* @returns {string} - Query for Data Manager
*/
getDataManagerQuery(rule: RuleModel): Query;
/**
* Get the predicate from collection of rules.
*
* @param {RuleModel} rule - 'rule' to be passed to get predicate.
* @returns {Predicate} - Predicate from collection of rules
*/
getPredicate(rule: RuleModel): Predicate;
private getLocale;
private getColumn;
/**
* Return the operator bound to the column.
*
* @returns {[key: string]: Object}[] - Operator bound to the column
*/
getOperators(field: string): {
[key: string]: Object;
}[];
private setTime;
private datePredicate;
private arrayPredicate;
private getDate;
private isTime;
private importRules;
private renderGroup;
private renderRule;
private enableReadonly;
private enableBtnGroup;
private isDateFunction;
private getSqlString;
/**
* Sets the rules from the sql query.
*
* @param {string} sqlString - 'sql String' to be passed to set the rule.
* @param {boolean} sqlLocale - Optional. Set `true` if Localization for Sql query.
* @returns {void}
*/
setRulesFromSql(sqlString: string, sqlLocale?: boolean): void;
/**
* Get the rules from SQL query.
*
* @param {string} sqlString - 'sql String' to be passed to get the rule.
* @param {boolean} sqlLocale - Set `true` if Localization for Sql query.
* @returns {object} - Rules from SQL query
*/
getRulesFromSql(sqlString: string, sqlLocale?: boolean): RuleModel;
/**
* Gets the sql query from rules.
*
* @param {RuleModel} rule - 'rule' to be passed to get the sql.
* @param {boolean} allowEscape - Set `true` if it exclude the escape character.
* @param {boolean} sqlLocale - Set `true` if Localization for Sql query.
* @returns {string} - Sql query from rules.
*/
getSqlFromRules(rule?: RuleModel, allowEscape?: boolean, sqlLocale?: boolean): string;
/**
* Gets the parameter SQL query from rules.
*
* @param {RuleModel} rule – Specify the rule to be passed to get the parameter sql string.
* @returns {ParameterizedSql} – Parameterized SQL query from rules.
*/
getParameterizedSql(rule?: RuleModel): ParameterizedSql;
/**
* Sets the rules from the parameter sql query.
*
* @param { ParameterizedSql} sqlQuery – Specifies the parameter SQL to be passed to set the rule and load it to the query builder.
* @returns {void}
*/
setParameterizedSql(sqlQuery: ParameterizedSql): void;
/**
* Gets the named parameter SQL query from rules.
*
* @param {RuleModel} rule – Specify the rule to be passed to get the named parameter SQL string.
* @returns {ParameterizedNamedSql} – Parameterized Named SQL query from rules.
*/
getParameterizedNamedSql(rule?: RuleModel): ParameterizedNamedSql;
/**
* Sets the rules from the named parameter SQL query.
*
* @param { ParameterizedNamedSql } sqlQuery – Specifies the named parameter SQL to be passed to set the rule and load it to the query builder.
* @returns {void}
*/
setParameterizedNamedSql(sqlQuery: ParameterizedNamedSql): void;
/**
* Set the rules from Mongo query.
*
* @param {string} mongoQuery - 'sql String' to be passed to get the rule.
* @param {boolean} mongoLocale - Set `true` if Localization for Mongo query.
* @returns {void}
*/
setMongoQuery(mongoQuery: string, mongoLocale?: boolean): void;
/**
* Gets the Mongo query from rules.
*
* @param {RuleModel} rule - 'rule' to be passed to get the sql.
* @returns {object} - Sql query from rules.
*/
getMongoQuery(rule?: RuleModel): string;
/**
* Clones the rule based on the rule ID to the specific group.
*
* @param {string} ruleID - Specifies the ruleID that needs to be cloned.
* @param {string} groupID - Specifies the groupID in which the rule to be cloned.
* @param {number} index - Specifies the index to insert the cloned rule inside the group.
* @returns {void}
*/
cloneRule(ruleID: string, groupID: string, index: number): void;
/**
* Clones the group based on the group ID to the specific group.
*
* @param {string} groupID - Specifies the groupID that needs to be cloned.
* @param {string} parentGroupID - Specifies the parentGroupID in which the group to be cloned.
* @param {number} index - Specifies the index to insert the cloned group inside the parent group.
* @returns {void}
*/
cloneGroup(groupID: string, parentGroupID: string, index: number): void;
/**
* Locks the rule based on the rule ID.
*
* @param {string} ruleID - Specifies the ruleID that needs to be locked.
* @returns {void}
*/
lockRule(ruleID: string): void;
/**
* Locks the group based on the group ID
*
* @param {string} groupID - Specifies the groupID that needs to be locked.
* @returns {void}
*/
lockGroup(groupID: string): void;
private sqlParser;
private parseSqlStrings;
private getDoubleQuoteString;
private checkCondition;
private getSingleQuoteString;
private combineSingleQuoteString;
private checkLiteral;
private checkNumberLiteral;
private getOperator;
private getTypeFromColumn;
private getLabelFromColumn;
private getLabelFromField;
private processParser;
/**
* Clone the Group
*
* @param {Element | string} target - 'target' to be passed to clone the group.
* @returns {void}
*/
private groupClone;
private ruleClone;
private ruleLock;
private groupLock;
private updateLockItems;
private disableHeaderControls;
private disableRuleControls;
}
export interface Level {
[key: string]: number[];
}
/**
* Creates the custom component of Query Builder
*/
export interface TemplateColumn {
/**
* Creates the custom component.