@progress/kendo-angular-pivotgrid 19.1.2-develop.4 → 19.1.2-develop.6

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.
Files changed (38) hide show
  1. package/data-binding/base-binding-directive.d.ts +13 -10
  2. package/data-binding/local-binding.directive.d.ts +19 -4
  3. package/data-binding/olap-binding.directive.d.ts +20 -4
  4. package/directives.d.ts +17 -1
  5. package/esm2022/data-binding/base-binding-directive.mjs +13 -10
  6. package/esm2022/data-binding/local-binding.directive.mjs +19 -4
  7. package/esm2022/data-binding/olap-binding.directive.mjs +20 -4
  8. package/esm2022/directives.mjs +17 -1
  9. package/esm2022/localization/custom-messages.component.mjs +14 -1
  10. package/esm2022/localization/messages.mjs +48 -84
  11. package/esm2022/models/configuration-change-event.mjs +6 -6
  12. package/esm2022/models/expanded-change-event.mjs +4 -4
  13. package/esm2022/package-metadata.mjs +2 -2
  14. package/esm2022/pivotgrid.component.mjs +27 -13
  15. package/esm2022/pivotgrid.module.mjs +7 -18
  16. package/esm2022/rendering/templates/pivotgrid-cell-template.directive.mjs +11 -10
  17. package/esm2022/rendering/templates/pivotgrid-column-header-cell-template.directive.mjs +11 -10
  18. package/esm2022/rendering/templates/pivotgrid-row-header-cell-template.directive.mjs +11 -10
  19. package/esm2022/rendering/templates/pivotgrid-value-cell-template.directive.mjs +10 -9
  20. package/esm2022/util.mjs +1 -1
  21. package/fesm2022/progress-kendo-angular-pivotgrid.mjs +221 -187
  22. package/localization/custom-messages.component.d.ts +14 -1
  23. package/localization/messages.d.ts +48 -84
  24. package/models/configuration-change-event.d.ts +6 -6
  25. package/models/configurator-position.d.ts +1 -1
  26. package/models/configurator-settings.d.ts +4 -4
  27. package/models/data-row-item.d.ts +3 -3
  28. package/models/expanded-change-event.d.ts +4 -4
  29. package/models/loader-settings.d.ts +19 -7
  30. package/models/virtualization-settings.d.ts +14 -5
  31. package/package.json +13 -13
  32. package/pivotgrid.component.d.ts +27 -13
  33. package/pivotgrid.module.d.ts +7 -18
  34. package/rendering/templates/pivotgrid-cell-template.directive.d.ts +11 -10
  35. package/rendering/templates/pivotgrid-column-header-cell-template.directive.d.ts +11 -10
  36. package/rendering/templates/pivotgrid-row-header-cell-template.directive.d.ts +11 -10
  37. package/rendering/templates/pivotgrid-value-cell-template.directive.d.ts +10 -9
  38. package/schematics/ngAdd/index.js +2 -2
@@ -320,7 +320,7 @@ const filterAndMap = (arr, predicate, mapper) => arr.reduce((acc, curr) => predi
320
320
  /**
321
321
  * @hidden
322
322
  */
323
- const replaceMessagePlaceholder = (message, name, value) => message.replace(new RegExp(`\{\\s*${name}\\s*\}`, 'g'), value);
323
+ const replaceMessagePlaceholder = (message, name, value) => message.replace(new RegExp(`{\\s*${name}\\s*}`, 'g'), value);
324
324
  /**
325
325
  * @hidden
326
326
  */
@@ -2978,19 +2978,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
2978
2978
  }] } });
2979
2979
 
2980
2980
  /**
2981
- * The event data for the ExpandChangeEvent
2981
+ * Represents the event data for the `expandChange` event.
2982
2982
  */
