@progress/kendo-angular-gantt 19.1.2-develop.4 → 19.1.2-develop.5

package/template-directives/task-tooltip-template.directive.d.ts

@@ -5,11 +5,10 @@
 import { TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents a template that defines the whole content of the Task tooltip.
- * To define the template, nest an `<ng-template>` tag
- * with the `kendoGanttTaskTooltipTemplate` directive inside the `<kendo-gantt>` tag.
+ * Defines a template for the entire Task tooltip.
+ * Place an `<ng-template>` tag with the `kendoGanttTaskTooltipTemplate` directive inside the `<kendo-gantt>` tag to set the template.
  *
- * The template context is set to the respective data item.
+ * The template context uses the related data item.
  *
  * @example
  * ```ts-preview

package/timeline/timeline-day-view.component.d.ts

@@ -8,11 +8,16 @@ import { ViewBase } from './view-base';
 import { OptionChangesService } from '../common/option-changes.service';
 import * as i0 from "@angular/core";
 /**
- * The Gantt timeline day view component.
+ * Represents the Gantt timeline day view component.
+ *
+ * @example
+ * ```html
+ * <kendo-gantt-timeline-day-view></kendo-gantt-timeline-day-view>
+ * ```
  */
 export declare class TimelineDayViewComponent extends ViewBase {
     /**
-     * The type for this view (`day`).
+     * Specifies the type for this view (`day`).
      */
     readonly type: TimelineViewType;
     constructor(optionChangesService: OptionChangesService, dependencyDomService: DependencyDomService);

package/timeline/timeline-month-view.component.d.ts

@@ -8,11 +8,16 @@ import { ViewBase } from './view-base';
 import { OptionChangesService } from '../common/option-changes.service';
 import * as i0 from "@angular/core";
 /**
- * The Gantt timeline month view component.
+ * Represents the Gantt timeline month view component.
+ *
+ * @example
+ * ```html
+ * <kendo-gantt-timeline-month-view></kendo-gantt-timeline-month-view>
+ * ```
  */
 export declare class TimelineMonthViewComponent extends ViewBase {
     /**
-     * The type for this view (`month`).
+     * Specifies the type for this view (`month`).
      */
     readonly type: TimelineViewType;
     constructor(optionChangesService: OptionChangesService, dependencyDomService: DependencyDomService);

package/timeline/timeline-week-view.component.d.ts

@@ -8,11 +8,16 @@ import { ViewBase } from './view-base';
 import { OptionChangesService } from '../common/option-changes.service';
 import * as i0 from "@angular/core";
 /**
- * The Gantt timeline week view component.
+ * Represents the Gantt timeline week view component.
+ *
+ * @example
+ * ```html
+ * <kendo-gantt-timeline-week-view></kendo-gantt-timeline-week-view>
+ * ```
  */
 export declare class TimelineWeekViewComponent extends ViewBase {
     /**
-     * The type for this view (`week`).
+     * Specifies the type for this view (`week`).
      */
     readonly type: TimelineViewType;
     constructor(optionChangesService: OptionChangesService, dependencyDomService: DependencyDomService);

package/timeline/timeline-year-view.component.d.ts

@@ -8,11 +8,16 @@ import { ViewBase } from './view-base';
 import { OptionChangesService } from '../common/option-changes.service';
 import * as i0 from "@angular/core";
 /**
- * The Gantt timeline year view component.
+ * Represents the Gantt timeline year view component.
+ *
+ * @example
+ * ```html
+ * <kendo-gantt-timeline-year-view></kendo-gantt-timeline-year-view>
+ * ```
  */
 export declare class TimelineYearViewComponent extends ViewBase {
     /**
-     * The type for this view (`year`).
+     * Specifies the type for this view (`year`).
      */
     readonly type: TimelineViewType;
     constructor(optionChangesService: OptionChangesService, dependencyDomService: DependencyDomService);

package/timeline/view-base.d.ts

@@ -10,13 +10,20 @@ import { TimelineHeaderDateFormat } from '../models/timeline-header-date-format'
 import { CurrentTimeSettings } from '../models/current-time-settings.interface';
 import * as i0 from "@angular/core";
 /**
- * The base class for the timeline view components of the Gantt.
+ * Serves as the base class for the timeline view components of the Gantt.
+ *
+ * @example
+ * ```typescript
+ * export class CustomTimelineViewComponent extends ViewBase {
+ *   public readonly type: TimelineViewType = 'custom';
+ * }
+ * ```
  */
 export declare abstract class ViewBase implements OnChanges {
     private optionChangesService;
     private dependencyDomService;
     /**
-     * The width of the time slot headers. Values are treated as pixels.
+     * Sets the width of the time slot headers in pixels.
      *
      * @default 100
      */
@@ -27,13 +34,12 @@ export declare abstract class ViewBase implements OnChanges {
     timelineHeadersDateFormat: TimelineHeaderDateFormat;
     /**
      * Specifies the current time marker settings.
-     * If not set, the value is taken from the Gantt component
+     * If you do not set a value, the component uses the value from the Gantt component
      * [`currentTimeMarker`]({% slug api_gantt_ganttcomponent %}#toc-currentTimeMarker) property.
-     *
      */
     currentTimeMarker: boolean | CurrentTimeSettings;
     /**
-     * The type for the view (`day`, `week`, `month` or `year`).
+     * Specifies the type for the view (`day`, `week`, `month`, or `year`).
      */
     abstract type: TimelineViewType;
     /**

package/toolbar/toolbar-template.directive.d.ts

@@ -8,101 +8,28 @@ import * as i0 from "@angular/core";
 /**
  * Represents the toolbar template of the Gantt.
  *
- * The template context has the following field:
- * - `position`—The position at which the toolbar template is rendered. The possible values are `'top'` and `'bottom'`.
+ * The template context includes:
+ * - `position`—The position where the toolbar template renders. Possible values are `'top'` and `'bottom'`.
  *
  * @example
- * ```ts-preview
- *
- * _@Component({
- *     selector: 'my-app',
- *     template: `
- *       <div class="example-config">
- *         <input type="radio" kendoRadioButton id="top" name="position" value="top" checked (click)="positionChange($event)"/>
- *         <kendo-label class="k-radio-label" for="top">Top</kendo-label><br/>
- *         <input type="radio" kendoRadioButton id="bottom" name="position" value="bottom" (click)="positionChange($event)"/>
- *         <kendo-label class="k-radio-label" for="bottom">Bottom</kendo-label><br/>
- *         <input type="radio" kendoRadioButton id="both" name="position" value="both" (click)="positionChange($event)"/>
- *         <kendo-label class="k-radio-label" for="both">Both</kendo-label><br/>
- *       </div>
- *       <kendo-gantt [[kendoGanttHierarchyBinding]="data"]="data" [style.height.px]="400">
- *            <ng-template kendoGanttToolbarTemplate [position]="position" let-position="position">
- *                <button kendoButton (click)="onClick()">Custom action</button>
- *            </ng-template>
- *        </kendo-gantt>
- *     `
- * })
- *
- * class AppComponent {
- *     public position: 'top' | 'bottom' | 'both' = 'top';
- *
- *     public data = [{
- *       id: 7,
- *       title: "Software validation, research and implementation",
- *       orderId: 0,
- *       start: new Date("2014-06-02T00:00:00.000Z"),
- *       end: new Date("2014-07-12T00:00:00.000Z"),
- *       completionRatio: 0.45708333333333334,
- *       isExpanded: true,
- *       children: [{
- *               id: 11,
- *               title: "Research",
- *               orderId: 1,
- *               start: new Date("2014-06-02T00:00:00.000Z"),
- *               end: new Date("2014-06-07T00:00:00.000Z"),
- *               completionRatio: 0.5766666666666667,
- *               isExpanded: true,
- *               children: [{
- *                       id: 19,
- *                       title: "Validation with Customers",
- *                       orderId: 0,
- *                       start: new Date("2014-06-02T00:00:00.000Z"),
- *                       end: new Date("2014-06-04T00:00:00.000Z"),
- *                       completionRatio: 0.25,
- *                       isExpanded: true
- *                   },
- *                   {
- *                       id: 20,
- *                       title: "Market Research",
- *                       orderId: 1,
- *                       start: new Date("2014-06-02T00:00:00.000Z"),
- *                       end: new Date("2014-06-03T02:00:00.000Z"),
- *                       completionRatio: 0.82,
- *                       isExpanded: true
- *                   },
- *                   {
- *                       id: 39,
- *                       title: "Functional and Technical Specification",
- *                       orderId: 2,
- *                       start: new Date("2014-06-04T00:00:00.000Z"),
- *                       end: new Date("2014-06-07T00:00:00.000Z"),
- *                       completionRatio: 0.66,
- *                       isExpanded: true
- *                   }]
- *           }]
- *       };
- *
- *     public positionChange(event: MouseEvent): void {
- *        this.position = event.target['defaultValue'];
- *     }
- *
- *     public onClick(): void {
- *         console.log("button was clicked");
- *     }
- * }
- *
+ * ```html
+ * <kendo-gantt [kendoGanttHierarchyBinding]="data" [style.height.px]="400">
+ *  <ng-template kendoGanttToolbarTemplate [position]="position" let-position="position">
+ *    <button kendoButton (click)="onClick()">Custom action</button>
+ *  </ng-template>
+ * </kendo-gantt>
  * ```
  */
 export declare class ToolbarTemplateDirective {
     templateRef: TemplateRef<any>;
     _position: ToolbarPosition;
     /**
-     * Defines the Gantt Toolbar that will use this template.
+     * Sets the Gantt Toolbar that uses this template.
      *
-     * The possible values are:
-     * - `top`&mdash;The template will be rendered in the top toolbar (if present) only.
-     * - `bottom`&mdash;The template will be rendered in the bottom toolbar (if present) only.
-     * - `both`&mdash;The template will be rendered in both toolbars (if present).
+     * Possible values:
+     * - `top`&mdash;Renders the template in the top toolbar (if present) only.
+     * - `bottom`&mdash;Renders the template in the bottom toolbar (if present) only.
+     * - `both`&mdash;Renders the template in both toolbars (if present).
      */
     set position(position: ToolbarPosition);
     get position(): ToolbarPosition;

package/toolbar/view-selector.component.d.ts

@@ -7,22 +7,22 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
 import { TimelineViewType } from './../models/timeline-view';
 import * as i0 from "@angular/core";
 /**
- * The Gantt ViewSelector component. Shows the currently active view type, and allows switching to another view type.
+ * The Gantt ViewSelector component. Shows the current view type and lets you switch to another view type.
  */
 export declare class ViewSelectorComponent {
     private localizationService;
     hostClass: boolean;
     /**
-     * The collection of the timeline view types in the current Gantt configuration.
+     * Lists the timeline view types in the current Gantt configuration.
      */
     views: TimelineViewType[];
     /**
-     * The currently active view type.
+     * Sets the current view type.
      * @default 'week'
      */
     activeView: TimelineViewType;
     /**
-     * Fires each time the user selects a different view type. The event data contains the type of the newly selected view.
+     * Fires when the user selects a different view type. The event data contains the type of the new view.
      */
     activeViewChange: EventEmitter<TimelineViewType>;
     constructor(localizationService: LocalizationService);