@progress/kendo-react-charts 7.0.3-develop.9 → 7.1.0-develop.10

package/option-types/legend/item.interface.d.ts

@@ -3,15 +3,40 @@
 * Licensed under commercial license. See LICENSE.md in the package root for more information
 *-------------------------------------------------------------------------------------------*/
 import { drawing } from '@progress/kendo-drawing';
-import { LegendItemVisualArgs } from '../../common/property-types';
+import { Border, DashType, LegendItemVisualArgs } from '../../common/property-types';
+import { SeriesMarkers } from './../series-item/markers.interface';
 /**
- * @hidden
+ * The configuration of the Chart legend item.
  */
 export interface LegendItem {
     /**
      * The cursor style of the legend item.
      */
     cursor?: string;
+    /**
+     * Sets the type of the legend item.
+     * The default value is based on the series type.
+     */
+    type?: LegendItemType;
+    /**
+     * Sets the configuration of the legend items of type `line`.
+     * This is the default legend item type for all line and scatter series.
+     */
+    line?: LegendItemLine;
+    /**
+     * Sets the configuration of the legend items of type `area`.
+     * By default, all series except line and scatter use this legend type.
+     */
+    area?: LegendItemArea;
+    /**
+     * The markers configuration of the legend item.
+     * Defaults to the series options.
+     */
+    markers?: LegendItemMarkers;
+    /**
+     * The highlight configuration of the legend item.
+     */
+    highlight?: LegendItemHighlight;
     /**
      * A function for creating a custom visual for the legend items.
      *
@@ -23,3 +48,74 @@ export interface LegendItem {
      */
     visual?: (e: LegendItemVisualArgs) => drawing.Element;
 }
+/**
+ * The configuration of the Chart legend item markers border.
+ */
+export interface LegendItemMarkersBorder extends Omit<Border, 'width'> {
+}
+/**
+ * The configuration of the Chart legend item markers.
+ */
+export interface LegendItemMarkers extends Omit<SeriesMarkers, 'size' | 'border' | 'rotation' | 'from' | 'to'> {
+    /**
+     * The border of the markers.
+     */
+    border?: LegendItemMarkersBorder;
+}
+/**
+ * The configuration of the Chart legend item highlight state.
+ */
+export interface LegendItemHighlight {
+    /**
+     * If set to `false`, the hover effect of the legend item is disabled.
+     */
+    visible?: boolean;
+    /**
+     * The `markers` configuration of the legend item when it is hovered.
+     */
+    markers?: LegendItemMarkers;
+}
+/**
+ * The configuration of the Chart legend item of type `line`.
+ * Defaults to the series options.
+ */
+export interface LegendItemLine {
+    /**
+     * The color of the legend item. Accepts a valid CSS color string, including HEX and RGB.
+     * Defaults to the series color.
+     */
+    color?: string;
+    /**
+     * The opacity of the legend item.
+     * Defaults to the series opacity.
+     */
+    opacity?: number;
+    /**
+     * The dash type of the legend item.
+     * Defaults to the series dash type.
+     */
+    dashType?: DashType;
+}
+/**
+ * The configuration of the Chart legend items of type `area`.
+ * Defaults to the series options.
+ */
+export interface LegendItemArea {
+    /**
+     * The background color of the legend item. Accepts a valid CSS color string, including HEX and RGB.
+     * Defaults to the series color.
+     */
+    background?: string;
+    /**
+     * The opacity of the legend item.
+     * Defaults to the series opacity.
+     */
+    opacity?: number;
+}
+/**
+ * The type of the Chart legend item.
+ *
+ * - `"line"`&mdash;the legend items are rendered as a line. This is the default value for line charts.
+ * - `"area"`&mdash;the legend items are rendered as a filled rectangle. This is the default value for area charts.
+ */
+export type LegendItemType = 'line' | 'area';

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

@@ -19,4 +19,16 @@ export interface SeriesTrendline {
      * The period setting is supported only for Moving Average trendlines.
      */
     period?: number;
+    /**
+     * The order (degree) of the Polynomial trendline. The default value is 2.
+     *
+     * Accepted values are from 2 to 6:
+     * * 2: a Quadratic polynomial trendline with a single extreme point (minimum or maximum) point.
+     * * 3: a Cubic polynomial trendline with up to 2 extreme points.
+     * * 4: a polynomial trendline of 4th degree with up to 3 extreme points.
+     * * 5: a polynomial trendline of 5th degree with up to 4 extreme points.
+     * * 6: a polynomial trendline of 6th degree with up to 5 extreme points.
+     *
+     */
+    order?: number;
 }

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

