scichart 3.2.0-beta → 3.2.442

package/package.json

@@ -2,7 +2,7 @@
   "name": "scichart",
   "description": "Fast WebGL JavaScript Charting Library and Framework",
   "homepage": "https://www.scichart.com",
-  "version": "3.2.0-beta",
+  "version": "3.2.442",
   "main": "index.js",
   "types": "index.d.ts",
   "keywords": [

package/utils/MemoryUsageHelper.d.ts

@@ -1,34 +1,65 @@
-declare type TWeakRef = {
-    deref: () => any;
+/** @ignore */
+declare type TWeakRef<T = any> = {
+    deref: () => T;
 };
 /** @ignore */
 declare type TObjectEntryInfo = {
     isWasmObject: boolean;
     /** WeakRef for the original object */
     objectRef: TWeakRef;
+    /** WeakRef for the proxy of the object */
+    proxyRef?: TWeakRef;
+    /** revocableToken for the proxy of the object */
+    revocableTokenRef?: TWeakRef<ReturnType<ProxyConstructor["revocable"]>>;
+};
+/** @ignore */
+declare type TObjectEntryOptions = {
+    isWasmObject?: boolean;
+    revocableToken?: ReturnType<ProxyConstructor["revocable"]>;
+    proxy?: any;
 };
+/** ObjectRegistry represents a structure for storing object lifecycle info.
+ * Adding an object to the registry will place it into a category of undeleted until it is remove from the registry.
+ * Also the object will be placed into a category of uncollected until it is disposed by garbage collector.
+ */
 export declare class ObjectRegistry {
-    protected weakMapRegistry: WeakMap<object, any>;
-    protected undeletedObjectsMap: Map<string, TObjectEntryInfo>;
-    protected uncollectedObjectsMap: Map<string, TObjectEntryInfo>;
+    weakMapRegistry: WeakMap<object, any>;
+    undeletedObjectsMap: Map<string, TObjectEntryInfo>;
+    uncollectedObjectsMap: Map<string, TObjectEntryInfo>;
     protected finalizationRegistry: any;
-    add(obj: any, id: string, isWasmObject?: boolean): void;
+    /** Adds an object and its related info to the registry */
+    add(obj: any, id: string, options?: TObjectEntryOptions): void;
+    /** Removes the object from the undeleted objects collection */
     remove(id: string): boolean;
     getObjectId(obj: any): any;
-    has(id: string): boolean;
+    /** Calls `delete` on instances of {@link IDeletable} objects within the registry */
     deleteIDeletableObjects(): void;
+    /** Calls `delete` on instances of Web Assembly objects within the registry */
     deleteWasmObjects(): void;
+    /** Outputs the state of registry to the console */
     log(): void;
-    generateCurrentState(): any;
+    /** Returns the state of the registry */
+    getState(): any;
+    /** Calls `delete` on a specific object within the registry */
     protected deleteEntry(entry: TObjectEntryInfo, key: string): void;
+    /** The callback executed when an object is being garbage collected */
     protected onCollect(id: string): void;
 }
 /** @ignore */
 export declare const generateIdentifier: (entity: any) => string;
+/** {@link MemoryUsageHelper} provides tools for tracking, debugging, and testing common issus related to lifecycle of SciChart entities. */
 export declare class MemoryUsageHelper {
     protected static isMemoryUsageDebugEnabledProperty: boolean;
     static objectRegistry: ObjectRegistry;
+    /** Gets or sets the `Memory Usage Debug Mode`.
+     * Enabling the mode, provides warnings about wrong usage or cleanup.
+     * Also it wraps SciChart entities and adds them to the {@link objectRegistry} to track their lifecycle
+     */
     static get isMemoryUsageDebugEnabled(): boolean;
+    /** Gets or sets the `Memory Usage Debug Mode`.
+     * Enabling the mode, provides warnings about wrong usage or cleanup.
+     * Also it wraps SciChart entities and adds them to the {@link objectRegistry} to track their lifecycle
+     */
     static set isMemoryUsageDebugEnabled(value: boolean);
     /**
      * Adds entity to the object registry to keep track of it being collected
@@ -36,10 +67,26 @@ export declare class MemoryUsageHelper {
      * @param id optional custom ID of the entity
      */
     static register(entity: any, id?: string): void;
+    /**
+     * Removes entity from the object registry
+     * @param id ID of the entity
+     */
     static unregister(id: string): void;
+    /**
+     * Calls `delete` on all 2D and 3D charts instantiated with {@link SciChartSurface.create} or {@link SciChart3DSurface.create}
+     */
     static destroyMultiChart(): void;
+    /**
+     * Calls `delete` on all 2D and 3D charts instantiated with {@link SciChartSurface.createSingle} or {@link SciChart3DSurface.createSingle}
+     */
     static destroySingleCharts(): void;
+    /**
+     * Calls `delete` on all charts instantiated with {@link SciChartPieSurface.create}
+     */
     static destroyPieCharts(): void;
+    /**
+     * Calls `delete` on all charts
+     */
     static destroyAllCharts(): void;
 }
 export {};

package/utils/MemoryUsageHelper.js

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MemoryUsageHelper = exports.generateIdentifier = exports.ObjectRegistry = void 0;
 var Globals_1 = require("../Core/Globals");
 var guid_1 = require("./guid");
+/** ObjectRegistry represents a structure for storing object lifecycle info.
+ * Adding an object to the registry will place it into a category of undeleted until it is remove from the registry.
+ * Also the object will be placed into a category of uncollected until it is disposed by garbage collector.
+ */
 var ObjectRegistry = /** @class */ (function () {
     function ObjectRegistry() {
         var _this = this;
@@ -17,8 +21,11 @@ var ObjectRegistry = /** @class */ (function () {
             _this.onCollect(id);
         });
     }
-    ObjectRegistry.prototype.add = function (obj, id, isWasmObject) {
-        if (isWasmObject === void 0) { isWasmObject = false; }
+    /** Adds an object and its related info to the registry */
+    ObjectRegistry.prototype.add = function (obj, id, options) {
+        var _a, _b;
+        if (options === void 0) { options = { isWasmObject: false }; }
+        var isWasmObject = options.isWasmObject;
         if (this.weakMapRegistry.has(obj)) {
             console.warn("Adding existing entry to the registry!", id);
         }
@@ -27,14 +34,24 @@ var ObjectRegistry = /** @class */ (function () {
         }
         this.finalizationRegistry.register(obj, id);
         this.weakMapRegistry.set(obj, id);
+        var proxy = (_b = (_a = options === null || options === void 0 ? void 0 : options.revocableToken) === null || _a === void 0 ? void 0 : _a.proxy) !== null && _b !== void 0 ? _b : options === null || options === void 0 ? void 0 : options.proxy;
+        var revocableToken = options === null || options === void 0 ? void 0 : options.revocableToken;
+        if (proxy) {
+            this.weakMapRegistry.set(proxy, id);
+        }
         // @ts-ignore WeakRef
         var objectRef = new WeakRef(obj);
-        var objInfo = { isWasmObject: isWasmObject, objectRef: objectRef };
+        // @ts-ignore WeakRef
+        var proxyRef = proxy && new WeakRef(proxy);
+        // @ts-ignore WeakRef
+        var revocableTokenRef = revocableToken && new WeakRef(revocableToken);
+        var objInfo = { isWasmObject: isWasmObject, objectRef: objectRef, proxyRef: proxyRef, revocableTokenRef: revocableTokenRef };
         if (obj.delete) {
             this.undeletedObjectsMap.set(id, objInfo);
         }
         this.uncollectedObjectsMap.set(id, objInfo);
     };
+    /** Removes the object from the undeleted objects collection */
     ObjectRegistry.prototype.remove = function (id) {
         if (!this.undeletedObjectsMap.has(id) && !this.uncollectedObjectsMap.has(id)) {
             console.warn("".concat(id, " was not found in the ObjectRegistry!"));
@@ -44,9 +61,7 @@ var ObjectRegistry = /** @class */ (function () {
     ObjectRegistry.prototype.getObjectId = function (obj) {
         return this.weakMapRegistry.get(obj);
     };
-    ObjectRegistry.prototype.has = function (id) {
-        return this.undeletedObjectsMap.has(id);
-    };
+    /** Calls `delete` on instances of {@link IDeletable} objects within the registry */
     ObjectRegistry.prototype.deleteIDeletableObjects = function () {
         var _this = this;
         this.undeletedObjectsMap.forEach(function (entry, key) {
@@ -55,6 +70,7 @@ var ObjectRegistry = /** @class */ (function () {
             }
         });
     };
+    /** Calls `delete` on instances of Web Assembly objects within the registry */
     ObjectRegistry.prototype.deleteWasmObjects = function () {
         var _this = this;
         this.undeletedObjectsMap.forEach(function (entry, key) {
@@ -63,6 +79,7 @@ var ObjectRegistry = /** @class */ (function () {
             }
         });
     };
+    /** Outputs the state of registry to the console */
     ObjectRegistry.prototype.log = function () {
         var _this = this;
         var undeletedObjectsIds = Array.from(this.undeletedObjectsMap.keys());
@@ -77,7 +94,8 @@ var ObjectRegistry = /** @class */ (function () {
         console.log("weakMap", this.weakMapRegistry);
         console.log("Object Registry Log End");
     };
-    ObjectRegistry.prototype.generateCurrentState = function () {
+    /** Returns the state of the registry */
+    ObjectRegistry.prototype.getState = function () {
         var undeletedObjectsIds = Array.from(this.undeletedObjectsMap.keys());
         var uncollectedObjectsIds = Array.from(this.uncollectedObjectsMap.keys());
         var state = {};
@@ -89,6 +107,7 @@ var ObjectRegistry = /** @class */ (function () {
         }
         return state;
     };
+    /** Calls `delete` on a specific object within the registry */
     ObjectRegistry.prototype.deleteEntry = function (entry, key) {
         var originalObject = entry.objectRef.deref();
         if (originalObject) {
@@ -99,6 +118,7 @@ var ObjectRegistry = /** @class */ (function () {
             console.warn("Looks like the ".concat(key, " has already been garbage collected, thus the proper cleanup could not be executed!"));
         }
     };
+    /** The callback executed when an object is being garbage collected */
     ObjectRegistry.prototype.onCollect = function (id) {
         // Override with custom behavior
     };
@@ -110,23 +130,37 @@ var generateIdentifier = function (entity) {
     return "".concat(entity === null || entity === void 0 ? void 0 : entity.constructor.name, "_").concat((0, guid_1.generateGuid)());
 };
 exports.generateIdentifier = generateIdentifier;
+/** {@link MemoryUsageHelper} provides tools for tracking, debugging, and testing common issus related to lifecycle of SciChart entities. */
 var MemoryUsageHelper = /** @class */ (function () {
     function MemoryUsageHelper() {
     }
     Object.defineProperty(MemoryUsageHelper, "isMemoryUsageDebugEnabled", {
+        /** Gets or sets the `Memory Usage Debug Mode`.
+         * Enabling the mode, provides warnings about wrong usage or cleanup.
+         * Also it wraps SciChart entities and adds them to the {@link objectRegistry} to track their lifecycle
+         */
         get: function () {
             return this.isMemoryUsageDebugEnabledProperty;
         },
+        /** Gets or sets the `Memory Usage Debug Mode`.
+         * Enabling the mode, provides warnings about wrong usage or cleanup.
+         * Also it wraps SciChart entities and adds them to the {@link objectRegistry} to track their lifecycle
+         */
         set: function (value) {
-            this.isMemoryUsageDebugEnabledProperty = value;
-            if (process.env.NODE_ENV !== "production") {
-                if (value && !MemoryUsageHelper.objectRegistry) {
-                    MemoryUsageHelper.objectRegistry = new ObjectRegistry();
+            if (value) {
+                console.warn("Memory usage debug enabled! Make sure to disable it for production build!");
+            }
+            try {
+                if (process.env.NODE_ENV !== "production") {
+                    this.isMemoryUsageDebugEnabledProperty = value;
+                    if (value && !MemoryUsageHelper.objectRegistry) {
+                        MemoryUsageHelper.objectRegistry = new ObjectRegistry();
+                    }
+                    return;
                 }
-                return;
             }
-            if (value) {
-                console.warn("Memory usage debug enabled! Consider disabling it for production build 'MemoryUsageHelper.isMemoryUsageDebugEnabled = false'.");
+            catch (err) {
+                console.warn(err);
             }
         },
         enumerable: false,
@@ -145,21 +179,37 @@ var MemoryUsageHelper = /** @class */ (function () {
         }
         (_a = MemoryUsageHelper.objectRegistry) === null || _a === void 0 ? void 0 : _a.add(entity, id !== null && id !== void 0 ? id : (0, exports.generateIdentifier)(entity));
     };
+    /**
+     * Removes entity from the object registry
+     * @param id ID of the entity
+     */
     MemoryUsageHelper.unregister = function (id) {
         var _a;
         (_a = MemoryUsageHelper.objectRegistry) === null || _a === void 0 ? void 0 : _a.remove(id);
     };
+    /**
+     * Calls `delete` on all 2D and 3D charts instantiated with {@link SciChartSurface.create} or {@link SciChart3DSurface.create}
+     */
     MemoryUsageHelper.destroyMultiChart = function () {
         Globals_1.sciChartDestinations.forEach(function (destination) { return destination.sciChartSurface.delete(true); });
         Globals_1.sciChart3DDestinations.forEach(function (destination) { return destination.sciChartSurface.delete(true); });
     };
+    /**
+     * Calls `delete` on all 2D and 3D charts instantiated with {@link SciChartSurface.createSingle} or {@link SciChart3DSurface.createSingle}
+     */
     MemoryUsageHelper.destroySingleCharts = function () {
         Globals_1.sciChartSingleDestinations.forEach(function (destination) { return destination.sciChartSurface.delete(true); });
         Globals_1.sciChart3DSingleDestinations.forEach(function (destination) { return destination.sciChartSurface.delete(true); });
     };
+    /**
+     * Calls `delete` on all charts instantiated with {@link SciChartPieSurface.create}
+     */
     MemoryUsageHelper.destroyPieCharts = function () {
         Globals_1.sciChartPieDestinations.forEach(function (destination) { return destination.sciChartSurface.delete(true); });
     };
+    /**
+     * Calls `delete` on all charts
+     */
     MemoryUsageHelper.destroyAllCharts = function () {
         MemoryUsageHelper.destroyMultiChart();
         MemoryUsageHelper.destroySingleCharts();

package/utils/colorUtil.d.ts

@@ -31,3 +31,10 @@ export declare function uintArgbColorToAbgr(argbColor: number): number;
 export declare function uintArgbColorMultiplyOpacity(argbColor: number, opacity: number): number;
 export declare function uintArgbColorOverrideOpacity(argbColor: number, opacity: number): number;
 export declare function uintArgbColorIsTransparent(argbColor: number): boolean;
+/**
+ * Applies the given opacity to an html color code or name, returning an html color code.
+ * @param color
+ * @param opacity
+ * @returns
+ */
+export declare function applyOpacityToHtmlColor(color: string, opacity: number): string;

package/utils/colorUtil.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.uintArgbColorIsTransparent = exports.uintArgbColorOverrideOpacity = exports.uintArgbColorMultiplyOpacity = exports.uintArgbColorToAbgr = exports.linearColorMapLerp = exports.uintArgbColorLerp = exports.uintArgbColorLerp24bit = void 0;
+exports.applyOpacityToHtmlColor = exports.uintArgbColorIsTransparent = exports.uintArgbColorOverrideOpacity = exports.uintArgbColorMultiplyOpacity = exports.uintArgbColorToAbgr = exports.linearColorMapLerp = exports.uintArgbColorLerp = exports.uintArgbColorLerp24bit = void 0;
 var TLinearColorMap_1 = require("../types/TLinearColorMap");
 var parseColor_1 = require("./parseColor");
 /**
@@ -115,3 +115,15 @@ function uintArgbColorIsTransparent(argbColor) {
     return alpha !== 0xff000000;
 }
 exports.uintArgbColorIsTransparent = uintArgbColorIsTransparent;
+/**
+ * Applies the given opacity to an html color code or name, returning an html color code.
+ * @param color
+ * @param opacity
+ * @returns
+ */
+function applyOpacityToHtmlColor(color, opacity) {
+    var tarbg = (0, parseColor_1.parseColorToTArgb)(color);
+    tarbg.opacity = Math.floor(opacity * 256);
+    return (0, parseColor_1.parseTArgbToHtmlColor)(tarbg);
+}
+exports.applyOpacityToHtmlColor = applyOpacityToHtmlColor;

package/utils/parseColor.js

@@ -128,10 +128,10 @@ exports.parseArgbToHtmlColor = parseArgbToHtmlColor;
  * @param targb
  */
 var parseTArgbToHtmlColor = function (targb) {
-    var r = targb.red.toString(16);
-    var g = targb.green.toString(16);
-    var b = targb.blue.toString(16);
-    var a = targb.opacity.toString(16);
+    var r = convertComponent(targb.red);
+    var g = convertComponent(targb.green);
+    var b = convertComponent(targb.blue);
+    var a = convertComponent(targb.opacity);
     return ("#" + r + g + b + a).toUpperCase();
 };
 exports.parseTArgbToHtmlColor = parseTArgbToHtmlColor;
@@ -176,6 +176,21 @@ var convertOpacity = function (opacity) {
     }
     return Math.floor(opacity * 256);
 };
+/**
+ * @ignore
+ * Converts number (color component) from 0 to 256 to hex string, with 0 padding
+ * @param component
+ */
+var convertComponent = function (component) {
+    if (component >= 256) {
+        return "ff";
+    }
+    if (component <= 0) {
+        return "00";
+    }
+    var hex = component.toString(16);
+    return hex.length === 1 ? "0" + hex : hex;
+};
 // https://www.w3schools.com/colors/colors_names.asp
 // https://en.wikipedia.org/wiki/Web_colors
 // http://www.colors.commutercreative.com/grid/