scichart 3.0.300 → 3.0.301

package/Charting/ChartModifiers/ChartModifierBase.d.ts

@@ -166,8 +166,9 @@ export declare abstract class ChartModifierBase<TSurfaceType extends SciChartSur
     protected mousePoint: Point;
     protected executeOnProperty: EExecuteOn;
     private parentSurfaceProperty;
-    constructor(options?: {
+    protected constructor(options?: {
         id?: string;
+        executeOn?: EExecuteOn;
     });
     /** @inheritDoc */
     applyTheme(themeProvider: IThemeProvider): void;

package/Charting/ChartModifiers/ChartModifierBase.js

@@ -17,10 +17,11 @@ var EModifierType;
  */
 var ChartModifierBase = /** @class */ (function () {
     function ChartModifierBase(options) {
-        var _a;
+        var _a, _b;
         this.isEnabledProperty = true;
         this.executeOnProperty = ExecuteOn_1.EExecuteOn.MouseLeftButton;
         this.id = (_a = options === null || options === void 0 ? void 0 : options.id) !== null && _a !== void 0 ? _a : (0, guid_1.generateGuid)();
+        this.executeOnProperty = (_b = options === null || options === void 0 ? void 0 : options.executeOn) !== null && _b !== void 0 ? _b : this.executeOn;
     }
     /** @inheritDoc */
     ChartModifierBase.prototype.applyTheme = function (themeProvider) {

package/Charting/ChartModifiers/ChartModifierBase2D.d.ts

@@ -45,6 +45,9 @@ export interface IChartModifierBaseOptions {
  * to SciChart - High Performance Realtime {@link https://www.scichart.com/javascript-chart-features | 2D JavaScript Charts}
  */
 export declare abstract class ChartModifierBase2D extends ChartModifierBase<SciChartSurface> {
+    /**
+     * The type of chartmodifier. See {@link EChart2DModifierType} for available options
+     */
     abstract readonly type: EChart2DModifierType | string;
     xyDirection: EXyDirection;
     protected changedPropertiesList: string[];
@@ -74,6 +77,9 @@ export declare abstract class ChartModifierBase2D extends ChartModifierBase<SciC
      * @remarks This function allows mocking in tests
      */
     getAllSeries(): IRenderableSeries[];
+    /**
+     * @inheritDoc
+     */
     toJSON(): {
         type: string;
         options: Required<Omit<IChartModifierBaseOptions, never>>;

package/Charting/ChartModifiers/ChartModifierBase2D.js

@@ -33,7 +33,7 @@ var ChartModifierBase2D = /** @class */ (function (_super) {
      */
     function ChartModifierBase2D(options) {
         var _this = this;
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d;
         _this = _super.call(this, options) || this;
         _this.xyDirection = XyDirection_1.EXyDirection.XyDirection;
         _this.changedPropertiesList = [];
@@ -41,11 +41,10 @@ var ChartModifierBase2D = /** @class */ (function (_super) {
         _this.yAxisIdProperty = AxisCore_1.AxisCore.DEFAULT_AXIS_ID;
         // used to track if registered types were used for function properties, so they can be serialized
         _this.typeMap = new Map();
-        _this.executeOn = (_a = options === null || options === void 0 ? void 0 : options.executeOn) !== null && _a !== void 0 ? _a : _this.executeOn;
-        _this.xyDirection = (_b = options === null || options === void 0 ? void 0 : options.xyDirection) !== null && _b !== void 0 ? _b : _this.xyDirection;
-        _this.modifierGroup = (_c = options === null || options === void 0 ? void 0 : options.modifierGroup) !== null && _c !== void 0 ? _c : _this.modifierGroup;
-        _this.xAxisIdProperty = (_d = options === null || options === void 0 ? void 0 : options.xAxisId) !== null && _d !== void 0 ? _d : _this.xAxisIdProperty;
-        _this.yAxisIdProperty = (_e = options === null || options === void 0 ? void 0 : options.yAxisId) !== null && _e !== void 0 ? _e : _this.yAxisIdProperty;
+        _this.xyDirection = (_a = options === null || options === void 0 ? void 0 : options.xyDirection) !== null && _a !== void 0 ? _a : _this.xyDirection;
+        _this.modifierGroup = (_b = options === null || options === void 0 ? void 0 : options.modifierGroup) !== null && _b !== void 0 ? _b : _this.modifierGroup;
+        _this.xAxisIdProperty = (_c = options === null || options === void 0 ? void 0 : options.xAxisId) !== null && _c !== void 0 ? _c : _this.xAxisIdProperty;
+        _this.yAxisIdProperty = (_d = options === null || options === void 0 ? void 0 : options.yAxisId) !== null && _d !== void 0 ? _d : _this.yAxisIdProperty;
         return _this;
     }
     Object.defineProperty(ChartModifierBase2D.prototype, "modifierType", {
@@ -92,6 +91,9 @@ var ChartModifierBase2D = /** @class */ (function (_super) {
     ChartModifierBase2D.prototype.getAllSeries = function () {
         return this.parentSurface.renderableSeries.asArray();
     };
+    /**
+     * @inheritDoc
+     */
     ChartModifierBase2D.prototype.toJSON = function () {
         var options = {
             id: this.id,
@@ -110,6 +112,7 @@ var ChartModifierBase2D = /** @class */ (function (_super) {
         if (!this.changedPropertiesList.includes(propertyName)) {
             this.changedPropertiesList.push(propertyName);
         }
+        _super.prototype.notifyPropertyChanged.call(this, propertyName);
     };
     /**
      * Grows the Axis by a fraction around the mouse point

package/Charting/ChartModifiers/CustomChartModifier2D.d.ts

@@ -0,0 +1,16 @@
+import { EChart2DModifierType } from "../../types/ChartModifierType";
+import { ChartModifierBase2D, IChartModifierBaseOptions } from "./ChartModifierBase2D";
+/**
+ * Base class for custom Chart Modifiers (allows custom zooming, panning, interaction behaviour) on 2D Charts
+ */
+export declare class CustomChartModifier2D extends ChartModifierBase2D {
+    /**
+     * @inheritDoc
+     */
+    readonly type: EChart2DModifierType;
+    /**
+     * @inheritDoc
+     * @param options
+     */
+    constructor(options?: IChartModifierBaseOptions);
+}

package/Charting/ChartModifiers/CustomChartModifier2D.js

@@ -0,0 +1,40 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomChartModifier2D = void 0;
+var ChartModifierType_1 = require("../../types/ChartModifierType");
+var ChartModifierBase2D_1 = require("./ChartModifierBase2D");
+/**
+ * Base class for custom Chart Modifiers (allows custom zooming, panning, interaction behaviour) on 2D Charts
+ */
+var CustomChartModifier2D = /** @class */ (function (_super) {
+    __extends(CustomChartModifier2D, _super);
+    /**
+     * @inheritDoc
+     * @param options
+     */
+    function CustomChartModifier2D(options) {
+        var _this = _super.call(this, options) || this;
+        /**
+         * @inheritDoc
+         */
+        _this.type = ChartModifierType_1.EChart2DModifierType.Custom;
+        return _this;
+    }
+    return CustomChartModifier2D;
+}(ChartModifierBase2D_1.ChartModifierBase2D));
+exports.CustomChartModifier2D = CustomChartModifier2D;

package/Charting/ChartModifiers/LegendModifier.d.ts

@@ -105,7 +105,7 @@ export declare class LegendModifier extends ChartModifierBase2D implements IIncl
     getIncludedRenderableSeries(): IRenderableSeries[];
     /** @inheritDoc */
     toJSON(): {
-        type: string;
+        type: string; /** @inheritDoc */
         options: Required<Omit<IChartModifierBaseOptions, never>>;
     };
     /** @inheritDoc */

package/Charting/ChartModifiers/YAxisDragModifier.d.ts

@@ -72,7 +72,9 @@ export declare class YAxisDragModifier extends ChartModifierBase2D implements II
      */
     modifierMouseUp(args: ModifierMouseArgs): void;
     toJSON(): {
-        type: string;
+        type: string; /**
+         * @inheritDoc
+         */
         options: Required<Omit<IChartModifierBaseOptions, never>>;
     };
     protected updateCursor(mousePoint: Point): void;

package/Charting3D/ChartModifiers/ChartModifierBase3D.d.ts

@@ -1,12 +1,26 @@
 import { ChartModifierBase, EModifierType } from "../../Charting/ChartModifiers/ChartModifierBase";
+import { EChart3DModifierType } from "../../types/ChartModifierType";
+import { EExecuteOn } from "../../types/ExecuteOn";
 import { SciChart3DSurface } from "../Visuals/SciChart3DSurface";
 export interface IChartModifierBase3DOptions {
+    /**
+     * A unique Id for the {@link ChartModifierBase3D}
+     */
+    id?: string;
+    /**
+     * Defines the operation that modifier should respond to
+     */
+    executeOn?: EExecuteOn;
 }
 /**
  * Defines a base class to a ChartModifier3D - a class which provides Zoom, Pan, Tooltip or interaction behavior
  * to SciChart - High Performance Realtime {@link https://www.scichart.com/javascript-chart-features | JavaScript 3D Charts}
  */
 export declare abstract class ChartModifierBase3D extends ChartModifierBase<SciChart3DSurface> {
+    /**
+     * The type of chartmodifier. See {@link EChart3DModifierType} for available options
+     */
+    abstract readonly type: EChart3DModifierType | string;
     /**
      * Creates an instance of a {@link ChartModifierBase3D}
      * @param options Optional parameters of type {@link IChartModifierBase3DOptions} used to configure the modifier
@@ -16,4 +30,8 @@ export declare abstract class ChartModifierBase3D extends ChartModifierBase<SciC
      * @inheritDoc
      */
     get modifierType(): EModifierType;
+    toJSON(): {
+        type: string;
+        options: Required<Omit<IChartModifierBase3DOptions, never>>;
+    };
 }

package/Charting3D/ChartModifiers/ChartModifierBase3D.js

@@ -28,7 +28,7 @@ var ChartModifierBase3D = /** @class */ (function (_super) {
      * @param options Optional parameters of type {@link IChartModifierBase3DOptions} used to configure the modifier
      */
     function ChartModifierBase3D(options) {
-        return _super.call(this) || this;
+        return _super.call(this, options) || this;
     }
     Object.defineProperty(ChartModifierBase3D.prototype, "modifierType", {
         /**
@@ -40,6 +40,13 @@ var ChartModifierBase3D = /** @class */ (function (_super) {
         enumerable: false,
         configurable: true
     });
+    ChartModifierBase3D.prototype.toJSON = function () {
+        var options = {
+            id: this.id,
+            executeOn: this.executeOn
+        };
+        return { type: this.type, options: options };
+    };
     return ChartModifierBase3D;
 }(ChartModifierBase_1.ChartModifierBase));
 exports.ChartModifierBase3D = ChartModifierBase3D;

package/Charting3D/ChartModifiers/CustomChartModifier3D.d.ts

@@ -0,0 +1,16 @@
+import { EChart3DModifierType } from "../../types/ChartModifierType";
+import { ChartModifierBase3D, IChartModifierBase3DOptions } from "./ChartModifierBase3D";
+/**
+ * Base class for custom Chart Modifiers (allows custom zooming, panning, interaction behaviour) on 2D Charts
+ */
+export declare class CustomChartModifier3D extends ChartModifierBase3D {
+    /**
+     * @inheritDoc
+     */
+    readonly type: EChart3DModifierType;
+    /**
+     * @inheritDoc
+     * @param options
+     */
+    constructor(options?: IChartModifierBase3DOptions);
+}

package/Charting3D/ChartModifiers/CustomChartModifier3D.js

@@ -0,0 +1,40 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomChartModifier3D = void 0;
+var ChartModifierType_1 = require("../../types/ChartModifierType");
+var ChartModifierBase3D_1 = require("./ChartModifierBase3D");
+/**
+ * Base class for custom Chart Modifiers (allows custom zooming, panning, interaction behaviour) on 2D Charts
+ */
+var CustomChartModifier3D = /** @class */ (function (_super) {
+    __extends(CustomChartModifier3D, _super);
+    /**
+     * @inheritDoc
+     * @param options
+     */
+    function CustomChartModifier3D(options) {
+        var _this = _super.call(this, options) || this;
+        /**
+         * @inheritDoc
+         */
+        _this.type = ChartModifierType_1.EChart3DModifierType.Custom;
+        return _this;
+    }
+    return CustomChartModifier3D;
+}(ChartModifierBase3D_1.ChartModifierBase3D));
+exports.CustomChartModifier3D = CustomChartModifier3D;

package/Charting3D/ChartModifiers/MouseWheelZoomModifier3D.d.ts

@@ -27,6 +27,7 @@ export interface IMouseWheelZoomModifier3DOptions extends IChartModifierBase3DOp
  * @remarks The speed of mouse-wheel zoom can be modified via the {@link MouseWheelZoomModifier3D.mouseWheelSensitivity} property.
  */
 export declare class MouseWheelZoomModifier3D extends ChartModifierBase3D {
+    readonly type = EChart3DModifierType.MouseWheelZoom;
     /**
      * The mouse wheel sensitifivity is a factor that determines how much the camera zooms when the mouse wheel scrolls.
      * Default value is 0.1
@@ -41,10 +42,11 @@ export declare class MouseWheelZoomModifier3D extends ChartModifierBase3D {
      * @inheritDoc
      */
     modifierMouseWheel(args: ModifierMouseArgs): void;
-    toJSON?(): {
-        type: EChart3DModifierType;
-        options: {
-            mouseWheelSensitivity: number;
-        };
+    /**
+     * @inheritDoc
+     */
+    toJSON(): {
+        type: string;
+        options: Required<Omit<IChartModifierBase3DOptions, never>>;
     };
 }

package/Charting3D/ChartModifiers/MouseWheelZoomModifier3D.js

@@ -42,6 +42,7 @@ var MouseWheelZoomModifier3D = /** @class */ (function (_super) {
      */
     function MouseWheelZoomModifier3D(options) {
         var _this = _super.call(this, options) || this;
+        _this.type = ChartModifierType_1.EChart3DModifierType.MouseWheelZoom;
         _this.mouseWheelSensitivity = (options === null || options === void 0 ? void 0 : options.mouseWheelSensitivity) || 0.1;
         return _this;
     }
@@ -70,12 +71,16 @@ var MouseWheelZoomModifier3D = /** @class */ (function (_super) {
         }
         args.handled = true;
     };
-    //@ts-ignore
+    /**
+     * @inheritDoc
+     */
     MouseWheelZoomModifier3D.prototype.toJSON = function () {
-        return {
-            type: ChartModifierType_1.EChart3DModifierType.MouseWheelZoom,
-            options: { mouseWheelSensitivity: this.mouseWheelSensitivity }
+        var json = _super.prototype.toJSON.call(this);
+        var options = {
+            mouseWheelSensitivity: this.mouseWheelSensitivity
         };
+        Object.assign(json.options, options);
+        return json;
     };
     return MouseWheelZoomModifier3D;
 }(ChartModifierBase3D_1.ChartModifierBase3D));

package/Charting3D/ChartModifiers/OrbitModifier3D.d.ts

@@ -1,6 +1,11 @@
 import { ModifierMouseArgs } from "../../Charting/ChartModifiers/ModifierMouseArgs";
 import { EChart3DModifierType } from "../../types/ChartModifierType";
-import { ChartModifierBase3D } from "./ChartModifierBase3D";
+import { ChartModifierBase3D, IChartModifierBase3DOptions } from "./ChartModifierBase3D";
+/**
+ * Optional parameters passed to the constructor of {@link OrbitModifier3D} to configure it
+ */
+export interface IOrbitModifier3DOptions extends IChartModifierBase3DOptions {
+}
 /**
  * @summary The {@link OrbitModifier3D} provides behavior to orbit around a target point on a 3D {@link SciChart3DSurface}
  * within SciChart - High Performance {@link https://www.scichart.com/javascript-chart-features | JavaScript 3D Charts}
@@ -15,9 +20,13 @@ import { ChartModifierBase3D } from "./ChartModifierBase3D";
  * ```
  */
 export declare class OrbitModifier3D extends ChartModifierBase3D {
+    /**
+     * @inheritDoc
+     */
+    readonly type = EChart3DModifierType.Orbit;
     private pointStart;
     private isDragging;
-    constructor();
+    constructor(options?: IOrbitModifier3DOptions);
     /**
      * @inheritDoc
      */
@@ -30,7 +39,4 @@ export declare class OrbitModifier3D extends ChartModifierBase3D {
      * @inheritDoc
      */
     modifierMouseUp(args: ModifierMouseArgs): void;
-    toJSON(): {
-        type: EChart3DModifierType;
-    };
 }

package/Charting3D/ChartModifiers/OrbitModifier3D.js

@@ -34,8 +34,13 @@ var ChartModifierBase3D_1 = require("./ChartModifierBase3D");
  */
 var OrbitModifier3D = /** @class */ (function (_super) {
     __extends(OrbitModifier3D, _super);
-    function OrbitModifier3D() {
-        return _super.call(this) || this;
+    function OrbitModifier3D(options) {
+        var _this = _super.call(this, options) || this;
+        /**
+         * @inheritDoc
+         */
+        _this.type = ChartModifierType_1.EChart3DModifierType.Orbit;
+        return _this;
     }
     /**
      * @inheritDoc
@@ -80,9 +85,6 @@ var OrbitModifier3D = /** @class */ (function (_super) {
         this.isDragging = false;
         this.pointStart = undefined;
     };
-    OrbitModifier3D.prototype.toJSON = function () {
-        return { type: ChartModifierType_1.EChart3DModifierType.Orbit };
-    };
     return OrbitModifier3D;
 }(ChartModifierBase3D_1.ChartModifierBase3D));
 exports.OrbitModifier3D = OrbitModifier3D;

package/Charting3D/ChartModifiers/ResetCamera3DModifier.d.ts

@@ -17,7 +17,7 @@ export interface IResetCamera3DOptions extends IChartModifierBase3DOptions {
     /**
      * Defines the easing function for animation. See {@link TEasingFn} for a range of functions
      */
-    easingFunction?: TEasingFn;
+    easingFunction?: TEasingFn | string;
     /**
      * The camera settings to reset to.  Defaults to the camera state when the modifier was attached to the chart.
      */
@@ -45,6 +45,10 @@ export declare type TCameraState = {
  *
  */
 export declare class ResetCamera3DModifier extends ChartModifierBase3D {
+    /**
+     * @inheritDoc
+     */
+    readonly type = EChart3DModifierType.ZoomExtents;
     /**
      * When true, the Zoom operations are animated. See also {@link animationDuration} and {@link easingFunction}
      */
@@ -68,12 +72,11 @@ export declare class ResetCamera3DModifier extends ChartModifierBase3D {
      * @inheritDoc
      */
     modifierDoubleClick(args: ModifierMouseArgs): void;
-    toJSON?(): {
-        type: EChart3DModifierType;
-        options: {
-            animationDuration: number;
-            easingFunction: string;
-            isAnimated: boolean;
-        };
+    /**
+     * @inheritDoc
+     */
+    toJSON(): {
+        type: string;
+        options: Required<Omit<IChartModifierBase3DOptions, never>>;
     };
 }

package/Charting3D/ChartModifiers/ResetCamera3DModifier.js

@@ -46,6 +46,10 @@ var ResetCamera3DModifier = /** @class */ (function (_super) {
         var _this = this;
         var _a, _b, _c;
         _this = _super.call(this, options) || this;
+        /**
+         * @inheritDoc
+         */
+        _this.type = ChartModifierType_1.EChart3DModifierType.ZoomExtents;
         /**
          * When true, the Zoom operations are animated. See also {@link animationDuration} and {@link easingFunction}
          */
@@ -64,6 +68,7 @@ var ResetCamera3DModifier = /** @class */ (function (_super) {
             options.easingFunction = EasingFunctions_1.easing[options.easingFunction];
         }
         _this.easingFunction = (_c = options === null || options === void 0 ? void 0 : options.easingFunction) !== null && _c !== void 0 ? _c : EasingFunctions_1.easing.outExpo;
+        _this.destination = options === null || options === void 0 ? void 0 : options.destination;
         return _this;
     }
     ResetCamera3DModifier.prototype.onAttach = function () {
@@ -128,16 +133,19 @@ var ResetCamera3DModifier = /** @class */ (function (_super) {
         }
         args.handled = true;
     };
-    // @ts-ignore
+    /**
+     * @inheritDoc
+     */
     ResetCamera3DModifier.prototype.toJSON = function () {
-        return {
-            type: ChartModifierType_1.EChart3DModifierType.ZoomExtents,
-            options: {
-                animationDuration: this.animationDuration,
-                easingFunction: this.easingFunction.name,
-                isAnimated: this.isAnimated
-            }
+        var json = _super.prototype.toJSON.call(this);
+        var options = {
+            animationDuration: this.animationDuration,
+            easingFunction: this.easingFunction.name,
+            isAnimated: this.isAnimated,
+            destination: this.destination
         };
+        Object.assign(json.options, options);
+        return json;
     };
     return ResetCamera3DModifier;
 }(ChartModifierBase3D_1.ChartModifierBase3D));

package/Core/BuildStamp.d.ts

@@ -1,4 +1,4 @@
 import { TSciChart } from "../types/TSciChart";
 import { TSciChart3D } from "../types/TSciChart3D";
-export declare const libraryVersion = "3.0.300";
+export declare const libraryVersion = "3.0.301";
 export declare const checkBuildStamp: (wasmContext: TSciChart | TSciChart3D) => boolean;

package/Core/BuildStamp.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.checkBuildStamp = exports.libraryVersion = void 0;
-var buildStamp = "2023-02-17T00:00:00";
+var buildStamp = "2023-02-27T00:00:00";
 var result;
 // tslint:disable-next-line:no-var-requires
-exports.libraryVersion = "3.0.300";
+exports.libraryVersion = "3.0.301";
 var checkBuildStamp = function (wasmContext) {
     if (result !== undefined)
         return result;