scichart 2.1.2294 → 2.2.2378

package/Charting/Visuals/RenderableSeries/BaseRenderableSeries.d.ts

@@ -30,6 +30,7 @@ import { IRenderableSeries } from "./IRenderableSeries";
 import { RolloverModifierRenderableSeriesProps } from "./RolloverModifier/RolloverModifierRenderableSeriesProps";
 import { SeriesHoveredArgs } from "./SeriesHoveredArgs";
 import { SeriesSelectedArgs } from "./SeriesSelectedArgs";
+import { SeriesVisibleChangedArgs } from "./SeriesVisibleChangedArgs";
 import { ShaderEffect } from "./ShaderEffect";
 /**
  * @summary Defines the base class to a Render Series (or Chart Type) in SciChart's High Performance Real-time
@@ -47,23 +48,21 @@ export declare abstract class BaseRenderableSeries implements IRenderableSeries
     /** @inheritDoc */
     readonly id: string;
     /** @inheritDoc */
-    readonly isStacked = false;
+    readonly isStacked: boolean;
     /** @inheritDoc */
     readonly rolloverModifierProps: RolloverModifierRenderableSeriesProps;
     /** @inheritDoc */
     readonly rolloverModifierProps1: RolloverModifierRenderableSeriesProps;
     /** @inheritDoc */
-    parentSurface: SciChartSurface;
-    /** @inheritDoc */
     invalidateParentCallback: () => void;
     /** @inheritDoc */
-    drawingProviders: ISeriesDrawingProvider[];
-    /** @inheritDoc */
     hitTestProvider: IHitTestProvider;
     /** @inheritDoc */
     selected: EventHandler<SeriesSelectedArgs>;
     /** @inheritDoc */
     hovered: EventHandler<SeriesHoveredArgs>;
+    /** @inheritDoc */
+    isVisibleChanged: EventHandler<SeriesVisibleChangedArgs>;
     protected webAssemblyContext: TSciChart;
     protected dataSeriesProperty: IDataSeries;
     protected animationFSM: SeriesAnimationFiniteStateMachine;
@@ -72,11 +71,14 @@ export declare abstract class BaseRenderableSeries implements IRenderableSeries
     protected typeMap: Map<string, string>;
     protected resamplerHelper: ExtremeResamplerHelper;
     protected pointSeries: XyPointSeriesResampled;
+    protected currentRenderPassData: RenderPassData;
+    protected opacityProperty: number;
+    private parentSurfaceProperty;
+    private drawingProvidersProperty;
     private xAxisIdProperty;
     private yAxisIdProperty;
     private strokeThicknessProperty;
     private strokeProperty;
-    private opacityProperty;
     private pointMarkerProperty;
     private drawNaNAsProperty;
     private isVisibleProperty;
@@ -84,7 +86,6 @@ export declare abstract class BaseRenderableSeries implements IRenderableSeries
     private isDigitalLineProperty;
     private isSelectedProperty;
     private isHoveredProperty;
-    private currentRenderPassData;
     private resamplingModeProperty;
     private resamplingPrecisionProperty;
     /**
@@ -97,6 +98,14 @@ export declare abstract class BaseRenderableSeries implements IRenderableSeries
     /** @inheritDoc */
     applyTheme(themeProvider: IThemeProvider): void;
     /** @inheritDoc */
+    get parentSurface(): SciChartSurface;
+    /** @inheritDoc */
+    set parentSurface(value: SciChartSurface);
+    /** @inheritDoc */
+    get drawingProviders(): ISeriesDrawingProvider[];
+    /** @inheritDoc */
+    set drawingProviders(value: ISeriesDrawingProvider[]);
+    /** @inheritDoc */
     get isSelected(): boolean;
     /** @inheritDoc */
     set isSelected(isSelected: boolean);
@@ -296,4 +305,11 @@ export declare abstract class BaseRenderableSeries implements IRenderableSeries
     private effectPropertyChanged;
     private get canDraw();
 }
