scichart 3.1.348 → 3.2.434

package/Charting3D/Visuals/SciChart3DSurface.d.ts

@@ -1,13 +1,14 @@
 import { IChartModifierBase } from "../../Charting/ChartModifiers/ChartModifierBase";
 import { IThemeProvider } from "../../Charting/Themes/IThemeProvider";
-import { I2DSurfaceOptions } from "../../Charting/Visuals/I2DSurfaceOptions";
 import { ESurfaceType, SciChartSurfaceBase, TSciChartConfig } from "../../Charting/Visuals/SciChartSurfaceBase";
 import { TDpiChangedEventArgs } from "../../Charting/Visuals/TextureManager/DpiHelper";
 import { IGenericAnimation } from "../../Core/Animations/GenericAnimation";
 import { ObservableArray } from "../../Core/ObservableArray";
+import { Point } from "../../Core/Point";
 import { SCRTSceneWorld, TSciChart3D as TWasmContext } from "../../types/TSciChart3D";
 import { TSciChartSurfaceCanvases } from "../../types/TSciChartSurfaceCanvases";
 import { ICameraController } from "../CameraController";
+import { I3DSurfaceOptions } from "../I3DSurfaceOptions";
 import { Vector3 } from "../Vector3";
 import { AxisBase3D } from "./Axis/AxisBase3D";
 import { AxisCubeEntity } from "./Axis/AxisCubeEntity";
@@ -15,6 +16,8 @@ import { IRenderableSeries3D } from "./RenderableSeries/BaseRenderableSeries3D";
 import { RootSceneEntity } from "./RootSceneEntity";
 import { ViewportManager3DBase } from "./ViewportManager3DBase";
 import { EWatermarkPosition } from "../../types/WatermarkPosition";
