igniteui-angular 19.2.19 → 19.2.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -266,16 +266,53 @@ export interface RowType {
266
266
  */
267
267
  unpin?: () => void;
268
268
  }
269
+ /**
270
+ * Describes a field that can be used in the Grid and QueryBuilder components.
271
+ */
269
272
  export interface FieldType {
273
+ /**
274
+ * Display label for the field.
275
+ */
270
276
  label?: string;
277
+ /**
278
+ * The internal field name, used in expressions and queries.
279
+ */
271
280
  field: string;
281
+ /**
282
+ * Optional column header for UI display purposes.
283
+ */
272
284
  header?: string;
285
+ /**
286
+ * The data type of the field.
287
+ */
273
288
  dataType: DataType;
289
+ /**
290
+ * Options for the editor associated with this field.
291
+ */
274
292
  editorOptions?: IFieldEditorOptions;
293
+ /**
294
+ * Optional filtering operands that apply to this field.
295
+ */
275
296
  filters?: IgxFilteringOperand;
297
+ /**
298
+ * Optional arguments for any pipe applied to the field.
299
+ */
276
300
  pipeArgs?: IFieldPipeArgs;
301
+ /**
302
+ * Default time format for Date/Time fields.
303
+ */
277
304
  defaultTimeFormat?: string;
305
+ /**
306
+ * Default date/time format for Date/Time fields.
307
+ */
278
308
  defaultDateTimeFormat?: string;
309
+ /**
310
+ * Optional formatter function to transform the value before display.
311
+ *
312
+ * @param value - The value of the field.
313
+ * @param rowData - Optional row data that contains this field.
314
+ * @returns The formatted value.
315
+ */
279
316
  formatter?(value: any, rowData?: any): any;
280
317
  }
281
318
  /**
@@ -1059,7 +1096,7 @@ export interface GridType extends IGridDataBindable {
1059
1096
  refreshSearch(): void;
1060
1097
  getDefaultExpandState(record: any): boolean;
1061
1098
  trackColumnChanges(index: number, column: any): any;
1062
- getPossibleColumnWidth(): string;
1099
+ getPossibleColumnWidth(baseWidth?: number, minColumnWidth?: number): string;
1063
1100
  resetHorizontalVirtualization(): void;
1064
1101
  hasVerticalScroll(): boolean;
1065
1102
  getVisibleContentHeight(): number;
@@ -1349,10 +1386,22 @@ export interface IClipboardOptions {
1349
1386
  separator: string;
1350
1387
  }
1351
1388
  /**
1352
- * An interface describing entity
1389
+ * Describes an entity in the QueryBuilder.
1390
+ * An entity represents a logical grouping of fields and can have nested child entities.
1353
1391
  */
1354
1392
  export interface EntityType {
1393
+ /**
1394
+ * The name of the entity.
1395
+ * Typically used as an identifier in expressions.
1396
+ */
1355
1397
  name: string;
1398
+ /**
1399
+ * The list of fields that belong to this entity.
1400
+ */
1356
1401
  fields: FieldType[];
1402
+ /**
1403
+ * Optional child entities.
1404
+ * This allows building hierarchical or nested query structures.
1405
+ */
1357
1406
  childEntities?: EntityType[];
1358
1407
  }
@@ -2936,7 +2936,7 @@ export declare abstract class IgxGridBaseDirective implements GridType, OnInit,
2936
2936
  /**
2937
2937
  * @hidden @internal
2938
2938
  */
2939
- getPossibleColumnWidth(baseWidth?: number): string;
2939
+ getPossibleColumnWidth(baseWidth?: number, minColumnWidth?: number): string;
2940
2940
  /**
2941
2941
  * @hidden @internal
2942
2942
  */
