scichart 2.1.2294 → 2.2.2378

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

@@ -26,6 +26,10 @@ export interface IHeatmapRenderableSeriesOptions extends IBaseRenderableSeriesOp
      * The flag whether to make the heatmap linearly interpolated or smoothed between cells
      */
     useLinearTextureFiltering?: boolean;
+    /**
+     * The flag whether to fill cells with edge color if its value is outside of {@link colorMap.minimum} to {@link colorMap.maximum} range
+     */
+    fillValuesOutOfRange?: boolean;
 }
 /** @ignore */
 export declare const COLOR_MAP_PREFIX = "colorMap.";
@@ -72,6 +76,7 @@ export declare class UniformHeatmapRenderableSeries extends BaseRenderableSeries
     readonly type: ESeriesType;
     private colorMapProperty;
     private useLinearTextureFilteringProperty;
+    private fillValuesOutOfRangeProperty;
     private zLabelProviderProperty;
     /**
      * Creates an instance of the {@link UniformHeatmapRenderableSeries}
@@ -100,6 +105,14 @@ export declare class UniformHeatmapRenderableSeries extends BaseRenderableSeries
     checkIsOutOfDataRange(xValue: number, yValue: number): boolean;
     get zLabelProvider(): LabelProvider;
     set zLabelProvider(labelProvider: LabelProvider);
+    /**
+     * Gets or sets whether to fill cells with edge color if its value is outside of {@link colorMap.minimum} to {@link colorMap.maximum} range
+     */
+    get fillValuesOutOfRange(): boolean;
+    /**
+     * Gets or sets whether to fill cells with edge color if its value is outside of {@link colorMap.minimum} to {@link colorMap.maximum} range
+     */
+    set fillValuesOutOfRange(value: boolean);
     /** @inheritDoc */
     toPointSeries(resamplingParams?: ResamplingParams): IPointSeries;
     /** @inheritDoc */

package/Charting/Visuals/RenderableSeries/UniformHeatmapRenderableSeries.js