2983
2983
  class ExpandChangeEvent extends PreventableEvent {
2984
2984
  /**
2985
- * The current row axes configuration, resulting from the end user interaction.
2985
+ * Provides the current row axes configuration that results from user interaction.
2986
2986
  */
2987
2987
  rowAxes;
2988
2988
  /**
2989
- * The current column axes configuration, resulting from the end user interaction.
2989
+ * Provides the current column axes configuration that results from user interaction.
2990
2990
  */
2991
2991
  columnAxes;
2992
2992
  /**
2993
- * The measure axes configuration.
2993
+ * Provides the measure axes configuration.
2994
2994
  */
2995
2995
  measureAxes;
2996
2996
  /**
@@ -3003,27 +3003,27 @@ class ExpandChangeEvent extends PreventableEvent {
3003
3003
  }
3004
3004
 
3005
3005
  /**
3006
- * The event data for the ConfigurationChangeEvent
3006
+ * Represents the event data for the `configurationChange` event.
3007
3007
  */
3008
3008
  class ConfigurationChangeEvent extends PreventableEvent {
3009
3009
  /**
3010
- * The current row axes configuration, resulting from the end user interaction.
3010
+ * Specifies the current row axes configuration that results from user interaction.
3011
3011
  */
3012
3012
  rowAxes;
3013
3013
  /**
3014
- * The current column axes configuration, resulting from the end user interaction.
3014
+ * Specifies the current column axes configuration that results from user interaction.
3015
3015
  */
3016
3016
  columnAxes;
3017
3017
  /**
3018
- * The measure axes configuration.
3018
+ * Provides the measure axes configuration.
3019
3019
  */
3020
3020
  measureAxes;
3021
3021
  /**
3022
- * The sorting configuration.
3022
+ * Provides the sorting configuration.
3023
3023
  */
3024
3024
  sort;
3025
3025
  /**
3026
- * The filtering configuration.
3026
+ * Provides the filtering configuration.
3027
3027
  */
3028
3028
  filter;
3029
3029
  /**
@@ -3043,37 +3043,40 @@ class PivotBaseBindingDirective {
3043
3043
  dataService;
3044
3044
  zone;
3045
3045
  /**
3046
- * Represents the column axes configuration of the PivotGrid.
3046
+ * Defines the column axes configuration of the PivotGrid.
3047
3047
  */
3048
3048
  columnAxes = [];
3049
3049
  /**
3050
- * Represents the row axes configuration of the PivotGrid.
3050
+ * Defines the row axes configuration of the PivotGrid.
3051
3051
  */
3052
3052
  rowAxes = [];
3053
3053
  /**
3054
- * Represents the measure axes configuration of the PivotGrid.
3054
+ * Defines the measure axes configuration of the PivotGrid.
3055
3055
  */
3056
3056
  measureAxes = [];
3057
3057
  /**
3058
- * Represents the initial sorted state of the PivotGrid.
3058
+ * Sets the initial sorted state of the PivotGrid.
3059
3059
  */
3060
3060
  sort = [];
3061
3061
  /**
3062
- * Represents the initial filtered state of the PivotGrid.
3062
+ * Sets the initial filtered state of the PivotGrid.
3063
3063
  */
3064
3064
  filter;
3065
3065
  /**
3066
- * Fires each time a row or column header gets expanded or collapsed by the end user. The event is preventable.
3067
- * If you prevent the event, the PivotGrid will not be rerendered with the new state, resulting from the end user interaction.
3066
+ * Fires each time a row or column header gets expanded or collapsed by the user.
3067
+ *
3068
+ * The event is preventable. If you prevent the event, the PivotGrid will not rerender with the new state that results from the user interaction.
3068
3069
  */
3069
3070
  expandChange = new EventEmitter();
3070
3071
  /**
3071
- * Fires when the Configurator Apply button is pressed. The event is preventable.
3072
- * If you prevent the event, the PivotGrid will not be rerendered with the new state, resulting from the configuration changes, applied through the configurator interface.
3072
+ * Fires when the Configurator **Apply** button is pressed.
3073
+ *
3074
+ * The event is preventable. If you prevent the event, the PivotGrid will not rerender with the new state that results from the configuration changes.
3073
3075
  */
3074
3076
  configurationChange = new EventEmitter();
3075
3077
  /**
3076
- * Fires each time when new data is loaded and transformed to show aggregated values.
3078
+ * Fires each time new data is loaded and transformed to show aggregated values.
3079
+ *
3077
3080
  * The event fires upon initialization and on user interaction that changes the state of the PivotGrid.
3078
3081
  */
3079
3082
  dataLoaded = new EventEmitter();
@@ -3188,19 +3191,34 @@ const columnsData = 'columns';
3188
3191
  const bindingFields = { dataField, columnsData };
3189
3192
  const stringSeparator = '&';
3190
3193
  /**
3191
- * A directive which binds the PivotGrid to local data ([see example]({% slug directives_databinding_local_pivotgrid %})).
3194
+ * Represents a directive that binds the PivotGrid to local data ([see example]({% slug directives_databinding_local_pivotgrid %})).
3195
+ *
3196
+ * @example
3197
+ * ```html
3198
+ * <kendo-pivotgrid
3199
+ * [kendoPivotLocalBinding]="data"
3200
+ * [dimensions]="dimensions"
3201
+ * [measures]="measures"
3202
+ * [columnAxes]="columnAxes"
3203
+ * [rowAxes]="rowAxes"
3204
+ * [measureAxes]="measureAxes">
3205
+ * </kendo-pivotgrid>
3206
+ * ```
3207
+ *
3208
+ * @remarks
3209
+ * Applied to: {@link PivotGridComponent}
3192
3210
  */
3193
3211
  class PivotLocalBindingDirective extends PivotBaseBindingDirective {
3194
3212
  /**
3195
- * The array of data which will be used to populate the PivotGrid.
3213
+ * Contains the array of data which will be used to populate the PivotGrid.
3196
3214
  */
3197
3215
  data;
3198
3216
  /**
3199
- * Represents the dimensions object of the PivotGrid.
3217
+ * Defines the dimensions object of the PivotGrid.
3200
3218
  */
3201
3219
  dimensions;
3202
3220
  /**
3203
- * Represents the measures collection of the PivotGrid.
3221
+ * Contains the measures collection of the PivotGrid.
3204
3222
  */
3205
3223
  measures;
3206
3224
  type = 'local';
@@ -3266,19 +3284,35 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3266
3284
  }] } });
3267
3285
 
3268
3286
  /**
3269
- * A directive which binds the PivotGrid to data using an Online Analytical Processing (OLAP) service ([see example]({% slug directives_databinding_remote_pivotgrid %})).
3287
+ * Represents a directive that binds the PivotGrid to data using an Online Analytical Processing (OLAP) service ([see example]({% slug directives_databinding_remote_pivotgrid %})).
3288
+ *
3289
+ * @example
3290
+ * ```html
3291
+ * <kendo-pivotgrid
3292
+ * kendoPivotOLAPBinding
3293
+ * [url]="url"
3294
+ * catalog="Adventure Works DW 2008 SE"
3295
+ * cube="Adventure Works"
3296
+ * [columnAxes]="columnAxes"
3297
+ * [rowAxes]="rowAxes"
3298
+ * [measureAxes]="measureAxes">
3299
+ * </kendo-pivotgrid>
3300
+ * ```
3301
+ *
3302
+ * @remarks
3303
+ * Applied to: {@link PivotGridComponent}
3270
3304
  */
