scichart 2.1.2294 → 2.2.2378

package/Charting/Visuals/SciChartPieSurface/PieSegment/PieSegment.js

@@ -1,24 +1,55 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PieSegment = void 0;
+var classFactory_1 = require("../../../../Builder/classFactory");
+var Point_1 = require("../../../../Core/Point");
+var BaseType_1 = require("../../../../types/BaseType");
 var guid_1 = require("../../../../utils/guid");
+var PieLabelProvider_1 = require("../../Axis/LabelProvider/PieLabelProvider");
 var constants_1 = require("./constants");
 var PieSegment = /** @class */ (function () {
     function PieSegment(options) {
-        var _a, _b, _c, _d, _e, _f, _g;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         this.colorProperty = "grey";
         this.isSelectedProperty = false;
         this.textProperty = "";
-        this.deltaProperty = 0;
+        this.deltaProperty = 15;
+        this.shiftProperty = 0;
+        this.labelOffsetProperty = new Point_1.Point(0, 0);
+        this.radiusAdjustmentProperty = 1;
         this.id = (_a = options === null || options === void 0 ? void 0 : options.id) !== null && _a !== void 0 ? _a : (0, guid_1.generateGuid)();
         this.colorProperty = (_b = options === null || options === void 0 ? void 0 : options.color) !== null && _b !== void 0 ? _b : this.colorProperty;
         this.colorLinearGradientProperty = (_c = options === null || options === void 0 ? void 0 : options.colorLinearGradient) !== null && _c !== void 0 ? _c : this.colorLinearGradientProperty;
         this.isSelectedProperty = (_d = options === null || options === void 0 ? void 0 : options.isSelected) !== null && _d !== void 0 ? _d : this.isSelectedProperty;
         this.textProperty = (_e = options === null || options === void 0 ? void 0 : options.text) !== null && _e !== void 0 ? _e : this.textProperty;
         this.valueProperty = (_f = options === null || options === void 0 ? void 0 : options.value) !== null && _f !== void 0 ? _f : this.valueProperty;
-        this.delta = (_g = options === null || options === void 0 ? void 0 : options.delta) !== null && _g !== void 0 ? _g : this.deltaProperty;
+        this.deltaProperty = (_g = options === null || options === void 0 ? void 0 : options.delta) !== null && _g !== void 0 ? _g : this.deltaProperty;
+        if (options === null || options === void 0 ? void 0 : options.labelProvider) {
+            if (!("getSegmentText" in (options === null || options === void 0 ? void 0 : options.labelProvider))) {
+                options.labelProvider = (0, classFactory_1.createType)(BaseType_1.EBaseType.LabelProvider, options.labelProvider.type, undefined, options.labelProvider.options);
+            }
+        }
+        this.labelProviderProperty = options === null || options === void 0 ? void 0 : options.labelProvider; // No default here as we default to labelprovider on parent surface
+        this.labelOffsetProperty = (_h = options === null || options === void 0 ? void 0 : options.labelOffset) !== null && _h !== void 0 ? _h : this.labelOffsetProperty;
+        this.labelStyleProperty = options === null || options === void 0 ? void 0 : options.labelStyle;
+        this.radiusAdjustmentProperty = (_j = options === null || options === void 0 ? void 0 : options.radiusAdjustment) !== null && _j !== void 0 ? _j : this.radiusAdjustmentProperty;
     }
     PieSegment.prototype.onAttach = function (scps) {
+        this.parentSurface = scps;
+        if (this.labelProviderProperty) {
+            this.labelProviderProperty.attachedToSurface(scps);
+        }
         this.invalidateParentCallback = scps.invalidateElement;
     };
     PieSegment.prototype.onDetach = function () {
@@ -26,9 +57,15 @@ var PieSegment = /** @class */ (function () {
     };
     Object.defineProperty(PieSegment.prototype, "colorLinearGradient", {
         // GETTERS AND SETTERS FOR PROPERTIES
+        /**
+         * An optional color gradient
+         */
         get: function () {
             return this.colorLinearGradientProperty;
         },
+        /**
+         * An optional color gradient
+         */
         set: function (value) {
             this.colorLinearGradientProperty = value;
             this.notifyPropertyChanged(constants_1.PROPERTY.COLOR_LINEAR_GRADIENT);
@@ -37,9 +74,15 @@ var PieSegment = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(PieSegment.prototype, "color", {
+        /**
+         * The color of the segment as an HTML color code
+         */
         get: function () {
             return this.colorProperty;
         },
+        /**
+         * The color of the segment as an HTML color code
+         */
         set: function (value) {
             this.colorProperty = value;
             this.notifyPropertyChanged(constants_1.PROPERTY.COLOR);
@@ -48,26 +91,34 @@ var PieSegment = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(PieSegment.prototype, "isSelected", {
+        /**
+         * Whether the segment is selected.  Selected segments are shifted outwards by the delta
+         */
         get: function () {
             return this.isSelectedProperty;
         },
+        /**
+         * Whether the segment is selected.  Selected segments are shifted outwards by the delta
+         */
         set: function (value) {
-            this.isSelectedProperty = value;
-            if (value) {
-                this.deltaProperty = PieSegment.DEFAULT_DELTA;
-            }
-            else {
-                this.deltaProperty = 0;
+            if (this.isSelectedProperty !== value) {
+                this.isSelectedProperty = value;
+                this.notifyPropertyChanged(constants_1.PROPERTY.IS_SELECTED);
             }
-            this.notifyPropertyChanged(constants_1.PROPERTY.IS_SELECTED);
         },
         enumerable: false,
         configurable: true
     });
     Object.defineProperty(PieSegment.prototype, "text", {
+        /**
+         * A text value for the segment which will be displayed in the legend
+         */
         get: function () {
             return this.textProperty;
         },
+        /**
+         * A text value for the segment which will be displayed in the legend
+         */
         set: function (value) {
             this.textProperty = value;
             this.notifyPropertyChanged(constants_1.PROPERTY.TEXT);
@@ -75,39 +126,154 @@ var PieSegment = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(PieSegment.prototype, "labelProvider", {
+        /**
+         * Optional class that can override the default label formatting for this segment only.  Must be or inherit from {@link PieLabelProvider}
+         */
+        get: function () {
+            // Create a labelProvider if it is accessed.  This will override behaviour from the parent surface
+            if (this.labelProviderProperty === undefined) {
+                this.labelProvider = new PieLabelProvider_1.PieLabelProvider();
+            }
+            return this.labelProviderProperty;
+        },
+        /**
+         * Optional class that can override the default label formatting for this segment only.  Must be or inherit from {@link PieLabelProvider}
+         */
+        set: function (value) {
+            this.labelProviderProperty = value;
+            this.notifyPropertyChanged(constants_1.PROPERTY.LABEL_PROVIDER);
+        },
+        enumerable: false,
+        configurable: true
+    });
     PieSegment.prototype.getPercentage = function (total) {
-        var pers = (100 * this.value) / total;
-        return pers.toFixed(2) + " %";
+        return (100 * this.value) / total;
     };
     Object.defineProperty(PieSegment.prototype, "value", {
+        /**
+         * The numerical value of the segment
+         */
         get: function () {
             return this.valueProperty;
         },
+        /**
+         * The numerical value of the segment
+         */
         set: function (value) {
+            this.oldValueProperty = this.valueProperty;
             this.valueProperty = value;
             this.notifyPropertyChanged(constants_1.PROPERTY.VALUE);
         },
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(PieSegment.prototype, "oldValue", {
+        /**
+         * The previous value of the segment, if it has been updated.  Used for animations
+         */
+        get: function () {
+            return this.oldValueProperty;
+        },
+        enumerable: false,
+        configurable: true
+    });
     Object.defineProperty(PieSegment.prototype, "delta", {
+        /**
+         * The amount to shift the segment when it is selected.  Default 15 px
+         */
         get: function () {
             return this.deltaProperty;
         },
+        /**
+         * The amount to shift the segment when it is selected.  Default 15 px
+         */
         set: function (value) {
-            if (this.deltaProperty === PieSegment.DEFAULT_DELTA && value < PieSegment.DEFAULT_DELTA) {
-                this.isSelectedProperty = false;
+            if (this.deltaProperty !== value) {
+                this.deltaProperty = value;
+                this.notifyPropertyChanged(constants_1.PROPERTY.DELTA);
             }
-            else if (this.deltaProperty === 0 && value > 0) {
-                this.isSelectedProperty = true;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PieSegment.prototype, "shift", {
+        /**
+         * The amount the segment is shifted radially outwards.  Automatically set during selected/deselection animations
+         * Do not set this directly.  Use delta and isSelected instead
+         */
+        get: function () {
+            return this.shiftProperty;
+        },
+        /**
+         * The amount the segment is shifted radially outwards.  Automatically set during selected/deselection animations
+         */
+        set: function (value) {
+            if (this.shiftProperty !== value) {
+                this.shiftProperty = value;
+                this.notifyPropertyChanged(constants_1.PROPERTY.SHIFT);
             }
-            this.deltaProperty = value;
-            this.notifyPropertyChanged(constants_1.PROPERTY.DELTA);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PieSegment.prototype, "labelStyle", {
+        /**
+         * Gets or sets a {@link TTextStyle} object for styling labels for this segment only
+         */
+        get: function () {
+            var _a;
+            return __assign(__assign({}, (_a = this.parentSurface) === null || _a === void 0 ? void 0 : _a.labelStyle), this.labelStyleProperty);
+        },
+        /**
+         * Gets or sets a {@link TTextStyle} object for styling labels for this segment only
+         */
+        set: function (textStyle) {
+            this.labelStyleProperty = __assign(__assign({}, this.labelStyleProperty), textStyle);
+            this.notifyPropertyChanged(constants_1.PROPERTY.LABEL_STYLE);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PieSegment.prototype, "labelOffset", {
+        /**
+         * An x, y offset for the label position
+         */
+        get: function () {
+            return this.labelOffsetProperty;
+        },
+        /**
+         * An x, y offset for the label position
+         */
+        set: function (value) {
+            var _a, _b;
+            if (((_a = this.labelOffsetProperty) === null || _a === void 0 ? void 0 : _a.x) !== value.x && ((_b = this.labelOffsetProperty) === null || _b === void 0 ? void 0 : _b.y) !== value.y) {
+                this.labelOffsetProperty = value;
+                this.notifyPropertyChanged(constants_1.PROPERTY.LABEL_OFFSET);
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PieSegment.prototype, "radiusAdjustment", {
+        /**
+         * A relative adjustment of the radius for this segment. eg 1.5 will be 50% larger than normal
+         */
+        get: function () {
+            return this.radiusAdjustmentProperty;
+        },
+        /**
+         * A relative adjustment of the radius for this segment. eg 1.5 will be 50% larger than normal
+         */
+        set: function (value) {
+            this.radiusAdjustmentProperty = value;
+            this.notifyPropertyChanged(constants_1.PROPERTY.RADIUS_ADJUSTMENT);
         },
         enumerable: false,
         configurable: true
     });
     PieSegment.prototype.toJSON = function () {
+        var _a;
         return {
             id: this.id,
             color: this.color,
@@ -115,15 +281,30 @@ var PieSegment = /** @class */ (function () {
             isSelected: this.isSelected,
             delta: this.delta,
             text: this.text,
-            value: this.value
+            value: this.value,
+            // @ts-ignore
+            labelProvider: (_a = this.labelProviderProperty) === null || _a === void 0 ? void 0 : _a.toJSON(),
+            labelOffset: this.labelOffset,
+            labelStyle: this.labelStyle,
+            radiusAdjustment: this.radiusAdjustment
         };
     };
+    PieSegment.prototype.getLabelText = function (total) {
+        if (this.labelProviderProperty) {
+            return this.labelProvider.getSegmentText(this, total);
+        }
+        else {
+            return this.parentSurface.labelProvider.getSegmentText(this, total);
+        }
+    };
     PieSegment.prototype.notifyPropertyChanged = function (propertyName) {
+        if (propertyName === constants_1.PROPERTY.LABEL_PROVIDER && this.labelProviderProperty) {
+            this.labelProviderProperty.attachedToSurface(this.parentSurface);
+        }
         if (this.invalidateParentCallback) {
-            this.invalidateParentCallback();
+            this.invalidateParentCallback(propertyName);
         }
     };
-    PieSegment.DEFAULT_DELTA = 15;
     return PieSegment;
 }());
 exports.PieSegment = PieSegment;

package/Charting/Visuals/SciChartPieSurface/PieSegment/constants.d.ts

@@ -5,5 +5,10 @@ export declare enum PROPERTY {
     IS_SELECTED = "IS_SELECTED",
     PERCENTAGE = "PERCENTAGE",
     TEXT = "TEXT",
-    VALUE = "VALUE"
+    VALUE = "VALUE",
+    SHIFT = "SHIFT",
+    LABEL_PROVIDER = "LABEL_PROVIDER",
+    LABEL_STYLE = "LABEL_STYLE",
+    LABEL_OFFSET = "LABEL_OFFSET",
+    RADIUS_ADJUSTMENT = "RADIUS_ADJUSTMENT"
 }

package/Charting/Visuals/SciChartPieSurface/PieSegment/constants.js

@@ -10,4 +10,9 @@ var PROPERTY;
     PROPERTY["PERCENTAGE"] = "PERCENTAGE";
     PROPERTY["TEXT"] = "TEXT";
     PROPERTY["VALUE"] = "VALUE";
+    PROPERTY["SHIFT"] = "SHIFT";
+    PROPERTY["LABEL_PROVIDER"] = "LABEL_PROVIDER";
+    PROPERTY["LABEL_STYLE"] = "LABEL_STYLE";
+    PROPERTY["LABEL_OFFSET"] = "LABEL_OFFSET";
+    PROPERTY["RADIUS_ADJUSTMENT"] = "RADIUS_ADJUSTMENT";
 })(PROPERTY = exports.PROPERTY || (exports.PROPERTY = {}));

package/Charting/Visuals/SciChartPieSurface/SciChartPieSurface.d.ts

@@ -1,9 +1,13 @@
 import { ISciChartPieDefinition } from "../../../Builder/buildSurface";
 import { IDeletable } from "../../../Core/IDeletable";
 import { ObservableArray } from "../../../Core/ObservableArray";
+import { Thickness } from "../../../Core/Thickness";
 import { ESciChartSurfaceType } from "../../../types/SciChartSurfaceType";
+import { TBorder } from "../../../types/TBorder";
 import { TSciChartSurfaceCanvases } from "../../../types/TSciChartSurfaceCanvases";
 import { IThemeProvider } from "../../Themes/IThemeProvider";
+import { TTextStyle } from "../Axis/AxisCore";
+import { PieLabelProvider } from "../Axis/LabelProvider/PieLabelProvider";
 import { IEventSubscriptionItem } from "../Legend/SciChartLegendBase";
 import { SciChartPieLegend } from "../Legend/SciChartPieLegend";
 import { ISciChartSurfaceBase } from "../SciChartSurfaceBase";
@@ -23,6 +27,10 @@ export declare enum EPieType {
     Pie = "Pie",
     Donut = "Donut"
 }
+export declare enum EPieValueMode {
+    Percentage = 0,
+    Raw = 1
+}
 /**
  * @summary The {@link SciChartPieSurface} is the root Pie and Donut Chart control in SciChart's High Performance Real-time
  * {@link https://www.scichart.com/javascript-chart-features | JavaScript Chart Library}
@@ -61,6 +69,7 @@ export declare class SciChartPieSurface implements ISciChartSurfaceBase {
     readonly domSvgAdornerLayer: SVGSVGElement;
     readonly domDivContainer: HTMLDivElement;
     animate: boolean;
+    animationFrames: number;
     /**
      * An optional legend of type {@link SciChartPieLegend} which may be added to the Pie chart
      */
@@ -68,10 +77,12 @@ export declare class SciChartPieSurface implements ISciChartSurfaceBase {
     onCreatedName: string;
     protected widthAspect: number;
     protected heightAspect: number;
+    protected labelProviderProperty: PieLabelProvider;
     private pieTypeProperty;
     private holeRadiusProperty;
     private holeRadiusSizingModeProperty;
     private seriesSpacingProperty;
+    private labelRadiusProperty;
     private svg;
     private titleDivs;
     private viewRect;
@@ -80,7 +91,27 @@ export declare class SciChartPieSurface implements ISciChartSurfaceBase {
     private themeProviderProperty;
     private previousThemeProviderProperty;
     private deletables;
+    private paddingProperty?;
+    private canvasBorderProperty?;
+    private valueModeProperty;
+    private labelStyleProperty;
     constructor(canvases?: TSciChartSurfaceCanvases, options?: IPieSurfaceOptions);
+    /**
+     * Gets or sets a {@link LabelProvider} - a class which is responsible for formatting axis labels and cursor labels from numeric values
+     */
+    get labelProvider(): PieLabelProvider;
+    /**
+     * Gets or sets a {@link LabelProvider} - a class which is responsible for formatting axis labels and cursor labels from numeric values
+     */
+    set labelProvider(labelProvider: PieLabelProvider);
+    /**
+     * Gets or sets a {@link TTextStyle} object for styling labels
+     */
+    get labelStyle(): TTextStyle;
+    /**
+     * Gets or sets a {@link TTextStyle} object for styling labels
+     */
+    set labelStyle(textStyle: TTextStyle);
     /**
      * @inheritDoc
      */
@@ -97,7 +128,7 @@ export declare class SciChartPieSurface implements ISciChartSurfaceBase {
      * Call invalidateElement() to trigger a redraw of the {@link SciChartPieSurface}. SciChart's rendering
      * engine will schedule a redraw a the next time the renderer is free.
      */
-    invalidateElement(): void;
+    invalidateElement(propertyName?: string): void;
     /**
      * Called internally - Updates and draws the Pie Chart
      */
@@ -105,7 +136,7 @@ export declare class SciChartPieSurface implements ISciChartSurfaceBase {
     /**
      * @inheritDoc
      */
-    delete(): void;
+    delete(isAnimationProgress?: boolean): void;
     /**
      * @inheritDoc
      */
@@ -150,6 +181,39 @@ export declare class SciChartPieSurface implements ISciChartSurfaceBase {
      * which sets the size of a Donut Chart hole
      */
     set holeRadiusSizingMode(holeRadiusSizingMode: ESizingMode);
+    /**
+     * Gets or sets padding
+     */
+    get padding(): Thickness;
+    /**
+     * Gets or sets padding
+     */
+    set padding(value: Thickness);
+    /**
+     * Gets or sets canvas border
+     */
+    get canvasBorder(): TBorder;
+    /**
+     * Gets or sets canvas border
+     */
+    set canvasBorder(value: TBorder);
+    get seriesSpacing(): number;
+    set seriesSpacing(value: number);
+    /** Whether to show labels as percentages, or raw values.  Default to percentages */
+    get valueMode(): EPieValueMode;
+    /** Whether to show labels as percentages, or raw values.  Default to percentages */
+    set valueMode(value: EPieValueMode);
+    /**
+     * Use this to adjust the position of the labels.  1 is the default.  Larger values will shift the labels outwards.
+     * For Pie charts, 1.7 will place the labels outside the pie
+     * If you want more detailed control you can override calcTitlePosition.
+     */
+    get labelRadiusAdjustment(): number;
+    /**
+     * Use this to adjust the position of the labels.  1 is the default.  Larger values will shift the labels outwards.
+     * If you want more detailed control you can override calcTitlePosition.
+     */
+    set labelRadiusAdjustment(value: number);
     /**
      * Convert the surface to a {@link TSurfaceDefinition}
      * @param excludedata If false, segments will be included in the json
@@ -158,6 +222,11 @@ export declare class SciChartPieSurface implements ISciChartSurfaceBase {
         type: ESciChartSurfaceType;
         options: ISciChartPieDefinition;
     };
+    /** The method used to calculate the label position for each segment */
+    calcTitlePosition(x: number, y: number, outerRadius: number, innerRadius: number, a1: number, a2: number, delta: number, divWidth: number, divHeight: number): {
+        left: number;
+        top: number;
+    };
     /**
      * Changes the size of the DOM element where the {@link SciChartSurfaceBase} resides.
      * @param width
@@ -168,14 +237,19 @@ export declare class SciChartPieSurface implements ISciChartSurfaceBase {
     private isValidToDraw;
     private detachPieSegment;
     private attachPieSegment;
+    private updateLegendMargin;
+    private calculateViewRectWidth;
+    private calculateViewRectHeight;
     private draw;
     /**
      * @description Draws pie chart itself
      * @param animationProgress - Current progress from 0 to 1, is being used for sweep animation on start.
      */
     private drawChart;
-    private drawSegmentTitles;
+    private adjustDomContainer;
+    private drawSegmentLabel;
     private pieSegmentsTotalValue;
+    private pieSegmentsTotalOldValue;
     private applySciChartBackground;
 }
 /** @ignore */