@progress/kendo-angular-charts 7.0.0 → 7.1.0-dev.202204261149

package/option-types/series-defaults/labels.to.interface.d.ts

@@ -2,7 +2,7 @@
 * Copyright © 2021 Progress Software Corporation. All rights reserved.
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
-import { Border, Margin, Padding } from '../../common/property-types';
+import { Border, Margin, Padding, SeriesLabelsContentArgs } from '../../common/property-types';
 /**
  * The configuration options of the Chart series `to` labels.
  */
@@ -22,21 +22,8 @@ export interface SeriesDefaultsLabelsTo {
     /**
      * The function which returns the `from` label content of the Chart series.
      * You can split the text into multiple lines by using the line feed characters (`"\n"`).
-     *
-     * The available fields in the function argument are:
-     *
-     * - `category`—The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Line, and Pie
-     * series.
-     * - `dataItem`—The original data item used to construct the point. If binding to an array, it will be `null`.
-     * - `percentage`—The point value represented as a percentage value. Available for the Donut, Funnel, and
-     * Pie series.
-     * - `series`—The data series.
-     * - `value`—The point value. Can be a number or object containing each bound field.
-     * - `runningTotal`—The sum of point values since the last `"runningTotal"` summary point. Available for
-     * the Waterfall series.
-     * - `total`—The sum of all previous series values. Available for the Waterfall series.
-     */
-    content?: (e: any) => string;
+     */
+    content?: (e: SeriesLabelsContentArgs) => string;
     /**
      * The font style of the `to` labels.
      */

package/option-types/series-defaults/notes.label.interface.d.ts

@@ -2,7 +2,7 @@
 * Copyright © 2021 Progress Software Corporation. All rights reserved.
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
-import { Border, NoteLabelPosition } from '../../common/property-types';
+import { Border, NoteLabelPosition, SeriesNoteContentArgs } from '../../common/property-types';
 /**
  * The configuration options of the series notes label.
  */
@@ -21,10 +21,9 @@ export interface SeriesDefaultsNotesLabel {
     color?: string;
     /**
      * The function which returns the label content.
-     * The function argument contains a `value` field which defines the point value.
      * You can split the text into multiple lines by using line feed characters (`"\n"`).
      */
-    content?: (e: any) => string;
+    content?: (e: SeriesNoteContentArgs) => string;
     /**
      * The font style of the label.
      */

package/option-types/series-item/labels.from.interface.d.ts

@@ -2,7 +2,7 @@
 * Copyright © 2021 Progress Software Corporation. All rights reserved.
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
-import { Border, Margin, Padding } from '../../common/property-types';
+import { Border, Margin, Padding, SeriesLabelsContentArgs } from '../../common/property-types';
 /**
  * The configuration options of the series `from` labels.
  */
@@ -20,24 +20,10 @@ export interface SeriesLabelsFrom {
      */
     color?: string;
     /**
-     * The function which returns the Chart series `from` label content.
-     *
-     * The fields available in the function argument are:
-     *
-     * - `category`—The category name. Available for the Area, Bar, Column, Bubble, Donut, Line, Pie, and
-     * Waterfall series.
-     * - `dataItem`—The original data item used to construct the point. If binding to an array, it will be `null`.
-     * - `percentage`—The point value represented as a percentage value. Available only for the Donut, Pie, and
-     * 100% stacked charts.
-     * - `series`—The data series.
-     * - `value`—The point value. Can be a number or object containing each bound field.
-     * - `runningTotal`—The sum of point values since the last `"runningTotal"` summary point. Available for
-     * the Waterfall series.
-     * - `total`—The sum of all previous series values. Available for the Waterfall series.
-     *
+     * The function which returns the Chart series `from` label content.   *
      * The text can be split into multiple lines by using the line feed characters (`"\n"`).
      */
-    content?: (e: any) => string;
+    content?: (e: SeriesLabelsContentArgs) => string;
     /**
      * The font style of the `from` labels.
      */

package/option-types/series-item/labels.interface.d.ts

@@ -3,6 +3,7 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 import { drawing } from '@progress/kendo-drawing';
+import { SeriesLabelsContentArgs } from '../../common/property-types';
 import { Border, Margin, Padding, SeriesLabelsVisualArgs } from '../../common/property-types';
 import { SeriesLabelsPosition } from '../../common/property-types';
 import { SeriesLabelsFrom } from './labels.from.interface';
@@ -43,22 +44,8 @@ export interface SeriesLabels {
     /**
      * The function which returns the Chart series label content.
      * You can split the text into multiple lines by using line feed characters (`"\n"`).
-     *
-     * The fields available in the function argument are:
-     *
-     * - `category`—The category name. Available for the Area, Bar, Column, Bubble, Donut, Line, Pie, and
-     * Waterfall series.
-     * - `dataItem`—The original data item used to construct the point. If binding to an array, it will be `null`.
-     * - `percentage`—The point value represented as a percentage value. Available only for the Donut, Pie, and
-     * 100% stacked charts.
-     * - `series`—The data series.
-     * - `stackValue`—The cumulative point value on the stack. Available only for the stackable series.
-     * - `value`—The point value. Can be a number or object containing each bound field.
-     * - `runningTotal`—The sum of point values since the last `"runningTotal"` summary point. Available for
-     * the Waterfall series.
-     * - `total`—The sum of all previous series values. Available for the Waterfall series.
-     */
-    content?: (e: any) => string;
+     */
+    content?: (e: SeriesLabelsContentArgs) => string;
     /**
      * The distance between the labels when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"donut"` or `"pie"`.
      */

package/option-types/series-item/labels.to.interface.d.ts

@@ -2,7 +2,7 @@
 * Copyright © 2021 Progress Software Corporation. All rights reserved.
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
-import { Border, Margin, Padding } from '../../common/property-types';
+import { Border, Margin, Padding, SeriesLabelsContentArgs } from '../../common/property-types';
 /**
  * The configuration options of the series `to` labels.
  */
@@ -22,21 +22,8 @@ export interface SeriesLabelsTo {
     /**
      * The function which returns the Chart series `to` label content.
      * You can split the text into multiple lines by using line feed characters (`"\n"`).
-     *
-     * The fields available in the function argument are:
-     *
-     * - `category`—The category name. Available for the Area, Bar, Column, Bubble, Donut, Line, Pie, and
-     * Waterfall series.
-     * - `dataItem`—The original data item used to construct the point. If binding to an array, it will be `null`.
-     * - `percentage`—The point value represented as a percentage value. Available only for the Donut, Pie, and
-     * 100% stacked charts.
-     * - `series`—The data series.
-     * - `value`—The point value. Can be a number or object containing each bound field.
-     * - `runningTotal`—The sum of point values since the last `"runningTotal"` summary point. Available for
-     * the Waterfall series.
-     * - `total`—The sum of all previous series values. Available for the Waterfall series.
      */
-    content?: (e: any) => string;
+    content?: (e: SeriesLabelsContentArgs) => string;
     /**
      * The font style of the `to` labels.
      */

package/option-types/series-item/notes.label.interface.d.ts

@@ -2,7 +2,7 @@
 * Copyright © 2021 Progress Software Corporation. All rights reserved.
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
-import { Border, NoteLabelPosition } from '../../common/property-types';
+import { Border, NoteLabelPosition, SeriesNoteContentArgs } from '../../common/property-types';
 /**
  * The configuration options of the series notes label.
  */
@@ -21,10 +21,9 @@ export interface SeriesNotesLabel {
     color?: string;
     /**
      * The function which returns the label content.
-     * The function argument contains a `value` field which defines the point value.
      * You can split the text into multiple lines by using line feed characters (`"\n"`).
      */
-    content?: (e: any) => string;
+    content?: (e: SeriesNoteContentArgs) => string;
     /**
      * The font style of the label.
      */

package/option-types/value-axis-item/labels.interface.d.ts

@@ -3,7 +3,7 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 import { drawing } from '@progress/kendo-drawing';
-import { AxisLabelsPosition, AxisLabelVisualArgs, Border, LabelRotation, Margin } from '../../common/property-types';
+import { AxisLabelContentArgs, AxisLabelsPosition, AxisLabelVisualArgs, Border, LabelRotation, Margin } from '../../common/property-types';
 import { Padding } from '../../common/property-types';
 /**
  * The configuration options of the value axis labels.
@@ -33,7 +33,7 @@ export interface ValueAxisLabels {
      * - `index`—The index of the label.
      * - `count`—The total number of rendered labels.
      */
-    content?: (e: any) => string;
+    content?: (e: AxisLabelContentArgs) => string;
     /**
      * The font style of the labels.
      */

package/option-types/value-axis-item/notes.label.interface.d.ts

@@ -2,7 +2,7 @@
 * Copyright © 2021 Progress Software Corporation. All rights reserved.
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
-import { Border, NoteLabelPosition } from '../../common/property-types';
+import { AxisNoteContentArgs, Border, NoteLabelPosition } from '../../common/property-types';
 /**
  * The configuration options of the value axis notes label.
  */
@@ -21,10 +21,9 @@ export interface ValueAxisNotesLabel {
     color?: string;
     /**
      * The function which returns the label content.
-     * The function argument contains a `value` field. It defines the axis value.
      * You can split the text into multiple lines by using the line feed characters (`"\n"`).
      */
-    content?: (e: any) => string;
+    content?: (e: AxisNoteContentArgs) => string;
     /**
      * The font style of the label.
      */

package/option-types/x-axis-item/labels.interface.d.ts

@@ -3,7 +3,7 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 import { drawing } from '@progress/kendo-drawing';
-import { AxisLabelsPosition, AxisLabelVisualArgs, Border, DateFormats, LabelRotation } from '../../common/property-types';
+import { AxisLabelContentArgs, AxisLabelsPosition, AxisLabelVisualArgs, Border, DateFormats, LabelRotation } from '../../common/property-types';
 import { Margin, Padding } from '../../common/property-types';
 /**
  * The configuration of the X-axis labels.
@@ -24,15 +24,8 @@ export interface XAxisLabels {
     /**
      * The function which returns the label content.
      * You can split the text into multiple lines by using the line feed characters (`"\n"`).
-     *
-     * The available fields in the function argument are:
-     * - `value`—The category value.
-     * - `format`—The default format of the label.
-     * - `text`—The default label text.
-     * - `index`—The index of the label.
-     * - `count`—The total number of rendered labels.
      */
-    content?: (e: any) => string;
+    content?: (e: AxisLabelContentArgs) => string;
     /**
      * The culture to use when formatting date values.
      * The specified culture must be loaded as demonstrated in the [Internationalization Overview]({% slug overview_intl %}).

package/option-types/x-axis-item/notes.label.interface.d.ts

@@ -2,7 +2,7 @@
 * Copyright © 2021 Progress Software Corporation. All rights reserved.
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
-import { Border, NoteLabelPosition } from '../../common/property-types';
+import { AxisNoteContentArgs, Border, NoteLabelPosition } from '../../common/property-types';
 /**
  * The configuration options of the X-axis notes label.
  */
@@ -24,7 +24,7 @@ export interface XAxisNotesLabel {
      * The function argument contains a `value` field. It defines the axis value.
      * You can split the text into multiple lines by using the line feed characters (`"\n"`).
      */
-    content?: (e: any) => string;
+    content?: (e: AxisNoteContentArgs) => string;
     /**
      * The font style of the label.
      */

package/option-types/y-axis-item/labels.interface.d.ts

@@ -3,7 +3,7 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 import { drawing } from '@progress/kendo-drawing';
-import { AxisLabelsPosition, AxisLabelVisualArgs, Border, DateFormats, LabelRotation } from '../../common/property-types';
+import { AxisLabelContentArgs, AxisLabelsPosition, AxisLabelVisualArgs, Border, DateFormats, LabelRotation } from '../../common/property-types';
 import { Margin, Padding } from '../../common/property-types';
 /**
  * The yAxis.labels options.
@@ -24,15 +24,8 @@ export interface YAxisLabels {
     /**
      * The function which returns the label content.
      * You can split the text into multiple lines by using the line feed characters (`"\n"`).
-     *
-     * The available fields in the function argument are:
-     * - `value`—The category value.
-     * - `format`—The default format of the label.
-     * - `text`—The default label text.
-     * - `index`—The index of the label.
-     * - `count`—The total number of rendered labels.
      */
-    content?: (e: any) => string;
+    content?: (e: AxisLabelContentArgs) => string;
     /**
      * The culture to use when formatting date values.
      * The specified culture must be loaded as demonstrated in the [Internationalization Overview]({% slug overview_intl %}).

package/option-types/y-axis-item/notes.label.interface.d.ts

@@ -2,7 +2,7 @@
 * Copyright © 2021 Progress Software Corporation. All rights reserved.
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
-import { Border, NoteLabelPosition } from '../../common/property-types';
+import { AxisNoteContentArgs, Border, NoteLabelPosition } from '../../common/property-types';
 /**
  * The configuration options of the Y-axis notes label.
  */
@@ -21,10 +21,9 @@ export interface YAxisNotesLabel {
     color?: string;
     /**
      * The function which returns the label content.
-     * The function argument contains a `value` field. It defines the axis value.
      * You can split the text into multiple lines by using the line feed characters (`"\n"`).
      */
-    content?: (e: any) => string;
+    content?: (e: AxisNoteContentArgs) => string;
     /**
      * The font style of the label.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@progress/kendo-angular-charts",
-  "version": "7.0.0",
+  "version": "7.1.0-dev.202204261149",
   "description": "Kendo UI Charts for Angular",
   "license": "SEE LICENSE IN LICENSE.md",
   "author": "Progress",

package/stock-chart/navigator/hint.component.d.ts

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { ConfigurationService } from '../../common/configuration.service';
 import { SettingsComponent } from '../../common/settings.component';
-import { NavigatorHint } from '../option-types';
+import { NavigatorHint, NavigatorHintContentArgs } from '../option-types';
 import * as i0 from "@angular/core";
 /**
  * The default options of the navigator hint
@@ -12,7 +12,7 @@ import * as i0 from "@angular/core";
  */
 export declare class NavigatorHintComponent extends SettingsComponent implements NavigatorHint {
     configurationService: ConfigurationService;
-    content: (e: any) => string;
+    content: (e: NavigatorHintContentArgs) => string;
     format: string;
     visible: boolean;
     constructor(configurationService: ConfigurationService);

package/stock-chart/option-types/navigator/hint-content-args.interface.d.ts

@@ -0,0 +1,17 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * The navigator hint content function arguments.
+ */
+export interface NavigatorHintContentArgs {
+    /**
+     * The lower boundary of the selected range.
+     */
+    from?: Date;
+    /**
+     * The upper boundary of the selected range.
+     */
+    to?: Date;
+}

package/stock-chart/option-types/navigator/hint.interface.d.ts

@@ -2,6 +2,7 @@
 * Copyright © 2021 Progress Software Corporation. All rights reserved.
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
+import { NavigatorHintContentArgs } from './hint-content-args.interface';
 /**
  * The `navigator.hint` options.
  */
@@ -14,7 +15,7 @@ export interface NavigatorHint {
      * - `from`—The lower boundary of the selected range.
      * - `to`—The upper boundary of the selected range.
      */
-    content?: (e: any) => string;
+    content?: (e: NavigatorHintContentArgs) => string;
     /**
      * The format of the hint.
      */

package/stock-chart/option-types.d.ts

@@ -4,4 +4,5 @@
 *-------------------------------------------------------------------------------------------*/
 export { Navigator } from './option-types/navigator.interface';
 export { NavigatorHint } from './option-types/navigator/hint.interface';
+export { NavigatorHintContentArgs } from './option-types/navigator/hint-content-args.interface';
 export { NavigatorSelect } from './option-types/navigator/select.interface';