3271
3305
  class PivotOLAPBindingDirective extends PivotBaseBindingDirective {
3272
3306
  /**
3273
- * The OLAP service endpoint where the data is processed and retrieved to render the pivot table.
3307
+ * Defines the OLAP service endpoint where the data is processed and retrieved to render the pivot table.
3274
3308
  */
3275
3309
  url;
3276
3310
  /**
3277
- * The cube name that is used to retrieve data for the pivot table rendering.
3311
+ * Sets the cube name that is used to retrieve data for the pivot table rendering.
3278
3312
  */
3279
3313
  cube;
3280
3314
  /**
3281
- * The database name that is used to retrieve the data from the specified connection string.
3315
+ * Sets the database name that is used to retrieve the data from the specified connection string.
3282
3316
  */
3283
3317
  catalog;
3284
3318
  type = 'olap';
@@ -3447,200 +3481,164 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3447
3481
  */
3448
3482
  class PivotGridMessages extends ComponentMessages {
3449
3483
  /**
3450
- * The text content of the filter item in the column and row fields menu.
3484
+ * Sets the text content of the filter item in the column and row fields menu.
3451
3485
  */
3452
3486
  fieldMenuFilterItemLabel;
3453
3487
  /**
3454
- * The text content of the sort ascending item in the column and row fields menu.
3488
+ * Specifies the text content of the sort ascending item in the column and row fields menu.
3455
3489
  */
3456
3490
  fieldMenuSortAscendingItemLabel;
3457
3491
  /**
3458
- * The text content of the sort descending item in the column and row fields menu.
3492
+ * Sets the text content of the sort descending item in the column and row fields menu.
3459
3493
  */
3460
3494
  fieldMenuSortDescendingItemLabel;
3461
3495
  /**
3462
- * The label of the filter input.
3463
- *
3464
- * The filter input label consists of a two-part message - the name(s) of the fields and a localizable string.
3465
- * For fields named '[Geography][City]', the default label will be 'Geography City Filter'.
3466
- *
3467
- * To allow reordering the field name(s) and the localizable part, the filterInputLabel accepts a string with a
3468
- * placeholder for the fields - e.g. 'filter for {fields}'. The '{fields}' placeholder will be replaced
3469
- * internally with the current field(s) name(s), and the resulting label will be rendered as 'filter for Geography City'.
3496
+ * Defines the label of the filter input.
3470
3497
  *
3471
- * @example
3498
+ * The filter input label has two parts&mdash;the field name(s) and a localizable string.
3499
+ * For fields named `'[Geography][City]'`, the default label will be `'Geography City Filter'`.
3472
3500
  *
3473
- * ```ts-no-run
3474
- * <kendo-pivotgrid>
3475
- * <kendo-pivotgrid-messages
3476
- * filterInputLabel="filter for {fields}"
3477
- * >
3478
- * </kendo-pivotgrid-messages>
3479
- * </kendo-pivotgrid>
3480
- * ```
3501
+ * You can reorder the parts using `'{fields}'` as a placeholder. The `'{fields}'` placeholder will get replaced
3502
+ * with the field name(s). For example, `'filter for {fields}'` will become `'filter for Geography City'`.
3481
3503
  */
3482
3504
  filterInputLabel;
3483
3505
  /**
3484
- * The label of the filter operators DropDownList.
3506
+ * Specifies the label of the filter operators DropDownList.
3485
3507
  *
3486
- * The label consists of a two-part message - the name(s) of the fields and a localizable string.
3487
- * For fields named '[Geography][City]', the default label will be 'Geography City Filter Operators'.
3508
+ * The label has two parts&mdash;the field name(s) and a localizable string.
3509
+ * For fields named `'[Geography][City]'`, the default label will be `'Geography City Filter Operators'`.
3488
3510
  *
3489
- * To allow reordering the field name(s) and the localizable part, the filterMenuOperatorsDropDownLabel accepts a string with a
3490
- * placeholder for the fields - e.g. 'filter operators for {fields}'. The '{fields}' placeholder will be replaced
3491
- * internally with the current field(s) name(s), and the resulting label will be rendered as 'filter operators for Geography City'.
3492
- *
3493
- * @example
3494
- *
3495
- * ```ts-no-run
3496
- * <kendo-pivotgrid>
3497
- * <kendo-pivotgrid-messages
3498
- * filterMenuOperatorsDropDownLabel="filter operators for {fields}"
3499
- * >
3500
- * </kendo-pivotgrid-messages>
3501
- * </kendo-pivotgrid>
3502
- * ```
3511
+ * You can reorder the parts using `'{fields}'` as a placeholder. The `'{fields}'` placeholder will get replaced
3512
+ * with the field name(s). For example, `'filter operators for {fields}'` will become `'filter operators for Geography City'`.
3503
3513
  */
3504
3514
  filterOperatorsDropDownLabel;
3505
3515
  /**
3506
- * The text of the `Equal` (**Is equal to**) filter operator.
3516
+ * Sets the text of the `Equal` (**Is equal to**) filter operator.
3507
3517
  */
3508
3518
  filterEqOperator;
3509
3519
  /**
3510
- * The text of the `NotEqual` (**Is not equal to**) filter operator.
3520
+ * Specifies the text of the `NotEqual` (**Is not equal to**) filter operator.
3511
3521
  */
3512
3522
  filterNotEqOperator;
3513
3523
  /**
3514
- * The text of the `IsNull` (**Is null**) filter operator.
3524
+ * Specifies the text of the `IsNull` (**Is null**) filter operator.
3515
3525
  */
3516
3526
  filterIsNullOperator;
3517
3527
  /**
3518
- * The text of the `IsNotNull` (**Is not null**) filter operator.
3528
+ * Sets the text of the `IsNotNull` (**Is not null**) filter operator.
3519
3529
  */
3520
3530
  filterIsNotNullOperator;
3521
3531
  /**
3522
- * The text of the `IsEmpty` (**Is empty**) filter operator.
3532
+ * Specifies the text of the `IsEmpty` (**Is empty**) filter operator.
3523
3533
  */
3524
3534
  filterIsEmptyOperator;
3525
3535
  /**
3526
- * The text of the `IsNotEmpty` (**Is not empty**) filter operator.
3536
+ * Specifies the text of the `IsNotEmpty` (**Is not empty**) filter operator.
3527
3537
  */
3528
3538
  filterIsNotEmptyOperator;
3529
3539
  /**
3530
- * The text of the `StartsWith` (**Starts with**) filter operator.
3540
+ * Sets the text of the `StartsWith` (**Starts with**) filter operator.
3531
3541
  */
3532
3542
  filterStartsWithOperator;
3533
3543
  /**
3534
- * The text of the `Contains` (**Contains**) filter operator.
3544
+ * Sets the text of the `Contains` (**Contains**) filter operator.
3535
3545
  */
3536
3546
  filterContainsOperator;
3537
3547
  /**
3538
- * The text of the `DoesNotContain` (**Does not contain**) filter operator.
3548
+ * Specifies the text of the `DoesNotContain` (**Does not contain**) filter operator.
3539
3549
  */
3540
3550
  filterNotContainsOperator;
3541
3551
  /**
3542
- * The text of the `EndsWith` (**Ends with**) string filter operator.
3552
+ * Specifies the text of the `EndsWith` (**Ends with**) string filter operator.
3543
3553
  */
3544
3554
  filterEndsWithOperator;
3545
3555
  /**
3546
- * The text of the **Filter** button.
3556
+ * Sets the text of the **Filter** button.
3547
3557
  */
3548
3558
  filterFilterButton;
3549
3559
  /**
3550
- * The text of the **Clear filter** button.
3560
+ * Sets the text of the **Clear filter** button.
3551
3561
  */
3552
3562
  filterClearButton;
3553
3563
  /**
3554
- * The loading text.
3564
+ * Specifies the loading text.
3555
3565
  *
3556
3566
  * > The `loading` property is part of the accessibility support of the PivotGrid.
3557
- * Its value is detectable by screen readers and is not otherwise visible.
3567
+ * Its value is detectable by screen readers and is not visible otherwise.
3558
3568
  */
3559
3569
  loading;
3560
3570
  /**
3561
- * The value of the aria-label attribute placed on the PivotGrid focusable empty cell element.
3571
+ * Specifies the value of the aria-label attribute placed on the PivotGrid focusable empty cell element.
3562
3572
  */
3563
3573
  emptyCellLabel;
3564
3574
  /**
3565
- * The text content of the button that opens and closes the PivotGrid configurator.
3575
+ * Sets the text content of the button that opens and closes the PivotGrid configurator.
3566
3576
  */
3567
3577
  configuratorButtonText;
3568
3578
  /**
3569
- * The text content of the PivotGrid configurator title element.
3579
+ * Sets the text content of the PivotGrid configurator title element.
3570
3580
  */
3571
3581
  configuratorHeaderText;
3572
3582
  /**
3573
- * The text content of the PivotGrid configurator fields section title element.
3583
+ * Sets the text content of the PivotGrid configurator fields section title element.
3574
3584
  */
3575
3585
  configuratorFieldsText;
3576
3586
  /**
3577
- * The text content of the PivotGrid configurator columns section title element.
3587
+ * Sets the text content of the PivotGrid configurator columns section title element.
3578
3588
  */
3579
3589
  configuratorColumnsText;
3580
3590
  /**
3581
- * The text content of the PivotGrid configurator rows section title element.
3591
+ * Specifies the text content of the PivotGrid configurator rows section title element.
3582
3592
  */
3583
3593
  configuratorRowsText;
3584
3594
  /**
3585
- * The text content of the PivotGrid configurator values section title element.
3595
+ * Specifies the text content of the PivotGrid configurator values section title element.
3586
3596
  */
3587
3597
  configuratorValuesText;
3588
3598
  /**
3589
- * The text content of the PivotGrid configurator Cancel button.
3599
+ * Sets the text content of the PivotGrid configurator **Cancel** button.
3590
3600
  */
3591
3601
  configuratorCancelButtonText;
3592
3602
  /**
3593
- * The text content of the PivotGrid configurator Apply button.
3603
+ * Specifies the text content of the PivotGrid configurator **Apply** button.
3594
3604
  */
3595
3605
  configuratorApplyButtonText;
3596
3606
  /**
3597
- * The text content of the PivotGrid configurator empty rows container.
3607
+ * Sets the text content of the PivotGrid configurator empty rows container.
3598
3608
  */
3599
3609
  configuratorEmptyRowsText;
3600
3610
  /**
3601
- * The text content of the PivotGrid configurator empty columns container.
3611
+ * Sets the text content of the PivotGrid configurator empty columns container.
3602
3612
  */
3603
3613
  configuratorEmptyColumnsText;
3604
3614
  /**
3605
- * The text content of the PivotGrid configurator empty measures container.
3615
+ * Sets the text content of the PivotGrid configurator empty measures container.
3606
3616
  */
3607
3617
  configuratorEmptyMeasuresText;
3608
3618
  /**
3609
- * The text content of the Move to Columns item in the column and row fields menu.
3619
+ * Sets the text content of the **Move to Columns** item in the column and row fields menu.
3610
3620
  */
3611
3621
  fieldMenuMoveToColumnsItem;
3612
3622
  /**
3613
- * The text content of the Move to Rows item in the column and row fields menu.
3623
+ * Specifies the text content of the **Move to Rows** item in the column and row fields menu.
3614
3624
  */
3615
3625
  fieldMenuMoveToRowsItem;
3616
3626
  /**
3617
- * The text content of the Move as previous item in the column, row, and value fields menu.
3627
+ * Specifies the text content of the **Move as previous** item in the column, row, and value fields menu.
3618
3628
  */
3619
3629
  fieldMenuMovePreviousItem;
3620
3630
  /**
3621
- * The text content of the Move as next item in the column, row, and value fields menu.
3631
+ * Specifies the text content of the **Move as next** item in the column, row, and value fields menu.
3622
3632
  */
3623
3633
  fieldMenuMoveNextItem;
3624
3634
  /**
3625
- * The title of the chip menu icon.
3626
- *
3627
- * The title consists of a two-part message - the name of the chip and a localizable string.
3628
- * For a field named 'Product', the default title will be 'Product Field Menu'.
3635
+ * Controls the title of the chip menu icon.
3629
3636
  *
3630
- * To allow reordering the field name and the localizable part, the chipMenu accepts a string with a
3631
- * placeholder for the chip name - e.g. 'chip for {fieldName}'. The '{fieldName}' placeholder will be replaced
3632
- * internally with the current chip name, and the resulting title will be rendered as 'Product Field Menu'.
3637
+ * The title has two parts&mdash;the chip name and a localizable string.
3638
+ * For a field named `'Product'`, the default title will be `'Product Field Menu'`.
3633
3639
  *
3634
- * @example
3635
- *
3636
- * ```ts-no-run
3637
- * <kendo-pivotgrid>
3638
- * <kendo-pivotgrid-messages
3639
- * chipMenuIconTitle="'{fieldName} Field Menu'"
3640
- * >
3641
- * </kendo-pivotgrid-messages>
3642
- * </kendo-pivotgrid>
3643
- * ```
3640
+ * You can reorder the parts using `'{fieldName}'` as a placeholder. The `'{fieldName}'` placeholder will get replaced
3641
+ * with the current chip name. For example, `'chip for {fieldName}'` will become `'chip for Product Field Menu'`.
3644
3642
  */
3645
3643
  chipMenuIconTitle;
3646
3644
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: PivotGridMessages, deps: null, target: i0.ɵɵFactoryTarget.Directive });
@@ -3721,8 +3719,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3721
3719
  }] } });
