scichart 3.2.476 → 3.2.481

package/Builder/buildModifiers.d.ts

@@ -6,6 +6,7 @@ import { IMouseWheelZoomModifierOptions } from "../Charting/ChartModifiers/Mouse
 import { IRangeSelectionModifierOptions } from "../Charting/ChartModifiers/OverviewRangeSelectionModifier";
 import { IPinchZoomModifierOptions } from "../Charting/ChartModifiers/PinchZoomModifier";
 import { IRolloverModifierOptions } from "../Charting/ChartModifiers/RolloverModifier";
+import { IVerticalSliceOptions } from "../Charting/ChartModifiers/VerticalSliceModifier";
 import { IRubberBandXyZoomModifierOptions } from "../Charting/ChartModifiers/RubberBandXyZoomModifier";
 import { ISeriesSelectionModifierOptions } from "../Charting/ChartModifiers/SeriesSelectionModifier";
 import { IXAxisDragModifierOptions } from "../Charting/ChartModifiers/XAxisDragModifier";
@@ -32,6 +33,9 @@ export declare type TModifierDefinition = {
 } | {
     type: EChart2DModifierType.Rollover;
     options?: IRolloverModifierOptions;
+} | {
+    type: EChart2DModifierType.VerticalSlice;
+    options?: IVerticalSliceOptions;
 } | {
     type: EChart2DModifierType.RubberBandXYZoom;
     options?: IRubberBandXyZoomModifierOptions;

package/Builder/buildModifiers.js

@@ -8,6 +8,7 @@ var MouseWheelZoomModifier_1 = require("../Charting/ChartModifiers/MouseWheelZoo
 var OverviewRangeSelectionModifier_1 = require("../Charting/ChartModifiers/OverviewRangeSelectionModifier");
 var PinchZoomModifier_1 = require("../Charting/ChartModifiers/PinchZoomModifier");
 var RolloverModifier_1 = require("../Charting/ChartModifiers/RolloverModifier");
+var VerticalSliceModifier_1 = require("../Charting/ChartModifiers/VerticalSliceModifier");
 var RubberBandXyZoomModifier_1 = require("../Charting/ChartModifiers/RubberBandXyZoomModifier");
 var SeriesSelectionModifier_1 = require("../Charting/ChartModifiers/SeriesSelectionModifier");
 var XAxisDragModifier_1 = require("../Charting/ChartModifiers/XAxisDragModifier");
@@ -24,6 +25,7 @@ var classFactory_1 = require("./classFactory");
 (0, classFactory_1.registerType)(BaseType_1.EBaseType.Chart2DModifier, ChartModifierType_1.EChart2DModifierType.MouseWheelZoom, function (options) { return new MouseWheelZoomModifier_1.MouseWheelZoomModifier(options); }, true);
 (0, classFactory_1.registerType)(BaseType_1.EBaseType.Chart2DModifier, ChartModifierType_1.EChart2DModifierType.PinchZoom, function (options) { return new PinchZoomModifier_1.PinchZoomModifier(options); }, true);
 (0, classFactory_1.registerType)(BaseType_1.EBaseType.Chart2DModifier, ChartModifierType_1.EChart2DModifierType.Rollover, function (options) { return new RolloverModifier_1.RolloverModifier(options); }, true);
+(0, classFactory_1.registerType)(BaseType_1.EBaseType.Chart2DModifier, ChartModifierType_1.EChart2DModifierType.VerticalSlice, function (options) { return new VerticalSliceModifier_1.VerticalSliceModifier(options); }, true);
 (0, classFactory_1.registerType)(BaseType_1.EBaseType.Chart2DModifier, ChartModifierType_1.EChart2DModifierType.RubberBandXYZoom, function (options) { return new RubberBandXyZoomModifier_1.RubberBandXyZoomModifier(options); }, true);
 (0, classFactory_1.registerType)(BaseType_1.EBaseType.Chart2DModifier, ChartModifierType_1.EChart2DModifierType.SeriesSelection, function (options) { return new SeriesSelectionModifier_1.SeriesSelectionModifier(options); }, true);
 (0, classFactory_1.registerType)(BaseType_1.EBaseType.Chart2DModifier, ChartModifierType_1.EChart2DModifierType.XAxisDrag, function (options) { return new XAxisDragModifier_1.XAxisDragModifier(options); }, true);

package/Charting/ChartModifiers/RolloverModifier.d.ts

@@ -5,6 +5,7 @@ import { EChart2DModifierType } from "../../types/ChartModifierType";
 import { EMousePosition } from "../../types/MousePosition";
 import { SeriesInfo } from "../Model/ChartData/SeriesInfo";
 import { IThemeProvider } from "../Themes/IThemeProvider";
+import { LineAnnotation } from "../Visuals/Annotations/LineAnnotation";
 import { RolloverLegendSvgAnnotation } from "../Visuals/Annotations/RolloverLegendSvgAnnotation";
 import { HitTestInfo } from "../Visuals/RenderableSeries/HitTest/HitTestInfo";
 import { IRenderableSeries } from "../Visuals/RenderableSeries/IRenderableSeries";
@@ -53,6 +54,8 @@ export declare type TTooltipProps = {
     width: number;
     seriesInfo: SeriesInfo;
 };
+/** @ignore */
+export declare const TOOLTIP_SPACING = 4;
 /**
  * Optional parameters used to configure a {@link RolloverModifier} at construct time
  */
@@ -127,9 +130,10 @@ export declare class RolloverModifier extends ChartModifierBase2D implements IIn
     hitTestRadius: number;
     protected showRolloverLineProperty: boolean;
     protected showTooltipProperty: boolean;
-    private readonly rolloverLineAnnotation;
-    private readonly legendAnnotation;
-    private mousePosition;
+    protected absoluteXCoord: number;
+    readonly rolloverLineAnnotation: LineAnnotation | undefined;
+    protected mousePosition: EMousePosition;
+    protected readonly legendAnnotation: RolloverLegendSvgAnnotation | undefined;
     private tooltipDataTemplateProperty?;
     private allowTooltipOverlappingProperty;
     private includedSeriesMap;
@@ -139,6 +143,7 @@ export declare class RolloverModifier extends ChartModifierBase2D implements IIn
      * @param options Optional parameters {@link IRolloverModifierOptions} used to configure the modifier
      */
     constructor(options?: IRolloverModifierOptions);
+    protected createLine(options?: IRolloverModifierOptions): LineAnnotation;
     /**
      * @inheritDoc
      */
@@ -175,6 +180,7 @@ export declare class RolloverModifier extends ChartModifierBase2D implements IIn
      * @inheritDoc
      */
     onAttach(): void;
+    protected addLineAnnotationToSurface(): void;
     /**
      * @inheritDoc
      */
@@ -235,25 +241,27 @@ export declare class RolloverModifier extends ChartModifierBase2D implements IIn
     protected CalculateTooltipPositions(tooltipArray: TTooltipProps[], allowTooltipOverlapping: boolean, spacing: number, seriesViewRect: Rect, pixelRatio: number, isVerticalChart?: boolean): TTooltipProps[];
     /** @inheritDoc */
     protected notifyPropertyChanged(propertyName: string): void;
-    private isVerticalChart;
-    private removeSeriesAnnotationsFromParentSurface;
+    protected isVerticalChart(): boolean;
+    protected removeSeriesAnnotationsFromParentSurface(rs: IRenderableSeries): void;
     /**
      * @param rs
      */
-    private addSeriesAnnotationsToParentSurface;
-    private update;
-    private updateLine;
+    protected addSeriesAnnotationsToParentSurface(rs: IRenderableSeries): void;
+    protected getRolloverProps(rs: IRenderableSeries): RolloverModifierRenderableSeriesProps;
+    protected getRolloverProps1(rs: IRenderableSeries): RolloverModifierRenderableSeriesProps;
+    protected update(): void;
+    protected updateLine(): void;
     /**
      * @description Update Markers and Tooltips
      */
-    private updateSeriesAnnotations;
+    protected updateSeriesAnnotations(): void;
     /**
      * Test if the series is included or excluded, by default it is included
      * @param series
      * @private
      */
     private testIsIncludedSeries;
-    private getSeriesInfos;
+    protected getSeriesInfos(): SeriesInfo[];
     /**
      * Gets or sets the parent div element reference or id for the Tooltip
      */
@@ -290,3 +298,5 @@ export declare const calcTooltipProps: (index: number, rs: IRenderableSeries, ro
  * @param isVerticalChart
  */
 export declare const calcTooltipPositions: (tooltipArray: TTooltipProps[], allowTooltipOverlapping: boolean, spacing: number, seriesViewRect: Rect, pixelRatio: number, isVerticalChart?: boolean) => TTooltipProps[];
+/** @ignore */
+export declare const updateRolloverModifierProps: (rolloverRSProps: RolloverModifierRenderableSeriesProps, rs: IRenderableSeries, tooltipProps: TTooltipProps, showTooltip: boolean, showMarker: boolean, placementDivId?: string) => void;

package/Charting/ChartModifiers/RolloverModifier.js

@@ -15,7 +15,7 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.calcTooltipPositions = exports.calcTooltipProps = exports.RolloverModifier = void 0;
+exports.updateRolloverModifierProps = exports.calcTooltipPositions = exports.calcTooltipProps = exports.RolloverModifier = exports.TOOLTIP_SPACING = void 0;
 var classFactory_1 = require("../../Builder/classFactory");
 var BaseType_1 = require("../../types/BaseType");
 var ChartModifierType_1 = require("../../types/ChartModifierType");
@@ -34,7 +34,7 @@ var DpiHelper_1 = require("../Visuals/TextureManager/DpiHelper");
 var ChartModifierBase2D_1 = require("./ChartModifierBase2D");
 var constants_1 = require("./constants");
 /** @ignore */
-var TOOLTIP_SPACING = 4;
+exports.TOOLTIP_SPACING = 4;
 /**
  * The RolloverModifier provides tooltip and cursor behavior on a 2D {@link SciChartSurface}
  * within SciChart - High Performance {@link https://www.scichart.com/javascript-chart-features | JavaScript Charts}
@@ -56,7 +56,7 @@ var RolloverModifier = /** @class */ (function (_super) {
      */
     function RolloverModifier(options) {
         var _this = this;
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         _this = _super.call(this, options) || this;
         _this.type = ChartModifierType_1.EChart2DModifierType.Rollover;
         /**
@@ -78,21 +78,13 @@ var RolloverModifier = /** @class */ (function (_super) {
         _this.hitTestRadius = 0;
         _this.showRolloverLineProperty = true;
         _this.showTooltipProperty = true;
+        _this.absoluteXCoord = 0;
         _this.mousePosition = MousePosition_1.EMousePosition.OutOfCanvas;
         _this.allowTooltipOverlappingProperty = false;
         _this.includedSeriesMap = new Map();
         _this.hitTestRenderableSeries = _this.hitTestRenderableSeries.bind(_this);
         _this.placementDivIdProperty = (_a = options === null || options === void 0 ? void 0 : options.placementDivId) !== null && _a !== void 0 ? _a : _this.placementDivIdProperty;
-        _this.rolloverLineAnnotation = new LineAnnotation_1.LineAnnotation({
-            xCoordinateMode: AnnotationBase_1.ECoordinateMode.Pixel,
-            yCoordinateMode: AnnotationBase_1.ECoordinateMode.Pixel,
-            strokeDashArray: options === null || options === void 0 ? void 0 : options.rolloverLineStrokeDashArray,
-            strokeThickness: (_b = options === null || options === void 0 ? void 0 : options.rolloverLineStrokeThickness) !== null && _b !== void 0 ? _b : 2,
-            stroke: (_c = options === null || options === void 0 ? void 0 : options.rolloverLineStroke) !== null && _c !== void 0 ? _c : SciChartSurfaceBase_1.SciChartSurfaceBase.DEFAULT_THEME.cursorLineBrush,
-            isHidden: true,
-            xAxisId: _this.xAxisId,
-            yAxisId: _this.yAxisId
-        });
+        _this.rolloverLineAnnotation = _this.createLine(options);
         if (options === null || options === void 0 ? void 0 : options.tooltipLegendTemplate) {
             if (typeof options.tooltipLegendTemplate === "string") {
                 _this.typeMap.set("tooltipLegendTemplate", options.tooltipLegendTemplate);
@@ -100,9 +92,9 @@ var RolloverModifier = /** @class */ (function (_super) {
             }
         }
         _this.tooltipLegendTemplate =
-            (_d = options === null || options === void 0 ? void 0 : options.tooltipLegendTemplate) !== null && _d !== void 0 ? _d : _this.tooltipLegendTemplate;
-        _this.tooltipLegendOffsetX = (_e = options === null || options === void 0 ? void 0 : options.tooltipLegendOffsetX) !== null && _e !== void 0 ? _e : _this.tooltipLegendOffsetX;
-        _this.tooltipLegendOffsetY = (_f = options === null || options === void 0 ? void 0 : options.tooltipLegendOffsetY) !== null && _f !== void 0 ? _f : _this.tooltipLegendOffsetY;
+            (_b = options === null || options === void 0 ? void 0 : options.tooltipLegendTemplate) !== null && _b !== void 0 ? _b : _this.tooltipLegendTemplate;
+        _this.tooltipLegendOffsetX = (_c = options === null || options === void 0 ? void 0 : options.tooltipLegendOffsetX) !== null && _c !== void 0 ? _c : _this.tooltipLegendOffsetX;
+        _this.tooltipLegendOffsetY = (_d = options === null || options === void 0 ? void 0 : options.tooltipLegendOffsetY) !== null && _d !== void 0 ? _d : _this.tooltipLegendOffsetY;
         if (options === null || options === void 0 ? void 0 : options.tooltipDataTemplate) {
             if (typeof options.tooltipDataTemplate === "string") {
                 _this.typeMap.set("tooltipDataTemplate", options.tooltipDataTemplate);
@@ -110,9 +102,9 @@ var RolloverModifier = /** @class */ (function (_super) {
             }
         }
         _this.tooltipDataTemplateProperty =
-            (_g = options === null || options === void 0 ? void 0 : options.tooltipDataTemplate) !== null && _g !== void 0 ? _g : _this.tooltipDataTemplateProperty;
-        _this.showRolloverLineProperty = (_h = options === null || options === void 0 ? void 0 : options.showRolloverLine) !== null && _h !== void 0 ? _h : _this.showRolloverLineProperty;
-        _this.showTooltipProperty = (_j = options === null || options === void 0 ? void 0 : options.showTooltip) !== null && _j !== void 0 ? _j : _this.showTooltipProperty;
+            (_e = options === null || options === void 0 ? void 0 : options.tooltipDataTemplate) !== null && _e !== void 0 ? _e : _this.tooltipDataTemplateProperty;
+        _this.showRolloverLineProperty = (_f = options === null || options === void 0 ? void 0 : options.showRolloverLine) !== null && _f !== void 0 ? _f : _this.showRolloverLineProperty;
+        _this.showTooltipProperty = (_g = options === null || options === void 0 ? void 0 : options.showTooltip) !== null && _g !== void 0 ? _g : _this.showTooltipProperty;
         _this.legendAnnotation = new RolloverLegendSvgAnnotation_1.RolloverLegendSvgAnnotation({
             tooltipLegendTemplate: _this.tooltipLegendTemplate,
             tooltipLegendOffsetX: _this.tooltipLegendOffsetX,
@@ -120,11 +112,23 @@ var RolloverModifier = /** @class */ (function (_super) {
             xAxisId: _this.xAxisId,
             yAxisId: _this.yAxisId
         });
-        _this.allowTooltipOverlappingProperty = (_k = options === null || options === void 0 ? void 0 : options.allowTooltipOverlapping) !== null && _k !== void 0 ? _k : _this.allowTooltipOverlappingProperty;
-        _this.snapToDataPoint = (_l = options === null || options === void 0 ? void 0 : options.snapToDataPoint) !== null && _l !== void 0 ? _l : _this.snapToDataPoint;
-        _this.hitTestRadius = (_m = options === null || options === void 0 ? void 0 : options.hitTestRadius) !== null && _m !== void 0 ? _m : _this.hitTestRadius;
+        _this.allowTooltipOverlappingProperty = (_h = options === null || options === void 0 ? void 0 : options.allowTooltipOverlapping) !== null && _h !== void 0 ? _h : _this.allowTooltipOverlappingProperty;
+        _this.snapToDataPoint = (_j = options === null || options === void 0 ? void 0 : options.snapToDataPoint) !== null && _j !== void 0 ? _j : _this.snapToDataPoint;
+        _this.hitTestRadius = (_k = options === null || options === void 0 ? void 0 : options.hitTestRadius) !== null && _k !== void 0 ? _k : _this.hitTestRadius;
         return _this;
     }
+    RolloverModifier.prototype.createLine = function (options) {
+        var _a, _b;
+        return new LineAnnotation_1.LineAnnotation({
+            xCoordinateMode: AnnotationBase_1.ECoordinateMode.Pixel,
+            yCoordinateMode: AnnotationBase_1.ECoordinateMode.Pixel,
+            strokeDashArray: options === null || options === void 0 ? void 0 : options.rolloverLineStrokeDashArray,
+            strokeThickness: (_a = options === null || options === void 0 ? void 0 : options.rolloverLineStrokeThickness) !== null && _a !== void 0 ? _a : 2,
+            stroke: (_b = options === null || options === void 0 ? void 0 : options.rolloverLineStroke) !== null && _b !== void 0 ? _b : SciChartSurfaceBase_1.SciChartSurfaceBase.DEFAULT_THEME.cursorLineBrush,
+            xAxisId: this.xAxisId,
+            yAxisId: this.yAxisId
+        });
+    };
     /**
      * @inheritDoc
      */
@@ -233,10 +237,13 @@ var RolloverModifier = /** @class */ (function (_super) {
     RolloverModifier.prototype.onAttach = function () {
         var _this = this;
         _super.prototype.onAttach.call(this);
-        this.parentSurface.modifierAnnotations.add(this.rolloverLineAnnotation);
+        this.addLineAnnotationToSurface();
         this.parentSurface.modifierAnnotations.add(this.legendAnnotation);
         this.getIncludedRenderableSeries().forEach(function (rs) { return _this.addSeriesAnnotationsToParentSurface(rs); });
     };
+    RolloverModifier.prototype.addLineAnnotationToSurface = function () {
+        this.parentSurface.modifierAnnotations.add(this.rolloverLineAnnotation);
+    };
     /**
      * @inheritDoc
      */
@@ -432,19 +439,19 @@ var RolloverModifier = /** @class */ (function (_super) {
         if (rs.isStacked) {
             var stackedSeries = rs;
             stackedSeries.asArray().forEach(function (childRs) {
-                _this.parentSurface.modifierAnnotations.remove(childRs.rolloverModifierProps.marker);
-                _this.parentSurface.modifierAnnotations.remove(childRs.rolloverModifierProps.tooltip);
-                childRs.rolloverModifierProps.delete();
+                _this.parentSurface.modifierAnnotations.remove(_this.getRolloverProps(childRs).marker);
+                _this.parentSurface.modifierAnnotations.remove(_this.getRolloverProps(childRs).tooltip);
+                _this.getRolloverProps(childRs).delete();
             });
         }
         else {
-            this.parentSurface.modifierAnnotations.remove(rs.rolloverModifierProps.marker);
-            this.parentSurface.modifierAnnotations.remove(rs.rolloverModifierProps.tooltip);
-            rs.rolloverModifierProps.delete();
+            this.parentSurface.modifierAnnotations.remove(this.getRolloverProps(rs).marker);
+            this.parentSurface.modifierAnnotations.remove(this.getRolloverProps(rs).tooltip);
+            this.getRolloverProps(rs).delete();
             if (rs.type === SeriesType_1.ESeriesType.BandSeries) {
-                this.parentSurface.modifierAnnotations.remove(rs.rolloverModifierProps1.marker);
-                this.parentSurface.modifierAnnotations.remove(rs.rolloverModifierProps1.tooltip);
-                rs.rolloverModifierProps1.delete();
+                this.parentSurface.modifierAnnotations.remove(this.getRolloverProps1(rs).marker);
+                this.parentSurface.modifierAnnotations.remove(this.getRolloverProps1(rs).tooltip);
+                this.getRolloverProps1(rs).delete();
             }
         }
     };
@@ -457,16 +464,22 @@ var RolloverModifier = /** @class */ (function (_super) {
             rs.type === SeriesType_1.ESeriesType.StackedColumnCollection) {
             return;
         }
-        rs.rolloverModifierProps.rolloverModifier = this;
-        createAnnotations(rs, this.placementDivIdProperty);
-        this.parentSurface.modifierAnnotations.add(rs.rolloverModifierProps.marker);
-        this.parentSurface.modifierAnnotations.add(rs.rolloverModifierProps.tooltip);
+        this.getRolloverProps(rs).rolloverModifier = this;
+        createAnnotations(rs, this.getRolloverProps(rs), this.getRolloverProps1(rs), this.placementDivIdProperty);
+        this.parentSurface.modifierAnnotations.add(this.getRolloverProps(rs).marker);
+        this.parentSurface.modifierAnnotations.add(this.getRolloverProps(rs).tooltip);
         if (rs.type === SeriesType_1.ESeriesType.BandSeries) {
-            rs.rolloverModifierProps1.rolloverModifier = this;
-            this.parentSurface.modifierAnnotations.add(rs.rolloverModifierProps1.marker);
-            this.parentSurface.modifierAnnotations.add(rs.rolloverModifierProps1.tooltip);
+            this.getRolloverProps1(rs).rolloverModifier = this;
+            this.parentSurface.modifierAnnotations.add(this.getRolloverProps1(rs).marker);
+            this.parentSurface.modifierAnnotations.add(this.getRolloverProps1(rs).tooltip);
         }
     };
+    RolloverModifier.prototype.getRolloverProps = function (rs) {
+        return rs.rolloverModifierProps;
+    };
+    RolloverModifier.prototype.getRolloverProps1 = function (rs) {
+        return rs.rolloverModifierProps1;
+    };
     RolloverModifier.prototype.update = function () {
         this.updateLine();
         this.updateSeriesAnnotations();
@@ -533,32 +546,35 @@ var RolloverModifier = /** @class */ (function (_super) {
         var _this = this;
         var rsList = this.getIncludedRenderableSeries();
         rsList.forEach(function (rs) {
-            if (!rs.rolloverModifierProps.marker) {
+            var props = _this.getRolloverProps(rs);
+            if (!props.marker) {
                 _this.addSeriesAnnotationsToParentSurface(rs);
             }
-            rs.rolloverModifierProps.marker.suspendInvalidate();
-            rs.rolloverModifierProps.tooltip.suspendInvalidate();
-            rs.rolloverModifierProps.marker.isHidden = true;
-            rs.rolloverModifierProps.tooltip.isHidden = true;
-            rs.rolloverModifierProps.tooltip.x1 = undefined;
-            rs.rolloverModifierProps.tooltip.y1 = undefined;
+            props.marker.suspendInvalidate();
+            props.tooltip.suspendInvalidate();
+            props.marker.isHidden = true;
+            props.tooltip.isHidden = true;
+            props.tooltip.x1 = undefined;
+            props.tooltip.y1 = undefined;
             // TODO should be more general than looking at series type
             if (rs.type === SeriesType_1.ESeriesType.BandSeries) {
-                rs.rolloverModifierProps1.marker.suspendInvalidate();
-                rs.rolloverModifierProps1.tooltip.suspendInvalidate();
-                rs.rolloverModifierProps1.marker.isHidden = true;
-                rs.rolloverModifierProps1.tooltip.isHidden = true;
-                rs.rolloverModifierProps1.tooltip.x1 = undefined;
-                rs.rolloverModifierProps1.tooltip.y1 = undefined;
+                props.marker.suspendInvalidate();
+                props.tooltip.suspendInvalidate();
+                props.marker.isHidden = true;
+                props.tooltip.isHidden = true;
+                props.tooltip.x1 = undefined;
+                props.tooltip.y1 = undefined;
             }
         });
         if (this.mousePosition !== MousePosition_1.EMousePosition.SeriesArea) {
             rsList.forEach(function (rs) {
-                rs.rolloverModifierProps.marker.resumeInvalidate();
-                rs.rolloverModifierProps.tooltip.resumeInvalidate();
+                var props = _this.getRolloverProps(rs);
+                props.marker.resumeInvalidate();
+                props.tooltip.resumeInvalidate();
                 if (rs.type === SeriesType_1.ESeriesType.BandSeries) {
-                    rs.rolloverModifierProps1.marker.resumeInvalidate();
-                    rs.rolloverModifierProps1.tooltip.resumeInvalidate();
+                    // leave for now
+                    _this.getRolloverProps1(rs).marker.resumeInvalidate();
+                    _this.getRolloverProps1(rs).tooltip.resumeInvalidate();
                 }
             });
             return;
@@ -573,9 +589,9 @@ var RolloverModifier = /** @class */ (function (_super) {
                 if (rs.type !== SeriesType_1.ESeriesType.StackedColumnSeries || hitTestInfo.isHit) {
                     var isVisible = 0 <= hitTestInfo.yCoord && hitTestInfo.yCoord <= height;
                     if (isVisible) {
-                        var absoluteXCoord = _this.isVerticalChart() ? hitTestInfo.yCoord : hitTestInfo.xCoord;
+                        _this.absoluteXCoord = _this.isVerticalChart() ? hitTestInfo.yCoord : hitTestInfo.xCoord;
                         var absoluteYCoord = _this.isVerticalChart() ? hitTestInfo.xCoord : hitTestInfo.yCoord;
-                        var tooltipProps = (0, exports.calcTooltipProps)(index, rs, rs.rolloverModifierProps, _this.parentSurface.seriesViewRect, hitTestInfo.xValue, hitTestInfo.yValue, absoluteXCoord, absoluteYCoord, hitTestInfo, DpiHelper_1.DpiHelper.PIXEL_RATIO, false, _this.isVerticalChart());
+                        var tooltipProps = (0, exports.calcTooltipProps)(index, rs, _this.getRolloverProps(rs), _this.parentSurface.seriesViewRect, hitTestInfo.xValue, hitTestInfo.yValue, _this.absoluteXCoord, absoluteYCoord, hitTestInfo, DpiHelper_1.DpiHelper.PIXEL_RATIO, false, _this.isVerticalChart());
                         if (tooltipProps)
                             tooltipArray.push(tooltipProps);
                     }
@@ -585,7 +601,7 @@ var RolloverModifier = /** @class */ (function (_super) {
                     if (isVisibleY1) {
                         var absoluteXCoord = _this.isVerticalChart() ? hitTestInfo.y1Coord : hitTestInfo.xCoord;
                         var absoluteYCoord = _this.isVerticalChart() ? hitTestInfo.xCoord : hitTestInfo.y1Coord;
-                        var tooltipY1Props = (0, exports.calcTooltipProps)(index, rs, rs.rolloverModifierProps1, _this.parentSurface.seriesViewRect, hitTestInfo.xValue, hitTestInfo.y1Value, absoluteXCoord, absoluteYCoord, hitTestInfo, DpiHelper_1.DpiHelper.PIXEL_RATIO, true, _this.isVerticalChart());
+                        var tooltipY1Props = (0, exports.calcTooltipProps)(index, rs, _this.getRolloverProps1(rs), _this.parentSurface.seriesViewRect, hitTestInfo.xValue, hitTestInfo.y1Value, absoluteXCoord, absoluteYCoord, hitTestInfo, DpiHelper_1.DpiHelper.PIXEL_RATIO, true, _this.isVerticalChart());
                         if (tooltipY1Props)
                             tooltipArray.push(tooltipY1Props);
                     }
@@ -595,24 +611,24 @@ var RolloverModifier = /** @class */ (function (_super) {
         var orderedTooltipArray = tooltipArray.sort(function (a, b) {
             return a.yCoord > b.yCoord ? 1 : b.yCoord > a.yCoord ? -1 : 0;
         });
-        var tooltipPositions = this.CalculateTooltipPositions(orderedTooltipArray, this.allowTooltipOverlapping, TOOLTIP_SPACING * DpiHelper_1.DpiHelper.PIXEL_RATIO, this.parentSurface.seriesViewRect, DpiHelper_1.DpiHelper.PIXEL_RATIO, this.isVerticalChart());
+        var tooltipPositions = this.CalculateTooltipPositions(orderedTooltipArray, this.allowTooltipOverlapping, exports.TOOLTIP_SPACING * DpiHelper_1.DpiHelper.PIXEL_RATIO, this.parentSurface.seriesViewRect, DpiHelper_1.DpiHelper.PIXEL_RATIO, this.isVerticalChart());
         tooltipPositions.forEach(function (el) {
             var rs = rsList[el.index];
             var showTooltip = _this.showTooltip && el.seriesInfo.isHit;
             var showMarker = el.seriesInfo.isHit;
             if (el.isY1) {
-                updateRolloverModifierProps(rs.rolloverModifierProps1, rs, el, showTooltip, showMarker, _this.placementDivId);
+                (0, exports.updateRolloverModifierProps)(_this.getRolloverProps1(rs), rs, el, showTooltip, showMarker, _this.placementDivId);
             }
             else {
-                updateRolloverModifierProps(rs.rolloverModifierProps, rs, el, showTooltip, showMarker, _this.placementDivId);
+                (0, exports.updateRolloverModifierProps)(_this.getRolloverProps(rs), rs, el, showTooltip, showMarker, _this.placementDivId);
             }
         });
         rsList.forEach(function (rs) {
-            rs.rolloverModifierProps.marker.resumeInvalidate();
-            rs.rolloverModifierProps.tooltip.resumeInvalidate();
+            _this.getRolloverProps(rs).marker.resumeInvalidate();
+            _this.getRolloverProps(rs).tooltip.resumeInvalidate();
             if (rs.type === SeriesType_1.ESeriesType.BandSeries) {
-                rs.rolloverModifierProps1.marker.resumeInvalidate();
-                rs.rolloverModifierProps1.tooltip.resumeInvalidate();
+                _this.getRolloverProps1(rs).marker.resumeInvalidate();
+                _this.getRolloverProps1(rs).tooltip.resumeInvalidate();
             }
         });
     };
@@ -652,8 +668,8 @@ var RolloverModifier = /** @class */ (function (_super) {
             if (this.placementDivIdProperty !== value) {
                 this.placementDivIdProperty = value;
                 (_a = this.parentSurface) === null || _a === void 0 ? void 0 : _a.renderableSeries.asArray().forEach(function (rs) {
-                    rs.rolloverModifierProps.tooltip.placementDivId = _this.placementDivIdProperty;
-                    rs.rolloverModifierProps1.tooltip.placementDivId = _this.placementDivIdProperty;
+                    _this.getRolloverProps(rs).tooltip.placementDivId = _this.placementDivIdProperty;
+                    _this.getRolloverProps1(rs).tooltip.placementDivId = _this.placementDivIdProperty;
                 });
             }
         },
@@ -763,45 +779,45 @@ exports.calcTooltipPositions = calcTooltipPositions;
  * @description Creates MarkerAnnotation and TooltipAnnotation and assigns to rolloverSeries properties
  * @param rs RenderableSeries
  */
-var createAnnotations = function (rs, placementDivId) {
+var createAnnotations = function (rs, rolloverModifierProps, rolloverModifierProps1, placementDivId) {
     var _a, _b, _c, _d;
-    if (!rs.rolloverModifierProps.marker) {
-        rs.rolloverModifierProps.marker = new RolloverMarkerSvgAnnotation_1.RolloverMarkerSvgAnnotation(rs.rolloverModifierProps);
+    if (!rolloverModifierProps.marker) {
+        rolloverModifierProps.marker = new RolloverMarkerSvgAnnotation_1.RolloverMarkerSvgAnnotation(rolloverModifierProps);
         // Rollover tooltips for multiple Y-Axes are not supported for stacked series
         if (!rs.isStacked) {
-            rs.rolloverModifierProps.marker.xAxisId = rs.xAxisId;
-            rs.rolloverModifierProps.marker.yAxisId = rs.yAxisId;
+            rolloverModifierProps.marker.xAxisId = rs.xAxisId;
+            rolloverModifierProps.marker.yAxisId = rs.yAxisId;
         }
     }
-    if (!rs.rolloverModifierProps.tooltip) {
-        rs.rolloverModifierProps.tooltipTitle = (_b = (_a = rs.rolloverModifierProps.tooltipTitle) !== null && _a !== void 0 ? _a : rs.getDataSeriesName()) !== null && _b !== void 0 ? _b : "";
-        rs.rolloverModifierProps.tooltipColor = rs.rolloverModifierProps.tooltipColor;
-        rs.rolloverModifierProps.tooltip = new RolloverTooltipSvgAnnotation_1.RolloverTooltipSvgAnnotation(rs.rolloverModifierProps, {
+    if (!rolloverModifierProps.tooltip) {
+        rolloverModifierProps.tooltipTitle = (_b = (_a = rolloverModifierProps.tooltipTitle) !== null && _a !== void 0 ? _a : rs.getDataSeriesName()) !== null && _b !== void 0 ? _b : "";
+        rolloverModifierProps.tooltipColor = rolloverModifierProps.tooltipColor;
+        rolloverModifierProps.tooltip = new RolloverTooltipSvgAnnotation_1.RolloverTooltipSvgAnnotation(rolloverModifierProps, {
             seriesType: rs.type,
             placementDivId: placementDivId
         });
         // Rollover tooltips for multiple Y-Axes are not supported for stacked series
         if (!rs.isStacked) {
-            rs.rolloverModifierProps.tooltip.xAxisId = rs.xAxisId;
-            rs.rolloverModifierProps.tooltip.yAxisId = rs.yAxisId;
+            rolloverModifierProps.tooltip.xAxisId = rs.xAxisId;
+            rolloverModifierProps.tooltip.yAxisId = rs.yAxisId;
         }
     }
     if (rs.type === SeriesType_1.ESeriesType.BandSeries) {
         var bandRs = rs;
-        if (!bandRs.rolloverModifierProps1.marker) {
-            bandRs.rolloverModifierProps1.marker = new RolloverMarkerSvgAnnotation_1.RolloverMarkerSvgAnnotation(bandRs.rolloverModifierProps1);
-            bandRs.rolloverModifierProps1.marker.xAxisId = bandRs.xAxisId;
-            bandRs.rolloverModifierProps1.marker.yAxisId = bandRs.yAxisId;
-        }
-        if (!bandRs.rolloverModifierProps1.tooltip) {
-            bandRs.rolloverModifierProps1.tooltipTitle =
-                (_d = (_c = bandRs.rolloverModifierProps1.tooltipTitle) !== null && _c !== void 0 ? _c : bandRs.getDataSeriesName()) !== null && _d !== void 0 ? _d : "";
-            bandRs.rolloverModifierProps1.tooltipColor = bandRs.rolloverModifierProps1.tooltipColor;
-            bandRs.rolloverModifierProps1.tooltip = new RolloverTooltipSvgAnnotation_1.RolloverTooltipSvgAnnotation(bandRs.rolloverModifierProps1, {
+        if (!rolloverModifierProps1.marker) {
+            rolloverModifierProps1.marker = new RolloverMarkerSvgAnnotation_1.RolloverMarkerSvgAnnotation(rolloverModifierProps1);
+            rolloverModifierProps1.marker.xAxisId = bandRs.xAxisId;
+            rolloverModifierProps1.marker.yAxisId = bandRs.yAxisId;
+        }
+        if (!rolloverModifierProps1.tooltip) {
+            rolloverModifierProps1.tooltipTitle =
+                (_d = (_c = rolloverModifierProps1.tooltipTitle) !== null && _c !== void 0 ? _c : bandRs.getDataSeriesName()) !== null && _d !== void 0 ? _d : "";
+            rolloverModifierProps1.tooltipColor = rolloverModifierProps1.tooltipColor;
+            rolloverModifierProps1.tooltip = new RolloverTooltipSvgAnnotation_1.RolloverTooltipSvgAnnotation(rolloverModifierProps1, {
                 placementDivId: placementDivId
             });
-            bandRs.rolloverModifierProps1.tooltip.xAxisId = bandRs.xAxisId;
-            bandRs.rolloverModifierProps1.tooltip.yAxisId = bandRs.yAxisId;
+            rolloverModifierProps1.tooltip.xAxisId = bandRs.xAxisId;
+            rolloverModifierProps1.tooltip.yAxisId = bandRs.yAxisId;
         }
     }
 };
@@ -836,3 +852,4 @@ var updateRolloverModifierProps = function (rolloverRSProps, rs, tooltipProps, s
         }
     }
 };
+exports.updateRolloverModifierProps = updateRolloverModifierProps;

package/Charting/ChartModifiers/VerticalSliceModifier.d.ts

@@ -0,0 +1,76 @@
+import { RolloverModifier, IRolloverModifierOptions } from "./RolloverModifier";
+import { ModifierMouseArgs } from "./ModifierMouseArgs";
+import { RolloverModifierRenderableSeriesProps } from "../Visuals/RenderableSeries/RolloverModifier/RolloverModifierRenderableSeriesProps";
+import { IRenderableSeries } from "../Visuals/RenderableSeries/IRenderableSeries";
+import { ECoordinateMode } from "../Visuals/Annotations/AnnotationBase";
+import { LineAnnotation } from "../Visuals/Annotations/LineAnnotation";
+import { IChartModifierBaseOptions } from "./ChartModifierBase2D";
+/**
+ * Optional parameters used to configure a {@link RolloverModifier} at construct time
+ */
+export interface IVerticalSliceOptions extends IRolloverModifierOptions {
+    /**
+     * @description the X1 coordinate of the modifier
+     * @remarks The X1 coordinate obeys {@link xCoordinateMode} which defines whether the X1 coordinate is a pixel, data-value or relative coordinate
+     */
+    x1?: number;
+    /**
+     * The X-Coordinate mode. See {@link ECoordinateMode} for a list of values
+     * @remarks Want to display an annotation stretching across the entire width (or height) or the {@link SciChartSurface}?
+     * The {@link ECoordinateMode} enum has options which allow for relative, absolute or pixel coordinates which define annotation
+     * placement.
+     */
+    xCoordinateMode?: ECoordinateMode;
+    /** Whether the annotation is draggable by the user.  Default false */
+    isDraggable?: boolean;
+    /** If set and isDraggable is true, a selection box of this color will be shown around the line when it is clicked. */
+    lineSelectionColor?: string;
+}
+export declare class VerticalSliceModifier extends RolloverModifier {
+    /** @inheritDoc */
+    get x1(): number;
+    /** @inheritDoc */
+    set x1(value: number);
+    /** @inheritDoc */
+    get xCoordinateMode(): ECoordinateMode;
+    /** @inheritDoc */
+    set xCoordinateMode(value: ECoordinateMode);
+    /** @inheritDoc */
+    get verticalLine(): LineAnnotation;
+    /** @inheritDoc */
+    get isDraggable(): boolean;
+    /** @inheritDoc */
+    set isDraggable(value: boolean);
+    /** @inheritDoc */
+    get lineSelectionColor(): string;
+    /** @inheritDoc */
+    set lineSelectionColor(value: string);
+    private x1Property;
+    private xCoordinateModeProperty;
+    private isDraggableProperty;
+    private lineSelectionColorProperty;
+    private rmrsProps;
+    private rmrsProps1;
+    constructor(options?: IVerticalSliceOptions);
+    modifierMouseMove(args: ModifierMouseArgs): void;
+    /**
+     * @inheritDoc
+     */
+    modifierMouseLeave(args: ModifierMouseArgs): void;
+    toJSON(): {
+        type: string;
+        options: Required<Omit<IChartModifierBaseOptions, never>>;
+    };
+    protected getRolloverProps(rs: IRenderableSeries): RolloverModifierRenderableSeriesProps;
+    protected getRolloverProps1(rs: IRenderableSeries): RolloverModifierRenderableSeriesProps;
+    protected removeSeriesAnnotationsFromParentSurface(rs: IRenderableSeries): void;
+    /**
+     * @param rs
+     */
+    protected addSeriesAnnotationsToParentSurface(rs: IRenderableSeries): void;
+    protected createLine(options?: IRolloverModifierOptions): LineAnnotation;
+    protected update(): void;
+    /** @inheritDoc */
+    protected notifyPropertyChanged(propertyName: string): void;
+    private calculateXPosition;
+}