@progress/kendo-angular-treelist 13.0.0-develop.6 → 13.0.0-develop.8

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 (124) hide show
  1. package/column-menu/column-chooser.component.d.ts +10 -6
  2. package/column-menu/column-menu-chooser.component.d.ts +6 -10
  3. package/column-menu/column-menu-filter.component.d.ts +6 -10
  4. package/column-menu/column-menu-item-content-template.directive.d.ts +1 -1
  5. package/column-menu/column-menu-item.component.d.ts +8 -6
  6. package/column-menu/column-menu-lock.component.d.ts +5 -11
  7. package/column-menu/column-menu-sort.component.d.ts +5 -11
  8. package/column-menu/column-menu.component.d.ts +1 -1
  9. package/column-menu/column-menu.service.d.ts +1 -1
  10. package/columns/checkbox-column.component.d.ts +1 -1
  11. package/columns/column-group.component.d.ts +9 -6
  12. package/columns/column.component.d.ts +16 -66
  13. package/columns/command-column.component.d.ts +13 -15
  14. package/columns/span-column.component.d.ts +10 -81
  15. package/editing/add-command.directive.d.ts +1 -1
  16. package/editing/cancel-command.directive.d.ts +1 -1
  17. package/editing/edit-command.directive.d.ts +1 -1
  18. package/editing/edit-template.directive.d.ts +11 -0
  19. package/editing/remove-command.directive.d.ts +1 -1
  20. package/editing/save-command.directive.d.ts +1 -1
  21. package/esm2020/column-menu/column-chooser.component.mjs +10 -6
  22. package/esm2020/column-menu/column-menu-chooser.component.mjs +8 -12
  23. package/esm2020/column-menu/column-menu-filter.component.mjs +6 -10
  24. package/esm2020/column-menu/column-menu-item-content-template.directive.mjs +1 -1
  25. package/esm2020/column-menu/column-menu-item.component.mjs +8 -6
  26. package/esm2020/column-menu/column-menu-lock.component.mjs +5 -11
  27. package/esm2020/column-menu/column-menu-sort.component.mjs +5 -11
  28. package/esm2020/column-menu/column-menu.component.mjs +1 -1
  29. package/esm2020/column-menu/column-menu.service.mjs +1 -1
  30. package/esm2020/columns/checkbox-column.component.mjs +1 -1
  31. package/esm2020/columns/column-group.component.mjs +9 -6
  32. package/esm2020/columns/column.component.mjs +16 -39
  33. package/esm2020/columns/command-column.component.mjs +13 -15
  34. package/esm2020/columns/span-column.component.mjs +10 -81
  35. package/esm2020/editing/add-command.directive.mjs +1 -1
  36. package/esm2020/editing/cancel-command.directive.mjs +1 -1
  37. package/esm2020/editing/edit-command.directive.mjs +1 -1
  38. package/esm2020/editing/edit-template.directive.mjs +11 -0
  39. package/esm2020/editing/remove-command.directive.mjs +1 -1
  40. package/esm2020/editing/save-command.directive.mjs +1 -1
  41. package/esm2020/excel/excel-command.directive.mjs +1 -1
  42. package/esm2020/filtering/cell/boolean-filter-cell.component.mjs +11 -11
  43. package/esm2020/filtering/cell/date-filter-cell.component.mjs +11 -11
  44. package/esm2020/filtering/cell/filter-cell-operators.component.mjs +15 -0
  45. package/esm2020/filtering/cell/numeric-filter-cell.component.mjs +13 -12
  46. package/esm2020/filtering/cell/string-filter-cell.component.mjs +14 -13
  47. package/esm2020/filtering/date-filter.component.mjs +6 -1
  48. package/esm2020/filtering/menu/boolean-filter-menu.component.mjs +11 -12
  49. package/esm2020/filtering/menu/date-filter-menu.component.mjs +12 -12
  50. package/esm2020/filtering/menu/numeric-filter-menu.component.mjs +12 -12
  51. package/esm2020/filtering/menu/string-filter-menu.component.mjs +15 -0
  52. package/esm2020/filtering/numeric-filter.component.mjs +4 -1
  53. package/esm2020/filtering/operators/after-eq-filter-operator.component.mjs +2 -5
  54. package/esm2020/filtering/operators/after-filter-operator.component.mjs +2 -5
  55. package/esm2020/filtering/operators/before-eq-filter-operator.component.mjs +2 -5
  56. package/esm2020/filtering/operators/before-filter-operator.component.mjs +3 -6
  57. package/esm2020/filtering/operators/contains-filter-operator.component.mjs +1 -4
  58. package/esm2020/filtering/operators/ends-with-filter-operator.component.mjs +1 -4
  59. package/esm2020/filtering/operators/eq-filter-operator.component.mjs +1 -4
  60. package/esm2020/filtering/operators/gt-filter-operator.component.mjs +1 -4
  61. package/esm2020/filtering/operators/gte-filter-operator.component.mjs +1 -4
  62. package/esm2020/filtering/operators/is-empty-filter-operator.component.mjs +1 -4
  63. package/esm2020/filtering/operators/is-not-empty-filter-operator.component.mjs +1 -4
  64. package/esm2020/filtering/operators/is-not-null-filter-operator.component.mjs +1 -4
  65. package/esm2020/filtering/operators/isnull-filter-operator.component.mjs +1 -4
  66. package/esm2020/filtering/operators/lt-filter-operator.component.mjs +2 -5
  67. package/esm2020/filtering/operators/lte-filter-operator.component.mjs +1 -4
  68. package/esm2020/filtering/operators/neq-filter-operator.component.mjs +1 -4
  69. package/esm2020/filtering/operators/not-contains-filter-operator.component.mjs +1 -4
  70. package/esm2020/filtering/operators/starts-with-filter-operator.component.mjs +1 -4
  71. package/esm2020/filtering/string-filter.component.mjs +2 -1
  72. package/esm2020/localization/custom-messages.component.mjs +1 -1
  73. package/esm2020/package-metadata.mjs +2 -2
  74. package/esm2020/pager/pager-numeric-buttons.component.mjs +1 -1
  75. package/esm2020/pager/pager-page-sizes.component.mjs +1 -1
  76. package/esm2020/pager/pager-template.directive.mjs +1 -1
  77. package/esm2020/pdf/pdf-command.directive.mjs +1 -1
  78. package/esm2020/pdf/pdf-margin.component.mjs +9 -0
  79. package/esm2020/rendering/cell-template.directive.mjs +1 -1
  80. package/esm2020/rendering/common/spacer.component.mjs +1 -1
  81. package/esm2020/treelist.component.mjs +24 -288
  82. package/excel/excel-command.directive.d.ts +1 -1
  83. package/excel/excel.component.d.ts +9 -8
  84. package/fesm2015/progress-kendo-angular-treelist.mjs +303 -668
  85. package/fesm2020/progress-kendo-angular-treelist.mjs +303 -668
  86. package/filtering/cell/boolean-filter-cell.component.d.ts +11 -11
  87. package/filtering/cell/date-filter-cell.component.d.ts +11 -11
  88. package/filtering/cell/filter-cell-operators.component.d.ts +15 -0
  89. package/filtering/cell/numeric-filter-cell.component.d.ts +13 -12
  90. package/filtering/cell/string-filter-cell.component.d.ts +12 -11
  91. package/filtering/date-filter.component.d.ts +7 -11
  92. package/filtering/menu/boolean-filter-menu.component.d.ts +11 -12
  93. package/filtering/menu/date-filter-menu.component.d.ts +12 -12
  94. package/filtering/menu/numeric-filter-menu.component.d.ts +12 -12
  95. package/filtering/menu/string-filter-menu.component.d.ts +15 -0
  96. package/filtering/numeric-filter.component.d.ts +4 -1
  97. package/filtering/operators/after-eq-filter-operator.component.d.ts +4 -0
  98. package/filtering/operators/after-filter-operator.component.d.ts +4 -0
  99. package/filtering/operators/before-eq-filter-operator.component.d.ts +4 -0
  100. package/filtering/operators/before-filter-operator.component.d.ts +4 -0
  101. package/filtering/operators/contains-filter-operator.component.d.ts +1 -4
  102. package/filtering/operators/ends-with-filter-operator.component.d.ts +1 -4
  103. package/filtering/operators/eq-filter-operator.component.d.ts +1 -4
  104. package/filtering/operators/gte-filter-operator.component.d.ts +1 -4
  105. package/filtering/operators/is-empty-filter-operator.component.d.ts +1 -4
  106. package/filtering/operators/is-not-empty-filter-operator.component.d.ts +1 -4
  107. package/filtering/operators/is-not-null-filter-operator.component.d.ts +1 -4
  108. package/filtering/operators/isnull-filter-operator.component.d.ts +1 -4
  109. package/filtering/operators/lt-filter-operator.component.d.ts +4 -0
  110. package/filtering/operators/neq-filter-operator.component.d.ts +1 -4
  111. package/filtering/operators/not-contains-filter-operator.component.d.ts +1 -4
  112. package/filtering/operators/starts-with-filter-operator.component.d.ts +1 -4
  113. package/filtering/string-filter.component.d.ts +2 -1
  114. package/localization/custom-messages.component.d.ts +1 -1
  115. package/localization/messages.d.ts +1 -1
  116. package/package.json +16 -16
  117. package/pager/pager-numeric-buttons.component.d.ts +1 -1
  118. package/pager/pager-template.directive.d.ts +1 -1
  119. package/pdf/pdf-command.directive.d.ts +1 -1
  120. package/pdf/pdf-margin.component.d.ts +9 -0
  121. package/rendering/cell-template.directive.d.ts +1 -1
  122. package/rendering/common/spacer.component.d.ts +1 -1
  123. package/schematics/ngAdd/index.js +3 -3
  124. package/treelist.component.d.ts +24 -287
