@progress/kendo-charts 2.1.0-dev.202401181402 → 2.1.0

package/dist/npm/sankey.d.ts

@@ -4,16 +4,22 @@
 export interface SankeyLinkHighlight {
     /**
      * The opacity of the link.
+     *
+     * @default 0.8
      */
     opacity?: number;
     /**
      * The opacity of the inactive link.
+     *
+     * @default 0.2
      */
     inactiveOpacity?: number;
 }
 
 /**
  * Represents the offset option of the Sankey node and label elements.
+ *
+ * @default `{ top: 0, left: 0 }`
  */
 export interface SankeyOffset {
     left?: number;
@@ -42,6 +48,8 @@ export interface SankeyLink {
      * * `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.
+     *
+     * @default 'static'
      */
     colorType?: 'static' | 'source' | 'target';
     /**
@@ -51,10 +59,14 @@ export interface SankeyLink {
     color?: string;
     /**
      * The opacity of the link.
+     *
+     * @default 0.4
      */
     opacity?: number;
     /**
      * The highlight options of the link.
+     *
+     * @default `{ opacity: 0.8, inactiveOpacity: 0.2 }`
      */
     highlight?: SankeyLinkHighlight;
 }
@@ -69,6 +81,8 @@ export interface SankeyLabel {
     text?: string;
     /**
      * The visibility of the label.
+     *
+     * @default true
      */
     visible?: boolean;
     /**
@@ -81,17 +95,21 @@ export interface SankeyLabel {
     color?: string;
     /**
      * The opacity of the label.
+     *
+     * @default 1
      */
     opacity?: number;
     /**
      * The alignment of the label.
+     *
+     * @default 'left'
      */
     align?: 'left' | 'right' | 'center';
     /**
      * The position of the label.
      *
      * The supported values are:
-     * * `inside`—The label is positioned after the node, except for the nodes at the end of the sankey, that are placed before the node.
+     * * `inside`—The label is positioned after the node, except for the nodes at the end of the Sankey, that are placed before the node.
      * * `before`—The label is positioned before the node.
      * * `after`—The label is positioned after the node.
      *
@@ -100,6 +118,8 @@ export interface SankeyLabel {
     position?: 'inside' | 'before' | 'after';
     /**
      * The padding of the label.
+     *
+     * @default 0
      */
     padding?: number | {
         left?: number;
@@ -109,6 +129,8 @@ export interface SankeyLabel {
     };
     /**
      * The margin of the label.
+     *
+     * @default `{ left: 8, right: 8 }`
      */
     margin?: {
         left?: number;
@@ -116,6 +138,8 @@ export interface SankeyLabel {
     };
     /**
      * The border of the label.
+     *
+     * @default `{ width: 0 }`
      */
     border?: {
         width?: number;
@@ -124,7 +148,7 @@ export interface SankeyLabel {
         dashType?: string;
     };
     /**
-     * The offset of the label applied to the label position.
+     * The offset applied to the label's position.
      *
      * @default `{ top: 0, left: 0 }`
      */
@@ -149,37 +173,44 @@ export interface SankeyNode {
     color?: string;
     /**
      * The opacity of the node.
+     *
+     * @default 1
      */
     opacity?: number;
     /**
-     * The offset of the node applied to the node position.
+     * The offset applied to the node's position.
      *
      * @default `{ top: 0, left: 0 }`
      */
     offset?: SankeyOffset;
     /**
      * The minimum vertical space between two nodes.
+     *
+     * @default 16
      */
     padding?: number;
     /**
      * The width of the node.
+     *
+     * @default 24
      */
     width?: number;
 }
 
 /**
- * Represents the default links options of the Sankey widget.
+ * Represents the default link options of the Sankey widget.
  * The value will be applied to all links unless overridden by the `links` prop of the Sankey data option.
  */
 export interface SankeyLinkDefaults extends Omit<SankeyLink, 'sourceId' | 'targetId' | 'value'> { }
+
 /**
- * Represents the default labels options of the Sankey widget.
+ * Represents the default label options of the Sankey widget.
  * The value will be applied to all labels unless overridden by the `nodes` label prop of the Sankey data option.
  */
 export interface SankeyLabelDefaults extends Omit<SankeyLabel, 'text'> { }
 
 /**
- * Represents the default nodes options of the Sankey widget.
+ * Represents the default node options of the Sankey widget.
  * The value will be applied to all nodes unless overridden by the `nodes` prop of the Sankey data option.
  */
 export interface SankeyNodeDefaults extends Omit<SankeyNode, 'id' | 'label'> { }

package/package.json

@@ -3,7 +3,7 @@
   "description": "Kendo UI platform-independent Charts library",
   "author": "Progress",
   "license": "SEE LICENSE IN license.txt",
-  "version": "2.1.0-dev.202401181402",
+  "version": "2.1.0",
   "main": "dist/npm/main.js",
   "module": "dist/es/main.js",
   "jsnext:main": "dist/es/main.js",