+import { EventHandler } from "../../Core/EventHandler";
+import { Thickness } from "../../Core/Thickness";
 export declare type TSciChart3D = TWasmContext;
 export declare type TWebAssemblyChart3D = {
     wasmContext: TSciChart3D;
@@ -60,9 +63,9 @@ export declare class SciChart3DSurface extends SciChartSurfaceBase {
     /**
      * USED INTERNALLY - performs a similar operation to {@link SciChart3DSurface.create} but used internally for testing
      * @param divElement The Div Element ID or reference where the {@link SciChartSurface} will reside
-     * @param options Optional parameters of type {@link I2DSurfaceOptions}
+     * @param options Optional parameters of type {@link I3DSurfaceOptions}
      */
-    static createSingle(divElement: string | HTMLDivElement, options?: I2DSurfaceOptions): Promise<TWebAssemblyChart3D>;
+    static createSingle(divElement: string | HTMLDivElement, options?: I3DSurfaceOptions): Promise<TWebAssemblyChart3D>;
     /**
      * Allows setting of web URL for Wasm and Data files, in the case you are loading SciChart outside of npm/webpack environment.
      * Note if loading from CDN the version number of data/wasm Urls must match the version number of SciChart.js you are using.
@@ -84,10 +87,11 @@ export declare class SciChart3DSurface extends SciChartSurfaceBase {
     /**
      * Creates a {@link SciChart3DSurface} and {@link TSciChart3D | WebAssembly Context} to occupy the div by element ID in your DOM.
      * @remarks This method is async and must be awaited
-     * @param divElementId The Div Element ID where the {@link SciChart3DSurface} will reside
-     * @param options Optional parameters of type {@link IChartCreationOptions}
+     * @param divElementId The ID or reference of Div Element where the {@link SciChart3DSurface} will reside
+     * @param options Optional parameters of type {@link I3DSurfaceOptions}
      */
-    static create(divElementId: string, options?: I2DSurfaceOptions): Promise<TWebAssemblyChart3D>;
+    static create(divElementId: string | HTMLDivElement, options?: I3DSurfaceOptions): Promise<TWebAssemblyChart3D>;
+    static disposeSharedWasmContext(): void;
     /**
      * @summary Gets the collection of {@link IRenderableSeries3D} - the chart types or seres on this {@link SciChart3DSurface}
      * @description A {@link SciChart3DSurface} can have zero to many {@link IRenderableSeries3D | RenderableSeries}.
@@ -124,6 +128,11 @@ export declare class SciChart3DSurface extends SciChartSurfaceBase {
     readonly webAssemblyContext3D: TSciChart3D;
     /** The position of the watermark for trials and community licenses */
     watermarkPosition: EWatermarkPosition;
+    /**
+     * An event handler which notifies its subscribers when a render operation starts. Use this
+     * to update elements of the chart for the current render.  Any updates made here will not trigger a subsequent render.
+     */
+    preRender: EventHandler<void>;
     protected animationList: IGenericAnimation[];
     private xAxisProperty;
     private yAxisProperty;
@@ -137,6 +146,7 @@ export declare class SciChart3DSurface extends SciChartSurfaceBase {
     private watermarkPropertyPosition;
     private isAxisCubeRenderedProperty;
     private sceneWorldProperty;
+    private isHitTestEnabledProperty;
     /**
      * Creates an instance of {@link SciChart3DSurface}
      * @param webAssemblyContext The {@link TSciChart3D | SciChart 3D WebAssembly Context} containing native methods and
@@ -148,10 +158,20 @@ export declare class SciChart3DSurface extends SciChartSurfaceBase {
      * Used internally: Gets the {@link SCRTSceneWorld} object at the root of the 3d scene graph
      */
     getSceneWorld(): SCRTSceneWorld;
+    /**
+     * Converts a 3D Xyz coordinate in world coordinates space to a screen coordinate (2d) in pixels.
+     * This allows you to get the 2D screen coordinate of any object or vertex in the 3D scene.
+     * @remarks Note: Conversions to/from world/data space must be performed using the {@link AxisBase3D.getCurrentCoordinateCalculator()}
+     * API, which returns {@link CoordinateCalculatorBase}. Functions {@link CoordinateCalculatorBase.getDataValue} and
+     * {@link CoordinateCalculatorBase.getCoordinate} convert to/from world coords/data space
+     * @param worldCoordXyz The 3D Xyz coordinate
+     * @returns The 2D screen coordinate in pixels
+     */
+    worldToScreenCoord(worldCoordXyz: Vector3): Point;
     /**
      * @inheritdoc
      */
-    delete(): void;
+    delete(clearHtml?: boolean): void;
     /**
      * Gets or sets whether the Xyz gizmo is enabled - a small 3D Xyz axis on the bottom left of the 3D Chart
      */
@@ -224,6 +244,24 @@ export declare class SciChart3DSurface extends SciChartSurfaceBase {
      * @remarks Axis types which derive from {@link AxisBase3D} or concrete type {@link NumericAxis3D} are valid
      */
     set zAxis(zAxis: AxisBase3D);
+    /**
+     * Required to enable Hit-Test if any of the following functions are needed in SciChart3DSurface:
+     *  - {@link BaseRenderableSeries3D.hitTest}
+     *  - {@link TooltipModiifer3D}
+     *
+     *  Enabling hit-test adds minor a performance overhead for drawing and should be disabled if not required.
+     * @param isEnabled
+     */
+    set isHitTestEnabled(isEnabled: boolean);
+    /**
+     * Required to enable Hit-Test if any of the following functions are needed in SciChart3DSurface:
+     *  - {@link BaseRenderableSeries3D.hitTest}
+     *  - {@link TooltipModiifer3D}
+     *
+     *  Enabling hit-test adds minor a performance overhead for drawing and should be disabled if not required.
+     * @param isEnabled
+     */
+    get isHitTestEnabled(): boolean;
     /**
      * Called internally
      * Sets isAxisCubeRenderedProperty flag after Axis Cube is rendered
@@ -282,10 +320,20 @@ export declare class SciChart3DSurface extends SciChartSurfaceBase {
      * @param timeElapsed
      */
     onAnimate(timeElapsed: number): void;
+    /**
+     * @inheritDoc
+     */
+    getXAxisById(axisId: string): AxisBase3D;
+    /**
+     * @inheritDoc
+     */
+    getYAxisById(axisId: string): AxisBase3D;
     /**
      * @inheritDoc
      */
     updateWatermark(left: number, bottom: number): void;
+    getSeriesViewRectPadding(scaled: boolean): Thickness;
+    protected applyOptions(options: I3DSurfaceOptions): void;
     /**
      * @inheritDoc
      */

package/Charting3D/Visuals/SciChart3DSurface.js

@@ -21,6 +21,7 @@ var DpiHelper_1 = require("../../Charting/Visuals/TextureManager/DpiHelper");
 var app_1 = require("../../constants/app");
 var Deleter_1 = require("../../Core/Deleter");
 var ObservableArray_1 = require("../../Core/ObservableArray");
+var Point_1 = require("../../Core/Point");
 var CameraController_1 = require("../CameraController");
 var Vector3_1 = require("../Vector3");
 var AxisCubeEntity_1 = require("./Axis/AxisCubeEntity");
@@ -33,6 +34,11 @@ var RootSceneEntity_1 = require("./RootSceneEntity");
 var SciChart3DRenderer_1 = require("./SciChart3DRenderer");
 var BuildStamp_1 = require("../../Core/BuildStamp");
 var SciChartDefaults_1 = require("../../Charting/Visuals/SciChartDefaults");
+var WebGlHelper_1 = require("../../Core/WebGlHelper");
+var Globals_1 = require("../../Core/Globals");
+var createMaster_1 = require("../../Charting/Visuals/createMaster");
+var EventHandler_1 = require("../../Core/EventHandler");
+var Thickness_1 = require("../../Core/Thickness");
 exports.sciChartConfig3D = {};
 /**
  * @summary The {@link SciChart3DSurface} is the root 3D Chart control in SciChart's High Performance Real-time
@@ -64,8 +70,14 @@ var SciChart3DSurface = /** @class */ (function (_super) {
         _this = _super.call(this, webAssemblyContext, options === null || options === void 0 ? void 0 : options.canvases) || this;
         /** The position of the watermark for trials and community licenses */
         _this.watermarkPosition = SciChartDefaults_1.SciChartDefaults.watermarkPosition;
+        /**
+         * An event handler which notifies its subscribers when a render operation starts. Use this
+         * to update elements of the chart for the current render.  Any updates made here will not trigger a subsequent render.
+         */
+        _this.preRender = new EventHandler_1.EventHandler();
         _this.animationList = [];
         _this.isAxisCubeRenderedProperty = false;
+        _this.isHitTestEnabledProperty = false;
         var canvasWidth = (_b = (_a = _this.domCanvas2D) === null || _a === void 0 ? void 0 : _a.width) !== null && _b !== void 0 ? _b : app_1.DEFAULT_WIDTH;
         var canvasHeight = (_d = (_c = _this.domCanvas2D) === null || _c === void 0 ? void 0 : _c.height) !== null && _d !== void 0 ? _d : app_1.DEFAULT_HEIGHT;
         _this.webAssemblyContext3D = webAssemblyContext;
@@ -82,7 +94,7 @@ var SciChart3DSurface = /** @class */ (function (_super) {
         _this.invalidateElement = _this.invalidateElement.bind(_this);
         _this.sciChart3DRenderer = new SciChart3DRenderer_1.SciChart3DRenderer(_this, webAssemblyContext);
         // Set default viewportManager
-        _this.viewportManager = new DefaultViewportManager3D_1.DefaultViewportManager3D();
+        _this.viewportManager = new DefaultViewportManager3D_1.DefaultViewportManager3D(canvasWidth, canvasHeight);
         // Set default WorldDimensions
         _this.worldDimensionsProperty = (options === null || options === void 0 ? void 0 : options.worldDimensions) || new Vector3_1.Vector3(300, 200, 300);
         // Setup series
@@ -94,9 +106,8 @@ var SciChart3DSurface = /** @class */ (function (_super) {
             (_a = args.getOldItems()) === null || _a === void 0 ? void 0 : _a.forEach(function (rs) { return _this.detachSeries(rs); });
             (_b = args.getNewItems()) === null || _b === void 0 ? void 0 : _b.forEach(function (rs) { return _this.attachSeries(rs); });
         });
-        // Set default camera
+        // Set default scene
         _this.childPropertyChanged = _this.childPropertyChanged.bind(_this);
-        _this.camera = (options === null || options === void 0 ? void 0 : options.camera) || new CameraController_1.CameraController(_this.webAssemblyContext3D);
         _this.sceneWorldProperty = new _this.webAssemblyContext3D.SCRTSceneWorld();
         _this.sceneWorldProperty.Init();
         _this.rootEntity = new RootSceneEntity_1.RootSceneEntity(webAssemblyContext, _this);
@@ -119,10 +130,13 @@ var SciChart3DSurface = /** @class */ (function (_super) {
     /**
      * USED INTERNALLY - performs a similar operation to {@link SciChart3DSurface.create} but used internally for testing
      * @param divElement The Div Element ID or reference where the {@link SciChartSurface} will reside
-     * @param options Optional parameters of type {@link I2DSurfaceOptions}
+     * @param options Optional parameters of type {@link I3DSurfaceOptions}
      */
     SciChart3DSurface.createSingle = function (divElement, options) {
-        return (0, createSingle3d_1.createSingle3dInternal)(divElement, options);
+        return (0, createSingle3d_1.createSingle3dInternal)(divElement, options).then(function (result) {
+            result.sciChart3DSurface.applyOptions(options);
+            return result;
+        });
     };
     /**
      * Allows setting of web URL for Wasm and Data files, in the case you are loading SciChart outside of npm/webpack environment.
@@ -152,11 +166,21 @@ var SciChart3DSurface = /** @class */ (function (_super) {
     /**
      * Creates a {@link SciChart3DSurface} and {@link TSciChart3D | WebAssembly Context} to occupy the div by element ID in your DOM.
      * @remarks This method is async and must be awaited
-     * @param divElementId The Div Element ID where the {@link SciChart3DSurface} will reside
-     * @param options Optional parameters of type {@link IChartCreationOptions}
+     * @param divElementId The ID or reference of Div Element where the {@link SciChart3DSurface} will reside
+     * @param options Optional parameters of type {@link I3DSurfaceOptions}
      */
     SciChart3DSurface.create = function (divElementId, options) {
-        return (0, createMaster3d_1.createMultichart3d)(divElementId, options);
+        return (0, createMaster3d_1.createMultichart3d)(divElementId, options).then(function (result) {
+            result.sciChart3DSurface.applyOptions(options);
+            return result;
+        });
+    };
+    SciChart3DSurface.disposeSharedWasmContext = function () {
+        if (Globals_1.sciChart3DDestinations.length === 0 && Globals_1.sciChartDestinations.length === 0) {
+            (0, createMaster_1.disposeMultiChart)();
+            (0, createMaster3d_1.disposeMultiChart3d)();
+        }
+        _super.disposeSharedWasmContext.call(this);
     };
     /**
      * Used internally: Gets the {@link SCRTSceneWorld} object at the root of the 3d scene graph
@@ -164,11 +188,31 @@ var SciChart3DSurface = /** @class */ (function (_super) {
     SciChart3DSurface.prototype.getSceneWorld = function () {
         return this.sceneWorldProperty;
     };
+    /**
+     * Converts a 3D Xyz coordinate in world coordinates space to a screen coordinate (2d) in pixels.
+     * This allows you to get the 2D screen coordinate of any object or vertex in the 3D scene.
+     * @remarks Note: Conversions to/from world/data space must be performed using the {@link AxisBase3D.getCurrentCoordinateCalculator()}
+     * API, which returns {@link CoordinateCalculatorBase}. Functions {@link CoordinateCalculatorBase.getDataValue} and
+     * {@link CoordinateCalculatorBase.getCoordinate} convert to/from world coords/data space
+     * @param worldCoordXyz The 3D Xyz coordinate
+     * @returns The 2D screen coordinate in pixels
+     */
+    SciChart3DSurface.prototype.worldToScreenCoord = function (worldCoordXyz) {
+        var sceneWorld = this.getSceneWorld();
+        if (!sceneWorld)
+            return undefined;
+        var tsrWorldXyz = worldCoordXyz.toTsrVector3(this.webAssemblyContext3D);
+        var tsrScreen2D = sceneWorld.TransformWorldToScreenCoords(tsrWorldXyz);
+        var screen2D = new Point_1.Point(tsrScreen2D.x, tsrScreen2D.y);
+        tsrScreen2D.delete();
+        tsrWorldXyz.delete();
+        return screen2D;
+    };
     /**
      * @inheritdoc
      */
-    SciChart3DSurface.prototype.delete = function () {
-        _super.prototype.delete.call(this);
+    SciChart3DSurface.prototype.delete = function (clearHtml) {
+        if (clearHtml === void 0) { clearHtml = true; }
         this.renderableSeries.asArray().forEach(function (el) { return el.delete(); });
         this.renderableSeries.clear();
         this.xAxis = (0, Deleter_1.deleteSafe)(this.xAxis);
@@ -181,6 +225,8 @@ var SciChart3DSurface = /** @class */ (function (_super) {
         if (!app_1.IS_TEST_ENV) {
             this.webAssemblyContext3D.SCRTSetActiveWorld(null);
         }
+        this.clearRootElement(clearHtml);
+        _super.prototype.delete.call(this);
     };
     Object.defineProperty(SciChart3DSurface.prototype, "enableGizmo", {
         /**
@@ -328,6 +374,35 @@ var SciChart3DSurface = /** @class */ (function (_super) {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(SciChart3DSurface.prototype, "isHitTestEnabled", {
+        /**
+         * Required to enable Hit-Test if any of the following functions are needed in SciChart3DSurface:
+         *  - {@link BaseRenderableSeries3D.hitTest}
+         *  - {@link TooltipModiifer3D}
+         *
+         *  Enabling hit-test adds minor a performance overhead for drawing and should be disabled if not required.
+         * @param isEnabled
+         */
+        get: function () {
+            return this.isHitTestEnabledProperty;
+        },
+        /**
+         * Required to enable Hit-Test if any of the following functions are needed in SciChart3DSurface:
+         *  - {@link BaseRenderableSeries3D.hitTest}
+         *  - {@link TooltipModiifer3D}
+         *
+         *  Enabling hit-test adds minor a performance overhead for drawing and should be disabled if not required.
+         * @param isEnabled
+         */
+        set: function (isEnabled) {
+            if (isEnabled !== this.isHitTestEnabledProperty) {
+                this.isHitTestEnabledProperty = isEnabled;
+                this.invalidateElement();
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
     /**
      * Called internally
      * Sets isAxisCubeRenderedProperty flag after Axis Cube is rendered
@@ -350,11 +425,16 @@ var SciChart3DSurface = /** @class */ (function (_super) {
      * @inheritDoc
      */
     SciChart3DSurface.prototype.invalidateElement = function () {
+        var _a;
         // When isSuspended (see suspendUpdates() function) ignore drawing
-        if (this.isSuspended) {
+        if (this.isSuspended || this.isDeleted) {
             // Logger.log("SciChart3DSurface.isSuspended = true. Ignoring invalidateElement() call");
             return;
         }
+        // Prevent drawing request when WebGL context is lost
+        if ((_a = WebGlHelper_1.WebGlHelper.getContext(this.webAssemblyContext3D.canvas)) === null || _a === void 0 ? void 0 : _a.isContextLost()) {
+            return;
+        }
         var canvasId = this.domCanvas2D ? this.domCanvas2D.id : "undefinedCanvasId";
         this.webAssemblyContext3D.TSRRequestCanvasDraw(canvasId);
     };
@@ -382,7 +462,10 @@ var SciChart3DSurface = /** @class */ (function (_super) {
      * Called after the {@link SciChart3DSurface} has rendered.
      */
     SciChart3DSurface.prototype.onSciChartRendered = function () {
-        // TODO - event after rendered
+        this.chartModifiers.asArray().forEach(function (cm) {
+            cm.onParentSurfaceRendered();
+        });
+        this.rendered.raiseEvent();
     };
     /**
      * Called internally - the main drawing loop
@@ -406,9 +489,12 @@ var SciChart3DSurface = /** @class */ (function (_super) {
      * @inheritDoc
      */
     SciChart3DSurface.prototype.changeViewportSize = function (pixelWidth, pixelHeight) {
-        if (!pixelWidth || !pixelHeight) {
+        if (!pixelWidth || !pixelHeight || this.isDeleted) {
             return;
         }
+        var backBufferWidth = pixelWidth * DpiHelper_1.DpiHelper.PIXEL_RATIO;
+        var backBufferHeight = pixelHeight * DpiHelper_1.DpiHelper.PIXEL_RATIO;
+        this.viewportManager.setSize(backBufferWidth, backBufferHeight);
         if (this.isCopyCanvasSurface) {
             this.changeMasterCanvasViewportSize(this.webAssemblyContext3D, pixelWidth, pixelHeight);
             if (this.domCanvas2D) {
@@ -418,6 +504,21 @@ var SciChart3DSurface = /** @class */ (function (_super) {
         else {
             this.changeWebGLCanvasViewportSize(this.webAssemblyContext3D, pixelWidth, pixelHeight);
         }
+        var svgRootElement = this.domSvgContainer;
+        if (svgRootElement) {
+            // Set width, height
+            svgRootElement.setAttribute("width", pixelWidth.toString());
+            svgRootElement.setAttribute("height", pixelHeight.toString());
+            // Set display width, height
+            svgRootElement.style.width = pixelWidth + "px";
+            svgRootElement.style.height = pixelHeight + "px";
+            // Set scaling so annotations, tooltips etc are in right position after DPI Scaling
+            svgRootElement.currentScale = 1;
+        }
+        if (this.domSvgAdornerLayer) {
+            this.domSvgAdornerLayer.setAttribute("width", pixelWidth.toString());
+            this.domSvgAdornerLayer.setAttribute("height", pixelHeight.toString());
+        }
         this.invalidateElement();
     };
     /**
@@ -475,6 +576,18 @@ var SciChart3DSurface = /** @class */ (function (_super) {
             this.animationList = remainingAnimations;
         }
     };
+    /**
+     * @inheritDoc
+     */
+    SciChart3DSurface.prototype.getXAxisById = function (axisId) {
+        return this.xAxis;
+    };
+    /**
+     * @inheritDoc
+     */
+    SciChart3DSurface.prototype.getYAxisById = function (axisId) {
+        return this.yAxis;
+    };
     /**
      * @inheritDoc
      */
@@ -490,6 +603,16 @@ var SciChart3DSurface = /** @class */ (function (_super) {
             this.webAssemblyContext3D.SCRT3DSetWaterMarkProperties(this.watermarkProperties);
         }
     };
+    SciChart3DSurface.prototype.getSeriesViewRectPadding = function (scaled) {
+        return Thickness_1.Thickness.fromNumber(0);
+    };
+    SciChart3DSurface.prototype.applyOptions = function (options) {
+        _super.prototype.applyOptions.call(this, options);
+        this.camera = new CameraController_1.CameraController(this.webAssemblyContext3D, options === null || options === void 0 ? void 0 : options.cameraOptions);
+        if (options === null || options === void 0 ? void 0 : options.worldDimensions) {
+            this.worldDimensions = options.worldDimensions;
+        }
+    };
     /**
      * @inheritDoc
      */

package/Charting3D/Visuals/ViewportManager3DBase.d.ts

@@ -14,6 +14,10 @@ export declare abstract class ViewportManager3DBase {
      * The parent {@link SciChart3DSurface} when attached
      */
     parentSurface: SciChart3DSurface;
+    width: number;
+    height: number;
+    constructor(width: number, height: number);
+    setSize(width: number, height: number): void;
     /**
      * Called when attached to a {@link SciChart3DSurface}
      * @param scs The {@link SciChart3DSurface}

package/Charting3D/Visuals/ViewportManager3DBase.js

@@ -7,8 +7,14 @@ var AutoRange_1 = require("../../types/AutoRange");
  * on a {@link SciChart3DSurface}
  */
 var ViewportManager3DBase = /** @class */ (function () {
-    function ViewportManager3DBase() {
+    function ViewportManager3DBase(width, height) {
+        this.width = width;
+        this.height = height;
     }
+    ViewportManager3DBase.prototype.setSize = function (width, height) {
+        this.width = width;
+        this.height = height;
+    };
     /**
      * Called when attached to a {@link SciChart3DSurface}
      * @param scs The {@link SciChart3DSurface}

package/Charting3D/Visuals/createMaster3d.d.ts

@@ -1,7 +1,6 @@
 import { I2DSurfaceOptions } from "../../Charting/Visuals/I2DSurfaceOptions";
-import { TSciChartDestination } from "../../Charting/Visuals/SciChartSurfaceBase";
 import { TWebAssemblyChart3D } from "./SciChart3DSurface";
 /** @ignore */
 export declare const createMultichart3d: (divElement: string | HTMLDivElement, options?: I2DSurfaceOptions) => Promise<TWebAssemblyChart3D>;
 /** @ignore */
-export declare const sciChartDestinations: TSciChartDestination[];
+export declare const disposeMultiChart3d: () => void;

package/Charting3D/Visuals/createMaster3d.js

@@ -36,14 +36,19 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sciChartDestinations = exports.createMultichart3d = void 0;
+exports.disposeMultiChart3d = exports.createMultichart3d = void 0;
 // @ts-ignore
 var WasmModule3D = require("../../_wasm/scichart3d");
 var chartBuilder_1 = require("../../Builder/chartBuilder");
+var licenseManager2D_1 = require("../../Charting/Visuals/licenseManager2D");
 var loader_1 = require("../../Charting/Visuals/loader");
+var SciChartDefaults_1 = require("../../Charting/Visuals/SciChartDefaults");
 var sciChartInitCommon_1 = require("../../Charting/Visuals/sciChartInitCommon");
 var SciChartSurfaceBase_1 = require("../../Charting/Visuals/SciChartSurfaceBase");
 var BuildStamp_1 = require("../../Core/BuildStamp");
+var DeletableEntity_1 = require("../../Core/DeletableEntity");
+var Globals_1 = require("../../Core/Globals");
+var MemoryUsageHelper_1 = require("../../utils/MemoryUsageHelper");
 var licenseManager3D_1 = require("./licenseManager3D");
 var SciChart3DSurface_1 = require("./SciChart3DSurface");
 /** @ignore */
@@ -63,7 +68,7 @@ var createMultichart3d = function (divElement, options) { return __awaiter(void
             case 0:
                 (0, chartBuilder_1.ensureRegistrations)();
                 sciChartInitCommon_1.default.checkChartDivExists(divElement);
-                canvases = sciChartInitCommon_1.default.initCanvas(divElement, (_a = options === null || options === void 0 ? void 0 : options.widthAspect) !== null && _a !== void 0 ? _a : 0, (_b = options === null || options === void 0 ? void 0 : options.heightAspect) !== null && _b !== void 0 ? _b : 0, sciChartInitCommon_1.default.ECanvasType.canvas2D);
+                canvases = sciChartInitCommon_1.default.initCanvas(divElement, (_a = options === null || options === void 0 ? void 0 : options.widthAspect) !== null && _a !== void 0 ? _a : 0, (_b = options === null || options === void 0 ? void 0 : options.heightAspect) !== null && _b !== void 0 ? _b : 0, sciChartInitCommon_1.default.ECanvasType.canvas2D, undefined, options === null || options === void 0 ? void 0 : options.touchAction);
                 loader = (_c = options === null || options === void 0 ? void 0 : options.loader) !== null && _c !== void 0 ? _c : new loader_1.DefaultSciChartLoader();
                 loaderDiv = loader.addChartLoader(canvases.domDivContainer, (_d = options === null || options === void 0 ? void 0 : options.theme) !== null && _d !== void 0 ? _d : SciChartSurfaceBase_1.SciChartSurfaceBase.DEFAULT_THEME);
                 _f.label = 1;
@@ -105,14 +110,25 @@ var createMultichart3d = function (divElement, options) { return __awaiter(void
     });
 }); };
 exports.createMultichart3d = createMultichart3d;
+var cleanupWasmContext;
 /** @ignore */
-exports.sciChartDestinations = [];
+var disposeMultiChart3d = function () {
+    if (cleanupWasmContext) {
+        cleanupWasmContext();
+    }
+    sciChartMaster3D.createChildSurface = undefined;
+    sciChartMaster3D.getChildSurfaces = undefined;
+    sciChartMaster3D.wasmContext = undefined;
+    sciChartMaster3DPromise = undefined;
+    licenseManager2D_1.licenseManager.clear();
+};
+exports.disposeMultiChart3d = disposeMultiChart3d;
 /** @ignore */
 var createMaster = function () {
     var createChildSurfaceInner = function (wasmContext, divElementId, canvases, theme) {
         var sciChart3DSurface = new SciChart3DSurface_1.SciChart3DSurface(wasmContext, { canvases: canvases });
         sciChart3DSurface.applyTheme(theme);
-        sciChart3DSurface.setDestinations(exports.sciChartDestinations);
+        sciChart3DSurface.setDestinations(Globals_1.sciChart3DDestinations);
         var unsub = sciChartInitCommon_1.default.subscribeToResize(canvases.domChartRoot, canvases.aspect, sciChart3DSurface);
         sciChart3DSurface.addDeletable(unsub);
         return sciChart3DSurface;
@@ -125,28 +141,77 @@ var createMaster = function () {
         }
         var dest = wasmContext.SCRTSurfaceDestination.implement(newDestination);
         chartInitObj3D.AddDestination(dest);
-        exports.sciChartDestinations.push({ canvasElementId: canvasElementId, sciChartSurface: sciChartSurface, width: width, height: height });
+        Globals_1.sciChart3DDestinations.push({ canvasElementId: canvasElementId, sciChartSurface: sciChartSurface, width: width, height: height });
     };
     return new Promise(function (resolve, reject) {
         var locateFile = (0, SciChartSurfaceBase_1.getLocateFile)(SciChart3DSurface_1.sciChartConfig3D);
         // @ts-ignore
         new WasmModule3D({ locateFile: locateFile, noInitialRun: true })
-            .then(function (wasmContext) {
-            var getChildSurfaces = function () { return exports.sciChartDestinations.map(function (el) { return el.sciChartSurface; }); };
+            .then(function (originalWasmContext) {
+            var revocable = (0, DeletableEntity_1.createWasmContextRevocableProxy)(originalWasmContext);
+            var wasmContext = revocable.proxy;
+            cleanupWasmContext = function () {
+                // Halt the engine
+                wasmContext.TSRRequestExit();
+                frameRenderer3D.delete();
+                // wasmContext.SCRTGetGlobalSampleChartInterface().GetFrameRenderer().delete();
+                wasmContext.SCRTGetGlobalSampleChartInterface().SetFrameRenderer(null);
+                wasmContext.SCRTGetGlobalSampleChartInterface().delete();
+                wasmContext.SCRTSetGlobalSampleChartInterface(null);
+                // deleteCache(wasmContext);
+                canvasCopyObj.delete();
+                wasmContext.SCRTSetGlobalCopyToDestinationInterface(null);
+                revocable.revoke();
+                revocable = undefined;
+                cleanupWasmContext = undefined;
+            };
+            var getChildSurfaces = function () {
+                return Globals_1.sciChart3DDestinations.map(function (el) { return el.sciChartSurface; });
+            };
             // Create of replace child surface
             var createChildSurface = function (divElementId, canvases, theme) {
                 var canvas2dId = sciChartInitCommon_1.default.getCanvas2dId(divElementId);
-                var otherDestinations = exports.sciChartDestinations.filter(function (el) { return el.canvasElementId !== canvas2dId; });
+                var otherDestinations = Globals_1.sciChart3DDestinations.filter(function (el) { return el.canvasElementId !== canvas2dId; });
                 chartInitObj.ClearDestinations();
-                var sameIdDestination = exports.sciChartDestinations.filter(function (el) { return el.canvasElementId === canvas2dId; });
+                var sameIdDestination = Globals_1.sciChart3DDestinations.filter(function (el) { return el.canvasElementId === canvas2dId; });
                 sameIdDestination.forEach(function (el) { return el.sciChartSurface.delete(); });
-                while (exports.sciChartDestinations.length > 0) {
-                    exports.sciChartDestinations.pop();
+                while (Globals_1.sciChart3DDestinations.length > 0) {
+                    Globals_1.sciChart3DDestinations.pop();
                 }
                 otherDestinations.forEach(function (el) {
                     return addDestination(wasmContext, el.canvasElementId, el.sciChartSurface, el.width, el.height, chartInitObj);
                 });
                 var sciChart3DSurface = createChildSurfaceInner(wasmContext, divElementId, canvases, theme);
+                sciChart3DSurface.addDeletable({
+                    delete: function () {
+                        if (SciChart3DSurface_1.SciChart3DSurface.autoDisposeWasmContext &&
+                            sciChart3DSurface.otherSurfaces.length === 0) {
+                            if (SciChart3DSurface_1.SciChart3DSurface.wasmContextDisposeTimeout) {
+                                setTimeout(function () {
+                                    if (Globals_1.sciChart3DDestinations.length === 0) {
+                                        SciChart3DSurface_1.SciChart3DSurface.disposeSharedWasmContext();
+                                    }
+                                }, SciChart3DSurface_1.SciChart3DSurface.wasmContextDisposeTimeout);
+                            }
+                            else {
+                                SciChart3DSurface_1.SciChart3DSurface.disposeSharedWasmContext();
+                            }
+                        }
+                        else {
+                            try {
+                                if (process.env.NODE_ENV !== "production") {
+                                    if (MemoryUsageHelper_1.MemoryUsageHelper.isMemoryUsageDebugEnabled &&
+                                        sciChart3DSurface.otherSurfaces.length === 0) {
+                                        console.warn("SciChart3DSurface.autoDisposeWasmContext is disabled, thus wasmContext should be disposed explicitly using \"SciChartSurface.disposeSharedWasmContext()\".");
+                                    }
+                                }
+                            }
+                            catch (err) {
+                                console.warn(err);
+                            }
+                        }
+                    }
+                });
                 addDestination(wasmContext, canvas2dId, sciChart3DSurface, canvases.domCanvas2D.width, canvases.domCanvas2D.height, chartInitObj);
                 (0, licenseManager3D_1.applyLicense3D)(wasmContext, sciChart3DSurface, false);
                 return sciChart3DSurface;
@@ -157,7 +222,7 @@ var createMaster = function () {
                     resolve({ getChildSurfaces: getChildSurfaces, createChildSurface: createChildSurface, wasmContext: wasmContext });
                 },
                 Draw: function (canvasId) {
-                    var dest = exports.sciChartDestinations.find(function (d) { return d.canvasElementId === canvasId; });
+                    var dest = Globals_1.sciChart3DDestinations.find(function (d) { return d.canvasElementId === canvasId; });
                     if (dest) {
                         dest.sciChartSurface.doDrawingLoop();
                     }
@@ -173,6 +238,8 @@ var createMaster = function () {
             var frameRenderer3D = new wasmContext.SCRTFrameRenderer3D();
             chartInitObj.SetFrameRenderer(frameRenderer3D);
             chartInitObj.SetFPSCounterEnabled(false);
+            // This may not be used in the case of 3D charts, but we set the property anyway as its passed down to TSR engine when initialising
+            chartInitObj.SetWasmBufferSizesKb(SciChartDefaults_1.SciChartDefaults.wasmBufferSizesKb);
             wasmContext.SCRTSetGlobalSampleChartInterface(chartInitObj);
             // create an object that native side can trigger the copy to from...
             var canvasCopyObj = wasmContext.SCRTCopyToDestinationInterface.implement({
@@ -183,7 +250,7 @@ var createMaster = function () {
             // SCJS-1321 fixes cutting 3d chart issue. 3D wasm and vice versa doesn't know about domMasterCanvas width/height
             // when creating one 3d chart and one 2d chart on the same screen. So we tell the other wasm about existing master canvas size
             if (SciChartSurfaceBase_1.SciChartSurfaceBase.domMasterCanvas) {
-                wasmContext.TSRSetMainWindowSize(SciChartSurfaceBase_1.SciChartSurfaceBase.domMasterCanvas.width, SciChartSurfaceBase_1.SciChartSurfaceBase.domMasterCanvas.height);
+                wasmContext.SCRTSetMainWindowSize(SciChartSurfaceBase_1.SciChartSurfaceBase.domMasterCanvas.width, SciChartSurfaceBase_1.SciChartSurfaceBase.domMasterCanvas.height);
             }
             // @ts-ignore
             wasmContext.callMain();
@@ -195,5 +262,5 @@ var createMaster = function () {
 };
 /** @ignore */
 var getDestinationById = function (destinationId) {
-    return exports.sciChartDestinations.find(function (dest) { return dest.canvasElementId === destinationId; });
+    return Globals_1.sciChart3DDestinations.find(function (dest) { return dest.canvasElementId === destinationId; });
 };