-export declare const getDataPointWidth: (xValues: SCRTDoubleVector, xCoordCalc: CoordinateCalculatorBase, seriesViewRectWidth: number, widthFraction: number, isCategoryAxis: boolean) => number;
+/** @ignore */
+export declare const getDataPointWidth: (xValues: SCRTDoubleVector, xCoordCalc: CoordinateCalculatorBase, seriesViewRectWidth: number, widthFraction: number, isCategoryAxis: boolean, wasmContext: TSciChart) => number;
+/** @ignore */
+export declare const getDelta: ({ pointSize, areaSize, range }: {
+    pointSize: number;
+    areaSize: number;
+    range: NumberRange;
+}) => number;

package/Charting/Visuals/RenderableSeries/BaseRenderableSeries.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDataPointWidth = exports.BaseRenderableSeries = void 0;
+exports.getDelta = exports.getDataPointWidth = exports.BaseRenderableSeries = void 0;
 var classFactory_1 = require("../../../Builder/classFactory");
 var AnimationFiniteStateMachine_1 = require("../../../Core/Animations/AnimationFiniteStateMachine");
 var Deleter_1 = require("../../../Core/Deleter");
@@ -13,6 +13,7 @@ var SeriesType_1 = require("../../../types/SeriesType");
 var guid_1 = require("../../../utils/guid");
 var WebGlRenderContext2D_1 = require("../../Drawing/WebGlRenderContext2D");
 var HeatmapSeriesInfo_1 = require("../../Model/ChartData/HeatmapSeriesInfo");
+var HlcSeriesInfo_1 = require("../../Model/ChartData/HlcSeriesInfo");
 var OhlcSeriesInfo_1 = require("../../Model/ChartData/OhlcSeriesInfo");
 var XySeriesInfo_1 = require("../../Model/ChartData/XySeriesInfo");
 var XyySeriesInfo_1 = require("../../Model/ChartData/XyySeriesInfo");
@@ -25,11 +26,13 @@ var ResamplingMode_1 = require("../../Numerics/Resamplers/ResamplingMode");
 var AxisCore_1 = require("../Axis/AxisCore");
 var SciChartDefaults_1 = require("../SciChartDefaults");
 var SciChartSurfaceBase_1 = require("../SciChartSurfaceBase");
+var DpiHelper_1 = require("../TextureManager/DpiHelper");
 var animationHelpers_1 = require("./Animations/animationHelpers");
 var constants_1 = require("./constants");
 var RolloverModifierRenderableSeriesProps_1 = require("./RolloverModifier/RolloverModifierRenderableSeriesProps");
 var SeriesHoveredArgs_1 = require("./SeriesHoveredArgs");
 var SeriesSelectedArgs_1 = require("./SeriesSelectedArgs");