@@ -13,12 +13,14 @@ import * as i0 from "@angular/core";
13
13
  * Represents the component for selecting columns in the TreeList. To enable the user to show or hide columns,
14
14
  * add the component inside a [`ToolbarTemplate`]({% slug api_treelist_toolbartemplatedirective %}) directive.
15
15
  *
16
- * {% meta height:500 %}
17
- * {% embed_file column-menu/chooser-toolbar/app.component.ts preview %}
18
- * {% embed_file column-menu/chooser-toolbar/app.module.ts %}
19
- * {% embed_file shared/main.ts %}
20
- * {% embed_file shared/employees.ts %}
21
- * {% endmeta %}
16
+ * @example
17
+ * ```html
18
+ * <kendo-treelist ...>
19
+ * <ng-template kendoTreeListToolbarTemplate>
20
+ * <kendo-treelist-column-chooser> </kendo-treelist-column-chooser>
21
+ * </ng-template>
22
+ * </kendo-treelist>
23
+ * ```
22
24
  */
23
25
  export declare class ColumnChooserComponent implements OnDestroy {
24
26
  localization: LocalizationService;
@@ -29,10 +31,12 @@ export declare class ColumnChooserComponent implements OnDestroy {
29
31
  private changeDetector;
30
32
  /**
31
33
  * Specifies if the changes in the visibility of the column will be immediately applied.
34
+ * @default false
32
35
  */
33
36
  autoSync: boolean;
34
37
  /**
35
38
  * Specifies if all columns can be hidden.
39
+ * @default true
36
40
  */
37
41
  allowHideAll: boolean;
38
42
  get columns(): any[];
@@ -9,18 +9,13 @@ import { ColumnMenuItemBase } from './column-menu-item-base';
9
9
  import { SVGIcon } from '@progress/kendo-svg-icons';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
- * Represents the component for selecting columns in the TreeList that can be placed
13
- * inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
12
+ * Represents the column-menu item for selecting columns in the TreeList. [See example](slug:columnmenu_treelist#toc-column-chooser-item).
14
13
  *
15
- * > You have to set the [ColumnMenuService]({% slug api_treelist_columnmenuservice %}) that is passed by
16
- * > the template to the service input of the `kendo-treelist-columnmenu-chooser` component.
14
+ * The component can be placed inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
15
+ *
16
+ * To register the component as a known column menu item, set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %})
17
+ * that is passed by the template to the service input of the `kendo-treelist-columnmenu-chooser` component.
17
18
  *
18
- * {% meta height:500 %}
19
- * {% embed_file column-menu/template-chooser/app.component.ts preview %}
20
- * {% embed_file column-menu/template-chooser/app.module.ts %}
21
- * {% embed_file shared/main.ts %}
22
- * {% embed_file shared/employees.ts %}
23
- * {% endmeta %}
24
19
  */
25
20
  export declare class ColumnMenuChooserComponent extends ColumnMenuItemBase {
26
21
  localization: LocalizationService;
@@ -36,6 +31,7 @@ export declare class ColumnMenuChooserComponent extends ColumnMenuItemBase {
36
31
  collapse: EventEmitter<any>;
37
32
  /**
38
33
  * Specifies if the content is expanded.
34
+ * @default false
39
35
  */
40
36
  expanded: boolean;
41
37
  /**
@@ -8,18 +8,13 @@ import { ColumnMenuItemBase } from './column-menu-item-base';
8
8
  import { SVGIcon } from '@progress/kendo-svg-icons';
9
9
  import * as i0 from "@angular/core";
10
10
  /**
11
- * Represents the component for editing column filters in the TreeList that can be placed
12
- * inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
11
+ * Represents the column-menu item for editing column filters in the TreeList.
13
12
  *
14
- * > You have to set the [ColumnMenuService]({% slug api_treelist_columnmenuservice %}) that is passed by
15
- * > the template to the service input of the `kendo-treelist-columnmenu-filter` component.
13
+ * The component can be placed inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
14
+ *
15
+ * To register the component as a known column menu item, set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %})
16
+ * that is passed by the template to the service input of the `kendo-treelist-columnmenu-filter` component.
16
17
  *
17
- * {% meta height:500 %}
18
- * {% embed_file column-menu/template-filter/app.component.ts preview %}
19
- * {% embed_file column-menu/template-filter/app.module.ts %}
20
- * {% embed_file shared/main.ts %}
21
- * {% embed_file shared/employees.ts %}
22
- * {% endmeta %}
23
18
  */
24
19
  export declare class ColumnMenuFilterComponent extends ColumnMenuItemBase {
25
20
  localization: LocalizationService;
@@ -33,6 +28,7 @@ export declare class ColumnMenuFilterComponent extends ColumnMenuItemBase {
33
28
  collapse: EventEmitter<any>;
34
29
  /**
35
30
  * Specifies if the content is expanded.
31
+ * @default false
36
32
  */
37
33
  expanded: boolean;
38
34
  /**
@@ -13,7 +13,7 @@ import * as i0 from "@angular/core";
13
13
  *
14
14
  * @example
15
15
  * ```html
16
- * <kendo-treelist>
16
+ * <kendo-treelist ...>
17
17
  * <kendo-treelist-column field="ProductName">
18
18
  * <ng-template kendoTreeListColumnMenuTemplate>
19
19
  * <kendo-treelist-columnmenu-item text="Item Text" [expanded]="true">
@@ -10,12 +10,14 @@ import * as i0 from "@angular/core";
10
10
  * Represents an item that can be placed inside a
11
11
  * [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
12
12
  *
13
- * {% meta height:500 %}
14
- * {% embed_file column-menu/template-item/app.component.ts preview %}
15
- * {% embed_file column-menu/template-item/app.module.ts %}
16
- * {% embed_file shared/main.ts %}
17
- * {% embed_file shared/employees.ts %}
18
- * {% endmeta %}
13
+ * * @example
14
+ * ```html
15
+ * <kendo-treelist ...>
16
+ * <ng-template kendoTreeListColumnMenuTemplate let-service="service" let-column="column">
17
+ * <kendo-treelist-columnmenu-item text="Fit column"></kendo-treelist-columnmenu-item>
18
+ * </ng-template>
19
+ * </kendo-treelist>
20
+ * ```
19
21
  */
20
22
  export declare class ColumnMenuItemComponent implements OnChanges {
21
23
  /**
@@ -9,19 +9,13 @@ import { ColumnMenuItemBase } from './column-menu-item-base';
9
9
  import { SVGIcon } from '@progress/kendo-svg-icons';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
- * Represents a column-menu item that can be placed inside a
13
- * [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
14
- * Allows the user to lock or unlock the columns.
12
+ * Represents the column-menu item that allows the user to lock or unlock columns.
15
13
  *
16
- * > You have to set the [ColumnMenuService]({% slug api_treelist_columnmenuservice %}) that is passed by
17
- * > the template to the service input of the `kendo-treelist-columnmenu-lock` component.
14
+ * The componnt can be placed inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
15
+ *
16
+ * To register the component as a known column menu item, set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %})
17
+ * that is passed by the template to the service input of the `kendo-treelist-columnmenu-lock` component.
18
18
  *
19
- * {% meta height:500 %}
20
- * {% embed_file column-menu/template-lock/app.component.ts preview %}
21
- * {% embed_file column-menu/template-lock/app.module.ts %}
22
- * {% embed_file shared/main.ts %}
23
- * {% embed_file shared/employees.ts %}
24
- * {% endmeta %}
25
19
  */
26
20
  export declare class ColumnMenuLockComponent extends ColumnMenuItemBase {
27
21
  private localization;
@@ -8,19 +8,13 @@ import { ColumnMenuItemBase } from './column-menu-item-base';
8
8
  import { SVGIcon } from '@progress/kendo-svg-icons';
9
9
  import * as i0 from "@angular/core";
10
10
  /**
11
- * Represents a column-menu item for sorting TreeList columns that can be placed inside a
12
- * [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
13
- * Allows the user to sort the column.
11
+ * Represents the column-menu item for sorting TreeList columns.
14
12
  *
15
- * > You have to set the [ColumnMenuService]({% slug api_treelist_columnmenuservice %}) that is passed by
16
- * > the template to the service input of the `kendo-treelist-columnmenu-sort` component.
13
+ * The component can be placed inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
14
+ *
15
+ * To register the component as a known column menu item, set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %})
16
+ * that is passed by the template to the service input of the `kendo-treelist-columnmenu-sort` component.
17
17
  *
18
- * {% meta height:500 %}
19
- * {% embed_file column-menu/template-sort/app.component.ts preview %}
20
- * {% embed_file column-menu/template-sort/app.module.ts %}
21
- * {% embed_file shared/main.ts %}
22
- * {% embed_file shared/employees.ts %}
23
- * {% endmeta %}
24
18
  */
25
19
  export declare class ColumnMenuSortComponent extends ColumnMenuItemBase {
26
20
  localization: LocalizationService;
@@ -10,7 +10,7 @@ import { ColumnMenuSettings } from './column-menu-settings.interface';
10
10
  import { SVGIcon } from '@progress/kendo-svg-icons';
11
11
  import * as i0 from "@angular/core";
12
12
  /**
13
- * Represents the [column menu]({% slug columnmenu_treelist %}) component.
13
+ * Represents the [column menu]({% slug columnmenu_treelist %}) component of the TreeList.
14
14
  */
15
15
  export declare class ColumnMenuComponent implements OnChanges, OnDestroy {
16
16
  protected popupService: SinglePopupService;
@@ -10,7 +10,7 @@ import * as i0 from "@angular/core";
10
10
  *
11
11
  * @example
12
12
  * ```html
13
- * <kendo-treelist>
13
+ * <kendo-treelist ...>
14
14
  * <ng-template
15
15
  * kendoTreeListColumnMenuTemplate
16
16
  * let-service="service"
@@ -7,7 +7,7 @@ import { ColumnBase } from './column-base';
7
7
  import { CellTemplateDirective } from '../rendering/cell-template.directive';
8
8
  import * as i0 from "@angular/core";
9
9
  /**
10
- * Represents the checkbox for selecting rows in the TreeList.
10
+ * Represents the checkbox for selecting rows in the TreeList. [See example](slug:selection_treelist#toc-select-all-checkbox).
11
11
  */
12
12
  export declare class CheckboxColumnComponent extends ColumnBase {
13
13
  parent?: ColumnBase;
@@ -14,12 +14,15 @@ export declare function isColumnGroupComponent(column: any): column is ColumnGro
14
14
  * Represents the column group header of the TreeList
15
15
  * ([more information and examples]({% slug multicolumnheaders_columns_treelist %})).
16
16
  *
17
- * {% meta height:533 %}
18
- * {% embed_file configuration/multi-column-headers/app.component.ts preview %}
19
- * {% embed_file configuration/multi-column-headers/app.module.ts %}
20
- * {% embed_file shared/main.ts %}
21
- * {% embed_file shared/filesystem.ts %}
22
- * {% endmeta %}
17
+ * @example
18
+ * ```html
19
+ * <kendo-treelist ...>
20
+ * <kendo-treelist-column-group title="File Info">
21
+ * <kendo-treelist-column field="type" title="Type"> </kendo-treelist-column>
22
+ * <kendo-treelist-column field="size" title="Size"> </kendo-treelist-column>
23
+ * </kendo-treelist-column-group>
24
+ * </kendo-treelist>
25
+ * ```
23
26
  */
24
27
  export declare class ColumnGroupComponent extends ColumnBase {
25
28
  /**
@@ -16,14 +16,15 @@ import * as i0 from "@angular/core";
16
16
  */
17
17
  export declare function isColumnComponent(column: any): column is ColumnComponent;
18
18
  /**
19
- * Represents the columns of the [Angular TreeList]({% slug getstarted_treelist %}).
19
+ * Represents the columns of the TreeList.
20
20
  *
21
- * {% meta height:470 %}
22
- * {% embed_file basic-usage/app.component.ts preview %}
23
- * {% embed_file basic-usage/app.module.ts %}
24
- * {% embed_file shared/main.ts %}
25
- * {% embed_file shared/employees.ts %}
26
- * {% endmeta %}
21
+ * @example
22
+ * ```html
23
+ * <kendo-treelist [kendoTreeListFlatBinding]="data" ...>
24
+ * <kendo-treelist-column field="name" title="Name"></kendo-treelist-column>
25
+ * <kendo-treelist-column field="title"title="Title"></kendo-treelist-column>
26
+ * </kendo-treelist>
27
+ * ```
27
28
  */
28
29
  export declare class ColumnComponent extends ColumnBase {
29
30
  /**
@@ -40,33 +41,6 @@ export declare class ColumnComponent extends ColumnBase {
40
41
  * Takes the `{0:format}` form where `format` is a standard number format, a custom number format,
41
42
  * a standard date format, a custom date format or a format object. For more information on the supported date and number formats,
42
43
  * refer to the [kendo-intl](https://github.com/telerik/kendo-intl/blob/develop/docs/index.md) documentation.
43
- *
44
- * Standard format:
45
- * @example
46
- * ```html-no-run
47
- * <kendo-treelist>
48
- * <kendo-treelist-column field="UnitPrice" format="{0:c}">
49
- * </kendo-treelist-column>
50
- * </kendo-treelist>
51
- * ```
52
- *
53
- * Format object for currency:
54
- * @example
55
- * ```html-no-run
56
- * <kendo-treelist>
57
- * <kendo-treelist-column field="UnitPrice" [format]="{ style: 'currency', currency: 'EUR' }">
58
- * </kendo-treelist-column>
59
- * </kendo-treelist>
60
- * ```
61
- *
62
- * Format object for dates:
63
- * @example
64
- * ```html-no-run
65
- * <kendo-treelist>
66
- * <kendo-treelist-column field="FirstOrderedOn" [format]="{ date: 'short' }">
67
- * </kendo-treelist-column>
68
- * </kendo-treelist>
69
- * ```
70
44
  */
71
45
  format: any;
72
46
  /**
@@ -76,51 +50,27 @@ export declare class ColumnComponent extends ColumnBase {
76
50
  sortable: boolean | ColumnSortSettings;
77
51
  /**
78
52
  * Defines the editor type ([see example]({% slug editing_reactive_forms_treelist %}#toc-setup)).
79
- * Used when the column enters the edit mode. The default value is `text`.
53
+ * Used when the column enters the edit mode. [See example](slug:editing_reactive_forms_treelist).
80
54
  *
81
- * @example
82
- * ```html-no-run
83
- * <kendo-treelist>
84
- * <kendo-treelist-column field="UnitPrice" editor="numeric">
85
- * </kendo-treelist-column>
86
- * </kendo-treelist>
87
- * ```
55
+ * @default 'text'
88
56
  */
89
57
  editor: 'text' | 'numeric' | 'date' | 'boolean';
90
58
  /**
91
- * Defines the filter type that is displayed inside the filter row. The default value is `text`.
59
+ * Defines the filter type that is displayed inside the filter row.
92
60
  *
93
- * @example
94
- * ```html-no-run
95
- * <kendo-treelist>
96
- * <kendo-treelist-column field="UnitPrice" filter="numeric">
97
- * </kendo-treelist-column>
98
- * </kendo-treelist>
99
- * ```
61
+ * @default 'text'
100
62
  */
101
63
  filter: 'text' | 'numeric' | 'boolean' | 'date';
102
64
  /**
103
- * Defines if a filter UI will be displayed for this column. The default value is `true`.
65
+ * Defines if a filter UI will be displayed for this column.
104
66
  *
105
- * @example
106
- * ```html-no-run
107
- * <kendo-treelist>
108
- * <kendo-treelist-column field="UnitPrice" [filterable]="false">
109
- * </kendo-treelist-column>
110
- * </kendo-treelist>
111
- * ```
67
+ * @default true
112
68
  */
113
69
  filterable: boolean;
114
70
  /**
115
- * Defines whether the column is editable. The default value is `true`.
71
+ * Defines whether the column is editable.
116
72
  *
117
- * @example
118
- * ```html-no-run
119
- * <kendo-treelist>
120
- * <kendo-treelist-column field="UnitPrice" [editable]="false">
121
- * </kendo-treelist-column>
122
- * </kendo-treelist>
123
- * ```
73
+ * @default true
124
74
  */
125
75
  editable: boolean;
126
76
  template: CellTemplateDirective;
@@ -9,30 +9,28 @@ import { OptionChangesService } from '../common/option-changes.service';
9
9
  import * as i0 from "@angular/core";
10
10
  /**
11
11
  * Represents the command columns of the TreeList. You have to define the content of the
12
- * column inside an `<ng-template>` tag. The template context is set to the current
13
- * data item. For more information and examples on using the passed fields
12
+ * column inside an `<ng-template>` tag. For more information and examples on using the passed fields
14
13
  * and the command directives, refer to the article on
15
14
  * [editing the TreeList in Angular Reactive Forms]({% slug editing_reactive_forms_treelist %}).
16
15
  *
17
- * The following additional fields are passed:
18
- * - `columnIndex`&mdash;The current column index.
19
- * - `rowIndex`&mdash;The current data row index. If inside a new item row, `rowIndex`is `-1`.
20
- * - `dataItem`&mdash;The current data item.
21
- * - `column`&mdash;The current column instance.
22
- * - `isNew`&mdash;The state of the current item.
23
- *
24
16
  * Usually, the template contains CRUD command directives such as:
25
17
  * - [`EditCommandDirective`]({% slug api_treelist_editcommanddirective %})
26
18
  * - [`RemoveCommandDirective`]({% slug api_treelist_removecommanddirective %})
27
19
  * - [`CancelCommandDirective`]({% slug api_treelist_cancelcommanddirective %})
28
20
  * - [`SaveCommandDirective`]({% slug api_treelist_savecommanddirective %})
29
21
  *
30
- * {% meta height:590 %}
31
- * {% embed_file editing/editing-directives/reactive-editing/app.component.ts preview %}
32
- * {% embed_file shared/employees.ts %}
33
- * {% embed_file editing/editing-directives/reactive-editing/app.module.ts %}
34
- * {% embed_file shared/main.ts %}
35
- * {% endmeta %}
22
+ * @example
23
+ * ```html
24
+ * <kendo-treelist ...>
25
+ * <kendo-treelist-column field="ProductID"></kendo-treelist-column>
26
+ * <kendo-treelist-command-column title="command" >
27
+ * <ng-template kendoTreeListCellTemplate>
28
+ * <button kendoTreeListEditCommand class="k-primary">Edit</button>
29
+ * <button kendoTreeListRemoveCommand>Remove</button>
30
+ * </ng-template>
31
+ * </kendo-treelist-command-column>
32
+ * </kendo-treelist>
33
+ * ```
36
34
  */
37
35
  export declare class CommandColumnComponent extends ColumnBase {
38
36
  parent?: ColumnBase;
@@ -20,25 +20,15 @@ export declare function isSpanColumnComponent(column: any): column is SpanColumn
20
20
  * [sorting]({% slug sorting_treelist %}) and [filtering]({% slug filtering_treelist %}). Wrap the columns that will be
21
21
  * merged inside the `<kendo-treelist-span-column>` tag.
22
22
  *
23
- * {% meta height:570 %}
24
- * {% embed_file configuration/span-column/app.component.ts preview %}
25
- * {% embed_file configuration/span-column/app.module.ts %}
26
- * {% embed_file shared/main.ts %}
27
- * {% embed_file shared/employees.ts %}
28
- * {% endmeta %}
29
- *
30
- * By default, the data cell displays the data for the specified fields. To further customize
31
- * the span-column functionality, use a [cell template]({% slug api_treelist_celltemplatedirective %}).
32
- *
33
- * ```html-no-run
23
+ * ```html
34
24
  * <kendo-treelist-span-column>
35
- * <kendo-treelist-column field="field1" title="Field 1"></kendo-treelist-column>
36
- * <kendo-treelist-column field="field2" title="Field 2"></kendo-treelist-column>
37
- * <ng-template kendoTreeListCellTemplate let-dataItem>
38
- * <h5>{{ dataItem.field1 }}</h5>
39
- * <p>{{ dataItem.field2 }}</p>
40
- * </ng-template>
41
- * </kendo-treelist-span-column>
25
+ * <kendo-treelist-column field="field1" ></kendo-treelist-column>
26
+ * <kendo-treelist-column field="field2" ></kendo-treelist-column>
27
+ * <ng-template kendoTreeListCellTemplate let-dataItem>
28
+ * <h5>{{ dataItem.field1 }}</h5>
29
+ * <p>{{ dataItem.field2 }}</p>
30
+ * </ng-template>
31
+ * </kendo-treelist-span-column>
42
32
  * ```
43
33
  */
44
34
  export declare class SpanColumnComponent extends ColumnBase {
@@ -89,22 +79,8 @@ export declare class SpanColumnComponent extends ColumnBase {
89
79
  /**
90
80
  * Defines whether the edit template of the column will be rendered. The default value is `false`.
91
81
  *
92
- * > To enable the editing functionality for a spanned column, set an edit template for it.
82
+ * To enable the editing functionality for a spanned column, set an edit template for it.
93
83
  *
94
- * @example
95
- * ```html-no-run
96
- * <kendo-treelist>
97
- * <kendo-treelist-span-column [editable]="false">
98
- * <kendo-treelist-column field="UnitPrice">
99
- * </kendo-treelist-column>
100
- * <kendo-treelist-column field="ProductName">
101
- * </kendo-treelist-column>
102
- * <ng-template kendoTreeListEditTemplate>
103
- * .....
104
- * </ng-template>
105
- * </kendo-treelist-span-column>
106
- * </kendo-treelist>
107
- * ```
108
84
  */
109
85
  set editable(value: boolean);
110
86
  get editable(): boolean;
@@ -134,56 +110,9 @@ export declare class SpanColumnComponent extends ColumnBase {
134
110
  get colspan(): number;
135
111
  /**
136
112
  * Toggles the locked (frozen) state of the columns. Locked columns are visible
137
- * at all times during the horizontal scrolling of the TreeList.
138
- *
139
- * For the option to work properly, make sure that:
140
- * - Scrolling is enabled.
141
- * - The `height` option of the TreeList is set.
142
- * - The widths of all TreeList columns are explicitly set in pixels. In this way,
143
- * the TreeList adjusts the layout of the locked and unlocked columns.
113
+ * at all times during the horizontal scrolling of the TreeList. [See example](slug:locked_columns_treelist).
144
114
  *
145
115
  * @default false
146
- *
147
- * @example
148
- * ```ts
149
- * _@Component({
150
- * selector: 'my-app',
151
- * template: `
152
- * <kendo-treelist [data]="treelistData" [scrollable]="scrollable" style="height: 200px">
153
- * <kendo-treelist-span-column [locked]="true">
154
- * <kendo-treelist-column field="ProductID" title="Product ID" [width]="120">
155
- * </kendo-treelist-column>
156
- * <kendo-treelist-column field="ProductName" title="Product Name" [width]="200">
157
- * </kendo-treelist-column>
158
- * </kendo-treelist-span-column>
159
- * <kendo-treelist-column field="UnitPrice" title="Unit Price" [width]="230">
160
- * </kendo-treelist-column>
161
- * </kendo-treelist>
162
- * `
163
- * })
164
- *
165
- * class AppComponent {
166
- * public treelistData: any[];
167
- *
168
- * constructor() {
169
- * this.treelistData = products;
170
- * }
171
- * }
172
- *
173
- * const products = [{
174
- * "ProductID": 1,
175
- * "ProductName": "Chai",
176
- * "UnitPrice": 18.0000,
177
- * "Discontinued": true
178
- * }, {
179
- * "ProductID": 2,
180
- * "ProductName": "Chang",
181
- * "UnitPrice": 19.0000,
182
- * "Discontinued": false
183
- * }
184
- * ];
185
- *
186
- * ```
187
116
  */
188
117
  set locked(value: boolean);
189
118
  get locked(): boolean;
@@ -22,7 +22,7 @@ import * as i0 from "@angular/core";
22
22
  *
23
23
  * @example
24
24
  * ```html
25
- * <kendo-treelist>
25
+ * <kendo-treelist ...>
26
26
  * <kendo-treelist-command-column title="command">
27
27
  * <ng-template kendoTreeListCellTemplate let-cellContext="cellContext">
28
28
  * <button [kendoTreeListAddCommand]="cellContext" class="k-primary">Edit</button>
@@ -19,7 +19,7 @@ import * as i0 from "@angular/core";
19
19
  *
20
20
  * @example
21
21
  * ```html
22
- * <kendo-treelist>
22
+ * <kendo-treelist ...>
23
23
  * <kendo-treelist-command-column title="command">
24
24
  * <ng-template kendoTreeListCellTemplate let-cellContext="cellContext">
25
25
  * <button [kendoTreeListCancelCommand]="cellContext">Cancel changes</button>
@@ -19,7 +19,7 @@ import * as i0 from "@angular/core";
19
19
  *
20
20
  * @example
21
21
  * ```html
22
- * <kendo-treelist>
22
+ * <kendo-treelist ...>
23
23
  * <kendo-treelist-command-column title="command">
24
24
  * <ng-template kendoTreeListCellTemplate let-cellContext="cellContext">
25
25
  * <button [kendoTreeListEditCommand]="cellContext">Edit</button>
@@ -16,6 +16,17 @@ import * as i0 from "@angular/core";
16
16
  * - `formGroup`&mdash;The current [`FormGroup`](link:site.data.urls.angular['formgroupapi']). If you use the TreeList inside [Template-Driven Forms](link:site.data.urls.angular['forms']), `formGroup` will be `undefined`.
17
17
  * - `isNew`&mdash;The state of the current item.
18
18
  * - `rowIndex`&mdash;The current row index. If inside a new item row, `rowIndex` is `-1`.
19
+ *
20
+ * * @example
21
+ * ```html
22
+ * <kendo-treelist ...>
23
+ * <kendo-treelist-command-column title="command">
24
+ * <ng-template kendoTreeListEditTemplate let-rowIndex="rowIndex">
25
+ * {{rowIndex}}
26
+ * </ng-template>
27
+ * </kendo-treelist-command-column>
28
+ * </kendo-treelist>
29
+ * ```
19
30
  */
20
31
  export declare class EditTemplateDirective {
21
32
  templateRef: TemplateRef<any>;
@@ -19,7 +19,7 @@ import * as i0 from "@angular/core";
19
19
  *
20
20
  * @example
21
21
  * ```html
22
- * <kendo-treelist>
22
+ * <kendo-treelist ...>
23
23
  * <kendo-treelist-command-column title="command">
24
24
  * <ng-template kendoTreeListCellTemplate let-cellContext="cellContext">
25
25
  * <button [kendoTreeListRemoveCommand]="cellContext">Remove row</button>
@@ -19,7 +19,7 @@ import * as i0 from "@angular/core";
19
19
  *
20
20
  * @example
21
21
  * ```html
22
- * <kendo-treelist>
22
+ * <kendo-treelist ...>
23
23
  * <kendo-treelist-command-column title="command">
24
24
  * <ng-template kendoTreeListCellTemplate let-cellContext="cellContext">
25
25
  * <button [kendoTreeListSaveCommand]="cellContext">Save changes</button>
@@ -19,12 +19,14 @@ import * as i5 from "./column-list.component";
19
19
  * Represents the component for selecting columns in the TreeList. To enable the user to show or hide columns,
20
20
  * add the component inside a [`ToolbarTemplate`]({% slug api_treelist_toolbartemplatedirective %}) directive.
21
21
  *
22
- * {% meta height:500 %}
23
- * {% embed_file column-menu/chooser-toolbar/app.component.ts preview %}
24
- * {% embed_file column-menu/chooser-toolbar/app.module.ts %}
25
- * {% embed_file shared/main.ts %}
26
- * {% embed_file shared/employees.ts %}
27
- * {% endmeta %}
22
+ * @example
23
+ * ```html
24
+ * <kendo-treelist ...>
25
+ * <ng-template kendoTreeListToolbarTemplate>
26
+ * <kendo-treelist-column-chooser> </kendo-treelist-column-chooser>
27
+ * </ng-template>
28
+ * </kendo-treelist>
29
+ * ```
28
30
  */
29
31
  export class ColumnChooserComponent {
30
32
  constructor(localization, columnInfoService, popupService, ngZone, renderer, changeDetector) {
@@ -36,10 +38,12 @@ export class ColumnChooserComponent {
36
38
  this.changeDetector = changeDetector;
37
39
  /**
38
40
  * Specifies if the changes in the visibility of the column will be immediately applied.
41
+ * @default false
39
42
  */
40
43
  this.autoSync = false;
41
44
  /**
42
45
  * Specifies if all columns can be hidden.
46
+ * @default true
43
47
  */
44
48
  this.allowHideAll = true;
45
49
  this.columnsIcon = columnsIcon;