@mescius/wijmo.chart.analytics 5.20232.939

package/index.d.ts

@@ -0,0 +1,723 @@
+/*!
+    *
+    * Wijmo Library 5.20232.939
+    * https://developer.mescius.com/wijmo
+    *
+    * Copyright(c) MESCIUS inc. All rights reserved.
+    *
+    * Licensed under the End-User License Agreement For MESCIUS Wijmo Software.
+    * us.sales@mescius.com
+    * https://developer.mescius.com/wijmo/licensing
+    *
+    */
+/**
+ * {@module wijmo.chart.analytics}
+ * Defines classes that add analytics features to charts including {@link TrendLine},
+ * {@link MovingAverage} and {@link FunctionSeries}.
+ */
+/**
+ *
+ */
+export declare var ___keepComment: any;
+import { Rect, Size } from '@grapecity/wijmo';
+import { SeriesBase, _HitTester, IRenderEngine, _IHitArea, FlexChartCore, _BarPlotter, _RectArea, _ISeries, _IAxis, Series } from '@grapecity/wijmo.chart';
+/**
+ * Represents a Waterfall series of {@link FlexChart}.
+ *
+ * The {@link Waterfall} series is normally used to demonstrate how
+ * the starting position either increases or decreases through a
+ * series of changes.
+ */
+export declare class Waterfall extends SeriesBase {
+    static CSS_CONNECTOR_LINE_GROUP: string;
+    static CSS_CONNECTOR_LINE: string;
+    static CSS_ENDLABEL: string;
+    _barPlotter: _BarPlotter;
+    private _start;
+    private _startLabel;
+    private _relativeData;
+    private _connectorLines;
+    private _showTotal;
+    private _totalLabel;
+    private _styles;
+    private _wfstyle;
+    private _xValues;
+    private _getXValues;
+    private _yValues;
+    private _showIntermediateTotal;
+    private _intermediateTotalPositions;
+    private _intermediateTotalLabels;
+    private _intermediateTotalPos;
+    /**
+     * Initializes a new instance of the {@link Waterfall} class.
+     *
+     * @param options JavaScript object containing initialization data for the object.
+     */
+    constructor(options?: any);
+    /**
+     * Gets or sets a value that determines whether the given data
+     * represents absolute or relative values (differences).
+     */
+    relativeData: boolean;
+    /**
+     * Gets or sets a value that determines the value of the start bar.
+     * If start is null, the start bar will not be shown.
+     */
+    start: number;
+    /**
+     * Gets or sets the label of the start bar.
+     */
+    startLabel: string;
+    /**
+     * Gets or sets a value that determines whether to show
+     * the total bar at the end of the chart.
+     */
+    showTotal: boolean;
+    /**
+     * Gets or sets the label of the total bar.
+     */
+    totalLabel: string;
+    /**
+     * Gets or sets a value that determines whether to show intermediate
+     * total bars.
+     *
+     * This property works with {@link intermediateTotalPositions} and
+     * {@link intermediateTotalLabels} properties.
+     */
+    showIntermediateTotal: boolean;
+    /**
+     * Gets or sets a value of the property that contains the index
+     * for positions of the intermediate total bars.
+     *
+     * This property works with the {@link showIntermediateTotal} and
+     * {@link intermediateTotalLabels} properties.
+     */
+    intermediateTotalPositions: number[];
+    /**
+     * Gets or sets the name of the property that contains labels for
+     * the intermediate total bars. This should be an array or a string.
+     *
+     * This property works with the {@link showIntermediateTotal} and
+     * {@link intermediateTotalPositions} properties.
+     */
+    intermediateTotalLabels: any;
+    /**
+     * Gets or sets a value that determines whether to show
+     * connector lines.
+     */
+    connectorLines: boolean;
+    /**
+     * Gets or sets the Waterfall styles.
+     *
+     * The following styles are supported:
+     *
+     * <ol>
+     *   <li><b>start</b>: Specifies the style of the start column.</li>
+     *   <li><b>total</b>: Specifies the style of the total column.</li>
+     *   <li><b>intermediateTotal</b>: Specifies the style of the intermediate total column.</li>
+     *   <li><b>falling</b>: Specifies the style of the falling columns.</li>
+     *   <li><b>rising</b>: Specifies the style of the rising columns.</li>
+     *   <li><b>connectorLines</b>: Specifies the style of the connectorLines.</li>
+     * </ol>
+     *
+     * <pre>waterfall.styles = {
+     *   start: { fill: 'blue', stroke: 'blue' },
+     *   total: { fill: 'yellow', stroke: 'yellow' },
+     *   falling: { fill: 'red', stroke: 'red' },
+     *   rising: { fill: 'green', stroke: 'green' },
+     *   connectorLines: { stroke: 'blue', 'stroke-dasharray': '10, 10' }
+     * }</pre>
+     */
+    styles: any;
+    getValues(dim: number): number[];
+    legendItemLength(): number;
+    measureLegendItem(engine: IRenderEngine, index: number): Size;
+    drawLegendItem(engine: IRenderEngine, rect: Rect, index: number): void;
+    _clearValues(): void;
+    _invalidate(): void;
+    _getXOffset(): number;
+    _getYOffset(pointIndex: number): number;
+    _getValue(pointIndex: number): number;
+    _getItem(pi: number): any;
+    private _rendering;
+    private _getStyles;
+    private _getStyleByKey;
+    private _drawConnectorLine;
+    private _getLegendStyles;
+    private _getName;
+}
+/**
+ * Represents base class for various trend lines.
+ */
+export declare class TrendLineBase extends SeriesBase {
+    private _sampleCount;
+    private _bind;
+    private _bindX;
+    _xValues: any[];
+    _yValues: any[];
+    _originXValues: any[];
+    _originYValues: any[];
+    /**
+     * Initializes a new instance of the {@link TrendLineBase} class.
+     *
+     * @param options JavaScript object containing initialization data for the object.
+     */
+    constructor(options?: any);
+    /**
+     * Gets or sets the sample count for function calculation.
+     * The property doesn't apply for MovingAverage.
+     */
+    sampleCount: number;
+    /**
+     * Gets the approximate y value from the given x value.
+     *
+     * @param x The x value to be used for calculating the Y value.
+     */
+    approximate(x: number): number;
+    getValues(dim: number): number[];
+    _calculateValues(): void;
+    _invalidate(): void;
+    _clearValues(): void;
+    _clearCalculatedValues(): void;
+}
+/**
+ * Specifies the type of MovingAverage Series.
+ */
+export declare enum MovingAverageType {
+    /**
+     * An average of the last n values.
+     */
+    Simple = 0,
+    /**
+     * Weighted average of the last n values,
+     * where the weight decreases by 1 with each previous value.
+     */
+    Weighted = 1,
+    /**
+     * Weighted average of the last n values,
+     * where the weight decreases exponentially with each previous value.
+     */
+    Exponential = 2,
+    /**
+     * Weighted average of the last n values,
+     * whose result is equivalent to a double smoothed simple moving average.
+     */
+    Triangular = 3
+}
+/**
+ * Represents a moving average trend line for {@link FlexChart} and {@link FinancialChart}.
+ *
+ * It is a calculation to analyze data points by creating a series of averages of
+ * different subsets of the full data set. You may define a different type on each
+ * {@link MovingAverage} object by setting the {@link type} property on the
+ * {@link MovingAverage} itself.
+ *
+ * The {@link MovingAverage} class has a {@link period} property that allows you to set
+ * the number of periods for computing the average value.
+ */
+export declare class MovingAverage extends TrendLineBase {
+    private _period;
+    private _type;
+    /**
+     * Initializes a new instance of the {@link MovingAverage} class.
+     *
+     * @param options JavaScript object containing initialization data for the object.
+     */
+    constructor(options?: any);
+    /**
+     * Gets or sets the type of the moving average series.
+     */
+    type: MovingAverageType;
+    /**
+     * Gets or sets the period of the moving average series.
+     * It should be set to integer value greater than 1.
+     */
+    period: number;
+    _checkPeriod(): void;
+    _calculateValues(): void;
+    private _calculateSimple;
+    private _calculateWeighted;
+    private _calculateExponential;
+    private _calculateTriangular;
+}
+/**
+ * Specifies the fit type for a {@link TrendLine} series.
+ */
+export declare enum TrendLineFitType {
+    /**
+     * A straight line that most closely approximates the data.  Y(x) = a * x + b.
+     */
+    Linear = 0,
+    /**
+     * Regression fit to the equation Y(x) = a * exp(b*x).
+     */
+    Exponential = 1,
+    /**
+     * Regression fit to the equation Y(x) = a * ln(x) + b.
+     */
+    Logarithmic = 2,
+    /**
+     * Regression fit to the equation Y(x) = a * pow(x, b).
+     */
+    Power = 3,
+    /**
+     * Regression fit to the equation Y(x) = a + b * cos(x) + c * sin(x) + d * cos(2*x) + e * sin(2*x) + ...
+     */
+    Fourier = 4,
+    /**
+     * Regression fit to the equation Y(x) = a * x^n + b * x^n-1 + c * x^n-2 + ... + z.
+     */
+    Polynomial = 5,
+    /**
+     * The minimum X-value.
+     */
+    MinX = 6,
+    /**
+     * The minimum Y-value.
+     */
+    MinY = 7,
+    /**
+     * The maximum X-value.
+     */
+    MaxX = 8,
+    /**
+     * The maximum Y-value.
+     */
+    MaxY = 9,
+    /**
+     * The average X-value.
+     */
+    AverageX = 10,
+    /**
+     * The average Y-value.
+     */
+    AverageY = 11
+}
+/**
+ * Represents a trend line series in a {@link FlexChart} or {@link FinancialChart}.
+ *
+ * A trend line is a line superimposed on a chart revealing the overall
+ * direction of data.
+ *
+ * You may define a different fit type for each {@link TrendLine} series
+ * on the {@link FlexChart} by setting its {@link fitType} property.
+ */
+export declare class TrendLine extends TrendLineBase {
+    private _fitType;
+    private _order;
+    private _helper;
+    /**
+     * Initializes a new instance of the {@link TrendLine} class.
+     *
+     * @param options JavaScript object containing initialization data for the object.
+     */
+    constructor(options?: any);
+    /**
+     * Gets or sets the fit type of the {@link TrendLine}.
+     */
+    fitType: TrendLineFitType;
+    /**
+     * Gets or sets the number of terms in a polynomial or Fourier equation.
+     *
+     * Set this value to an integer greater than 1.
+     * It gets applied when the fitType is set to
+     * TrendLineFitType.Polynomial or
+     * TrendLineFitType.Fourier.
+     */
+    order: number;
+    /**
+     * Gets the coefficients of the equation.
+     */
+    readonly coefficients: number[];
+    /**
+     * Gets the approximate y value from the given x value.
+     *
+     * @param x The x value to be used for calculating the Y value.
+     */
+    approximate(x: number): number;
+    /**
+     * Gets the formatted equation string for the coefficients.
+     *
+     * @param fmt The formatting function used to convert the coefficients
+     * into strings. This parameter is optional.
+     */
+    getEquation(fmt?: Function): string;
+    _calculateValues(): void;
+}
+/**
+ * Represents a base class of function series for {@link FlexChart}.
+ */
+export declare class FunctionSeries extends TrendLineBase {
+    private _min;
+    private _max;
+    /**
+     * Initializes a new instance of the {@link FunctionSeries} class.
+     *
+     * @param options JavaScript object containing initialization data for the object.
+     */
+    constructor(options?: any);
+    /**
+     * Gets or sets the minimum value of the parameter for calculating a function.
+     */
+    min: number;
+    /**
+     * Gets or sets the maximum value of the parameter for calculating a function.
+     */
+    max: number;
+    getValues(dim: number): number[];
+    _calculateValues(): void;
+    _validateValue(value: number): number;
+    _calculateValue(func: Function, parameter: number): number;
+    _calculateX(value: number): number;
+    _calculateY(value: number): number;
+}
+/**
+ * Represents a Y function series of {@link FlexChart}.
+ *
+ * The {@link YFunctionSeries} plots a function defined by formulas
+ * of type y=f(x), specified using the {@link func} property.
+ */
+export declare class YFunctionSeries extends FunctionSeries {
+    private _func;
+    /**
+     * Initializes a new instance of the {@link YFunctionSeries} class.
+     *
+     * @param options JavaScript object containing initialization data for the object.
+     */
+    constructor(options?: any);
+    /**
+     * Gets or sets the function used to calculate Y value.
+     */
+    func: Function;
+    _calculateX(value: number): number;
+    _calculateY(value: number): number;
+    /**
+     * Gets the approximate y value from the given x value.
+     *
+     * @param x The x value to be used for calculating the Y value.
+     */
+    approximate(x: number): number;
+}
+/**
+ * Represents a parametric function series for {@link FlexChart}.
+ *
+ * The {@link ParametricFunctionSeries} plots a function defined by formulas
+ * x=f(t) and y=f(t).
+ *
+ * The x and y values are calculated by the functions assigned to the
+ * {@link xFunc} and {@link yFunc} properties.
+ */
+export declare class ParametricFunctionSeries extends FunctionSeries {
+    private _xFunc;
+    private _yFunc;
+    /**
+     * Initializes a new instance of the {@link ParametricFunctionSeries} class.
+     *
+     * @param options JavaScript object containing initialization data for the object.
+     */
+    constructor(options?: any);
+    /**
+     * Gets or sets the function used to calculate the x value.
+     */
+    xFunc: Function;
+    /**
+     * Gets or sets the function used to calculate the y value.
+     */
+    yFunc: Function;
+    _calculateX(value: number): number;
+    _calculateY(value: number): number;
+    /**
+     * Gets the approximate x and y from the given value.
+     *
+     * @param value The value to calculate.
+     */
+    approximate(value: number): any;
+}
+/**
+ * Specifies the meaning of the {@link ErrorBar}'s {@link ErrorBar.value} property.
+ */
+export declare enum ErrorAmount {
+    /** The value property represents the error as an absolute value. */
+    FixedValue = 0,
+    /** The value property represents the error as a percentage. */
+    Percentage = 1,
+    /** The value property represents the error as a number of standard deviations. */
+    StandardDeviation = 2,
+    /** The error is the standard error of the mean (value property is not used). */
+    StandardError = 3,
+    /** Error values are bound through the {@link ErrorBar.binding} property or set to an object with 'plus' and 'minus' values. */
+    Custom = 4
+}
+/**
+ * Specifies the end style of the error bars.
+ */
+export declare enum ErrorBarEndStyle {
+    /** Error bars end with a cap. */
+    Cap = 0,
+    /** Error bars are simple lines. */
+    NoCap = 1
+}
+/**
+ * Specifies the direction of the error bar.
+ */
+export declare enum ErrorBarDirection {
+    /** Show errors in both directions. */
+    Both = 0,
+    /** Show errors only in the minus direction. */
+    Minus = 1,
+    /** Show errors only in the plus direction. */
+    Plus = 2
+}
+/**
+ * Represents an {@link ErrorBar} series on a {@link FlexChart}.
+ *
+ * The {@link ErrorBar} series shows error margins and standard deviations
+ * at a glance. They can be shown as a standard error amounts, percentages,
+ * or standard deviation.
+ *
+ * You can also set the error values explicitly to display the exact
+ * amounts you want.
+ */
+export declare class ErrorBar extends Series {
+    private __errorValue;
+    private _mean;
+    private _errorAmount;
+    private _endStyle;
+    private _direction;
+    private _value;
+    private _errorBarStyle;
+    private _paddings;
+    private _plusBindingValues;
+    private _minusBindingValues;
+    private _errorBarEles;
+    /**
+     * Initializes a new instance of the {@link ErrorBar} class.
+     *
+     * @param options JavaScript object containing initialization data for the object.
+     */
+    constructor(options?: any);
+    /**
+     * Gets or sets a value that specifies the error value of the series.
+     *
+     * This property works with the {@link errorAmount} property.
+     */
+    value: any;
+    /**
+     * Gets or sets a value that specifies the meaning of the
+     * {@link value} property.
+     */
+    errorAmount: ErrorAmount;
+    /**
+     * Gets or sets the style used to render the error bars.
+     */
+    errorBarStyle: any;
+    /**
+     * Gets or sets a value that specifies the end style of the error bars.
+     */
+    endStyle: ErrorBarEndStyle;
+    /**
+     * Gets or sets a value that specifies the direction of the error bars.
+     */
+    direction: ErrorBarDirection;
+    getDataRect(currentRect?: Rect, calculatedRect?: Rect): Rect;
+    private _getCustomValue;
+    _calculateErrorValue(): void;
+    _clearValues(): void;
+    getValues(dim: number): number[];
+    _chart: FlexChartCore;
+    _errorValue: number;
+    readonly _showPlus: boolean;
+    readonly _showMinus: boolean;
+    private _rendering;
+    /**
+     * Gets the plot element that corresponds to the specified point index.
+     *
+     * @param pointIndex The index of the data point.
+     */
+    getPlotElement(pointIndex: number): any;
+}
+/** Defines styles for the {@link BreakEven} series. */
+export interface IBreakEvenStyles {
+    /** Specifies the style of the fixed cost line. */
+    fixedCost?: any;
+    /** Specifies the style of the variable cost line. */
+    variableCost?: any;
+    /** Specifies the style of the total cost line. */
+    totalCost?: any;
+    /** Specifies the style of the sales revenue line. */
+    salesRevenue?: any;
+    /** Specifies the style of the safety margin area. */
+    safetyMargin?: any;
+    /** Specifies the style of the marginal profit line. */
+    marginalProfit?: any;
+    /** Specifies the style of the break even markers. */
+    breakEven?: any;
+}
+/**
+ * Represents a Break Even chart series.
+ *
+ * A break even chart is a chart that shows the sales volume level at which total costs equal sales.
+ * Use the styles property to customize appearance of different parts of Break Even chart.
+ * The name property contains comma-separated names that are shown as legend entries.
+ */
+export declare class BreakEven extends SeriesBase {
+    private _fixedCost;
+    private _variableCost;
+    private _salesPrice;
+    private _styles;
+    /**
+     * Initializes a new instance of the {@link BreakEven} class.
+     *
+     * @param options JavaScript object containing initialization data for the object.
+     */
+    constructor(options?: any);
+    /**
+     * Gets or sets a value of fixed cost.
+     */
+    fixedCost: number;
+    /**
+     * Gets or sets a value of variable cost.
+     */
+    variableCost: number;
+    /**
+     * Gets or sets a value of sales price.
+     */
+    salesPrice: number;
+    /**
+     * Gets or sets the styles of Break Even chart.
+     *
+     * The following styles are supported:
+     *
+     * <ol>
+     *   <li><b>fixedCost</b>: Specifies the style of the fixed cost.</li>
+     *   <li><b>variableCost</b>: Specifies the style of the variable cost.</li>
+     *   <li><b>totalCost</b>: Specifies the style of the total cost.</li>
+     *   <li><b>salesRevenue</b>: Specifies the style of the sales revenue.</li>
+     *   <li><b>safetyMargin</b>: Specifies the style of the safety margin.</li>
+     *   <li><b>marginalProfit</b>: Specifies the style of the marginal profit.</li>
+     *   <li><b>breakEven</b>: Specifies the style of the break even.</li>
+     * </ol>
+     *
+     * The style of profit and loss areas is specified by the style and altStyle properties.
+     */
+    styles: IBreakEvenStyles;
+    getValues(dim: number): number[];
+    private _rendering;
+    _setStyle(eng: IRenderEngine, style: any): void;
+    _getName(dim: number): string;
+    legendItemLength(): number;
+    _getStyle(index: number): any;
+    measureLegendItem(engine: IRenderEngine, index: number): Size;
+    drawLegendItem(engine: IRenderEngine, rect: Rect, index: number): void;
+}
+/**
+ * Specifies the quartile calculation method of {@link BoxWhisker} series.
+ */
+export declare enum QuartileCalculation {
+    /** Include median value when calculating quartile. */
+    InclusiveMedian = 0,
+    /** Exclude median value when calculating quartile. */
+    ExclusiveMedian = 1
+}
+/**
+ * Represents a Box&Whisker chart series.
+ *
+ * The {@link BoxWhisker} series is normally used to compare distributions
+ * between different sets of numerical data.
+ */
+export declare class BoxWhisker extends SeriesBase {
+    private _groupWidth;
+    private _gapWidth;
+    private _showMeanLine;
+    private _meanLineStyle;
+    private _showMeanMarker;
+    private _meanMarkerStyle;
+    private _showInnerPoints;
+    private _showOutliers;
+    private _quartileCalculation;
+    hitTester: _HitTester;
+    /**
+     * Initializes a new instance of the {@link BoxWhisker} class.
+     *
+     * @param options JavaScript object containing initialization data for the object.
+     */
+    constructor(options?: any);
+    private _initProperties;
+    _clearValues(): void;
+    /**
+     * Gets or sets a value that specifies the quartile calculation method.
+     */
+    quartileCalculation: QuartileCalculation;
+    /**
+     * Gets or sets a value that determines the group width as a percentage.
+     *
+     * The default value for this property is 0.8. The min value is 0 and max value is 1.
+     */
+    groupWidth: number;
+    /**
+     * Gets or sets a value that determines the width of the gab between groups
+     * as a percentage.
+     *
+     * The default value for this property is 0.1. The min value is 0 and max value is 1.
+     */
+    gapWidth: number;
+    /**
+     * Gets or sets a value that determines whether to show the mean line.
+     */
+    showMeanLine: boolean;
+    /**
+     * Gets or sets a value that specifies the style for the mean line.
+     */
+    meanLineStyle: any;
+    /**
+     * Gets or sets a value that determines whether to show the mean marker.
+     */
+    showMeanMarker: boolean;
+    /**
+     * Gets or sets a value that specifies the style for the mean marker.
+     */
+    meanMarkerStyle: any;
+    /**
+     * Gets or sets a value that determines whether to show the inner data points
+     * for each point in the series.
+     */
+    showInnerPoints: boolean;
+    /**
+     * Gets or sets a value that determines whether to show outliers.
+     *
+     * Outliers are inner points outside the range between the first
+     * and third quartiles.
+     */
+    showOutliers: boolean;
+    private _rendering;
+    _convertPoints(points: number[], axis: _IAxis): number[];
+    _drawBoxWhisker(engine: IRenderEngine, xs: any, ys: any, prevXS: any, prevYS: any, series: _ISeries): void;
+    _renderLabels(engine: IRenderEngine, smap: _IHitArea[], chart: FlexChartCore, lblAreas: _RectArea[]): void;
+}
+export declare class _BoxPlot {
+    private _data;
+    private _min;
+    private _max;
+    private _mean;
+    private _firstQuartile;
+    private _thirdQuartile;
+    private _median;
+    private _quartileCalculation;
+    private _iqr;
+    private _outlierPoints;
+    private _innerPoints;
+    private _showOutliers;
+    constructor(data: number[], quartileCalculation: QuartileCalculation, showOutliers: boolean);
+    readonly showOutliers: boolean;
+    readonly min: number;
+    readonly max: number;
+    readonly mean: number;
+    readonly firstQuartile: number;
+    readonly thirdQuartile: number;
+    readonly median: number;
+    readonly outlierPoints: number[];
+    readonly innerPoints: number[];
+    _parse(): void;
+    _quartileInc(data: number[], percent: number): any;
+    _quartileExc(data: number[], percent: number): any;
+}