+var SeriesVisibleChangedArgs_1 = require("./SeriesVisibleChangedArgs");
 /**
  * @summary Defines the base class to a Render Series (or Chart Type) in SciChart's High Performance Real-time
  * {@link https://www.scichart.com/javascript-chart-features | JavaScript Charts}
@@ -50,31 +53,31 @@ var BaseRenderableSeries = /** @class */ (function () {
     function BaseRenderableSeries(webAssemblyContext, options) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
         /** @inheritDoc */
-        this.isStacked = false;
-        /** @inheritDoc */
         this.rolloverModifierProps = new RolloverModifierRenderableSeriesProps_1.RolloverModifierRenderableSeriesProps(this);
         /** @inheritDoc */
         this.rolloverModifierProps1 = new RolloverModifierRenderableSeriesProps_1.RolloverModifierRenderableSeriesProps(this, true);
         /** @inheritDoc */
-        this.drawingProviders = [];
-        /** @inheritDoc */
         this.selected = new EventHandler_1.EventHandler();
         /** @inheritDoc */
         this.hovered = new EventHandler_1.EventHandler();
+        /** @inheritDoc */
+        this.isVisibleChanged = new EventHandler_1.EventHandler();
         this.animationQueue = [];
         this.paletteProviderProperty = IPaletteProvider_1.DefaultPaletteProvider.createEmpty();
-        // used to track if registered types were used for function propertes, so they can be serialized
+        // used to track if registered types were used for function properties, so they can be serialized
         this.typeMap = new Map();
+        this.opacityProperty = 1;
+        this.drawingProvidersProperty = [];
         this.xAxisIdProperty = AxisCore_1.AxisCore.DEFAULT_AXIS_ID;
         this.yAxisIdProperty = AxisCore_1.AxisCore.DEFAULT_AXIS_ID;
         this.strokeThicknessProperty = 2;
         this.strokeProperty = SciChartSurfaceBase_1.SciChartSurfaceBase.DEFAULT_THEME.lineSeriesColor;
-        this.opacityProperty = 1;
         this.drawNaNAsProperty = WebGlRenderContext2D_1.ELineDrawMode.DiscontinuousLine;
         this.isVisibleProperty = true;
         this.isDigitalLineProperty = false;
         this.resamplingModeProperty = ResamplingMode_1.EResamplingMode.Auto;
         this.resamplingPrecisionProperty = 0;
+        this.isStacked = false;
         this.webAssemblyContext = webAssemblyContext;
         this.id = (_a = options === null || options === void 0 ? void 0 : options.id) !== null && _a !== void 0 ? _a : (0, guid_1.generateGuid)();
         // It is very important to add bind(this) first line in constructor,
@@ -113,7 +116,7 @@ var BaseRenderableSeries = /** @class */ (function () {
                 options.effect = (0, classFactory_1.createType)(BaseType_1.EBaseType.ShaderEffect, options.effect.type, webAssemblyContext, options.effect.options);
             }
         }
-        this.effect = options === null || options === void 0 ? void 0 : options.effect;
+        this.effectProperty = options === null || options === void 0 ? void 0 : options.effect;
         if (options === null || options === void 0 ? void 0 : options.paletteProvider) {
             if (!("onAttached" in options.paletteProvider)) {
                 if (options.paletteProvider.type === PaletteProviderType_1.EPaletteProviderType.Custom) {
@@ -130,6 +133,21 @@ var BaseRenderableSeries = /** @class */ (function () {
         this.hitTestProvider = this.newHitTestProvider();
         this.isSelected = (_q = options === null || options === void 0 ? void 0 : options.isSelected) !== null && _q !== void 0 ? _q : false;
         this.isHovered = (_r = options === null || options === void 0 ? void 0 : options.isHovered) !== null && _r !== void 0 ? _r : false;
+        if (options === null || options === void 0 ? void 0 : options.onIsVisibleChanged) {
+            if (typeof options.onIsVisibleChanged === "string") {
+                this.typeMap.set("onIsVisibleChanged", options.onIsVisibleChanged);
+                var visibleChanged_1 = (0, classFactory_1.getFunction)(BaseType_1.EBaseType.OptionFunction, options.onIsVisibleChanged);
+                this.isVisibleChanged.subscribe(function (args) {
+                    return visibleChanged_1(args.sourceSeries, args.isVisible);
+                });
+            }
+            else {
+                var onIsVisibleChangedCallback_1 = options === null || options === void 0 ? void 0 : options.onIsVisibleChanged;
+                this.isVisibleChanged.subscribe(function (args) {
+                    return onIsVisibleChangedCallback_1(args.sourceSeries, args.isVisible);
+                });
+            }
+        }
         if (options === null || options === void 0 ? void 0 : options.onSelectedChanged) {
             if (typeof options.onSelectedChanged === "string") {
                 this.typeMap.set("onSelectedChanged", options.onSelectedChanged);
@@ -182,6 +200,32 @@ var BaseRenderableSeries = /** @class */ (function () {
             this.rolloverModifierProps.markerColor = themeProvider.textAnnotationBackground;
         }
     };
+    Object.defineProperty(BaseRenderableSeries.prototype, "parentSurface", {
+        /** @inheritDoc */
+        get: function () {
+            return this.parentSurfaceProperty;
+        },
+        /** @inheritDoc */
+        set: function (value) {
+            this.parentSurfaceProperty = value;
+            this.notifyPropertyChanged(constants_1.PROPERTY.PARENT_SURFACE);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(BaseRenderableSeries.prototype, "drawingProviders", {
+        /** @inheritDoc */
+        get: function () {
+            return this.drawingProvidersProperty;
+        },
+        /** @inheritDoc */
+        set: function (value) {
+            this.drawingProvidersProperty = value;
+            this.notifyPropertyChanged(constants_1.PROPERTY.DRAWING_PROVIDERS);
+        },
+        enumerable: false,
+        configurable: true
+    });
     Object.defineProperty(BaseRenderableSeries.prototype, "isSelected", {
         /** @inheritDoc */
         get: function () {
@@ -248,8 +292,12 @@ var BaseRenderableSeries = /** @class */ (function () {
         },
         /** @inheritDoc */
         set: function (isVisible) {
-            this.isVisibleProperty = isVisible;
-            this.notifyPropertyChanged(constants_1.PROPERTY.IS_VISIBLE);
+            var _a;
+            if (this.valueChanged(this.isVisibleProperty, isVisible)) {
+                this.isVisibleProperty = isVisible;
+                (_a = this.isVisibleChanged) === null || _a === void 0 ? void 0 : _a.raiseEvent(new SeriesVisibleChangedArgs_1.SeriesVisibleChangedArgs(this, isVisible));
+                this.notifyPropertyChanged(constants_1.PROPERTY.IS_VISIBLE);
+            }
         },
         enumerable: false,
         configurable: true
@@ -376,10 +424,16 @@ var BaseRenderableSeries = /** @class */ (function () {
         },
         /** @inheritDoc */
         set: function (dataSeries) {
-            var _a, _b;
-            (_a = this.dataSeriesProperty) === null || _a === void 0 ? void 0 : _a.dataChanged.unsubscribe(this.dataSeriesDataChanged);
+            var _a, _b, _c;
+            if (this.dataSeriesProperty) {
+                var xAxis = (_a = this.parentSurface) === null || _a === void 0 ? void 0 : _a.getXAxisById(this.xAxisId);
+                if (xAxis && xAxis.isCategoryAxis) {
+                    xAxis.clearCoordCalcCache();
+                }
+            }
+            (_b = this.dataSeriesProperty) === null || _b === void 0 ? void 0 : _b.dataChanged.unsubscribe(this.dataSeriesDataChanged);
             this.dataSeriesProperty = dataSeries;
-            (_b = this.dataSeriesProperty) === null || _b === void 0 ? void 0 : _b.dataChanged.subscribe(this.dataSeriesDataChanged);
+            (_c = this.dataSeriesProperty) === null || _c === void 0 ? void 0 : _c.dataChanged.subscribe(this.dataSeriesDataChanged);
             this.notifyPropertyChanged(constants_1.PROPERTY.DATA_SERIES);
         },
         enumerable: false,
@@ -500,9 +554,9 @@ var BaseRenderableSeries = /** @class */ (function () {
      */
     BaseRenderableSeries.prototype.getDataPointWidth = function (xCoordCalc, widthFraction) {
         var xValues = this.dataSeries.getNativeXValues();
-        var seriesViewRectWidth = this.parentSurface.seriesViewRect.width;
-        var isCategoryAxis = this.parentSurface.xAxes.size() !== 0 && this.xAxis.isCategoryAxis;
-        return (0, exports.getDataPointWidth)(xValues, xCoordCalc, seriesViewRectWidth, widthFraction, isCategoryAxis);
+        var seriesViewRectWidth = xCoordCalc.viewportDimension;
+        var isCategoryAxis = xCoordCalc.isCategoryCoordinateCalculator;
+        return (0, exports.getDataPointWidth)(xValues, xCoordCalc, seriesViewRectWidth, widthFraction, isCategoryAxis, this.webAssemblyContext);
     };
     /** @inheritDoc */
     BaseRenderableSeries.prototype.onDetach = function () {
@@ -587,6 +641,8 @@ var BaseRenderableSeries = /** @class */ (function () {
                 return new XyySeriesInfo_1.XyySeriesInfo(this, hitTestInfo);
             case IDataSeries_1.EDataSeriesType.HeatmapUniform:
                 return new HeatmapSeriesInfo_1.HeatmapSeriesInfo(this, hitTestInfo);
+            case IDataSeries_1.EDataSeriesType.Hlc:
+                return new HlcSeriesInfo_1.HlcSeriesInfo(this, hitTestInfo);
             default:
                 return new XySeriesInfo_1.XySeriesInfo(this, hitTestInfo);
         }
@@ -602,7 +658,7 @@ var BaseRenderableSeries = /** @class */ (function () {
     };
     /** @inheritDoc */
     BaseRenderableSeries.prototype.toJSON = function (excludeData) {
-        var _a, _b, _c, _d, _e, _f, _g;
+        var _a, _b, _c, _d, _e, _f, _g, _h;
         if (excludeData === void 0) { excludeData = false; }
         var paletteProvider;
         if (this.paletteProvider) {
@@ -634,27 +690,24 @@ var BaseRenderableSeries = /** @class */ (function () {
             // onSelectedChanged: this.onSelectedChanged
         };
         if (((_c = this.dataSeries) === null || _c === void 0 ? void 0 : _c.type) === IDataSeries_1.EDataSeriesType.Xy) {
-            // @ts-ignore
             return { type: this.type, options: options, xyData: this.dataSeries.toJSON(excludeData) };
         }
         else if (((_d = this.dataSeries) === null || _d === void 0 ? void 0 : _d.type) === IDataSeries_1.EDataSeriesType.Xyy) {
-            // @ts-ignore
             return { type: this.type, options: options, xyyData: this.dataSeries.toJSON(excludeData) };
         }
         else if (((_e = this.dataSeries) === null || _e === void 0 ? void 0 : _e.type) === IDataSeries_1.EDataSeriesType.Xyz) {
-            // @ts-ignore
             return { type: this.type, options: options, xyzData: this.dataSeries.toJSON(excludeData) };
         }
         else if (((_f = this.dataSeries) === null || _f === void 0 ? void 0 : _f.type) === IDataSeries_1.EDataSeriesType.Ohlc) {
-            // @ts-ignore
             return { type: this.type, options: options, ohlcData: this.dataSeries.toJSON(excludeData) };
         }
-        else if (((_g = this.dataSeries) === null || _g === void 0 ? void 0 : _g.type) === IDataSeries_1.EDataSeriesType.HeatmapUniform) {
-            // @ts-ignore
+        else if (((_g = this.dataSeries) === null || _g === void 0 ? void 0 : _g.type) === IDataSeries_1.EDataSeriesType.Hlc) {
+            return { type: this.type, options: options, hlcData: this.dataSeries.toJSON(excludeData) };
+        }
+        else if (((_h = this.dataSeries) === null || _h === void 0 ? void 0 : _h.type) === IDataSeries_1.EDataSeriesType.HeatmapUniform) {
             return { type: this.type, options: options, heatmapData: this.dataSeries.toJSON(excludeData) };
         }
         else {
-            // @ts-ignore
             return { type: this.type, options: options };
         }
     };
@@ -729,9 +782,7 @@ var BaseRenderableSeries = /** @class */ (function () {
                 this.pointSeries.xRange = rp.xVisibleRange;
             }
             this.resamplerHelper.resampleIntoPointSeries(this.webAssemblyContext, rp, this.dataSeries.getNativeXValues(), this.dataSeries.getNativeYValues(), this.pointSeries.intIndexes, this.pointSeries.xValues, this.pointSeries.yValues, false);
-            if (rp.isCategoryAxis) {
-                this.pointSeries.updateIndexes();
-            }
+            this.pointSeries.updateIndexes();
             this.pointSeries.clearIntIndexes();
             // this.pointSeries.debugOutputForUnitTests();
             return this.pointSeries;
@@ -756,11 +807,13 @@ var BaseRenderableSeries = /** @class */ (function () {
             var seriesTypeSupportsResampling = ![
                 SeriesType_1.ESeriesType.UniformContoursSeries,
                 SeriesType_1.ESeriesType.UniformHeatmapSeries,
-                SeriesType_1.ESeriesType.ScatterSeries
+                SeriesType_1.ESeriesType.ScatterSeries,
+                SeriesType_1.ESeriesType.ErrorBarsSeries
             ].includes(this.type);
             return (seriesTypeSupportsResampling &&
                 SciChartDefaults_1.SciChartDefaults.enableResampling &&
                 this.enableDrawingOptimisations &&
+                !this.isStacked &&
                 this.dataSeries &&
                 this.dataSeries.count() > 0 &&
                 this.dataSeries.dataDistributionCalculator.isSortedAscending);
@@ -871,7 +924,8 @@ var BaseRenderableSeries = /** @class */ (function () {
     return BaseRenderableSeries;
 }());
 exports.BaseRenderableSeries = BaseRenderableSeries;
-var getDataPointWidth = function (xValues, xCoordCalc, seriesViewRectWidth, widthFraction, isCategoryAxis) {
+/** @ignore */
+var getDataPointWidth = function (xValues, xCoordCalc, seriesViewRectWidth, widthFraction, isCategoryAxis, wasmContext) {
     if (widthFraction < 0 || widthFraction > 1) {
         throw new Error("WidthFraction should be between 0.0 and 1.0 inclusive");
     }
@@ -881,12 +935,28 @@ var getDataPointWidth = function (xValues, xCoordCalc, seriesViewRectWidth, widt
     var barsAmount = count;
     // TODO: logarithmic axis
     if (barsAmount > 1) {
-        var max = xCoordCalc.getCoordinate(xValues.get(count - 1));
-        var min = xCoordCalc.getCoordinate(xValues.get(0));
+        var max = Number.MIN_VALUE;
+        var min = Number.MAX_VALUE;
         if (isCategoryAxis) {
             max = xCoordCalc.getCoordinate(count - 1);
             min = xCoordCalc.getCoordinate(0);
         }
+        else {
+            var minMax = void 0;
+            try {
+                minMax = wasmContext.NumberUtil.MinMax(xValues);
+                // if (!isRealNumber(minMax.minD) || !isRealNumber(minMax.maxD)) {
+                //     return new NumberRange(0, 0);
+                // }
+                min = minMax.minD;
+                max = minMax.maxD;
+            }
+            finally {
+                (0, Deleter_1.deleteSafe)(minMax);
+            }
+            max = xCoordCalc.getCoordinate(max);
+            min = xCoordCalc.getCoordinate(min);
+        }
         dataPointWidth = Math.abs(max - min) / (barsAmount - 1);
     }
     else if (barsAmount === 1) {
@@ -899,3 +969,11 @@ var getDataPointWidth = function (xValues, xCoordCalc, seriesViewRectWidth, widt
     return candleWidth;
 };
 exports.getDataPointWidth = getDataPointWidth;
+/** @ignore */
+var getDelta = function (_a) {
+    var pointSize = _a.pointSize, areaSize = _a.areaSize, range = _a.range;
+    var pointScaled = pointSize * DpiHelper_1.DpiHelper.PIXEL_RATIO;
+    var k = areaSize / (areaSize - pointScaled);
+    return (Math.abs(range.max - range.min) * (k - 1)) / 2;
+};
+exports.getDelta = getDelta;

package/Charting/Visuals/RenderableSeries/BaseStackedCollection.d.ts

@@ -29,6 +29,7 @@ import { RolloverModifierRenderableSeriesProps } from "./RolloverModifier/Rollov
 import { SeriesHoveredArgs } from "./SeriesHoveredArgs";
 import { SeriesSelectedArgs } from "./SeriesSelectedArgs";
 import { ShaderEffect } from "./ShaderEffect";
+import { SeriesVisibleChangedArgs } from "./SeriesVisibleChangedArgs";
 /**
  * Options to pass to the {@link BaseStackedCollection} constructor
  */
@@ -99,6 +100,8 @@ export declare abstract class BaseStackedCollection<T extends BaseStackedRendera
      */
     protected constructor(webAssemblyContext: TSciChart, options?: IBaseStackedCollectionOptions);
     /** @inheritDoc */
+    get isVisibleChanged(): EventHandler<SeriesVisibleChangedArgs>;
+    /** @inheritDoc */
     get selected(): EventHandler<SeriesSelectedArgs>;
     /** @inheritDoc */
     get hovered(): EventHandler<SeriesHoveredArgs>;

package/Charting/Visuals/RenderableSeries/BaseStackedCollection.js

@@ -72,6 +72,14 @@ var BaseStackedCollection = /** @class */ (function (_super) {
         _this.accumulatedFinalAnimationValues0 = new _this.webAssemblyContext.SCRTDoubleVector();
         return _this;
     }
+    Object.defineProperty(BaseStackedCollection.prototype, "isVisibleChanged", {
+        /** @inheritDoc */
+        get: function () {
+            throw new Error("getting visibleChanged event is not supported for BaseStackedCollection");
+        },
+        enumerable: false,
+        configurable: true
+    });
     Object.defineProperty(BaseStackedCollection.prototype, "selected", {
         /** @inheritDoc */
         get: function () {