@progress/kendo-angular-treelist 12.0.1-develop.3 → 12.0.1-develop.4

package/esm2020/pdf/pdf-command.directive.mjs

@@ -14,19 +14,18 @@ import * as i4 from "@angular/common";
 /**
  * Represents the `export-to-PDF` command of the TreeList.
  * You can apply this directive to any `button` element inside a
- * [`ToolbarTemplate`]({% slug api_treelist_commandcolumncomponent %}).
+ * [`ToolbarTemplate`](slug:toolbartemplate_treelist).
  * When the user clicks a button that is associated with the directive, the
  * [`pdfExport`]({% slug api_treelist_treelistcomponent %}#toc-pdfexport) event
  * fires ([see example]({% slug pdfexport_treelist %})).
  *
  * @example
- * ```html-no-run
+ * ```html
  * <kendo-treelist>
- *      <ng-template kendoTreeListToolbarTemplate>
- *          <button kendoTreeListPDFCommand>Export to PDF</button>
- *      </ng-template>
- *      <kendo-treelist-pdf fileName="TreeList.pdf">
- *      </kendo-treelist-pdf>
+ *   <ng-template kendoTreeListToolbarTemplate>
+ *     <button kendoTreeListPDFCommand>Export to PDF</button>
+ *   </ng-template>
+ *   <kendo-treelist-pdf fileName="TreeList.pdf"></kendo-treelist-pdf>
  * </kendo-treelist>
  * ```
  */

package/esm2020/pdf/pdf-template.directive.mjs

@@ -13,12 +13,19 @@ import * as i0 from "@angular/core";
  * - `pageNumber`—Defines PDF page number.
  * - `totalPages`—Defines the total number of PDF pages.
  *
