scichart 2.2.2417 → 3.0.0-beta.230

package/Charting/Visuals/RenderableSeries/DataLabels/BaseDataLabelProvider.js

@@ -0,0 +1,129 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseDataLabelProvider = void 0;
+var Guard_1 = require("../../../../Core/Guard");
+var TextPosition_1 = require("../../../../types/TextPosition");
+var parseColor_1 = require("../../../../utils/parseColor");
+var IThemeProvider_1 = require("../../../Themes/IThemeProvider");
+var NativeObject_1 = require("../../Helpers/NativeObject");
+var DpiHelper_1 = require("../../TextureManager/DpiHelper");
+var BaseDataLabelProvider = /** @class */ (function () {
+    /**
+     * Creates an instance of the {@link DataLabelProvider}
+     */
+    function BaseDataLabelProvider(options) {
+        /**
+         * The text to draw, along with the sizes and positions.  Usually generated, but can be updated before final drawing
+         */
+        this.dataLabels = [];
+        this.styleProperty = options === null || options === void 0 ? void 0 : options.style;
+        this.colorProperty = options === null || options === void 0 ? void 0 : options.color;
+    }
+    /**
+     * Called when a DataLabelProvider is attached to a parent {@link IRenderableSeries | RenderableSeries}
+     * @param webAssemblyContext
+     * @param parentSeries
+     */
+    BaseDataLabelProvider.prototype.onAttach = function (webAssemblyContext, parentSeries) {
+        Guard_1.Guard.notNull(webAssemblyContext, "webAssemblyContext");
+        Guard_1.Guard.notNull(parentSeries, "parentSeries");
+        this.webAssemblyContext = webAssemblyContext;
+        this.parentSeries = parentSeries;
+    };
+    Object.defineProperty(BaseDataLabelProvider.prototype, "style", {
+        /**
+         * Gets or sets the text style used for data labels. The style must be set, with fontFamily and fontSize set, in order for text to be drawn.
+         */
+        get: function () {
+            return this.styleProperty;
+        },
+        /**
+         * Gets or sets the text style used for data labels. The style must be set, with fontFamily and fontSize set, in order for text to be drawn.
+         */
+        set: function (value) {
+            this.styleProperty = value;
+            this.invalidateParent();
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(BaseDataLabelProvider.prototype, "color", {
+        /**
+         * Gets or sets the color for data labels.  Defaults to axis label color
+         */
+        get: function () {
+            var _a, _b, _c;
+            if (!this.colorProperty) {
+                return (_c = (_b = (_a = this.parentSeries) === null || _a === void 0 ? void 0 : _a.parentSurface) === null || _b === void 0 ? void 0 : _b.themeProvider) === null || _c === void 0 ? void 0 : _c.tickTextBrush;
+            }
+            return (0, IThemeProvider_1.stripAutoColor)(this.colorProperty);
+        },
+        /**
+         * Gets or sets the color for data labels.  Defaults to axis label color
+         */
+        set: function (value) {
+            this.colorProperty = value;
+            this.invalidateParent();
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /** Update the style.  Only the properties passed will be updated */
+    BaseDataLabelProvider.prototype.updateStyle = function (value) {
+        this.styleProperty = __assign(__assign({}, this.styleProperty), value);
+        this.invalidateParent();
+    };
+    /**
+     * Base behaviour is to do nothing.  Labels will only be drawn if they have been manually set
+     */
+    BaseDataLabelProvider.prototype.generateDataLabels = function (renderContext, renderPassData) { };
+    BaseDataLabelProvider.prototype.draw = function (renderContext) {
+        var _a, _b, _c;
+        if (!this.dataLabels || this.dataLabels.length === 0) {
+            return;
+        }
+        if (!this.style || !this.style.fontFamily || !this.style.fontSize) {
+            return;
+        }
+        var color = (0, parseColor_1.parseColorToUIntArgb)(this.color);
+        var dpiAdjustedStyle = DpiHelper_1.DpiHelper.adjustTextStyle(this.style);
+        var font = renderContext.getFont(dpiAdjustedStyle);
+        var rotationVector = (0, NativeObject_1.getVector4)(this.webAssemblyContext, 0, 0, 0, 0);
+        var alignMode = (0, TextPosition_1.convertMultiLineAlignment)(this.style.multiLineAlignment, this.webAssemblyContext);
+        for (var _i = 0, _d = this.dataLabels; _i < _d.length; _i++) {
+            var item = _d[_i];
+            // Adjust the postion to take into account the seriesVewRect.
+            // We do this because we are ending the font after the transformation has been popped.
+            font.DrawStringAdvanced((_a = item.text) !== null && _a !== void 0 ? _a : "", (_b = item.color) !== null && _b !== void 0 ? _b : color, Math.round(item.position.x + this.parentSeries.parentSurface.seriesViewRect.left), Math.round(item.position.y + this.parentSeries.parentSurface.seriesViewRect.top), rotationVector, alignMode, (_c = this.style.lineSpacing) !== null && _c !== void 0 ? _c : 2);
+        }
+        // Don't end font here to facilitate batch drawing
+    };
+    BaseDataLabelProvider.prototype.resolveAutoColors = function (index, maxSeries, theme) {
+        if (this.colorProperty && this.colorProperty.startsWith(IThemeProvider_1.AUTO_COLOR)) {
+            var color = theme.getStrokeColor(index, maxSeries, this.webAssemblyContext);
+            this.color = IThemeProvider_1.AUTO_COLOR + color;
+        }
+    };
+    BaseDataLabelProvider.prototype.toJSON = function () {
+        return { type: this.type, options: { style: this.style, color: this.color } };
+    };
+    BaseDataLabelProvider.prototype.invalidateParent = function () {
+        var _a;
+        if ((_a = this.parentSeries) === null || _a === void 0 ? void 0 : _a.invalidateParentCallback) {
+            this.parentSeries.invalidateParentCallback();
+        }
+    };
+    return BaseDataLabelProvider;
+}());
+exports.BaseDataLabelProvider = BaseDataLabelProvider;

package/Charting/Visuals/RenderableSeries/DataLabels/BubbleSeriesDataLabelProvider.d.ts

@@ -0,0 +1,17 @@
+import { Point } from "../../../../Core/Point";
+import { EHorizontalTextPosition, EVerticalTextPosition } from "../../../../types/TextPosition";
+import { EDataLabelProviderType } from "../../../../types/DataLabelProviderType";
+import { TSRTextBounds } from "../../../../types/TSciChart";
+import { DataLabelProvider, IDataLabelProviderOptions } from "./DataLabelProvider";
+import { DataLabelState } from "./DataLabelState";
+export interface IBubbleSeriesDataLabelProviderOptions extends IDataLabelProviderOptions {
+    /** Sets the horizontal Anchor point for the label.  Default Center */
+    horizontalTextPosition?: EHorizontalTextPosition;
+    /** Sets the vertical Anchor point for the label. Default Center */
+    verticalTextPosition?: EVerticalTextPosition;
+}
+export declare class BubbleSeriesDataLabelProvider extends DataLabelProvider {
+    readonly type: EDataLabelProviderType;
+    constructor(options?: IBubbleSeriesDataLabelProviderOptions);
+    getPosition(state: DataLabelState, textBounds: TSRTextBounds): Point;
+}

package/Charting/Visuals/RenderableSeries/DataLabels/BubbleSeriesDataLabelProvider.js

@@ -0,0 +1,62 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BubbleSeriesDataLabelProvider = void 0;
+var Point_1 = require("../../../../Core/Point");
+var TextPosition_1 = require("../../../../types/TextPosition");
+var DataLabelProviderType_1 = require("../../../../types/DataLabelProviderType");
+var DataLabelProvider_1 = require("./DataLabelProvider");
+var BubbleSeriesDataLabelProvider = /** @class */ (function (_super) {
+    __extends(BubbleSeriesDataLabelProvider, _super);
+    function BubbleSeriesDataLabelProvider(options) {
+        var _this = this;
+        var _a, _b;
+        _this = _super.call(this, options) || this;
+        _this.type = DataLabelProviderType_1.EDataLabelProviderType.Bubble;
+        _this.horizontalTextPositionProperty = (_a = options === null || options === void 0 ? void 0 : options.horizontalTextPosition) !== null && _a !== void 0 ? _a : TextPosition_1.EHorizontalTextPosition.Center;
+        _this.verticalTextPositionProperty = (_b = options === null || options === void 0 ? void 0 : options.verticalTextPosition) !== null && _b !== void 0 ? _b : TextPosition_1.EVerticalTextPosition.Center;
+        return _this;
+    }
+    BubbleSeriesDataLabelProvider.prototype.getPosition = function (state, textBounds) {
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        var x = state.xCoord();
+        var radius = Math.abs(state.parentSeries.getBubbleDiameter(state.index)) / 2;
+        if (this.horizontalTextPosition === TextPosition_1.EHorizontalTextPosition.Center) {
+            x -= textBounds.m_fWidth / 2;
+        }
+        else if (this.horizontalTextPosition === TextPosition_1.EHorizontalTextPosition.Left) {
+            x -= textBounds.m_fWidth + ((_b = (_a = this.style.padding) === null || _a === void 0 ? void 0 : _a.right) !== null && _b !== void 0 ? _b : 0) + radius;
+        }
+        else {
+            x += ((_d = (_c = this.style.padding) === null || _c === void 0 ? void 0 : _c.right) !== null && _d !== void 0 ? _d : 0) + radius;
+        }
+        var yOffset = textBounds.m_fHeight - textBounds.GetLineBounds(0).m_fHeight;
+        var y = state.yCoord() - yOffset;
+        if (this.verticalTextPosition === TextPosition_1.EVerticalTextPosition.Center) {
+            y += textBounds.m_fHeight / 2;
+        }
+        else if (this.verticalTextPosition === TextPosition_1.EVerticalTextPosition.Bottom) {
+            y += textBounds.m_fHeight + ((_f = (_e = this.style.padding) === null || _e === void 0 ? void 0 : _e.top) !== null && _f !== void 0 ? _f : 0) + radius;
+        }
+        else {
+            y -= ((_h = (_g = this.style.padding) === null || _g === void 0 ? void 0 : _g.bottom) !== null && _h !== void 0 ? _h : 0) + radius;
+        }
+        return new Point_1.Point(x, y);
+    };
+    return BubbleSeriesDataLabelProvider;
+}(DataLabelProvider_1.DataLabelProvider));
+exports.BubbleSeriesDataLabelProvider = BubbleSeriesDataLabelProvider;

package/Charting/Visuals/RenderableSeries/DataLabels/ColumnSeriesDataLabelProvider.d.ts

@@ -0,0 +1,47 @@
+import { Point } from "../../../../Core/Point";
+import { EDataLabelProviderType } from "../../../../types/DataLabelProviderType";
+import { TSRTextBounds } from "../../../../types/TSciChart";
+import { WebGlRenderContext2D } from "../../../Drawing/WebGlRenderContext2D";
+import { RenderPassData } from "../../../Services/RenderPassData";
+import { DataLabelProvider, IDataLabelProviderOptions } from "./DataLabelProvider";
+import { DataLabelState } from "./DataLabelState";
+export declare enum EColumnDataLabelPosition {
+    Outside = "Outside",
+    Inside = "Inside",
+    VerticalPosition = "VerticalPosition"
+}
+export interface IColumnSeriesDataLabelProviderOptions extends IDataLabelProviderOptions {
+    /**
+     * Sets whether text should be positioned outside or inside the end of the column using {@link EColumnDataLabelPosition}.
+     * If VerticalPosition then the {@link verticalPosition} property is used.
+     * Default Outside
+     */
+    positionMode?: EColumnDataLabelPosition;
+}
+export declare class ColumnSeriesDataLabelProvider extends DataLabelProvider {
+    readonly type: EDataLabelProviderType;
+    private yAdj;
+    private positionModeProperty;
+    constructor(options?: IColumnSeriesDataLabelProviderOptions);
+    /**
+     * Sets whether text should be positioned outside or inside the end of the column using {@link EColumnDataLabelPosition}.
+     * If VerticalPosition then the {@link verticalPosition} property is used.
+     * Default Outside
+     */
+    get positionMode(): EColumnDataLabelPosition;
+    /**
+     * Sets whether text should be positioned outside or inside the end of the column using {@link EColumnDataLabelPosition}.
+     * If VerticalPosition then the {@link verticalPosition} property is used.
+     * Default Outside
+     */
+    set positionMode(value: EColumnDataLabelPosition);
+    generateDataLabels(renderContext: WebGlRenderContext2D, renderPassData: RenderPassData): void;
+    getPosition(state: DataLabelState, textBounds: TSRTextBounds): Point;
+    toJSON(): {
+        type: EDataLabelProviderType;
+        options: {
+            style: import("../../../../types/TDataLabelStyle").TDataLabelStyle;
+            color: string;
+        };
+    };
+}

package/Charting/Visuals/RenderableSeries/DataLabels/ColumnSeriesDataLabelProvider.js

@@ -0,0 +1,125 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ColumnSeriesDataLabelProvider = exports.EColumnDataLabelPosition = void 0;
+var Point_1 = require("../../../../Core/Point");
+var DataLabelProviderType_1 = require("../../../../types/DataLabelProviderType");
+var TextPosition_1 = require("../../../../types/TextPosition");
+var DataLabelProvider_1 = require("./DataLabelProvider");
+var EColumnDataLabelPosition;
+(function (EColumnDataLabelPosition) {
+    EColumnDataLabelPosition["Outside"] = "Outside";
+    EColumnDataLabelPosition["Inside"] = "Inside";
+    EColumnDataLabelPosition["VerticalPosition"] = "VerticalPosition";
+})(EColumnDataLabelPosition = exports.EColumnDataLabelPosition || (exports.EColumnDataLabelPosition = {}));
+var ColumnSeriesDataLabelProvider = /** @class */ (function (_super) {
+    __extends(ColumnSeriesDataLabelProvider, _super);
+    function ColumnSeriesDataLabelProvider(options) {
+        var _this = this;
+        var _a;
+        _this = _super.call(this, options) || this;
+        _this.type = DataLabelProviderType_1.EDataLabelProviderType.Column;
+        _this.positionModeProperty = EColumnDataLabelPosition.Outside;
+        _this.positionModeProperty = (_a = options === null || options === void 0 ? void 0 : options.positionMode) !== null && _a !== void 0 ? _a : _this.positionMode;
+        return _this;
+    }
+    Object.defineProperty(ColumnSeriesDataLabelProvider.prototype, "positionMode", {
+        /**
+         * Sets whether text should be positioned outside or inside the end of the column using {@link EColumnDataLabelPosition}.
+         * If VerticalPosition then the {@link verticalPosition} property is used.
+         * Default Outside
+         */
+        get: function () {
+            return this.positionModeProperty;
+        },
+        /**
+         * Sets whether text should be positioned outside or inside the end of the column using {@link EColumnDataLabelPosition}.
+         * If VerticalPosition then the {@link verticalPosition} property is used.
+         * Default Outside
+         */
+        set: function (value) {
+            this.positionModeProperty = value;
+            this.invalidateParent();
+        },
+        enumerable: false,
+        configurable: true
+    });
+    ColumnSeriesDataLabelProvider.prototype.generateDataLabels = function (renderContext, renderPassData) {
+        var parent = this.parentSeries;
+        this.yAdj = Math.ceil(parent.strokeThickness / 2);
+        if (parent.pointMarker) {
+            this.yAdj = Math.max(this.yAdj, Math.ceil(parent.pointMarker.height / 2));
+        }
+        _super.prototype.generateDataLabels.call(this, renderContext, renderPassData);
+    };
+    ColumnSeriesDataLabelProvider.prototype.getPosition = function (state, textBounds) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+        var x = state.xCoord();
+        if (this.horizontalTextPosition === TextPosition_1.EHorizontalTextPosition.Center) {
+            x -= textBounds.m_fWidth / 2;
+        }
+        else if (this.horizontalTextPosition === TextPosition_1.EHorizontalTextPosition.Left) {
+            x -= textBounds.m_fWidth + ((_b = (_a = this.style.padding) === null || _a === void 0 ? void 0 : _a.right) !== null && _b !== void 0 ? _b : 0);
+        }
+        else {
+            x += (_d = (_c = this.style.padding) === null || _c === void 0 ? void 0 : _c.left) !== null && _d !== void 0 ? _d : 0;
+        }
+        if (this.positionMode === EColumnDataLabelPosition.Outside) {
+            // Handle multiline
+            var yOffset = textBounds.m_fHeight - textBounds.GetLineBounds(0).m_fHeight;
+            var y = state.yCoord() - yOffset;
+            // Text anchor point is bottom left
+            if (state.yVal() >= 0) {
+                // positive - draw above
+                y -= this.yAdj + ((_f = (_e = state.style.padding) === null || _e === void 0 ? void 0 : _e.bottom) !== null && _f !== void 0 ? _f : 1);
+            }
+            else {
+                // negative - draw below
+                y += textBounds.m_fHeight + this.yAdj + ((_h = (_g = state.style.padding) === null || _g === void 0 ? void 0 : _g.top) !== null && _h !== void 0 ? _h : 1);
+            }
+            return new Point_1.Point(x, y);
+        }
+        else if (this.positionMode === EColumnDataLabelPosition.Inside) {
+            // Handle multiline
+            var yOffset = textBounds.m_fHeight - textBounds.GetLineBounds(0).m_fHeight;
+            var y = state.yCoord() - yOffset;
+            // Text anchor point is bottom left
+            if (state.yVal() >= 0) {
+                y += textBounds.m_fHeight + this.yAdj + ((_k = (_j = state.style.padding) === null || _j === void 0 ? void 0 : _j.top) !== null && _k !== void 0 ? _k : 1);
+                // positive - draw below
+            }
+            else {
+                // negative - draw above
+                y -= this.yAdj + ((_m = (_l = state.style.padding) === null || _l === void 0 ? void 0 : _l.bottom) !== null && _m !== void 0 ? _m : 1);
+            }
+            return new Point_1.Point(x, y);
+        }
+        else {
+            return _super.prototype.getPosition.call(this, state, textBounds);
+        }
+    };
+    ColumnSeriesDataLabelProvider.prototype.toJSON = function () {
+        var json = _super.prototype.toJSON.call(this);
+        var options = {
+            positionMode: this.positionMode
+        };
+        Object.assign(json.options, options);
+        return json;
+    };
+    return ColumnSeriesDataLabelProvider;
+}(DataLabelProvider_1.DataLabelProvider));
+exports.ColumnSeriesDataLabelProvider = ColumnSeriesDataLabelProvider;

package/Charting/Visuals/RenderableSeries/DataLabels/ContoursDataLabelProvider.d.ts

@@ -0,0 +1,71 @@
+import { Point } from "../../../../Core/Point";
+import { EDataLabelProviderType } from "../../../../types/DataLabelProviderType";
+import { ENumericFormat } from "../../../../types/NumericFormat";
+import { Size } from "../../../../types/Size";
+import { WebGlRenderContext2D } from "../../../Drawing/WebGlRenderContext2D";
+import { BaseHeatmapDataSeries } from "../../../Model/BaseHeatmapDataSeries";
+import { IPointMetadata } from "../../../Model/IPointMetadata";
+import { RenderPassData } from "../../../Services/RenderPassData";
+import { BaseDataLabelProvider, IBaseDataLabelProviderOptions, TDataLabel } from "./BaseDataLabelProvider";
+export interface IContoursDataLabelProviderOptions extends IBaseDataLabelProviderOptions {
+    /**
+     * Gets or sets numeric format to use for formatting values to text. For a list of values, see {@link ENumericFormat}
+     */
+    numericFormat?: ENumericFormat;
+    /**
+     * Gets or sets the precision to use when formatting values to text.
+     */
+    precision?: number;
+    /**
+     * If this is set it will be used to get text values from metaData, rather than formatting y values.
+     * The selector will be called even if the metaData for an index is undefined.
+     */
+    metaDataSelector?: (metadata: IPointMetadata) => string;
+    /** sets the number of rows of data labels. Default 10 */
+    labelRowCount?: number;
+}
+export declare class ContoursDataLabelProvider extends BaseDataLabelProvider {
+    readonly type: EDataLabelProviderType;
+    /**
+     * If this is set it will be used to get text values from metaData, rather than formatting y values.
+     * The selector will be called even if the metaData for an index is undefined.
+     */
+    metaDataSelector: (metadata: IPointMetadata) => string;
+    protected dataSeries: BaseHeatmapDataSeries;
+    protected zValues: number[][];
+    protected colorValue: number;
+    private numericFormatProperty;
+    private precisionProperty;
+    private labelRowCountProperty;
+    constructor(options?: IContoursDataLabelProviderOptions);
+    /**
+     * Gets or sets numeric format to use when formatting values to text. For a list of values, see {@link ENumericFormat}
+     * For more control, override getText
+     */
+    get numericFormat(): ENumericFormat;
+    set numericFormat(value: ENumericFormat);
+    /**
+     * Gets or sets the precision to use when formatting values to text
+     * For more control, override getText
+     */
+    get precision(): number;
+    set precision(value: number);
+    /**
+     * Gets or sets the number of rows of data labels. Default 10
+     */
+    get labelRowCount(): number;
+    set labelRowCount(value: number);
+    getText(xIndex: number, yIndex: number): string;
+    getPosition(xIndex: number, yIndex: number, xVal: number, yVal: number, textSize: Size, renderPassData: RenderPassData): Point;
+    shouldGenerate(textSize: Size, cellWidth: number, cellHeight: number): boolean;
+    getColor(xIndex: number, yIndex: number, text: string): number;
+    shouldSkipLabel(xIndex: number, yIndex: number, label: TDataLabel, cellWidth: number, cellHeight: number): boolean;
+    generateDataLabels(renderContext: WebGlRenderContext2D, renderPassData: RenderPassData): void;
+    toJSON(): {
+        type: EDataLabelProviderType;
+        options: {
+            style: import("../../../../types/TDataLabelStyle").TDataLabelStyle;
+            color: string;
+        };
+    };
+}