3722
3720
 
3723
3721
  /**
3724
- * Custom component messages override default component messages
3722
+ * Represents the custom messages component of the PivotGrid.
3723
+ *
3724
+ * Use this component to override default messages for the PivotGrid.
3725
3725
  * ([see example]({% slug globalization_pivotgrid %}#toc-custom-messages)).
3726
+ *
3727
+ * @example
3728
+ * ```html
3729
+ * <kendo-pivotgrid>
3730
+ * <kendo-pivotgrid-messages
3731
+ * configuratorButtonText="Configure"
3732
+ * configuratorHeaderText="PivotGrid Settings"
3733
+ * configuratorApplyButtonText="Apply Changes">
3734
+ * </kendo-pivotgrid-messages>
3735
+ * </kendo-pivotgrid>
3736
+ * ```
3726
3737
  */
3727
3738
  class CustomMessagesComponent extends PivotGridMessages {
3728
3739
  service;
@@ -3795,23 +3806,24 @@ const packageMetadata = {
3795
3806
  productName: 'Kendo UI for Angular',
3796
3807
  productCode: 'KENDOUIANGULAR',
3797
3808
  productCodes: ['KENDOUIANGULAR'],
3798
- publishDate: 1750157217,
3799
- version: '19.1.2-develop.4',
3809
+ publishDate: 1750433952,
3810
+ version: '19.1.2-develop.6',
3800
3811
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/?utm_medium=product&utm_source=kendoangular&utm_campaign=kendo-ui-angular-purchase-license-keys-warning'
3801
3812
  };
3802
3813
 
3803
3814
  /**
3804
- * Represents the cell template of the PivotGrid.
3805
- * Helps to customize the content of the cells. To define the cell template, nest an `<ng-template>` tag with the
3806
- * `kendoPivotGridCellTemplate` directive inside a `<kendo-pivot-grid>` tag [see example](slug:templates_pivotgrid#toc-cell-template).
3815
+ * Represents the cell template of the PivotGrid. Allows customizing the content of the cells.
3816
+ *
3817
+ * To define the cell template, nest an `<ng-template>` tag with the
3818
+ * `kendoPivotGridCellTemplate` directive inside a `<kendo-pivot-grid>` tag ([see example](slug:templates_pivotgrid#toc-cell-template)).
3807
3819
  *
3808
- * The template context is set to the current cell item and the following additional fields are passed:
3809
- * - `cellItem`&mdash;The current cell item. Represents the default context that will be assigned to any template variable which utilizes the `let-x` syntax&mdash;for example, `let-cellItem`.
3810
- * - `columnIndex`&mdash;The current column index. Use it as an alias for a template variable by utilizing the `let-columnIndex="columnIndex"` syntax.
3811
- * - `rowIndex`&mdash;The current data row index. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
3812
- * - `expanded`&mdash;The expanded state of the cell. Use it as an alias for a template variable by utilizing the `let-expanded="expanded"` syntax.
3813
- * - `tableType`&mdash;The table type. Use it as an alias for a template variable by utilizing the `let-tableType="tableType"` syntax.
3814
- * - `text`&mdash;The default cell text. Use it as an alias for a template variable by utilizing the `let-text="text"` syntax.
3820
+ * The template context provides the current cell item and the following additional fields:
3821
+ * - `cellItem`&mdash;The current cell item. This is the default template context that you can access with any `let-x` syntax&mdash;for example, `let-cellItem`.
3822
+ * - `columnIndex`&mdash;The current column index. Use `let-columnIndex="columnIndex"` to access this variable in your template.
3823
+ * - `rowIndex`&mdash;The current row index. Use `let-rowIndex="rowIndex"` to access this variable in your template.
3824
+ * - `expanded`&mdash;The expanded state of the cell. Use `let-expanded="expanded"` to access this boolean variable in your template.
3825
+ * - `tableType`&mdash;The table type identifier. Use `let-tableType="tableType"` to access this variable in your template.
3826
+ * - `text`&mdash;The default cell text. Use `let-text="text"` to access this variable in your template.
3815
3827
  *
3816
3828
  * @example
3817
3829
  * ```html
@@ -3839,16 +3851,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3839
3851
  }], ctorParameters: function () { return [{ type: i0.TemplateRef }]; } });
3840
3852
 
3841
3853
  /**
3842
- * Represents the value cell template of the PivotGrid.
3843
- * Helps to customize the content of the value cells. To define the value cell template, nest an `<ng-template>` tag with the
3844
- * `kendoPivotGridValueCellTemplate` directive inside a `<kendo-pivot-grid>` tag [see example](slug:templates_pivotgrid#toc-value-cell-template).
3854
+ * Represents the value cell template of the PivotGrid. Allows customizing the content of the value cells.
3855
+ *
3856
+ * To define the value cell template, nest an `<ng-template>` tag with the
3857
+ * `kendoPivotGridValueCellTemplate` directive inside a `<kendo-pivot-grid>` tag ([see example](slug:templates_pivotgrid#toc-value-cell-template)).
3845
3858
  *
3846
- * The template context is set to the current cell item and the following additional fields are passed:
3847
- * - `cellItem`&mdash;The current cell item. Represents the default context that will be assigned to any template variable which utilizes the `let-x` syntax&mdash;for example, `let-cellItem`.
3848
- * - `columnIndex`&mdash;The current column index. Use it as an alias for a template variable by utilizing the `let-columnIndex="columnIndex"` syntax.
3849
- * - `rowIndex`&mdash;The current data row index. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
3850
- * - `tableType`&mdash;The table type. Use it as an alias for a template variable by utilizing the `let-tableType="tableType"` syntax.
3851
- * - `value`&mdash;The default cell value. Use it as an alias for a template variable by utilizing the `let-value="value"` syntax.
3859
+ * The template context provides the current cell item and the following additional fields:
3860
+ * - `cellItem`&mdash;The current cell item. This is the default template context that you can access with any `let-x` syntax&mdash;for example, `let-cellItem`.
3861
+ * - `columnIndex`&mdash;The current column index. Use `let-columnIndex="columnIndex"` to access this variable in your template.
3862
+ * - `rowIndex`&mdash;The current row index. Use `let-rowIndex="rowIndex"` to access this variable in your template.
3863
+ * - `tableType`&mdash;The table type identifier. Use `let-tableType="tableType"` to access this variable in your template.
3864
+ * - `value`&mdash;The default cell value. Use `let-value="value"` to access this variable in your template.
3852
3865
  *
3853
3866
  * @example
3854
3867
  * ```html
@@ -3876,17 +3889,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3876
3889
  }], ctorParameters: function () { return [{ type: i0.TemplateRef }]; } });
3877
3890
 
3878
3891
  /**
3879
- * Represents the row header cell template of the PivotGrid.
3880
- * Helps to customize the content of the row header cells. To define the row header cell template, nest an `<ng-template>` tag with the
3881
- * `kendoPivotGridRowHeaderCellTemplate` directive inside a `<kendo-pivot-grid>` tag [see example](slug:templates_pivotgrid#toc-row-header-cell-template).
3892
+ * Represents the row header cell template of the PivotGrid. Allows customizing the content of the row header cells.
3882
3893
  *
3883
- * The template context is set to the current cell item and the following additional fields are passed:
3884
- * - `cellItem`&mdash;The current cell item. Represents the default context that will be assigned to any template variable which utilizes the `let-x` syntax&mdash;for example, `let-cellItem`.
3885
- * - `columnIndex`&mdash;The current column index. Use it as an alias for a template variable by utilizing the `let-columnIndex="columnIndex"` syntax.
3886
- * - `rowIndex`&mdash;The current data row index. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
3887
- * - `expanded`&mdash;The expanded state of the cell. Use it as an alias for a template variable by utilizing the `let-expanded="expanded"` syntax.
3888
- * - `tableType`&mdash;The table type. Use it as an alias for a template variable by utilizing the `let-tableType="tableType"` syntax.
3889
- * - `text`&mdash;The default cell text. Use it as an alias for a template variable by utilizing the `let-text="text"` syntax.
3894
+ * To define the row header cell template, nest an `<ng-template>` tag with the
3895
+ * `kendoPivotGridRowHeaderCellTemplate` directive inside a `<kendo-pivot-grid>` tag ([see example](slug:templates_pivotgrid#toc-row-header-cell-template)).
3896
+ *
3897
+ * The template context provides the current cell item and the following additional fields:
3898
+ * - `cellItem`&mdash;The current cell item. This is the default template context that you can access with any `let-x` syntax&mdash;for example, `let-cellItem`.
3899
+ * - `columnIndex`&mdash;The current column index. Use `let-columnIndex="columnIndex"` to access this variable in your template.
3900
+ * - `rowIndex`&mdash;The current row index. Use `let-rowIndex="rowIndex"` to access this variable in your template.
3901
+ * - `expanded`&mdash;The expanded state of the cell. Use `let-expanded="expanded"` to access this boolean variable in your template.
3902
+ * - `tableType`&mdash;The table type identifier. Use `let-tableType="tableType"` to access this variable in your template.
3903
+ * - `text`&mdash;The default cell text. Use `let-text="text"` to access this variable in your template.
3890
3904
  *
3891
3905
  * @example
3892
3906
  * ```html
@@ -3914,17 +3928,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3914
3928
  }], ctorParameters: function () { return [{ type: i0.TemplateRef }]; } });
3915
3929
 
3916
3930
  /**
3917
- * Represents the column header cell template of the PivotGrid.
3918
- * Helps to customize the content of the column header cells. To define the column header cell template, nest an `<ng-template>` tag with the
3919
- * `kendoPivotGridColumnHeaderCellTemplate` directive inside a `<kendo-pivot-grid>` tag [see example](slug:templates_pivotgrid#toc-column-header-cell-template).
3931
+ * Represents the column header cell template of the PivotGrid. Allows customizing the content of the column header cells.
3932
+ *
3933
+ * To define the column header cell template, nest an `<ng-template>` tag with the
3934
+ * `kendoPivotGridColumnHeaderCellTemplate` directive inside a `<kendo-pivot-grid>` tag ([see example](slug:templates_pivotgrid#toc-column-header-cell-template)).
3920
3935
  *
3921
- * The template context is set to the current cell item and the following additional fields are passed:
3922
- * - `cellItem`&mdash;The current cell item. Represents the default context that will be assigned to any template variable which utilizes the `let-x` syntax&mdash;for example, `let-cellItem`.
3923
- * - `columnIndex`&mdash;The current column index. Use it as an alias for a template variable by utilizing the `let-columnIndex="columnIndex"` syntax.
3924
- * - `rowIndex`&mdash;The current data row index. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
3925
- * - `expanded`&mdash;The expanded state of the cell. Use it as an alias for a template variable by utilizing the `let-expanded="expanded"` syntax.
3926
- * - `tableType`&mdash;The table type. Use it as an alias for a template variable by utilizing the `let-tableType="tableType"` syntax.
3927
- * - `text`&mdash;The default cell text. Use it as an alias for a template variable by utilizing the `let-text="text"` syntax.
3936
+ * The template context provides the current cell item and the following additional fields:
3937
+ * - `cellItem`&mdash;The current cell item. This is the default template context that you can access with any `let-x` syntax&mdash;for example, `let-cellItem`.
3938
+ * - `columnIndex`&mdash;The current column index. Use `let-columnIndex="columnIndex"` to access this variable in your template.
3939
+ * - `rowIndex`&mdash;The current row index. Use `let-rowIndex="rowIndex"` to access this variable in your template.
3940
+ * - `expanded`&mdash;The expanded state of the cell. Use `let-expanded="expanded"` to access this boolean variable in your template.
3941
+ * - `tableType`&mdash;The table type identifier. Use `let-tableType="tableType"` to access this variable in your template.
3942
+ * - `text`&mdash;The default cell text. Use `let-text="text"` to access this variable in your template.
3928
3943
  *
3929
3944
  * @example
3930
3945
  * ```html
@@ -4634,7 +4649,24 @@ const DEFAULT_CONFIGURATOR_SETTINGS = {
4634
4649
  orientation: 'vertical'
4635
4650
  };
4636
4651
  /**
4637
- * Represents the Kendo UI PivotGrid component for Angular.
4652
+ * Represents the [Kendo UI PivotGrid component for Angular](slug:overview_pivotgrid).
4653
+ *
4654
+ * @example
4655
+ * ```html
4656
+ * <kendo-pivotgrid
4657
+ * [kendoPivotLocalBinding]="data"
4658
+ * [dimensions]="dimensions"
4659
+ * [measures]="measures"
4660
+ * [rowAxes]="defaultRowAxes"
4661
+ * [columnAxes]="defaultColumnAxes"
4662
+ * [measureAxes]="defaultMeasureAxes"
4663
+ * [configurator]="true"
4664
+ * >
4665
+ * </kendo-pivotgrid>
4666
+ * ```
4667
+ *
4668
+ * @remarks
4669
+ * Supported children components are: {@link CustomMessagesComponent}
4638
4670
  */
4639
4671
  class PivotGridComponent {
4640
4672
  hostEl;
@@ -4669,12 +4701,7 @@ class PivotGridComponent {
4669
4701
  rowHeaderCellTemplate;
4670
4702
  columnHeaderCellTemplate;
4671
4703
  /**
4672
- * Specify the type, size and color of the PivotGrid's loader.
4673
- *
4674
- * The default settings are:
4675
- * * type: `converging-spinner`
4676
- * * color: `primary`
4677
- * * size: `large`
4704
+ * Sets the type, size, and color of the PivotGrid loader.
4678
4705
  */
4679
4706
  set loaderSettings(settings) {
4680
4707
  this._loaderSettings = Object.assign({}, DEFAULT_LOADER_SETTINGS, settings);
@@ -4689,11 +4716,13 @@ class PivotGridComponent {
4689
4716
  return this.localization.get('loading');
4690
4717
  }
4691
4718
  /**
4692
- * Specifies whether the axes configurator should be displayed.
4719
+ * Controls whether the axes configurator is displayed.
4720
+ *
4721
+ * @default false
4693
4722
  */
4694
4723
  configurator;
4695
4724
  /**
4696
- * Sets the virtualization options of the component. By default the virtual scrolling functionality is disabled.
4725
+ * Sets the virtualization options of the component. By default, the virtual scrolling functionality is disabled.
4697
4726
  *
4698
4727
  * @default false
4699
4728
  */
@@ -4708,20 +4737,20 @@ class PivotGridComponent {
4708
4737
  return this.configurator && Object.assign({}, DEFAULT_CONFIGURATOR_SETTINGS, this.configurator);
4709
4738
  }
4710
4739
  /**
4711
- * Specify the width of the column header and data cells. Value is treated as pixels [(see example)]({% slug appearance_pivotgrid %}#toc-column-headers-width).
4740
+ * Sets the width of the column header and data cells. The provided value is treated in pixels [(see example)]({% slug appearance_pivotgrid %}#toc-column-headers-width).
4712
4741
  *
4713
4742
  * @default 200
4714
4743
  */
4715
4744
  columnHeadersWidth = 200;
4716
4745
  /**
4717
- * When the keyboard navigation is enabled, the user can use dedicated shortcuts to interact with the PivotGrid.
4718
- * By default, navigation is enabled. To disable it altogether, and include the PivotGrid content in the normal tab sequence, set the property to `false`.
4746
+ * Specifies whether the keyboard navigation is enabled. When enabled, you can use keyboard shortcuts to interact with the PivotGrid.
4747
+ * Set to `false` to disable navigation and include the PivotGrid content in the normal tab sequence.
4719
4748
  *
4720
4749
  * @default true
4721
4750
  */
4722
4751
  navigable = true;
4723
4752
  /**
4724
- * Holds the displayed aggregated PivotGrid values.
4753
+ * Gets the aggregated PivotGrid values that are displayed.
4725
4754
  */
4726
4755
  get aggregateData() {
4727
4756
  return cloneArray(this.dataService.aggregateData);
@@ -5329,7 +5358,23 @@ const KENDO_PIVOTGRID_DECLARATIONS = [
5329
5358
  ColumnHeaderCellTemplateDirective
5330
5359
  ];
5331
5360
  /**
5332
- * Utility array that contains all `@progress/kendo-angular-pivotgrid` related components and directives.
5361
+ * Use the `KENDO_PIVOTGRID` utility array to add all `@progress/kendo-angular-pivotgrid`-related components and directives to a standalone Angular component.
5362
+ *
5363
+ * @example
5364
+ * ```ts
5365
+ * import { Component } from '@angular/core';
5366
+ * import { KENDO_PIVOTGRID } from '@progress/kendo-angular-pivotgrid';
5367
+ *
5368
+ * @Component({
5369
+ * standalone: true,
5370
+ * imports: [KENDO_PIVOTGRID],
5371
+ * template: `
5372
+ * <kendo-pivotgrid [data]="data" ...>
5373
+ * </kendo-pivotgrid>
5374
+ * `
5375
+ * })
5376
+ * export class AppComponent { }
5377
+ * ```
5333
5378
  */
5334
5379
  const KENDO_PIVOTGRID = [
5335
5380
  PivotGridComponent,
@@ -5351,29 +5396,18 @@ const KENDO_PIVOTGRID = [
5351
5396
  *
5352
5397
  * @example
5353
5398
  *
5354
- * ```ts-no-run
5355
- * // Import the PivotGrid module
5356
- * import { PivotGrid } from '@progress/kendo-angular-pivotgrid';
5357
- *
5358
- * // The browser platform with a compiler
5359
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
5360
- *
5399
+ * ```typescript
5400
+ * import { BrowserModule } from '@angular/platform-browser';
5361
5401
  * import { NgModule } from '@angular/core';
5362
- *
5363
- * // Import the app component
5364
5402
  * import { AppComponent } from './app.component';
5403
+ * import { PivotGridModule } from '@progress/kendo-angular-pivotgrid';
5365
5404
  *
5366
- * // Define the app module
5367
- * _@NgModule({
5368
- * declarations: [AppComponent], // declare app component
5369
- * imports: [BrowserModule, PivotGridModule], // import PivotGrid module
5370
- * bootstrap: [AppComponent]
5405
+ * @NgModule({
5406
+ * declarations: [AppComponent],
5407
+ * imports: [BrowserModule, PivotGridModule],
5408
+ * bootstrap: [AppComponent]
5371
5409
  * })
5372
5410
  * export class AppModule {}
5373
- *
5374
- * // Compile and launch the module
5375
- * platformBrowserDynamic().bootstrapModule(AppModule);
5376
- *
5377
5411
  * ```
5378
5412
  */
5379
5413
  class PivotGridModule {