- * {% meta height:550 %}
- * {% embed_file pdf-export/page-template-inline/app.component.ts preview %}
- * {% embed_file pdf-export/page-template-inline/app.module.ts %}
- * {% embed_file shared/filesystem.ts %}
- * {% embed_file shared/main.ts %}
- * {% endmeta %}
+ * @example
+ * ```html
+ * <kendo-treelist-pdf fileName="Files.pdf" ...>
+ *   <ng-template
+ *     kendoTreeListPDFTemplate
+ *     let-pageNum="pageNum"
+ *     let-totalPages="totalPages">
+ *     <div style="position: absolute; top: 5px; left: 5px;">
+ *       Page {{ pageNum }} of {{ totalPages }}
+ *     </div>
+ *   </ng-template>
+ * </kendo-treelist-pdf>
+ * ```
  */
 export class PDFTemplateDirective extends PDFExportTemplateDirective {
     constructor(templateRef) {

package/esm2020/rendering/cell-template.directive.mjs

@@ -20,12 +20,16 @@ import * as i0 from "@angular/core";
  * - `loading`—Specifies if the item children are currently loading.
  * - `rowIndex`—The current row index. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
  *
- * {% meta height:470 %}
- * {% embed_file data-binding/hierarchy/app.component.ts preview %}
- * {% embed_file data-binding/hierarchy/app.module.ts %}
- * {% embed_file shared/main.ts %}
- * {% embed_file shared/filesystem.ts %}
- * {% endmeta %}
+ * * @example
+ * ```html
+ * <kendo-treelist ...>
+ *   <kendo-treelist-column field="ProductName">
+ *     <ng-template kendoTreeListCellTemplate let-dataItem let-rowIndex="rowIndex" let-column="column">
+ *       Data Row: {{rowIndex}}
+ *     </ng-template>
+ *   </kendo-treelist-column>
+ * </kendo-treelist>
+ *```
  */
 export class CellTemplateDirective {
     constructor(templateRef) {

package/esm2020/rendering/footer-template.directive.mjs

@@ -9,7 +9,7 @@ import * as i0 from "@angular/core";
  * ([more information and example]({% slug templates_columns_treelist %}#toc-footer-template)).
  * Helps to customize the table footer cell for the column.
  * To define a footer template, nest an `<ng-template>` tag with the
- * [`kendoTreeListFooterTemplate`]({% slug api_treelist_footertemplatedirective %}) directive inside the `<kendo-treelist-column>` tag.
+ * `kendoTreeListFooterTemplate` directive inside the `<kendo-treelist-column>` tag.
  *
  * The template context is set to the aggregate values and the following additional fields are passed:
  * * `aggregates`&mdash;The aggregates for the level items.
@@ -19,13 +19,14 @@ import * as i0 from "@angular/core";
  * * `items`&mdash;The data items on this level.
  * * `parentItem`&mdash;The parent data item; `null` for root level items.
  *
- *
- * {% meta height:500 %}
- * {% embed_file configuration/footer-template/app.component.ts preview %}
- * {% embed_file configuration/footer-template/app.module.ts %}
- * {% embed_file shared/main.ts %}
- * {% embed_file shared/employees.ts %}
- * {% endmeta %}
+ * @example
+ * ```html
+ * <kendo-treelist-column field="name">
+ *   <ng-template kendoTreeListFooterTemplate let-aggregates="aggregates">
+ *     {{ aggregates.name.count }}
+ *   </ng-template>
+ * </kendo-treelist-column>
+ * ```
  */
 export class FooterTemplateDirective {
     constructor(templateRef) {

package/esm2020/rendering/header/header-template.directive.mjs

@@ -15,12 +15,16 @@ import * as i0 from "@angular/core";
  * * `column`—Defines an instance of the [`ColumnComponent`]({% slug api_treelist_columncomponent %}) option.
  * * `columnIndex`—Defines the current column index.
  *
- * {% meta height:533 %}
- * {% embed_file configuration/header-template/app.component.ts preview %}
- * {% embed_file configuration/header-template/app.module.ts %}
- * {% embed_file shared/main.ts %}
- * {% embed_file shared/employees.ts %}
- * {% endmeta %}
+ * @example
+ * ```html
+ * <kendo-treelist-column field="name">
+ *   <ng-template
+ *     kendoTreeListHeaderTemplate
+ *     let-column>
+ *     {{ column.field }}
+ *   </ng-template>
+ * </kendo-treelist-column>
+ * ```
  */
 export class HeaderTemplateDirective {
     constructor(templateRef) {

package/esm2020/rendering/no-records-template.directive.mjs

@@ -9,14 +9,17 @@ import * as i0 from "@angular/core";
  * appearance of the item that is displayed when no data is present. To define the no-records template,
  * nest an `<ng-template>` tag with the `kendoTreeListNoRecordsTemplate` directive inside `<kendo-treelist>`.
  *
- * > When the locked columns of the TreeList are in use, the template is displayed in the non-locked part of the content.
+ * When the locked columns of the TreeList are in use, the template is displayed in the non-locked part of the content.
  *
- * {% meta height:533 %}
- * {% embed_file configuration/no-records-template/app.component.ts preview %}
- * {% embed_file configuration/no-records-template/app.module.ts %}
- * {% embed_file shared/main.ts %}
- * {% embed_file shared/employees.ts %}
- * {% endmeta %}
+ * @example
+ * ```html
+ * <kendo-treelist ... >
+ *   <kendo-treelist-column field="name" ></kendo-treelist-column>
+ *   <ng-template kendoTreeListNoRecordsTemplate>
+ *     No data loaded.
+ *   </ng-template>
+ * </kendo-treelist>
+ * ```
  */
 export class NoRecordsTemplateDirective {
     constructor(templateRef) {

package/esm2020/rendering/toolbar/toolbar-template.directive.mjs

@@ -10,15 +10,18 @@ import * as i1 from "../../common/option-changes.service";
  * Represents the toolbar template of the TreeList.
  *
  * The template context has the following field:
- * - `position`—The position at which the toolbar template is rendered. The possible values are "top" and "bottom".
+ * - `position`—The position at which the toolbar template is rendered. The possible values are `top`, `bottom` and `both`.
  *
  * @example
- * {% meta height:470 %}
- * {% embed_file configuration/toolbar-template/basic/app.component.ts preview %}
- * {% embed_file configuration/toolbar-template/basic/app.module.ts %}
- * {% embed_file shared/main.ts %}
- * {% embed_file shared/employees.ts %}
- * {% endmeta %}
+ * ```html
+ * <kendo-treelist ...>
+ *   <ng-template kendoTreeListToolbarTemplate>
+ *     <button kendoTreeListExcelCommand icon="file-excel">
+ *       Export to Excel
+ *     </button>
+ *   </ng-template>
+ * </kendo-treelist>
+ * ```
  */
 export class ToolbarTemplateDirective {
     constructor(templateRef, optionChanges) {
@@ -28,12 +31,8 @@ export class ToolbarTemplateDirective {
     }
     /**
      * The position of the toolbar ([see example]({% slug toolbartemplate_treelist %})).
-     *
-     * The possible values are:
-     * - `top`&mdash;Positions the toolbar above the group panel or header.
-     * - `bottom`&mdash;Positions the toolbar below the pager.
-     * - `both`&mdash;Displays two toolbar instances. Positions the first one above
-     * the group panel or header and the second one below the pager.
+     * The group panel or header and the second one below the pager.
+     * @default 'top'
      */
     set position(position) {
         this._position = position;

package/esm2020/selection/selectable.directive.mjs

@@ -11,7 +11,7 @@ import * as i0 from "@angular/core";
 import * as i1 from "../treelist.component";
 const defaultColumnKeyGetter = (_column, columnIndex) => columnIndex;
 /**
- * A directive which controls the selection state
+ * A directive which controls the selection state. [See example](slug:selection_treelist).
  */
 export class SelectableDirective {
     constructor(treelist) {

package/excel/excel-command.directive.d.ts

@@ -10,19 +10,18 @@ import * as i0 from "@angular/core";
 /**
  * Represents the `export-to-Excel` command of the TreeList. You can apply this
  * directive to any `button` element inside a
- * [`ToolbarTemplate`]({% slug api_treelist_commandcolumncomponent %}).
+ * [`ToolbarTemplate`](slug:toolbartemplate_treelist).
  * When the user clicks a button associated with the directive, the
  * [`excelExport`]({% slug api_treelist_treelistcomponent %}#toc-excelexport) event
  * fires ([see example]({% slug excelexport_treelist %})).
  *
  * @example
- * ```html-no-run
+ * ```html
  * <kendo-treelist>
- *      <ng-template kendoTreeListToolbarTemplate>
- *          <button kendoTreeListExcelCommand>Export to PDF</button>
- *      </ng-template>
- *      <kendo-treelist-excel fileName="TreeList.xlsx">
- *      </kendo-treelist-excel>
+ *   <ng-template kendoTreeListToolbarTemplate>
+ *     <button kendoTreeListExcelCommand>Export to PDF</button>
+ *   </ng-template>
+ *   <kendo-treelist-excel fileName="TreeList.xlsx"> </kendo-treelist-excel>
  * </kendo-treelist>
  * ```
  */

package/expand-state/expandable.directive.d.ts

@@ -6,7 +6,15 @@ import { OnDestroy, EventEmitter } from '@angular/core';
 import { ExpandableTreeComponent } from './expandable-tree-component';
 import * as i0 from "@angular/core";
 /**
- * A directive which controls the expanded state of the items.
+ * A directive which controls the expanded state of the items. [See example](slug:treelist_expanded_state#toc-built-in-directive).
+ *
+ * @example
+ * ```html
+ * <kendo-treelist ...
+ *   [kendoTreeListFlatBinding]="data"
+ *   kendoTreeListExpandable> ...
+ * </kendo-treelist>
+ * ```
  */
 export declare class ExpandableDirective implements OnDestroy {
     private component;