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

package/esm2022/events/zoom-event.mjs

@@ -4,11 +4,11 @@
 *-------------------------------------------------------------------------------------------*/
 import { PreventableEvent } from './preventable-event';
 /**
- * Arguments for the `zoom` event ([see example](slug:panzoom_chart_charts#toc-pan-and-zoom-events)).
+ * Represents the arguments for the `zoom` event of the Chart component ([see example](slug:panzoom_chart_charts#toc-pan-and-zoom-events)).
  */
 export class ZoomEvent extends PreventableEvent {
     /**
-     * A dictionary which contains the range (min and max values) of named axes.
+     * Specifies a dictionary which contains the range (min and max values) of named axes.
      * The axis name is used as a key.
      *
      * > The dictionary includes only the affected axis ranges.
@@ -16,13 +16,13 @@ export class ZoomEvent extends PreventableEvent {
      */
     axisRanges;
     /**
-     * A number that indicates the zoom amount and direction.
+     * Specifies a number that indicates the zoom amount and direction.
      * A negative value indicates a zoom-in action.
      * A positive value indicates a zoom-out action.
      */
     delta;
     /**
-     * The original user event that triggered the drag action.
+     * Specifies the original user event that triggered the drag action.
      */
     originalEvent;
     /**

package/esm2022/events/zoom-start-event.mjs

@@ -4,16 +4,16 @@
 *-------------------------------------------------------------------------------------------*/
 import { PreventableEvent } from './preventable-event';
 /**
- * Arguments for the `zoomStart` event ([see example](slug:panzoom_chart_charts#toc-pan-and-zoom-events)).
+ * Represents the arguments for the `zoomStart` event of the Chart component ([see example](slug:panzoom_chart_charts#toc-pan-and-zoom-events)).
  */
 export class ZoomStartEvent extends PreventableEvent {
     /**
-     * A dictionary which contains the range (min and max values) of named axes.
-     * The axis name is used as a key.
+     * Specifies a dictionary that contains the range of named axes.
+     * Use the axis name as a key to access the minimum and maximum values.
      */
     axisRanges;
     /**
-     * The original user event that triggered the drag action.
+     * Specifies the original user event that triggered the zoom action.
      */
     originalEvent;
     /**

package/esm2022/package-metadata.mjs

@@ -10,7 +10,7 @@ export const packageMetadata = {
     productName: 'Kendo UI for Angular',
     productCode: 'KENDOUIANGULAR',
     productCodes: ['KENDOUIANGULAR'],
-    publishDate: 1750157122,
-    version: '19.1.2-develop.4',
+    publishDate: 1750431031,
+    version: '19.1.2-develop.5',
     licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
 };

package/esm2022/sankey/data-binding/flat-binding.directive.mjs

@@ -11,28 +11,28 @@ import { SankeyFlatBindingDataBoundEvent } from "./flat-binding.event";
 import * as i0 from "@angular/core";
 import * as i1 from "../../sankey.component";
 /**
- * A directive which encapsulates the retrieval of the nodes and links when flat data is provided.
+ * Represents a directive that encapsulates the retrieval of the nodes and links when flat data is provided.
  *
  * See [Data Binding - Binding to Flat Data]({% slug data_binding_sankey %}#toc-binding-to-flat-data).
  */
 export class SankeyFlatBindingDirective {
     sankey;
     /**
-     * The data which will be displayed by the Sankey diagram.
+     * Specifies the data that the Sankey diagram displays.
      */
     data;
     /**
-     * Represents the fields which identify the nodes.
+     * Sets the fields that identify the nodes.
      */
     dimensionFields = [];
     /**
-     * Represents the unique field which represents the link value between nodes.
+     * Sets the unique field that represents the link value between nodes.
      */
     valueField;
     /**
      * Fires when the flat data has been converted to `SankeyData`.
      *
-     * To customize the created nodes and links, modify the data.
+     * Modify the data to customize the created nodes and links.
      */
     dataBound = new EventEmitter();
     constructor(sankey) {

package/esm2022/sankey/data-binding/flat-binding.event.mjs

@@ -3,17 +3,17 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Arguments for the `dataBound` event of the [`[kendoSankeyFlatBinding]`]({% slug api_charts_sankeyflatbindingdirective %}) directive.
+ * Represents the arguments for the `dataBound` event of the [`[kendoSankeyFlatBinding]`]({% slug api_charts_sankeyflatbindingdirective %}) directive.
  */
 export class SankeyFlatBindingDataBoundEvent {
     /**
-     * The original data passed to the directive.
+     * Stores the original data passed to the directive.
      */
     originalData;
     /**
-     * The newly created [`SankeyData`]({% slug api_charts_sankeydata %}).
+     * Contains the newly created [`SankeyData`]({% slug api_charts_sankeydata %}).
      *
-     * Changes to this object will be passed to the Sankey diagram.
+     * The Sankey diagram receives changes to this object.
      */
     data;
     /**

package/esm2022/sankey/events/sankey-base-event.mjs

@@ -8,11 +8,11 @@ import { PreventableEvent } from '@progress/kendo-angular-common';
  */
 export class SankeyBaseEvent extends PreventableEvent {
     /**
-     * The `SankeyComponent` that triggered the event.
+     * Stores the `SankeyComponent` that triggered the event.
      */
     sender;
     /**
-     * The original DOM event.
+     * Contains the original DOM event.
      */
     originalEvent;
     /**

package/esm2022/sankey/events/sankey-link-event.mjs

@@ -4,11 +4,11 @@
 *-------------------------------------------------------------------------------------------*/
 import { SankeyBaseEvent } from './sankey-base-event';
 /**
- * Arguments for the link-related events of the [`SankeyComponent`]({% slug api_charts_sankeycomponent %}).
+ * Represents the arguments for the link-related events of the [`SankeyComponent`]({% slug api_charts_sankeycomponent %}).
  */
 export class SankeyLinkEvent extends SankeyBaseEvent {
     /**
-     * The dataItem of the related element.
+     * Contains the `dataItem` of the related element.
      */
     dataItem;
     /**

package/esm2022/sankey/events/sankey-node-event.mjs

@@ -4,11 +4,11 @@
 *-------------------------------------------------------------------------------------------*/
 import { SankeyBaseEvent } from './sankey-base-event';
 /**
- * Arguments for the node-related events of the [`SankeyComponent`]({% slug api_charts_sankeycomponent %}).
+ * Represents the arguments for the node-related events of the [`SankeyComponent`]({% slug api_charts_sankeycomponent %}).
  */
 export class SankeyNodeEvent extends SankeyBaseEvent {
     /**
-     * The dataItem of the related element.
+     * Contains the `dataItem` of the related element.
      */
     dataItem;
     /**

package/esm2022/sankey/labels.component.mjs

@@ -8,7 +8,7 @@ import { SettingsComponent } from '../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../common/configuration.service";
 /**
- * The configuration options of the Sankey labels
+ * Represents the configuration options of the Sankey labels
  * ([see example](slug:customization_sankey#toc-customizing-the-sankey-diagram-elements)).
  */
 export class SankeyLabelsComponent extends SettingsComponent {

package/esm2022/sankey/legend.component.mjs

@@ -8,19 +8,19 @@ import { SettingsComponent } from '../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../common/configuration.service";
 /**
- * The configuration options of the Sankey legend
+ * Represents the configuration options of the Sankey legend
  * ([see example]({% slug legend_sankey %})).
  */
 export class SankeyLegendComponent extends SettingsComponent {
     configurationService;
     /**
-     * The legend is horizontally aligned when [`legend.position`]({% slug api_charts_sankeylegend %}#toc-position) is set to `"top"` or `"bottom"`.
-     * The legend is vertically aligned when [`legend.position`]({% slug api_charts_sankeylegend %}#toc-position) is set to `"left"` or `"right"`.
+     * Aligns the legend horizontally when [`legend.position`]({% slug api_charts_sankeylegend %}#toc-position) is set to `"top"` or `"bottom"`.
+     * Aligns the legend vertically when [`legend.position`]({% slug api_charts_sankeylegend %}#toc-position) is set to `"left"` or `"right"`.
      * @default 'center'
      */
     align;
     /**
-     * The background color of the legend. Accepts a valid CSS color string, including hex and rgb.
+     * Sets the background color of the legend. Accepts a valid CSS color string, including hex and rgb.
      * @default 'white'
      */
     background;
@@ -28,47 +28,47 @@ export class SankeyLegendComponent extends SettingsComponent {
     height;
     labels;
     /**
-     * The margin of the Sankey legend. A numeric value sets all paddings.
+     * Sets the margin of the Sankey legend. A numeric value sets all paddings.
      * @default 5
      */
     margin;
     /**
-     * The X offset of the Sankey legend. The offset is relative to the default position of the legend.
+     * Sets the X offset of the Sankey legend. The offset is relative to the default position of the legend.
      * For example, a value of `20` moves the legend 20 pixels to the right of its initial position.
      * Negative values move the legend to the left of its current position.
      * @default 0
      */
     offsetX;
     /**
-     * The Y offset of the Sankey legend. The offset is relative to the current position of the legend.
+     * Sets the Y offset of the Sankey legend. The offset is relative to the current position of the legend.
      * For example, a value of `20` moves the legend 20 pixels down from its initial position.
      * Negative values move the legend upwards from its current position.
      * @default 0
      */
     offsetY;
     /**
-     * The orientation of the legend items.
+     * Sets the orientation of the legend items.
      * @default 'vertical'
      */
     orientation;
     /**
-     * The padding of the Sankey legend. A numeric value sets all paddings.
+     * Sets the padding of the Sankey legend. A numeric value sets all paddings.
      * @default 5
      */
     padding;
     /**
-     * The position of the Sankey legend.
+     * Sets the position of the Sankey legend.
      * Setting the legend position to `custom` allows you to position the legend using the [`legend.offsetX`](slug:api_charts_sankeylegend#toc-offsetx) and [`legend.offsetY`](slug:api_charts_sankeylegend#toc-offsety) options.
      * @default 'right'
      */
     position;
     /**
-     * If set to `true`, the legend items are reversed.
+     * Determines if the legend items are reversed.
      * @default false
      */
     reverse;
     /**
-     * If set to `true`, the Sankey displays the legend. By default, the Sankey legend is visible.
+     * Determines if the Sankey displays the legend. By default, the Sankey legend is visible.
      * @default true
      */
     visible;

package/esm2022/sankey/links.component.mjs

@@ -8,7 +8,7 @@ import { SettingsComponent } from '../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../common/configuration.service";
 /**
- * The configuration options of the Sankey links
+ * Represents the configuration options of the Sankey links
  * ([see example](slug:customization_sankey#toc-customizing-the-sankey-diagram-elements)).
  */
 export class SankeyLinksComponent extends SettingsComponent {

package/esm2022/sankey/localization/custom-messages.component.mjs

@@ -8,7 +8,10 @@ import { Messages } from './messages';
 import * as i0 from "@angular/core";
 import * as i1 from "@progress/kendo-angular-l10n";
 /**
- * Custom component messages override default component messages.
+ * Represents the custom messages component of the Sankey.
+ *
+ * Use this component to override default messages for the Sankey.
+ *
  * @example
  * ```html
  * <kendo-sankey [data]="data">

package/esm2022/sankey/localization/messages.mjs

@@ -11,7 +11,7 @@ import * as i0 from "@angular/core";
  */
 export class Messages extends ComponentMessages {
     /**
-     * The format string to use when displaying node and link values in the tooltip.
+     * Sets the format string to use when displaying node and link values in the tooltip.
      */
     tooltipUnitFormat;
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: Messages, deps: null, target: i0.ɵɵFactoryTarget.Directive });

package/esm2022/sankey/nodes.component.mjs

@@ -8,17 +8,16 @@ import { SettingsComponent } from '../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../common/configuration.service";
 /**
- * The configuration options of the Sankey nodes
+ * Represents the configuration options of the Sankey nodes
  * ([see example](slug:customization_sankey#toc-customizing-the-sankey-diagram-elements)).
  */
 export class SankeyNodesComponent extends SettingsComponent {
     configurationService;
     /**
-     * The color type of the link.
-     * The supported values are:
-     * * `static`—The link color is static. The color is determined by the link's `color` option.
-     * * `source`—The link color is the same as the source node color.
-     * * `target`—The link color is the same as the target node color.
+     * Sets the color type of the link.
+     * Use `static` for static link color determined by the link's `color` option.
+     * Use `source` for link color that matches the source node color.
+     * Use `target` for link color that matches the target node color.
      *
      * @default 'static'
      */

package/esm2022/sankey/title.component.mjs

@@ -8,7 +8,7 @@ import { SettingsComponent } from '../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../common/configuration.service";
 /**
- * The configuration options of the Sankey title or text
+ * Represents the configuration options of the Sankey title or text
  * ([see example]({% slug title_sankey %})).
  *
  * @example
@@ -22,14 +22,14 @@ import * as i1 from "../common/configuration.service";
 export class SankeyTitleComponent extends SettingsComponent {
     configurationService;
     /**
-     * The alignment of the title.
-     * The alignment options for text include `center` for middle alignment, `left` for left alignment, and `right` for right alignment, allowing for flexible positioning of the title.
+     * Sets the alignment of the title.
+     * Use `center` for middle alignment, `left` for left alignment, or `right` for right alignment.
      *
      * @default 'center'
      */
     align;
     /**
-     * The background color of the title. Accepts a valid CSS color string, including HEX and RGB.
+     * Sets the background color of the title. Accepts a valid CSS color string, including HEX and RGB.
      *
      * @default 'white'
      */
@@ -37,21 +37,21 @@ export class SankeyTitleComponent extends SettingsComponent {
     border;
     color;
     /**
-     * The font of the title.
+     * Sets the font of the title.
      *
      * @default '16px sans-serif'
      */
     font;
     margin;
     /**
-     * The padding of the title. A numeric value sets all paddings.
+     * Sets the padding of the title. A numeric value sets all paddings.
      *
      * @default 5
      */
     padding;
     /**
-     * The position of the title.
-     * The positioning options for titles include `bottom` for positioning at the bottom and `top` for positioning at the top, providing flexibility in title placement.
+     * Sets the position of the title.
+     * Use `bottom` to place the title at the bottom or `top` to place it at the top.
      *
      * @default 'top'
      */
@@ -59,7 +59,7 @@ export class SankeyTitleComponent extends SettingsComponent {
     text;
     description;
     /**
-     * If set to `true`, the Sankey displays the title.
+     * Determines if the Sankey displays the title.
      *
      * @default true
      */

package/esm2022/sankey/tooltip/link-tooltip-template-context.mjs

@@ -3,19 +3,19 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The context that is passed to the Sankey diagram Link tooltip template.
+ * Represents the context that is passed to the Sankey diagram Link tooltip template.
  */
 export class SankeyLinkTooltipTemplateContext {
     /**
-     * The link source data item.
+     * Contains the link source data item.
      */
     source;
     /**
-     * The link target data item.
+     * Contains the link target data item.
      */
     target;
     /**
-     * The link value.
+     * Contains the link value.
      */
     value;
     /**

package/esm2022/sankey/tooltip/link-tooltip-template.directive.mjs

@@ -5,69 +5,24 @@
 import { Directive, TemplateRef, Optional } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * A directive that selects a [template](link:site.data.urls.angular['templatesyntax'])
+ * Selects a [template](link:site.data.urls.angular['templatesyntax'])
  * within the `<kendo-sankey-tooltip>` component for the
  * [links tooltip](slug:tooltip_sankey#toc-specifying-a-link-tooltip-template).
  * The following context fields are frequently utilized:
  * - `let-source="source"`&mdash;The link source data item..
  * - `let-target="target"`&mdash;The link target data item.
  * - `let-value="value"`&mdash;The link value.
- * For the full list of available fields, refer to the [`SankeyLinkTooltipTemplateContext`](slug:api_charts_sankeylinktooltiptemplatecontext).
+ * Refer to the [`SankeyLinkTooltipTemplateContext`](slug:api_charts_sankeylinktooltiptemplatecontext) for the full list of available fields.
  *
  * @example
- * ```ts
- * import { Component } from '@angular/core';
- *
- * _@Component({
- *   selector: 'my-app',
- *   template: `
- *     <kendo-chart>
- *       <kendo-chart-tooltip>
- *          <ng-template kendoChartSeriesTooltipTemplate let-value="value">
- *             Value is {{value}}
- *           </ng-template>
- *       </kendo-chart-tooltip>
- *       <kendo-chart-series>
- *         <kendo-chart-series-item [data]="[1, 2, 3]">
- *         </kendo-chart-series-item>
- *       </kendo-chart-series>
- *     </kendo-chart>
- *   `
- * })
- * class AppComponent {
- * }
- *
- * import { Component } from '@angular/core';
- * import { SankeyData } from '@progress/kendo-angular-charts';
- *
- * _@Component({
- *   selector: 'my-app',
- *   template: `
- *       <kendo-sankey [data]="data">
- *         <kendo-sankey-tooltip [followPointer]="true">
- *             <ng-template kendoSankeyLinkTooltipTemplate let-source="source" let-target="target" let-value="value">
- *                 {{ source.label?.text }} - {{ target.label?.text }}: {{ value }}
- *             </ng-template>
- *         </kendo-sankey-tooltip>
- *       </kendo-sankey>
- *   `,
- * })
- * export class AppComponent {
- *     public data: SankeyData = {
- *         nodes: [
- *           { id: 1, label: { text: 'Linux' } },
- *           { id: 0, label: { text: 'iOS'} },
- *           { id: 2, label: { text: 'Mobile' } },
- *           { id: 3, label: { text: 'Desktop' } },
- *         ],
- *         links: [
- *           { sourceId: 0, targetId: 2, value: 1 },
- *           { sourceId: 1, targetId: 2, value: 2 },
- *           { sourceId: 1, targetId: 3, value: 3 },
- *         ],
- *     };
- * }
- *
+ * ```html
+ * <kendo-sankey [data]="data">
+ *    <kendo-sankey-tooltip [followPointer]="true">
+ *        <ng-template kendoSankeyLinkTooltipTemplate let-source="source" let-target="target" let-value="value">
+ *            {{ source.label?.text }} - {{ target.label?.text }}: {{ value }}
+ *        </ng-template>
+ *    </kendo-sankey-tooltip>
+ * </kendo-sankey>
  * ```
  */
 export class SankeyLinkTooltipTemplateDirective {

package/esm2022/sankey/tooltip/node-tooltip-template-context.mjs

@@ -3,19 +3,19 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The context that is passed to the Sankey diagram Node tooltip template.
+ * Represents the context that is passed to the Sankey diagram Node tooltip template.
  */
 export class SankeyNodeTooltipTemplateContext {
     /**
-     * The node color.
+     * Contains the node color.
      */
     color;
     /**
-     * The node label data.
+     * Contains the node label data.
      */
     label;
     /**
-     * The node value.
+     * Contains the node value.
      */
     value;
     /**

package/esm2022/sankey/tooltip/node-tooltip-template.directive.mjs

@@ -5,14 +5,14 @@
 import { Directive, TemplateRef, Optional } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * A directive that selects a [template](link:site.data.urls.angular['templatesyntax'])
+ * Selects a [template](link:site.data.urls.angular['templatesyntax'])
  * within the `<kendo-sankey-tooltip>` component for the
  * [series tooltip](slug:tooltip_sankey#toc-specifying-a-node-tooltip-template).
  * The following context fields are frequently utilized:
  * - `let-color="color"`&mdash;The node color.
  * - `let-label="label"`&mdash;The node label data.
  * - `let-value="value"`&mdash;The node value.
- * For the full list of available fields, refer to the [`SankeyNodeTooltipTemplateContext`](slug:api_charts_sankeynodetooltiptemplatecontext).
+ * Refer to the [`SankeyNodeTooltipTemplateContext`](slug:api_charts_sankeynodetooltiptemplatecontext) for the full list of available fields.
  *
  * @example
  * ```ts

package/esm2022/sankey/tooltip.component.mjs

@@ -12,32 +12,32 @@ import * as i0 from "@angular/core";
 import * as i1 from "../common/configuration.service";
 import * as i2 from "./tooltip/tooltip-template.service";
 /**
- * The configuration options of the Sankey tooltip
+ * Represents the Sankey tooltip
  * ([see example]({% slug tooltip_sankey %})).
  */
 export class SankeyTooltipComponent extends SettingsComponent {
     configurationService;
     templateService;
     /**
-     * Indicates whether the tooltip will follow the mouse pointer.
+     * Determines if the tooltip follows the mouse pointer.
      *
      * @default false
      */
     followPointer;
     /**
-     * Represents the delay of the tooltip displaying.
+     * Sets the delay of the tooltip displaying.
      * The delay is measured in milliseconds.
      *
      * @default 100
      */
     delay;
     /**
-     * The distance between the tooltip and the mouse pointer in pixels.
+     * Sets the distance between the tooltip and the mouse pointer in pixels.
      * @default 12
      */
     offset;
     /**
-     * If set to `true`, the Sankey displays the link and node tooltips.
+     * Determines if the Sankey displays the link and node tooltips.
      * @default false
      */
     visible;