@@ -75,10 +75,11 @@ var UniformHeatmapRenderableSeries = /** @class */ (function (_super) {
      * @param options optional parameters of type {@link IHeatmapRenderableSeriesOptions} applied when constructing the series type
      */
     function UniformHeatmapRenderableSeries(webAssemblyContext, options) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f;
         var _this = _super.call(this, webAssemblyContext, options) || this;
         _this.type = SeriesType_1.ESeriesType.UniformHeatmapSeries;
         _this.useLinearTextureFilteringProperty = false;
+        _this.fillValuesOutOfRangeProperty = true;
         _this.colorMapPropertyChanged = _this.colorMapPropertyChanged.bind(_this);
         if (options === null || options === void 0 ? void 0 : options.colorMap) {
             if (!("toJSON" in options.colorMap)) {
@@ -91,9 +92,10 @@ var UniformHeatmapRenderableSeries = /** @class */ (function (_super) {
         _this.xAxisId = (_b = options === null || options === void 0 ? void 0 : options.yAxisId) !== null && _b !== void 0 ? _b : AxisCore_1.AxisCore.DEFAULT_AXIS_ID;
         _this.useLinearTextureFilteringProperty =
             (_c = options === null || options === void 0 ? void 0 : options.useLinearTextureFiltering) !== null && _c !== void 0 ? _c : _this.useLinearTextureFilteringProperty;
+        _this.fillValuesOutOfRangeProperty = (_d = options === null || options === void 0 ? void 0 : options.fillValuesOutOfRange) !== null && _d !== void 0 ? _d : _this.fillValuesOutOfRangeProperty;
         // Must be called here for the series type to be available
-        if ((_d = _this.paletteProvider) === null || _d === void 0 ? void 0 : _d.onAttached) {
-            (_e = _this.paletteProvider) === null || _e === void 0 ? void 0 : _e.onAttached(_this);
+        if ((_e = _this.paletteProvider) === null || _e === void 0 ? void 0 : _e.onAttached) {
+            (_f = _this.paletteProvider) === null || _f === void 0 ? void 0 : _f.onAttached(_this);
         }
         _this.drawingProviders = [];
         if (!app_1.IS_TEST_ENV) {
@@ -159,6 +161,23 @@ var UniformHeatmapRenderableSeries = /** @class */ (function (_super) {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(UniformHeatmapRenderableSeries.prototype, "fillValuesOutOfRange", {
+        /**
+         * Gets or sets whether to fill cells with edge color if its value is outside of {@link colorMap.minimum} to {@link colorMap.maximum} range
+         */
+        get: function () {
+            return this.fillValuesOutOfRangeProperty;
+        },
+        /**
+         * Gets or sets whether to fill cells with edge color if its value is outside of {@link colorMap.minimum} to {@link colorMap.maximum} range
+         */
+        set: function (value) {
+            this.fillValuesOutOfRangeProperty = value;
+            this.notifyPropertyChanged(constants_1.PROPERTY.FILL_VALUES_OUT_OF_RANGE);
+        },
+        enumerable: false,
+        configurable: true
+    });
     /** @inheritDoc */
     UniformHeatmapRenderableSeries.prototype.toPointSeries = function (resamplingParams) {
         // not used for Heatmap
@@ -171,6 +190,7 @@ var UniformHeatmapRenderableSeries = /** @class */ (function (_super) {
         var json = _super.prototype.toJSON.call(this, excludeData);
         var options = {
             colorMap: (_a = this.colorMap) === null || _a === void 0 ? void 0 : _a.toJSON(),
+            fillValuesOutOfRange: this.fillValuesOutOfRange,
             useLinearTextureFiltering: this.useLinearTextureFiltering
         };
         Object.assign(json.options, options);

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

@@ -40,6 +40,7 @@ export interface IXyScatterRenderableSeriesOptions extends IBaseRenderableSeries
  */
 export declare class XyScatterRenderableSeries extends BaseRenderableSeries {
     readonly type = ESeriesType.ScatterSeries;
+    private scatterOpacityProperty;
     /**
      * Creates an instance of the {@link XyScatterRenderableSeries}
      * @param webAssemblyContext The {@link TSciChart | SciChart WebAssembly Context} containing
@@ -51,4 +52,8 @@ export declare class XyScatterRenderableSeries extends BaseRenderableSeries {
     toPointSeries(rp?: ResamplingParams): IPointSeries;
     /** @inheritDoc */
     protected newHitTestProvider(): IHitTestProvider;
+    /** @inheritDoc */
+    get opacity(): number;
+    /** @inheritDoc */
+    set opacity(value: number);
 }

package/Charting/Visuals/RenderableSeries/XyScatterRenderableSeries.js

@@ -20,6 +20,7 @@ var SeriesType_1 = require("../../../types/SeriesType");
 var XyPointSeriesWrapped_1 = require("../../Model/PointSeries/XyPointSeriesWrapped");
 var EllipsePointMarker_1 = require("../PointMarkers/EllipsePointMarker");
 var BaseRenderableSeries_1 = require("./BaseRenderableSeries");
+var constants_1 = require("./constants");
 var PointMarkerDrawingProvider_1 = require("./DrawingProviders/PointMarkerDrawingProvider");
 var ScatterSeriesHitTestProvider_1 = require("./HitTest/ScatterSeriesHitTestProvider");
 /**
@@ -59,9 +60,10 @@ var XyScatterRenderableSeries = /** @class */ (function (_super) {
      * @param options Optional parameters of type {@link IBaseRenderableSeriesOptions} to configure the series
      */
     function XyScatterRenderableSeries(webAssemblyContext, options) {
-        var _a, _b;
+        var _a, _b, _c;
         var _this = _super.call(this, webAssemblyContext, options) || this;
         _this.type = SeriesType_1.ESeriesType.ScatterSeries;
+        _this.scatterOpacityProperty = 1;
         if (!_this.pointMarker) {
             _this.pointMarker = new EllipsePointMarker_1.EllipsePointMarker(webAssemblyContext, { width: 10, height: 10 });
         }
@@ -74,6 +76,7 @@ var XyScatterRenderableSeries = /** @class */ (function (_super) {
         if ((_a = _this.paletteProvider) === null || _a === void 0 ? void 0 : _a.onAttached) {
             (_b = _this.paletteProvider) === null || _b === void 0 ? void 0 : _b.onAttached(_this);
         }
+        _this.scatterOpacityProperty = (_c = options === null || options === void 0 ? void 0 : options.opacity) !== null && _c !== void 0 ? _c : _this.scatterOpacityProperty;
         return _this;
     }
     /** @inheritDoc */
@@ -84,6 +87,23 @@ var XyScatterRenderableSeries = /** @class */ (function (_super) {
     XyScatterRenderableSeries.prototype.newHitTestProvider = function () {
         return new ScatterSeriesHitTestProvider_1.ScatterSeriesHitTestProvider(this, this.webAssemblyContext);
     };
+    Object.defineProperty(XyScatterRenderableSeries.prototype, "opacity", {
+        /** @inheritDoc */
+        get: function () {
+            return this.scatterOpacityProperty;
+        },
+        /** @inheritDoc */
+        set: function (value) {
+            this.scatterOpacityProperty = value;
+            this.notifyPropertyChanged(constants_1.PROPERTY.OPACITY);
+            if (this.pointMarker) {
+                this.pointMarker.opacity = value;
+                this.notifyPropertyChanged(constants_1.PROPERTY.POINT_MARKER);
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
     return XyScatterRenderableSeries;
 }(BaseRenderableSeries_1.BaseRenderableSeries));
 exports.XyScatterRenderableSeries = XyScatterRenderableSeries;

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

@@ -9,13 +9,20 @@ export declare enum PROPERTY {
     CONTOUR_MAJOR_LINE_STYLE = "CONTOUR_MAJOR_LINE_STYLE",
     CONTOUR_COLOR_MAP_MODE = "CONTOUR_COLOR_MAP_MODE",
     DATA_POINT_WIDTH = "dataPointWidth",
+    DATA_POINT_WIDTH_MODE = "DATA_POINT_WIDTH_MODE",
     DATA_SERIES = "dataSeries",
+    DRAWING_PROVIDERS = "DRAWING_PROVIDERS",
     DRAW_NAN_AS = "drawNaNAs",
+    DRAW_CONNECTOR = "DRAW_CONNECTOR",
+    DRAW_WHISKERS = "DRAW_WHISKERS",
     EFFECT = "EFFECT",
     ENABLE_DRAWING_OPTIMISATIONS = "ENABLE_DRAWING_OPTIMISATIONS",
+    ERROR_DIRECTION = "ERROR_DIRECTION",
+    ERROR_MODE = "ERROR_MODE",
     FILL = "fill",
     FILL_Y1 = "FILL_Y1",
     FILL_LINEAR_GRADIENT = "FILL_LINEAR_GRADIENT",
+    FILL_VALUES_OUT_OF_RANGE = "FILL_VALUES_OUT_OF_RANGE",
     GRADIENT_STOPS = "GRADIENT_STOPS",
     HOVERED = "HOVERED",
     INTERPOLATION_POINTS = "INTERPOLATION_POINTS",
@@ -29,6 +36,7 @@ export declare enum PROPERTY {
     OFFSET = "OFFSET",
     OPACITY = "OPACITY",
     PALETTE_PROVIDER = "PALETTE_PROVIDER",
+    PARENT_SURFACE = "PARENT_SURFACE",
     POINT_MARKER = "pointMarker",
     RANGE = "RANGE",
     RESAMPLING_MODE = "RESAMPLING_MODE",

package/Charting/Visuals/RenderableSeries/constants.js

@@ -13,13 +13,20 @@ var PROPERTY;
     PROPERTY["CONTOUR_MAJOR_LINE_STYLE"] = "CONTOUR_MAJOR_LINE_STYLE";
     PROPERTY["CONTOUR_COLOR_MAP_MODE"] = "CONTOUR_COLOR_MAP_MODE";
     PROPERTY["DATA_POINT_WIDTH"] = "dataPointWidth";
+    PROPERTY["DATA_POINT_WIDTH_MODE"] = "DATA_POINT_WIDTH_MODE";
     PROPERTY["DATA_SERIES"] = "dataSeries";
+    PROPERTY["DRAWING_PROVIDERS"] = "DRAWING_PROVIDERS";
     PROPERTY["DRAW_NAN_AS"] = "drawNaNAs";
+    PROPERTY["DRAW_CONNECTOR"] = "DRAW_CONNECTOR";
+    PROPERTY["DRAW_WHISKERS"] = "DRAW_WHISKERS";
     PROPERTY["EFFECT"] = "EFFECT";
     PROPERTY["ENABLE_DRAWING_OPTIMISATIONS"] = "ENABLE_DRAWING_OPTIMISATIONS";
+    PROPERTY["ERROR_DIRECTION"] = "ERROR_DIRECTION";
+    PROPERTY["ERROR_MODE"] = "ERROR_MODE";
     PROPERTY["FILL"] = "fill";
     PROPERTY["FILL_Y1"] = "FILL_Y1";
     PROPERTY["FILL_LINEAR_GRADIENT"] = "FILL_LINEAR_GRADIENT";
+    PROPERTY["FILL_VALUES_OUT_OF_RANGE"] = "FILL_VALUES_OUT_OF_RANGE";
     PROPERTY["GRADIENT_STOPS"] = "GRADIENT_STOPS";
     PROPERTY["HOVERED"] = "HOVERED";
     PROPERTY["INTERPOLATION_POINTS"] = "INTERPOLATION_POINTS";
@@ -33,6 +40,7 @@ var PROPERTY;
     PROPERTY["OFFSET"] = "OFFSET";
     PROPERTY["OPACITY"] = "OPACITY";
     PROPERTY["PALETTE_PROVIDER"] = "PALETTE_PROVIDER";
+    PROPERTY["PARENT_SURFACE"] = "PARENT_SURFACE";
     PROPERTY["POINT_MARKER"] = "pointMarker";
     PROPERTY["RANGE"] = "RANGE";
     PROPERTY["RESAMPLING_MODE"] = "RESAMPLING_MODE";

package/Charting/Visuals/SciChartPieSurface/IPieSurfaceOptions.d.ts

@@ -1,5 +1,9 @@
+import { TLabelProviderDefinition } from "../../../Builder/buildAxis";
+import { Thickness } from "../../../Core/Thickness";
+import { TBorder } from "../../../types/TBorder";
+import { PieLabelProvider } from "../Axis/LabelProvider/PieLabelProvider";
 import { ISurfaceOptionsBase } from "../SciChartSurfaceBase";
-import { EPieType, ESizingMode } from "./SciChartPieSurface";
+import { EPieType, EPieValueMode, ESizingMode } from "./SciChartPieSurface";
 /**
  * Options passed to a {@link SciChartPieSurface} in the {@link SciChartPieSurface.create} function
  */
@@ -18,8 +22,10 @@ export interface IPieSurfaceOptions extends ISurfaceOptionsBase {
     pieType?: EPieType;
     /** Optional - the radius of the hole for a donut chart. */
     holeRadius?: number;
-    /** Optional - Whether to animate the chart as it is initially drawn.  Default true */
+    /** Optional - Whether to animate the chart as it is drawn.  Default true */
     animate?: boolean;
+    /** Optional - The number of frames for the animation. Default 30.  A frame will be trigged every 20ms. */
+    animationFrames?: number;
     /** Optional - how the hole radius is interpreted, either absolute, or relative to the total radius */
     holeRadiusSizingMode?: ESizingMode;
     /** Optional - whether to show the legend.  Default true */
@@ -30,4 +36,21 @@ export interface IPieSurfaceOptions extends ISurfaceOptionsBase {
     showLegendCheckBoxes?: boolean;
     /** Optional - whether to show series markers on the legend.  Default true */
     showLegendSeriesMarkers?: boolean;
+    /** Optional - adds the spacings / padding around the view area */
+    padding?: Thickness;
+    /** Optional - adds the border to the view area */
+    canvasBorder?: TBorder;
+    /** Optional - addes spacing between the segments */
+    seriesSpacing?: number;
+    /**
+     * Sets a {@link LabelProvider} - a class which is responsible for formatting axis labels and cursor labels from numeric values
+     */
+    labelProvider?: PieLabelProvider | TLabelProviderDefinition;
+    /** Whether to show labels as percentages, or raw values.  Default to percentages */
+    valueMode?: EPieValueMode;
+    /**
+     * Use this to adjust the position of the labels.  1 is the default.  Larger values will shift the labels outwards.
+     * If you want more detailed control you can override calcTitlePosition.
+     */
+    labelRadiusAdjustment?: number;
 }

package/Charting/Visuals/SciChartPieSurface/PieSegment/IPieSegment.d.ts

@@ -1,16 +1,24 @@
 import { GradientParams } from "../../../../Core/GradientParams";
+import { Point } from "../../../../Core/Point";
+import { TTextStyle } from "../../Axis/AxisCore";
 import { SciChartPieSurface } from "../SciChartPieSurface";
 import { IPieSegmentOptions } from "./PieSegment";
 export interface IPieSegment {
     readonly id: string;
     text: string;
     value: number;
+    oldValue: number;
     color: string;
     colorLinearGradient: GradientParams;
     isSelected: boolean;
     delta: number;
+    shift: number;
+    labelStyle: TTextStyle;
+    labelOffset: Point;
+    radiusAdjustment: number;
     onAttach(scs: SciChartPieSurface): void;
     onDetach(): void;
-    getPercentage(total: number): string;
     toJSON(): IPieSegmentOptions;
+    getPercentage(total: number): number;
+    getLabelText(total: number): string;
 }

package/Charting/Visuals/SciChartPieSurface/PieSegment/PieSegment.d.ts

@@ -1,42 +1,168 @@
+import { TLabelProviderDefinition } from "../../../../Builder/buildAxis";
 import { GradientParams } from "../../../../Core/GradientParams";
+import { Point } from "../../../../Core/Point";
 import { RequiredOwnProps } from "../../../../types/HelperTypes";
+import { TTextStyle } from "../../Axis/AxisCore";
+import { PieLabelProvider } from "../../Axis/LabelProvider/PieLabelProvider";
 import { SciChartPieSurface } from "../SciChartPieSurface";
 import { IPieSegment } from "./IPieSegment";
 export interface IPieSegmentOptions {
     id?: string;
+    /**
+     * A text value for the segment which will be displayed in the legend
+     */
     text?: string;
+    /**
+     * The numerical value of the segment
+     */
     value?: number;
+    /**
+     * The color of the segment as an HTML color code
+     */
     color?: string;
+    /**
+     * An optional color gradient
+     */
     colorLinearGradient?: GradientParams;
+    /**
+     * Whether the segment is selected.  Selected segments are shifted outwards by the delta
+     */
     isSelected?: boolean;
+    /**
+     * The amount to shift the segment when it is selected.  Default 15 px
+     */
     delta?: number;
+    /**
+     * Optional class that can override the default label formatting for this segment only.  Must be or inherit from {@link PieLabelProvider}
+     */
+    labelProvider?: PieLabelProvider | TLabelProviderDefinition;
+    /**
+     * Optional text style that will override the default style from the surface for this segment only
+     */
+    labelStyle?: TTextStyle;
+    /**
+     * An x, y offset for the label position
+     */
+    labelOffset?: Point;
+    /**
+     * A relative adjustment of the radius for this segment. eg 1.5 will be 50% larger than normal
+     */
+    radiusAdjustment?: number;
 }
 export declare class PieSegment implements IPieSegment {
-    static readonly DEFAULT_DELTA = 15;
     readonly id: string;
     private colorProperty;
     private colorLinearGradientProperty;
     private isSelectedProperty;
     private textProperty;
     private valueProperty;
+    private oldValueProperty;
     private deltaProperty;
+    private shiftProperty;
+    private parentSurface;
+    private labelProviderProperty;
+    private labelStyleProperty;
+    private labelOffsetProperty;
+    private radiusAdjustmentProperty;
     private invalidateParentCallback;
     constructor(options?: IPieSegmentOptions);
     onAttach(scps: SciChartPieSurface): void;
     onDetach(): void;
+    /**
+     * An optional color gradient
+     */
     get colorLinearGradient(): GradientParams;
+    /**
+     * An optional color gradient
+     */
     set colorLinearGradient(value: GradientParams);
+    /**
+     * The color of the segment as an HTML color code
+     */
     get color(): string;
+    /**
+     * The color of the segment as an HTML color code
+     */
     set color(value: string);
+    /**
+     * Whether the segment is selected.  Selected segments are shifted outwards by the delta
+     */
     get isSelected(): boolean;
+    /**
+     * Whether the segment is selected.  Selected segments are shifted outwards by the delta
+     */
     set isSelected(value: boolean);
+    /**
+     * A text value for the segment which will be displayed in the legend
+     */
     get text(): string;
+    /**
+     * A text value for the segment which will be displayed in the legend
+     */
     set text(value: string);
-    getPercentage(total: number): string;
+    /**
+     * Optional class that can override the default label formatting for this segment only.  Must be or inherit from {@link PieLabelProvider}
+     */
+    get labelProvider(): PieLabelProvider;
+    /**
+     * Optional class that can override the default label formatting for this segment only.  Must be or inherit from {@link PieLabelProvider}
+     */
+    set labelProvider(value: PieLabelProvider);
+    getPercentage(total: number): number;
+    /**
+     * The numerical value of the segment
+     */
     get value(): number;
+    /**
+     * The numerical value of the segment
+     */
     set value(value: number);
+    /**
+     * The previous value of the segment, if it has been updated.  Used for animations
+     */
+    get oldValue(): number;
+    /**
+     * The amount to shift the segment when it is selected.  Default 15 px
+     */
     get delta(): number;
+    /**
+     * The amount to shift the segment when it is selected.  Default 15 px
+     */
     set delta(value: number);
+    /**
+     * The amount the segment is shifted radially outwards.  Automatically set during selected/deselection animations
+     * Do not set this directly.  Use delta and isSelected instead
+     */
+    get shift(): number;
+    /**
+     * The amount the segment is shifted radially outwards.  Automatically set during selected/deselection animations
+     */
+    set shift(value: number);
+    /**
+     * Gets or sets a {@link TTextStyle} object for styling labels for this segment only
+     */
+    get labelStyle(): TTextStyle;
+    /**
+     * Gets or sets a {@link TTextStyle} object for styling labels for this segment only
+     */
+    set labelStyle(textStyle: TTextStyle);
+    /**
+     * An x, y offset for the label position
+     */
+    get labelOffset(): Point;
+    /**
+     * An x, y offset for the label position
+     */
+    set labelOffset(value: Point);
+    /**
+     * A relative adjustment of the radius for this segment. eg 1.5 will be 50% larger than normal
+     */
+    get radiusAdjustment(): number;
+    /**
+     * A relative adjustment of the radius for this segment. eg 1.5 will be 50% larger than normal
+     */
+    set radiusAdjustment(value: number);
     toJSON(): RequiredOwnProps<IPieSegmentOptions>;
+    getLabelText(total: number): string;
     private notifyPropertyChanged;
 }