@@ -25,7 +25,7 @@ export declare class IgxColumnResizerDirective implements OnInit, OnDestroy {
25
25
  set left(val: number);
26
26
  set top(val: number);
27
27
  onMouseup(event: MouseEvent): void;
28
- onMousedown(event: MouseEvent): void;
28
+ onMousedown(event: MouseEvent, resizeHandleTarget: HTMLElement): void;
29
29
  onMousemove(event: MouseEvent): void;
30
30
  static ɵfac: i0.ɵɵFactoryDeclaration<IgxColumnResizerDirective, never>;
31
31
  static ɵdir: i0.ɵɵDirectiveDeclaration<IgxColumnResizerDirective, "[igxResizer]", never, { "restrictHResizeMin": { "alias": "restrictHResizeMin"; "required": false; }; "restrictHResizeMax": { "alias": "restrictHResizeMax"; "required": false; }; "restrictResizerTop": { "alias": "restrictResizerTop"; "required": false; }; }, { "resizeEnd": "resizeEnd"; "resizeStart": "resizeStart"; "resize": "resize"; }, never, never, true, never>;
@@ -49,6 +49,11 @@ export declare class IgxIconComponent implements OnInit, OnChanges, OnDestroy {
49
49
  * ```
50
50
  */
51
51
  get getInactive(): boolean;
52
+ /**
53
+ * The `aria-hidden` attribute of the icon.
54
+ * By default is set to 'true'.
55
+ */
56
+ ariaHidden: boolean;
52
57
  /**
53
58
  * An @Input property that sets the value of the `family`. By default it's "material".
54
59
  *
@@ -152,6 +157,6 @@ export declare class IgxIconComponent implements OnInit, OnChanges, OnDestroy {
152
157
  */
153
158
  private setIcon;
154
159
  static ɵfac: i0.ɵɵFactoryDeclaration<IgxIconComponent, never>;
155
- static ɵcmp: i0.ɵɵComponentDeclaration<IgxIconComponent, "igx-icon", never, { "family": { "alias": "family"; "required": false; }; "name": { "alias": "name"; "required": false; }; "active": { "alias": "active"; "required": false; }; }, {}, never, ["*"], true, never>;
160
+ static ɵcmp: i0.ɵɵComponentDeclaration<IgxIconComponent, "igx-icon", never, { "ariaHidden": { "alias": "ariaHidden"; "required": false; }; "family": { "alias": "family"; "required": false; }; "name": { "alias": "name"; "required": false; }; "active": { "alias": "active"; "required": false; }; }, {}, never, ["*"], true, never>;
156
161
  static ngAcceptInputType_active: unknown;
157
162
  }
@@ -34,25 +34,53 @@ export declare class IgxQueryBuilderComponent implements OnDestroy {
34
34
  */
35
35
  showEntityChangeDialog: boolean;
36
36
  /**
37
- * Returns the entities.
38
- * @hidden
37
+ * Gets the list of entities available for the IgxQueryBuilderComponent.
38
+ *
39
+ * Each entity describes a logical group of fields that can be used in queries.
40
+ * An entity can optionally have child entities, allowing nested sub-queries.
41
+ *
42
+ * @returns An array of {@link EntityType} objects.
39
43
  */
40
44
  get entities(): EntityType[];
41
45
  /**
42
- * Sets the entities.
43
- * @hidden
46
+ * Sets the list of entities for the IgxQueryBuilderComponent.
47
+ * If the `expressionTree` is defined, it will be recreated with the new entities.
48
+ *
49
+ * Each entity should be an {@link EntityType} object describing the fields and optionally child entities.
50
+ *
51
+ * Example:
52
+ * ```ts
53
+ * [
54
+ * {
55
+ * name: 'Orders',
56
+ * fields: [{ field: 'OrderID', dataType: 'number' }],
57
+ * childEntities: [
58
+ * {
59
+ * name: 'OrderDetails',
60
+ * fields: [{ field: 'ProductID', dataType: 'number' }]
61
+ * }
62
+ * ]
63
+ * }
64
+ * ]
65
+ * ```
66
+ *
67
+ * @param entities - The array of entities to set.
44
68
  */
45
69
  set entities(entities: EntityType[]);
46
70
  /**
47
- * Returns the fields.
71
+ * Gets the list of fields for the QueryBuilder.
72
+ *
73
+ * @deprecated since version 19.1.0. Use the `entities` property instead.
48
74
  * @hidden
49
- * @deprecated in version 19.1.0. Use the `entities` property instead.
50
75
  */
51
76
  get fields(): FieldType[];
52
77
  /**
53
- * Sets the fields.
78
+ * Sets the list of fields for the QueryBuilder.
79
+ * Automatically wraps them into a single entity to maintain backward compatibility.
80
+ *
81
+ * @param fields - The array of fields to set.
82
+ * @deprecated since version 19.1.0. Use the `entities` property instead.
54
83
  * @hidden
55
- * @deprecated in version 19.1.0. Use the `entities` property instead.
56
84
  */
57
85
  set fields(fields: FieldType[]);
58
86
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "igniteui-angular",
3
- "version": "19.2.19",
3
+ "version": "19.2.21",
4
4
  "description": "Ignite UI for Angular is a dependency-free Angular toolkit for building modern web apps",
5
5
  "author": "Infragistics",
6
6
  "license": "SEE LICENSE IN LICENSE",