scichart 2.0.0-alpha.1930 → 2.0.0-alpha.1991

package/Charting3D/Visuals/Primitives/BaseSceneEntity3D.js

@@ -4,6 +4,7 @@ exports.BaseSceneEntity3D = void 0;
 var Deleter_1 = require("../../../Core/Deleter");
 var ObservableArray_1 = require("../../../Core/ObservableArray");
 var SceneEntityType_1 = require("../../../types/SceneEntityType");
+var guid_1 = require("../../../utils/guid");
 /**
  * The {@link BaseSceneEntity3D} provides a base class for entities, or 3D objects in the 3D scene within
  * SciChart's High Performance {@link https://www.scichart.com/javascript-chart-features | JavaScript 3D Charts}
@@ -20,6 +21,8 @@ var BaseSceneEntity3D = /** @class */ (function () {
      */
     function BaseSceneEntity3D(webAssemblyContext) {
         var _this = this;
+        /** @inheritDoc */
+        this.id = guid_1.generateGuid();
         /**
          * When true, the entity and all its children are visible
          */
@@ -36,9 +39,7 @@ var BaseSceneEntity3D = /** @class */ (function () {
         });
         this.onDpiChanged = this.onDpiChanged.bind(this);
     }
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     BaseSceneEntity3D.prototype.getRoot = function () {
         if (this.type === SceneEntityType_1.ESceneEntityType.RootSceneEntity) {
             return this;
@@ -52,9 +53,7 @@ var BaseSceneEntity3D = /** @class */ (function () {
         }
         return undefined;
     };
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     BaseSceneEntity3D.prototype.delete = function () {
         this.children.asArray().forEach(function (el) { return el.delete(); });
         if (this.nativeEntity) {
@@ -98,26 +97,18 @@ var BaseSceneEntity3D = /** @class */ (function () {
             this.nativeEntity.Render();
         }
     };
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     BaseSceneEntity3D.prototype.onEngineRestart = function () {
         // TODO: TSRSceneEntity.OnEngineRestart
     };
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     BaseSceneEntity3D.prototype.onDpiChanged = function (args) { };
     Object.defineProperty(BaseSceneEntity3D.prototype, "entityId", {
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         get: function () {
             return this.entityIdProperty;
         },
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         set: function (value) {
             this.entityIdProperty = value;
             // TODO: this.nativeEntity.SetEntityId(value)
@@ -125,15 +116,11 @@ var BaseSceneEntity3D = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     BaseSceneEntity3D.prototype.setRenderPassData = function (rpd) {
         this.currentRenderPassData = rpd;
     };
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     BaseSceneEntity3D.prototype.getEntity = function (type) {
         for (var i = 0; i < this.children.size(); i++) {
             var ent = this.children.get(i);
@@ -151,9 +138,7 @@ var BaseSceneEntity3D = /** @class */ (function () {
         var _a, _b;
         (_b = (_a = this.rootSceneEntity) === null || _a === void 0 ? void 0 : _a.parentSurface) === null || _b === void 0 ? void 0 : _b.invalidateElement();
     };
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     BaseSceneEntity3D.prototype.onAttached = function () {
         if (this.parent.type === SceneEntityType_1.ESceneEntityType.SCRTSceneEntity) {
             // TODO
@@ -162,15 +147,11 @@ var BaseSceneEntity3D = /** @class */ (function () {
             // _nativeEntity.SetWorld(world);
         }
     };
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     BaseSceneEntity3D.prototype.onDetached = function () {
         // Override in derived class to be notified of detached
     };
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     BaseSceneEntity3D.prototype.visitEntities = function (operation) {
         operation(this);
         this.children.asArray().forEach(function (child) {
@@ -178,9 +159,7 @@ var BaseSceneEntity3D = /** @class */ (function () {
         });
     };
     Object.defineProperty(BaseSceneEntity3D.prototype, "nativeEntity", {
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         get: function () {
             return this.nativeEntityProperty;
         },

package/Charting3D/Visuals/RenderableSeries/BaseRenderableSeries3D.d.ts

@@ -1,5 +1,6 @@
 import { IThemeable } from "../../../Charting/Themes/IThemeable";
 import { IThemeProvider } from "../../../Charting/Themes/IThemeProvider";
+import { INotifyOnDpiChanged, TDpiChangedEventArgs } from "../../../Charting/Visuals/TextureManager/DpiHelper";
 import { IDeletable } from "../../../Core/IDeletable";
 import { TSciChart3D } from "../../../types/TSciChart3D";
 import { BaseDataSeries3D } from "../../Model/DataSeries/BaseDataSeries3D";
@@ -9,7 +10,6 @@ import { IBaseSceneEntity } from "../Primitives/BaseSceneEntity3D";
 import { IRenderableSeriesSceneEntity } from "../Primitives/RenderableSeriesSceneEntity";
 import { SciChart3DSurface } from "../SciChart3DSurface";
 import { ESeriesType3D } from "./ESeriesType";
-import { INotifyOnDpiChanged, TDpiChangedEventArgs } from "../../../Charting/Visuals/TextureManager/DpiHelper";
 /**
  * @summary Defines the interface to a 3D Renderable Series (or 3D Chart Type) in SciChart's High Performance Real-time
  * {@link https://www.scichart.com/javascript-chart-features | JavaScript 3D Charts}
@@ -21,6 +21,10 @@ import { INotifyOnDpiChanged, TDpiChangedEventArgs } from "../../../Charting/Vis
  * See derived types of {@link IRenderableSeries3D} to find out what 3D JavaScript Chart types are available.
  */
 export interface IRenderableSeries3D extends IDeletable, IThemeable, INotifyOnDpiChanged {
+    /**
+     * A unique Id for the {@link IRenderableSeries3D}
+     */
+    readonly id: string;
     /**
      * Gets the Series type. See {@link ESeriesType3D} for a list of values
      */
@@ -82,6 +86,10 @@ export interface IRenderableSeries3D extends IDeletable, IThemeable, INotifyOnDp
  * Options to pass to the {@link BaseRenderableSeries3D} constructor
  */
 export interface IBaseRenderableSeries3DOptions {
+    /**
+     * A unique Id for the {@link IRenderableSeries3D}
+     */
+    readonly id?: string;
     /**
      * The {@link BaseDataSeries3D | DataSeries} which provides a datasource for this {@link BaseRenderableSeries3D} to draw
      */
@@ -115,13 +123,11 @@ export interface IBaseRenderableSeries3DOptions {
  * See derived types of {@link IRenderableSeries3D} to find out what 3D JavaScript Chart types are available.
  */
 export declare abstract class BaseRenderableSeries3D implements IRenderableSeries3D {
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
+    readonly id: string;
+    /** @inheritDoc */
     abstract type: ESeriesType3D;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     invalidateParentCallback: () => void;
     /**
      * The {@link TSciChart3D | SciChart 3D WebAssembly Context} containing
@@ -146,93 +152,49 @@ export declare abstract class BaseRenderableSeries3D implements IRenderableSerie
      * @protected
      */
     protected constructor(webAssemblyContext: TSciChart3D, options?: IBaseRenderableSeries3DOptions);
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     applyTheme(themeProvider: IThemeProvider): void;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     get opacity(): number;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     set opacity(opacity: number);
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     get sceneEntity(): IBaseSceneEntity;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     get shininess(): number;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     set shininess(shininess: number);
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     get paletteProvider(): IPaletteProvider3D;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     set paletteProvider(paletteProvider: IPaletteProvider3D);
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     get stroke(): string;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     set stroke(stroke: string);
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     get dataSeries(): BaseDataSeries3D;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     set dataSeries(dataSeries: BaseDataSeries3D);
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     get pointMarker(): BasePointMarker3D;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     set pointMarker(pointMarker: BasePointMarker3D);
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     get parentSurface(): SciChart3DSurface;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     set parentSurface(parentSurface: SciChart3DSurface);
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     get isVisible(): boolean;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     set isVisible(isVisible: boolean);
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     onAttach(scs: SciChart3DSurface): void;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     onDetach(): void;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     delete(): void;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     onDpiChanged(args: TDpiChangedEventArgs): void;
     /**
      * Used internally - sets the {@link IRenderableSeriesSceneEntity | 3D Scene Entity}

package/Charting3D/Visuals/RenderableSeries/BaseRenderableSeries3D.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseRenderableSeries3D = void 0;
 var Deleter_1 = require("../../../Core/Deleter");
+var guid_1 = require("../../../utils/guid");
 var Constants_1 = require("./Constants");
 /**
  * @summary Defines the base class to a 3D Render Series (or 3D Chart Type) in SciChart's High Performance Real-time
@@ -22,6 +23,8 @@ var BaseRenderableSeries3D = /** @class */ (function () {
      * @protected
      */
     function BaseRenderableSeries3D(webAssemblyContext, options) {
+        var _a;
+        this.id = (_a = options === null || options === void 0 ? void 0 : options.id) !== null && _a !== void 0 ? _a : guid_1.generateGuid();
         this.webAssemblyContext = webAssemblyContext;
         this.dataSeriesProperty = (options === null || options === void 0 ? void 0 : options.dataSeries) || undefined;
         this.isVisibleProperty = (options === null || options === void 0 ? void 0 : options.isVisible) !== undefined ? options === null || options === void 0 ? void 0 : options.isVisible : true;
@@ -31,22 +34,16 @@ var BaseRenderableSeries3D = /** @class */ (function () {
         this.pointMarkerPropertyChanged = this.pointMarkerPropertyChanged.bind(this);
         this.onDpiChanged = this.onDpiChanged.bind(this);
     }
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     BaseRenderableSeries3D.prototype.applyTheme = function (themeProvider) {
         // TODO
     };
     Object.defineProperty(BaseRenderableSeries3D.prototype, "opacity", {
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         get: function () {
             return this.opacityProperty;
         },
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         set: function (opacity) {
             this.opacityProperty = opacity;
             this.notifyPropertyChanged(Constants_1.PROPERTY.OPACITY);
@@ -55,9 +52,7 @@ var BaseRenderableSeries3D = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(BaseRenderableSeries3D.prototype, "sceneEntity", {
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         get: function () {
             return this.sceneEntityProperty;
         },
@@ -65,15 +60,11 @@ var BaseRenderableSeries3D = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(BaseRenderableSeries3D.prototype, "shininess", {
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         get: function () {
             return this.shininessProperty;
         },
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         set: function (shininess) {
             this.shininessProperty = shininess;
             this.notifyPropertyChanged(Constants_1.PROPERTY.SHININESS);
@@ -82,15 +73,11 @@ var BaseRenderableSeries3D = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(BaseRenderableSeries3D.prototype, "paletteProvider", {
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         get: function () {
             return this.paletteProviderProperty;
         },
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         set: function (paletteProvider) {
             this.paletteProviderProperty = paletteProvider;
             this.notifyPropertyChanged(Constants_1.PROPERTY.PALETTE_PROVIDER);
@@ -99,15 +86,11 @@ var BaseRenderableSeries3D = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(BaseRenderableSeries3D.prototype, "stroke", {
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         get: function () {
             return this.strokeProperty;
         },
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         set: function (stroke) {
             this.strokeProperty = stroke;
             this.notifyPropertyChanged(Constants_1.PROPERTY.STROKE);
@@ -116,15 +99,11 @@ var BaseRenderableSeries3D = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(BaseRenderableSeries3D.prototype, "dataSeries", {
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         get: function () {
             return this.dataSeriesProperty;
         },
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         set: function (dataSeries) {
             this.dataSeriesProperty = dataSeries;
             this.notifyPropertyChanged(Constants_1.PROPERTY.DATA_SERIES);
@@ -133,15 +112,11 @@ var BaseRenderableSeries3D = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(BaseRenderableSeries3D.prototype, "pointMarker", {
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         get: function () {
             return this.pointMarkerProperty;
         },
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         set: function (pointMarker) {
             this.detachPointMarker(this.pointMarkerProperty);
             this.pointMarkerProperty = pointMarker;
@@ -152,15 +127,11 @@ var BaseRenderableSeries3D = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(BaseRenderableSeries3D.prototype, "parentSurface", {
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         get: function () {
             return this.parentSurfaceProperty;
         },
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         set: function (parentSurface) {
             this.parentSurfaceProperty = parentSurface;
             this.notifyPropertyChanged(Constants_1.PROPERTY.PARENT_SURFACE);
@@ -169,15 +140,11 @@ var BaseRenderableSeries3D = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(BaseRenderableSeries3D.prototype, "isVisible", {
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         get: function () {
             return this.isVisibleProperty;
         },
-        /**
-         * @inheritDoc
-         */
+        /** @inheritDoc */
         set: function (isVisible) {
             this.isVisibleProperty = isVisible;
             if (this.sceneEntityProperty) {
@@ -188,9 +155,7 @@ var BaseRenderableSeries3D = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     BaseRenderableSeries3D.prototype.onAttach = function (scs) {
         this.parentSurface = scs;
         if (this.invalidateParentCallback) {
@@ -198,23 +163,17 @@ var BaseRenderableSeries3D = /** @class */ (function () {
         }
         this.invalidateParentCallback = scs.invalidateElement;
     };
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     BaseRenderableSeries3D.prototype.onDetach = function () {
         this.invalidateParentCallback = undefined;
         this.parentSurface = undefined;
     };
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     BaseRenderableSeries3D.prototype.delete = function () {
         this.sceneEntityProperty = Deleter_1.deleteSafe(this.sceneEntityProperty);
         this.dataSeries = Deleter_1.deleteSafe(this.dataSeries);
     };
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     BaseRenderableSeries3D.prototype.onDpiChanged = function (args) {
         var _a;
         (_a = this.sceneEntityProperty) === null || _a === void 0 ? void 0 : _a.onDpiChanged(args);