scichart 2.2.2351 → 2.2.2393

package/Charting/Visuals/RenderableSeries/constants.js

@@ -13,11 +13,16 @@ var PROPERTY;
     PROPERTY["CONTOUR_MAJOR_LINE_STYLE"] = "CONTOUR_MAJOR_LINE_STYLE";
     PROPERTY["CONTOUR_COLOR_MAP_MODE"] = "CONTOUR_COLOR_MAP_MODE";
     PROPERTY["DATA_POINT_WIDTH"] = "dataPointWidth";
+    PROPERTY["DATA_POINT_WIDTH_MODE"] = "DATA_POINT_WIDTH_MODE";
     PROPERTY["DATA_SERIES"] = "dataSeries";
     PROPERTY["DRAWING_PROVIDERS"] = "DRAWING_PROVIDERS";
     PROPERTY["DRAW_NAN_AS"] = "drawNaNAs";
+    PROPERTY["DRAW_CONNECTOR"] = "DRAW_CONNECTOR";
+    PROPERTY["DRAW_WHISKERS"] = "DRAW_WHISKERS";
     PROPERTY["EFFECT"] = "EFFECT";
     PROPERTY["ENABLE_DRAWING_OPTIMISATIONS"] = "ENABLE_DRAWING_OPTIMISATIONS";
+    PROPERTY["ERROR_DIRECTION"] = "ERROR_DIRECTION";
+    PROPERTY["ERROR_MODE"] = "ERROR_MODE";
     PROPERTY["FILL"] = "fill";
     PROPERTY["FILL_Y1"] = "FILL_Y1";
     PROPERTY["FILL_LINEAR_GRADIENT"] = "FILL_LINEAR_GRADIENT";

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

@@ -1,3 +1,4 @@
+import { TLabelProviderDefinition } from "../../../Builder/buildAxis";
 import { Thickness } from "../../../Core/Thickness";
 import { TBorder } from "../../../types/TBorder";
 import { PieLabelProvider } from "../Axis/LabelProvider/PieLabelProvider";