@@ -3,7 +3,7 @@
 * Licensed under commercial license. See LICENSE.md in the package root for more information
 *-------------------------------------------------------------------------------------------*/
 import { drawing } from '@progress/kendo-drawing';
-import { Border, BulletTarget, DashType, LabelConnectors, SeriesTrendline } from '../common/property-types';
+import { Border, BulletTarget, DashType, LabelConnectors, LegendItem, SeriesTrendline } from '../common/property-types';
 import { Margin, NegativeBubbleValues, Overlay, SeriesLine, SeriesType } from '../common/property-types';
 import { LineStyle, SeriesStack, SeriesVisualArgs } from '../common/property-types';
 import { SeriesErrorBars } from './series-item/error-bars.interface';
@@ -140,7 +140,8 @@ export interface Series {
     /**
      * The name of the parent series of the trendline.
      *
-     * The `for` option is supported  when [`series.type`]({% slug api_charts_chartseriesitemprops %}#toc-type) is set to `"linearTrendline"` or `"movingAverageTrendline"`.
+     * The `for` option is supported  when [`series.type`]({% slug api_charts_chartseriesitemprops %}#toc-type) is set to
+     * "`linearTrendline`", "`exponentialTrendline`", "`logarithmicTrendline`", "`powerTrendline`", "`polynomialTrendline`" or "`movingAverageTrendline`".
      */
     for?: string;
     /**
@@ -313,14 +314,22 @@ export interface Series {
      * - `candlestick`
      * - `column`
      * - `donut`
+     * - `exponentialTrendline`
      * - `funnel`
+     * - `pyramid`
+     * - `heatmap`
      * - `horizontalWaterfall`
      * - `line`
+     * - `linearTrendline`
+     * - `logarithmicTrendline`
+     * - `movingAverageTrendline`
      * - `ohlc`
      * - `pie`
      * - `polarArea`
      * - `polarLine`
      * - `polarScatter`
+     * - `polynomialTrendline`
+     * - `powerTrendline`
      * - `radarArea`
      * - `radarColumn`
      * - `radarLine`
@@ -435,9 +444,14 @@ export interface Series {
      */
     labels?: SeriesLabels;
     /**
-     * The configuration of the Chart series marker. The Chart displays the series labels when the [`series.markers.visible`]({% slug api_charts_chartseriesmarkersprops %}#toc-visible) option is set to `true`. The markers option is supported when [`series.type`]({% slug api_charts_chartseriesitemprops %}#toc-type) is set to `"area"`, `"rangeArea"`, `"line"`, `"scatter"`, `"scatterLine"`, `"radarLine"`, `"radarArea"`, `"polarLine"`, `"polarScatter"`, or `"polarArea"`.
+     * The configuration of the Chart series marker. The Chart displays the series markers when the [`series.markers.visible`]({% slug api_charts_chartseriesmarkersprops %}#toc-visible) option is set to `true`. The markers option is supported when [`series.type`]({% slug api_charts_chartseriesitemprops %}#toc-type) is set to `"area"`, `"rangeArea"`, `"line"`, `"scatter"`, `"scatterLine"`, `"radarLine"`, `"radarArea"`, `"polarLine"`, `"polarScatter"`, or `"polarArea"`.
      */
     markers?: SeriesMarkers;
+    /**
+     * The configuration of the Chart legend item.
+     * By default, the Legend item type and markers are inherited from the series.
+     */
+    legendItem?: LegendItem;
     /**
      * The configuration of the series notes.
      */
@@ -452,6 +466,9 @@ export interface Series {
     tooltip?: SeriesTooltip;
     /**
      * The configuration options of the series trendlines.
+     *
+     * The `trendline` option is supported  when [`series.type`]({% slug api_charts_chartseriesitemprops %}#toc-type) is set to
+     * "`linearTrendline`", "`exponentialTrendline`", "`logarithmicTrendline`", "`powerTrendline`", "`polynomialTrendline`" or "`movingAverageTrendline`".
      */
     trendline?: SeriesTrendline;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@progress/kendo-react-charts",
-  "version": "7.0.3-develop.9",
+  "version": "7.1.0-develop.10",
   "description": "React Chart renders a wide range of high-quality data visualizations. KendoReact Charts package",
   "author": "Progress",
   "license": "SEE LICENSE IN LICENSE.md",
@@ -24,17 +24,17 @@
   "peerDependencies": {
     "@progress/kendo-drawing": "^1.19.0",
     "@progress/kendo-licensing": "^1.3.4",
-    "@progress/kendo-react-common": "7.0.3-develop.9",
-    "@progress/kendo-react-intl": "7.0.3-develop.9",
-    "@progress/kendo-react-layout": "7.0.3-develop.9",
-    "@progress/kendo-react-popup": "7.0.3-develop.9",
+    "@progress/kendo-react-common": "7.1.0-develop.10",
+    "@progress/kendo-react-intl": "7.1.0-develop.10",
+    "@progress/kendo-react-layout": "7.1.0-develop.10",
+    "@progress/kendo-react-popup": "7.1.0-develop.10",
     "@progress/kendo-svg-icons": "^2.1.0",
     "hammerjs": "^2.0.0",
     "react": "^16.8.2 || ^17.0.0 || ^18.0.0",
     "react-dom": "^16.8.2 || ^17.0.0 || ^18.0.0"
   },
   "dependencies": {
-    "@progress/kendo-charts": "1.32.1",
+    "@progress/kendo-charts": "2.1.0",
     "prop-types": "^15.6.0"
   },
   "keywords": [

package/sankey/Sankey.d.ts

@@ -0,0 +1,10 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2024 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+import * as React from 'react';
+import { SankeyHandle, SankeyProps } from './types';
+/**
+ * The KendoReact Sankey component.
+ */
+export declare const Sankey: React.ForwardRefExoticComponent<SankeyProps & React.RefAttributes<SankeyHandle | null>>;

package/sankey/index.d.ts

@@ -0,0 +1,7 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2024 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+import { Sankey } from './Sankey';
+import { type SankeyProps, type SankeyHandle, type SankeyEvent, type SankeyNode, type SankeyLink, type SankeyLabel, type SankeyData, type SankeyEventHandler, type SankeyLinkHighlight, type SankeyLinkDefaults, type SankeyLabelDefaults, type SankeyNodeDefaults } from './types';
+export { Sankey, SankeyProps, SankeyHandle, SankeyEvent, SankeyEventHandler, SankeyLinkHighlight, SankeyNode, SankeyLink, SankeyLabel, SankeyLinkDefaults, SankeyLabelDefaults, SankeyNodeDefaults, SankeyData };

package/sankey/propTypes.d.ts

@@ -0,0 +1,117 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2024 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+import PropTypes from 'prop-types';
+/**
+ * @hidden
+ */
+export declare const sankeyPropTypes: {
+    data: PropTypes.Validator<Required<PropTypes.InferProps<{
+        nodes: PropTypes.Validator<Required<PropTypes.InferProps<{
+            color: PropTypes.Requireable<string>;
+            opacity: PropTypes.Requireable<number>;
+            offset: PropTypes.Requireable<Required<PropTypes.InferProps<{
+                left: PropTypes.Requireable<number>;
+                top: PropTypes.Requireable<number>;
+            }>>>;
+            padding: PropTypes.Requireable<number>;
+            width: PropTypes.Requireable<number>;
+            id: PropTypes.Validator<NonNullable<NonNullable<string | number | null | undefined>>>;
+            label: PropTypes.Validator<Required<PropTypes.InferProps<{
+                visible: PropTypes.Requireable<boolean>;
+                font: PropTypes.Requireable<string>;
+                color: PropTypes.Requireable<string>;
+                opacity: PropTypes.Requireable<number>;
+                align: PropTypes.Requireable<string>;
+                position: PropTypes.Requireable<string>;
+                padding: PropTypes.Requireable<NonNullable<number | Required<PropTypes.InferProps<{
+                    top: PropTypes.Requireable<number>;
+                    bottom: PropTypes.Requireable<number>;
+                    left: PropTypes.Requireable<number>;
+                    right: PropTypes.Requireable<number>;
+                }>> | null | undefined>>;
+                margin: PropTypes.Requireable<Required<PropTypes.InferProps<{
+                    left: PropTypes.Requireable<number>;
+                    right: PropTypes.Requireable<number>;
+                }>>>;
+                border: PropTypes.Requireable<Required<PropTypes.InferProps<{
+                    width: PropTypes.Requireable<number>;
+                    color: PropTypes.Requireable<string>;
+                    opacity: PropTypes.Requireable<number>;
+                    dashType: PropTypes.Requireable<string>;
+                }>>>;
+                offset: PropTypes.Requireable<Required<PropTypes.InferProps<{
+                    left: PropTypes.Requireable<number>;
+                    top: PropTypes.Requireable<number>;
+                }>>>;
+                text: PropTypes.Requireable<string>;
+            }>>>;
+        }>>[]>;
+        links: PropTypes.Validator<Required<PropTypes.InferProps<{
+            colorType: PropTypes.Requireable<string>;
+            color: PropTypes.Requireable<string>;
+            opacity: PropTypes.Requireable<number>;
+            highlight: PropTypes.Requireable<Required<PropTypes.InferProps<{
+                opacity: PropTypes.Requireable<number>;
+                inactiveOpacity: PropTypes.Requireable<number>;
+            }>>>;
+            sourceId: PropTypes.Validator<NonNullable<NonNullable<string | number | null | undefined>>>;
+            targetId: PropTypes.Validator<NonNullable<NonNullable<string | number | null | undefined>>>;
+            value: PropTypes.Validator<number>;
+        }>>[]>;
+    }>>>;
+    links: PropTypes.Requireable<Required<PropTypes.InferProps<{
+        colorType: PropTypes.Requireable<string>;
+        color: PropTypes.Requireable<string>;
+        opacity: PropTypes.Requireable<number>;
+        highlight: PropTypes.Requireable<Required<PropTypes.InferProps<{
+            opacity: PropTypes.Requireable<number>;
+            inactiveOpacity: PropTypes.Requireable<number>;
+        }>>>;
+    }>>>;
+    nodes: PropTypes.Requireable<Required<PropTypes.InferProps<{
+        color: PropTypes.Requireable<string>;
+        opacity: PropTypes.Requireable<number>;
+        offset: PropTypes.Requireable<Required<PropTypes.InferProps<{
+            left: PropTypes.Requireable<number>;
+            top: PropTypes.Requireable<number>;
+        }>>>;
+        padding: PropTypes.Requireable<number>;
+        width: PropTypes.Requireable<number>;
+    }>>>;
+    labels: PropTypes.Requireable<Required<PropTypes.InferProps<{
+        visible: PropTypes.Requireable<boolean>;
+        font: PropTypes.Requireable<string>;
+        color: PropTypes.Requireable<string>;
+        opacity: PropTypes.Requireable<number>;
+        align: PropTypes.Requireable<string>;
+        position: PropTypes.Requireable<string>;
+        padding: PropTypes.Requireable<NonNullable<number | Required<PropTypes.InferProps<{
+            top: PropTypes.Requireable<number>;
+            bottom: PropTypes.Requireable<number>;
+            left: PropTypes.Requireable<number>;
+            right: PropTypes.Requireable<number>;
+        }>> | null | undefined>>;
+        margin: PropTypes.Requireable<Required<PropTypes.InferProps<{
+            left: PropTypes.Requireable<number>;
+            right: PropTypes.Requireable<number>;
+        }>>>;
+        border: PropTypes.Requireable<Required<PropTypes.InferProps<{
+            width: PropTypes.Requireable<number>;
+            color: PropTypes.Requireable<string>;
+            opacity: PropTypes.Requireable<number>;
+            dashType: PropTypes.Requireable<string>;
+        }>>>;
+        offset: PropTypes.Requireable<Required<PropTypes.InferProps<{
+            left: PropTypes.Requireable<number>;
+            top: PropTypes.Requireable<number>;
+        }>>>;
+    }>>>;
+    className: PropTypes.Requireable<string>;
+    style: PropTypes.Requireable<object>;
+    onNodeEnter: PropTypes.Requireable<(...args: any[]) => any>;
+    onNodeLeave: PropTypes.Requireable<(...args: any[]) => any>;
+    onLinkEnter: PropTypes.Requireable<(...args: any[]) => any>;
+    onLinkLeave: PropTypes.Requireable<(...args: any[]) => any>;
+};

package/sankey/theme-service.d.ts

@@ -0,0 +1,9 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2024 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+import { SankeyTheme } from '@progress/kendo-charts';
+/**
+ * @hidden
+ */
+export declare const loadTheme: (doc: Document, done: (store: SankeyTheme) => void) => void;

package/sankey/types.d.ts

@@ -0,0 +1,124 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2024 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+import { SankeyEvent as SankeyWidgetEvent, SankeyNode as SankeyNodeOptions, SankeyLink as SankeyLinkOptions, SankeyLabel as SankeyLabelOptions, SankeyLinkHighlight, SankeyLinkDefaults as SankeyLinkDefaultsOptions, SankeyNodeDefaults as SankeyNodeDefaultsOptions, SankeyLabelDefaults as SankeyLabelDefaultsOptions } from '@progress/kendo-charts';
+import { BaseEvent } from '@progress/kendo-react-common';
+export { SankeyLinkHighlight };
+/**
+ * Represents the default link options of the Sankey component.
+ * The value will be applied to all links unless overridden by the `links` prop of the Sankey data option.
+ */
+export interface SankeyLinkDefaults extends SankeyLinkDefaultsOptions {
+}
+/**
+ * Represents the default label options of the Sankey component.
+ * The value will be applied to all labels unless overridden by the `nodes` label prop of the Sankey data option.
+ */
+export interface SankeyLabelDefaults extends SankeyLabelDefaultsOptions {
+}
+/**
+ * Represents the default node options of the Sankey component.
+ * The value will be applied to all nodes unless overridden by the `nodes` prop of the Sankey data option.
+ */
+export interface SankeyNodeDefaults extends SankeyNodeDefaultsOptions {
+}
+/**
+ * Represents the Sankey label options.
+ */
+export interface SankeyLabel extends SankeyLabelOptions {
+}
+/**
+ * Represents the Sankey link options.
+ */
+export interface SankeyLink extends SankeyLinkOptions {
+}
+/**
+ * Represents the Sankey node options.
+ */
+export interface SankeyNode extends SankeyNodeOptions {
+}
+/**
+ * The KendoReact Sankey event object.
+ */
+export interface SankeyEvent extends Omit<SankeyWidgetEvent, 'originalEvent'>, BaseEvent<SankeyHandle> {
+}
+/**
+ * Represents the event handler type of the [Sankey]({% slug api_charts_sankey %}) component.
+ */
+export type SankeyEventHandler = (event: SankeyEvent) => void;
+/**
+ * Represents the data of the [Sankey]({% slug api_charts_sankey %}) component.
+ */
+export interface SankeyData {
+    /**
+     * The links of the Sankey component.
+     */
+    links: SankeyLink[];
+    /**
+     * The nodes of the Sankey component.
+     */
+    nodes: SankeyNode[];
+}
+/**
+ * Represents the props of the KendoReact [Sankey]({% slug api_charts_sankey %}) component.
+ */
+export interface SankeyProps {
+    /**
+     * The styles that are applied to the Sankey component.
+     */
+    style?: React.CSSProperties;
+    /**
+     * Sets additional CSS classes to the Sankey component.
+     */
+    className?: string;
+    /**
+     * The data of the Sankey component containing the `links` and `nodes` props.
+     */
+    data: SankeyData;
+    /**
+     * The `links` default props of the Sankey component.
+     * The value will be applied to all links unless overridden by the `links` prop of the `data` prop.
+     */
+    links?: SankeyLinkDefaults;
+    /**
+     * The `nodes` default props of the Sankey component.
+     * The value will be applied to all nodes unless overridden by the `nodes` prop of the `data` prop.
+     */
+    nodes?: SankeyNodeDefaults;
+    /**
+     * The `labels` default props of the Sankey component.
+     * The value will be applied to all labels unless overridden by the `nodes` label prop of the `data` prop.
+     */
+    labels?: SankeyLabelDefaults;
+    /**
+     * Fires when the mouse pointer enters a node. Similar to the `mouseenter` event.
+     */
+    onNodeEnter?: SankeyEventHandler;
+    /**
+     * Fires when the mouse pointer leaves a node. Similar to the `mouseleave` event.
+     */
+    onNodeLeave?: SankeyEventHandler;
+    /**
+     * Fires when the mouse pointer enters a link. Similar to the `mouseenter` event,
+     */
+    onLinkEnter?: SankeyEventHandler;
+    /**
+     * Fires when the mouse pointer leaves a link. Similar to the `mouseleave` event.
+     */
+    onLinkLeave?: SankeyEventHandler;
+}
+/**
+ * Represents the object which is passed to the [`ref`](https://reactjs.org/docs/refs-and-the-dom.html)
+ * callback of the [Sankey]({% slug api_charts_sankey %}) component.
+ */
+export interface SankeyHandle {
+    /**
+     * The root DOM element of the Sankey component.
+     */
+    element: HTMLDivElement | null;
+    /**
+     * The props of the Sankey component.
+     */
+    props: SankeyProps;
+}