@@ -44,7 +45,7 @@ export interface IPieSurfaceOptions extends ISurfaceOptionsBase {
     /**
      * Sets a {@link LabelProvider} - a class which is responsible for formatting axis labels and cursor labels from numeric values
      */
-    labelProvider?: PieLabelProvider;
+    labelProvider?: PieLabelProvider | TLabelProviderDefinition;
     /** Whether to show labels as percentages, or raw values.  Default to percentages */
     valueMode?: EPieValueMode;
     /**

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

@@ -1,4 +1,6 @@
 import { GradientParams } from "../../../../Core/GradientParams";
+import { Point } from "../../../../Core/Point";
+import { TTextStyle } from "../../Axis/AxisCore";
 import { SciChartPieSurface } from "../SciChartPieSurface";
 import { IPieSegmentOptions } from "./PieSegment";
 export interface IPieSegment {
@@ -11,6 +13,9 @@ export interface IPieSegment {
     isSelected: boolean;
     delta: number;
     shift: number;
+    labelStyle: TTextStyle;
+    labelOffset: Point;
+    radiusAdjustment: number;
     onAttach(scs: SciChartPieSurface): void;
     onDetach(): void;
     toJSON(): IPieSegmentOptions;

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

@@ -1,17 +1,53 @@
+import { TLabelProviderDefinition } from "../../../../Builder/buildAxis";
 import { GradientParams } from "../../../../Core/GradientParams";
+import { Point } from "../../../../Core/Point";
 import { RequiredOwnProps } from "../../../../types/HelperTypes";
+import { TTextStyle } from "../../Axis/AxisCore";
 import { PieLabelProvider } from "../../Axis/LabelProvider/PieLabelProvider";
 import { SciChartPieSurface } from "../SciChartPieSurface";
 import { IPieSegment } from "./IPieSegment";
 export interface IPieSegmentOptions {
     id?: string;
+    /**
+     * A text value for the segment which will be displayed in the legend
+     */
     text?: string;
+    /**
+     * The numerical value of the segment
+     */
     value?: number;
+    /**
+     * The color of the segment as an HTML color code
+     */
     color?: string;
+    /**
+     * An optional color gradient
+     */
     colorLinearGradient?: GradientParams;
+    /**
+     * Whether the segment is selected.  Selected segments are shifted outwards by the delta
+     */
     isSelected?: boolean;
+    /**
+     * The amount to shift the segment when it is selected.  Default 15 px
+     */
     delta?: number;
-    labelProvider?: PieLabelProvider;
+    /**
+     * Optional class that can override the default label formatting for this segment only.  Must be or inherit from {@link PieLabelProvider}
+     */
+    labelProvider?: PieLabelProvider | TLabelProviderDefinition;
+    /**
+     * Optional text style that will override the default style from the surface for this segment only
+     */
+    labelStyle?: TTextStyle;
+    /**
+     * An x, y offset for the label position
+     */
+    labelOffset?: Point;
+    /**
+     * A relative adjustment of the radius for this segment. eg 1.5 will be 50% larger than normal
+     */
+    radiusAdjustment?: number;
 }
 export declare class PieSegment implements IPieSegment {
     readonly id: string;
@@ -25,28 +61,107 @@ export declare class PieSegment implements IPieSegment {
     private shiftProperty;
     private parentSurface;
     private labelProviderProperty;
+    private labelStyleProperty;
+    private labelOffsetProperty;
+    private radiusAdjustmentProperty;
     private invalidateParentCallback;
     constructor(options?: IPieSegmentOptions);
     onAttach(scps: SciChartPieSurface): void;
     onDetach(): void;
+    /**
+     * An optional color gradient
+     */
     get colorLinearGradient(): GradientParams;
+    /**
+     * An optional color gradient
+     */
     set colorLinearGradient(value: GradientParams);
+    /**
+     * The color of the segment as an HTML color code
+     */
     get color(): string;
+    /**
+     * The color of the segment as an HTML color code
+     */
     set color(value: string);
+    /**
+     * Whether the segment is selected.  Selected segments are shifted outwards by the delta
+     */
     get isSelected(): boolean;
+    /**
+     * Whether the segment is selected.  Selected segments are shifted outwards by the delta
+     */
     set isSelected(value: boolean);
+    /**
+     * A text value for the segment which will be displayed in the legend
+     */
     get text(): string;
+    /**
+     * A text value for the segment which will be displayed in the legend
+     */
     set text(value: string);
+    /**
+     * Optional class that can override the default label formatting for this segment only.  Must be or inherit from {@link PieLabelProvider}
+     */
     get labelProvider(): PieLabelProvider;
+    /**
+     * Optional class that can override the default label formatting for this segment only.  Must be or inherit from {@link PieLabelProvider}
+     */
     set labelProvider(value: PieLabelProvider);
     getPercentage(total: number): number;
+    /**
+     * The numerical value of the segment
+     */
     get value(): number;
+    /**
+     * The numerical value of the segment
+     */
     set value(value: number);
+    /**
+     * The previous value of the segment, if it has been updated.  Used for animations
+     */
     get oldValue(): number;
+    /**
+     * The amount to shift the segment when it is selected.  Default 15 px
+     */
     get delta(): number;
+    /**
+     * The amount to shift the segment when it is selected.  Default 15 px
+     */
     set delta(value: number);
+    /**
+     * 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 shift(): number;
+    /**
+     * The amount the segment is shifted radially outwards.  Automatically set during selected/deselection animations
+     */
     set shift(value: number);
+    /**
+     * Gets or sets a {@link TTextStyle} object for styling labels for this segment only
+     */
+    get labelStyle(): TTextStyle;
+    /**
+     * Gets or sets a {@link TTextStyle} object for styling labels for this segment only
+     */
+    set labelStyle(textStyle: TTextStyle);
+    /**
+     * An x, y offset for the label position
+     */
+    get labelOffset(): Point;
+    /**
+     * An x, y offset for the label position
+     */
+    set labelOffset(value: Point);
+    /**
+     * A relative adjustment of the radius for this segment. eg 1.5 will be 50% larger than normal
+     */
+    get radiusAdjustment(): number;
+    /**
+     * A relative adjustment of the radius for this segment. eg 1.5 will be 50% larger than normal
+     */
+    set radiusAdjustment(value: number);
     toJSON(): RequiredOwnProps<IPieSegmentOptions>;
     getLabelText(total: number): string;
     private notifyPropertyChanged;

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

@@ -1,17 +1,33 @@
 "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 = 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;
@@ -19,7 +35,15 @@ var PieSegment = /** @class */ (function () {
         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.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;
@@ -33,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);
@@ -44,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);
@@ -55,9 +91,15 @@ 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) {
             if (this.isSelectedProperty !== value) {
                 this.isSelectedProperty = value;
@@ -68,9 +110,15 @@ var PieSegment = /** @class */ (function () {
         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);
@@ -79,6 +127,9 @@ var PieSegment = /** @class */ (function () {
         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) {
@@ -86,6 +137,9 @@ var PieSegment = /** @class */ (function () {
             }
             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);
@@ -97,9 +151,15 @@ var PieSegment = /** @class */ (function () {
         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;
@@ -109,6 +169,9 @@ var PieSegment = /** @class */ (function () {
         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;
         },
@@ -116,9 +179,15 @@ var PieSegment = /** @class */ (function () {
         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 !== value) {
                 this.deltaProperty = value;
@@ -129,9 +198,16 @@ var PieSegment = /** @class */ (function () {
         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;
@@ -141,7 +217,63 @@ var PieSegment = /** @class */ (function () {
         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,
@@ -151,7 +283,10 @@ var PieSegment = /** @class */ (function () {
             text: this.text,
             value: this.value,
             // @ts-ignore
-            labelProvider: this.labelProvider.toJSON()
+            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) {
@@ -163,8 +298,8 @@ var PieSegment = /** @class */ (function () {
         }
     };
     PieSegment.prototype.notifyPropertyChanged = function (propertyName) {
-        if (propertyName === constants_1.PROPERTY.LABEL_PROVIDER) {
-            this.labelProvider.attachedToSurface(this.parentSurface);
+        if (propertyName === constants_1.PROPERTY.LABEL_PROVIDER && this.labelProviderProperty) {
+            this.labelProviderProperty.attachedToSurface(this.parentSurface);
         }
         if (this.invalidateParentCallback) {
             this.invalidateParentCallback(propertyName);

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

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

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

@@ -12,4 +12,7 @@ var PROPERTY;
     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

@@ -6,7 +6,7 @@ import { ESciChartSurfaceType } from "../../../types/SciChartSurfaceType";
 import { TBorder } from "../../../types/TBorder";
 import { TSciChartSurfaceCanvases } from "../../../types/TSciChartSurfaceCanvases";
 import { IThemeProvider } from "../../Themes/IThemeProvider";
-import { LabelProvider } from "../Axis/LabelProvider/LabelProvider";
+import { TTextStyle } from "../Axis/AxisCore";
 import { PieLabelProvider } from "../Axis/LabelProvider/PieLabelProvider";
 import { IEventSubscriptionItem } from "../Legend/SciChartLegendBase";
 import { SciChartPieLegend } from "../Legend/SciChartPieLegend";
@@ -77,7 +77,7 @@ export declare class SciChartPieSurface implements ISciChartSurfaceBase {
     onCreatedName: string;
     protected widthAspect: number;
     protected heightAspect: number;
-    protected labelProviderProperty: LabelProvider;
+    protected labelProviderProperty: PieLabelProvider;
     private pieTypeProperty;
     private holeRadiusProperty;
     private holeRadiusSizingModeProperty;
@@ -94,6 +94,7 @@ export declare class SciChartPieSurface implements ISciChartSurfaceBase {
     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
@@ -103,6 +104,14 @@ export declare class SciChartPieSurface implements ISciChartSurfaceBase {
      * 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
      */
@@ -238,8 +247,9 @@ export declare class SciChartPieSurface implements ISciChartSurfaceBase {
      */
     private drawChart;
     private adjustDomContainer;
-    private drawSegmentTitles;
+    private drawSegmentLabel;
     private pieSegmentsTotalValue;
+    private pieSegmentsTotalOldValue;
     private applySciChartBackground;
 }
 /** @ignore */