realchart 0.9.26 → 0.9.28

package/dist/index.d.ts

@@ -1,3 +1,14 @@
+interface ImageExportOptions {
+    type?: 'png' | 'jpeg';
+    width?: number;
+    scale?: number;
+    fileName?: string;
+    url?: string;
+    hideScrollbar?: boolean;
+    hideNavigator?: boolean;
+    hideZoomButton?: boolean;
+}
+
 declare class DatetimeFormatter {
     private static readonly Formatters;
     static getFormatter(format: string): DatetimeFormatter;
@@ -136,6 +147,7 @@ interface IValueRange {
     color: string;
     label?: string;
     style?: SVGStyleOrClass;
+    areaStyle?: SVGStyleOrClass;
 }
 interface IValueRanges {
     fromValue?: number;
@@ -144,6 +156,20 @@ interface IValueRanges {
     colors: string[];
     labels?: string[];
     styles?: SVGStyleOrClass[];
+    areaStyles?: SVGStyleOrClass[];
+}
+declare enum HoveringScope {
+    AUTO = "auto",
+    SERIES = "series",
+    GROUP = "group",
+    AXIS = "axis"
+}
+declare enum HoveringEffect {
+    NONE = "none",
+    DEFAULT = "default",
+    BRIGHTEN = "brighten",
+    ENLARGE = "enlarge",
+    BORDER = "border"
 }
 interface IAnnotationAnimation {
     type: string;
@@ -607,7 +633,8 @@ declare enum LineType {
 interface IPointPos {
     xPos: number;
     yPos: number;
-    isNull: boolean;
+    isNull?: boolean;
+    range?: IValueRange;
 }
 declare class DataPoint {
     static swap(pts: IPointPos[]): IPointPos[];
@@ -642,6 +669,7 @@ declare class DataPoint {
     getLabel(index: number): any;
     swap(): void;
     getTooltipPos(): IPoint;
+    toPoint(): IPointPos;
     protected _assignTo(proxy: any): any;
     protected _readArray(series: ISeries, v: any[]): void;
     protected _readObject(series: ISeries, v: any): void;
@@ -676,14 +704,31 @@ interface ILegendSource {
     legendLabel(): string;
 }
 
+declare enum TooltipLevel {
+    AUTO = "auto",
+    SERIES = "series",
+    GROUP = "group",
+    AXIS = "axis"
+}
+interface ITooltipContext {
+    getTooltipText(series: ISeries, point: DataPoint): string;
+    getTooltipParam(series: ISeries, point: DataPoint, param: string): string;
+}
+interface ITooltipOwner {
+    chart: IChart;
+    getTooltipContext(level: TooltipLevel, series: ISeries, point: DataPoint): ITooltipContext;
+}
 declare class Tooltip extends ChartItem {
-    series: ISeries;
+    owner: ITooltipOwner;
     static readonly HIDE_DELAY = 700;
     private _numberFormat;
     private _timeFormat;
+    private _ctx;
     private _series;
+    private _point;
     private _domain;
-    constructor(series: ISeries);
+    constructor(owner: ITooltipOwner);
+    level: TooltipLevel;
     html: string;
     text: string;
     offset: number;
@@ -695,7 +740,8 @@ declare class Tooltip extends ChartItem {
     set numberFormat(value: string);
     get timeFormat(): string;
     set timeFormat(value: string);
-    getTextDomain(series: Series): IRichTextDomain;
+    setTarget(series: ISeries, point: DataPoint): ITooltipContext;
+    getTextDomain(): IRichTextDomain;
     protected _doLoadSimple(source: any): boolean;
 }
 
@@ -738,6 +784,7 @@ interface IPlottingItem {
     zOrder: number;
     setCol(col: number): void;
     setRow(row: number): void;
+    getVisibleSeries(): ISeries[];
     getVisiblePoints(): DataPoint[];
     getLegendSources(list: ILegendSource[]): void;
     needAxes(): boolean;
@@ -778,32 +825,20 @@ declare class Trendline extends ChartItem {
     lineType: LineType;
     movingAverage: MovingAverage;
     protected _doPrepareRender(chart: IChart): void;
-    $_linear(pts: DataPoint[], list: {
-        x: number;
-        y: number;
-    }[]): void;
-    $_logarithmic(pts: DataPoint[], list: {
-        x: number;
-        y: number;
-    }[]): void;
-    $_polynomial(pts: DataPoint[], list: {
-        x: number;
-        y: number;
-    }[]): void;
-    $_power(pts: DataPoint[], list: {
-        x: number;
-        y: number;
-    }[]): void;
-    $_exponential(pts: DataPoint[], list: {
-        x: number;
-        y: number;
-    }[]): void;
-    $_movingAverage(pts: DataPoint[], list: {
+    private $_calcLine;
+    private $_calcLine2;
+    private $_linear;
+    private $_logarithmic;
+    private $_exponential;
+    private $_power;
+    $_polynomial(pts: IPoint[], list: {
         x: number;
         y: number;
     }[]): void;
+    private $_movingAverage;
 }
 interface ISeriesGroup extends IPlottingItem {
+    layout: SeriesGroupLayout;
 }
 interface ISeries extends IPlottingItem {
     chart: IChart;
@@ -839,9 +874,10 @@ interface IDataPointCallbackArgs {
 }
 type PointStyleCallback = (args: IDataPointCallbackArgs) => SVGStyleOrClass;
 type PointClickCallback = (args: IDataPointCallbackArgs) => boolean;
-declare abstract class Series extends ChartItem implements ISeries, ILegendSource {
+declare abstract class Series extends ChartItem implements ISeries, ILegendSource, ITooltipContext {
     static readonly LEGEND_MARKER = "rct-legend-item-marker";
     static _loadSeries(chart: IChart, src: any, defType?: string): Series;
+    static getPointTooltipParam(series: Series, point: DataPoint, param: string): any;
     _row: number;
     _col: number;
     index: number;
@@ -851,6 +887,7 @@ declare abstract class Series extends ChartItem implements ISeries, ILegendSourc
     protected _points: DataPointCollection;
     _runPoints: DataPoint[];
     _visPoints: DataPoint[];
+    _containsNull: boolean;
     _runRangeValue: 'x' | 'y' | 'z';
     _runRanges: IValueRange[];
     _minX: number;
@@ -869,12 +906,13 @@ declare abstract class Series extends ChartItem implements ISeries, ILegendSourc
     constructor(chart: IChart, name?: string);
     protected _initProps(): void;
     protected _createLabel(chart: IChart): DataPointLabel;
+    getTooltipText(series: ISeries, point: DataPoint): string;
+    getTooltipParam(series: ISeries, point: DataPoint, param: string): any;
     abstract _type(): string;
     readonly name: string;
     label: string;
     readonly pointLabel: DataPointLabel;
     readonly trendline: Trendline;
-    readonly tooltip: Tooltip;
     row: number;
     col: number;
     visibleThreshold: number;
@@ -895,6 +933,7 @@ declare abstract class Series extends ChartItem implements ISeries, ILegendSourc
     noClip: boolean;
     visibleInLegend: boolean;
     visibleInNavigator: boolean;
+    tooltipText: string;
     pointStyleCallback: PointStyleCallback;
     onPointClick: PointClickCallback;
     contains(p: DataPoint): boolean;
@@ -919,11 +958,12 @@ declare abstract class Series extends ChartItem implements ISeries, ILegendSourc
     canMaxPadding(axis: IAxis): boolean;
     hasMarker(): boolean;
     setShape(shape: Shape): void;
+    getVisibleSeries(): ISeries[];
     needClip(polar: boolean): boolean;
     setCol(col: number): void;
     setRow(row: number): void;
     createPoints(source: any[]): DataPoint[];
-    getXStart(): number;
+    private $_getXStart;
     getXStep(): number;
     prepareRender(): void;
     prepareAfter(): void;
@@ -934,7 +974,7 @@ declare abstract class Series extends ChartItem implements ISeries, ILegendSourc
         min: number;
         max: number;
     };
-    prepareViewRanges(): void;
+    private $_prepareViewRanges;
     pointValuesPrepared(axis: IAxis): void;
     reference(other: Series, axis: IAxis): void;
     isVisible(point: DataPoint): boolean;
@@ -949,7 +989,6 @@ declare abstract class Series extends ChartItem implements ISeries, ILegendSourc
     getPointText(p: DataPoint, label: any): string;
     getPointStyle(p: DataPoint): any;
     getPointLabelStyle(p: DataPoint): any;
-    getPointTooltip(point: DataPoint, param: string): any;
     pointClicked(p: DataPoint): boolean;
     getViewRangeAxis(): 'x' | 'y' | 'z';
     isPointLabelsVisible(): boolean;
@@ -1007,8 +1046,13 @@ declare enum SeriesGroupLayout {
     STACK = "stack",
     FILL = "fill"
 }
-declare abstract class SeriesGroup<T extends Series> extends ChartItem implements ISeriesGroup {
-    layoutMax: number;
+declare abstract class SeriesGroup<T extends Series> extends ChartItem implements ISeriesGroup, ITooltipContext {
+    static collectTooltipText(tooltip: {
+        tooltipHeader: string;
+        tooltipRow: string;
+        tooltipFooter: string;
+    }, series: ISeries[], point: DataPoint): string;
+    static inflateTooltipParam(series: ISeries[], ser: ISeries, point: DataPoint, param: string): string;
     _row: number;
     _col: number;
     index: number;
@@ -1017,7 +1061,10 @@ declare abstract class SeriesGroup<T extends Series> extends ChartItem implement
     _xAxisObj: IAxis;
     _yAxisObj: IAxis;
     _stackPoints: Map<number, DataPoint[]>;
+    _stacked: boolean;
     constructor(chart: IChart);
+    getTooltipText(series: ISeries, point: DataPoint): string;
+    getTooltipParam(series: ISeries, point: DataPoint, param: string): string;
     row: number;
     col: number;
     layout: SeriesGroupLayout;
@@ -1026,6 +1073,9 @@ declare abstract class SeriesGroup<T extends Series> extends ChartItem implement
     visibleInLegend: boolean;
     zOrder: number;
     noClip: boolean;
+    tooltipHeader: string;
+    tooltipRow: string;
+    tooltipFooter: string;
     get series(): T[];
     needAxes(): boolean;
     isEmpty(): boolean;
@@ -1033,10 +1083,14 @@ declare abstract class SeriesGroup<T extends Series> extends ChartItem implement
     defaultYAxisType(): string;
     clusterable(): boolean;
     getBaseValue(axis: IAxis): number;
+    getVisibleSeries(): ISeries[];
+    layoutMax: number;
     abstract _type(): string;
     abstract _seriesType(): string;
     setCol(col: number): void;
     setRow(row: number): void;
+    isFirstVisible(series: ISeries): boolean;
+    isLastVisible(series: ISeries): boolean;
     collectValues(axis: IAxis, vals: number[]): void;
     pointValuesPrepared(axis: IAxis): void;
     collectCategories(axis: IAxis): string[];
@@ -1044,6 +1098,7 @@ declare abstract class SeriesGroup<T extends Series> extends ChartItem implement
     getLegendSources(list: ILegendSource[]): void;
     canMinPadding(axis: IAxis): boolean;
     canMaxPadding(axis: IAxis): boolean;
+    getVisPoints(p: DataPoint): DataPoint[];
     getVisiblePoints(): DataPoint[];
     protected _doLoadProp(prop: string, value: any): boolean;
     prepareRender(): void;
@@ -1276,6 +1331,9 @@ declare class GuageScaleTick extends ChartItem {
     reversed: boolean;
     length: number;
 }
+declare class GaugeScaleLabel extends FormattableText {
+    getText(value: any): string;
+}
 declare abstract class GaugeScale extends ChartItem {
     gauge: ValueGauge | GaugeGroup<ValueGauge>;
     private _gap;
@@ -1287,7 +1345,7 @@ declare abstract class GaugeScale extends ChartItem {
     position: GaugeItemPosition;
     line: ChartItem;
     tick: GuageScaleTick;
-    tickLabel: ChartItem;
+    label: GaugeScaleLabel;
     steps: number[];
     stepCount: number;
     stepInterval: number;
@@ -1497,11 +1555,13 @@ interface IChart {
     _xPaneAxes: PaneXAxisMatrix;
     _yPaneAxes: PaneYAxisMatrix;
     options: ChartOptions;
+    export: ExportOptions;
     first: IPlottingItem;
     firstSeries: Series;
     xAxis: IAxis;
     yAxis: IAxis;
     subtitle: Subtitle;
+    tooltip: Tooltip;
     body: Body;
     split: Split;
     colors: string[];
@@ -1558,6 +1618,22 @@ declare class ChartOptions extends ChartItem {
     xStep: number | string;
     axisGap: number;
     credits: Credits;
+    hoveringScope: HoveringScope;
+    hoveringEffect: HoveringEffect;
+}
+declare enum ExportType {
+    PNG = "png",
+    JPEG = "jpeg"
+}
+declare class ExportOptions extends ChartItem {
+    menus: ExportType[];
+    fileName: string;
+    width: number;
+    scale: number;
+    url: string;
+    hideScrollbar: boolean;
+    hideNavigator: boolean;
+    hideZoomButton: boolean;
 }
 
 declare enum CrosshairType {
@@ -1598,12 +1674,12 @@ interface IAxis {
     chart: IChart;
     row: number;
     col: number;
-    _vlen: number;
     _isX: boolean;
     _isHorz: boolean;
     _isOpposite: boolean;
     _isBetween: boolean;
     reversed: boolean;
+    _vlen: number;
     _zoom: IAxisZoom;
     isContinuous(): boolean;
     getBaseValue(): number;
@@ -1706,7 +1782,7 @@ declare abstract class AxisLabel extends FormattableText {
     firstStyle: SVGStyleOrClass;
     lastStyle: SVGStyleOrClass;
     textCallback: (args: IAxisLabelArgs) => string;
-    styleCallback: (args: any) => SVGStyleOrClass;
+    styleCallback: (args: IAxisLabelArgs) => SVGStyleOrClass;
     abstract getTick(index: number, value: any): string;
     protected _getParamValue(tick: IAxisTick, param: string): any;
     getLabelText(tick: IAxisTick, count: number): string;
@@ -1751,8 +1827,10 @@ declare class AxisZoom {
     max: number;
     start: number;
     end: number;
-    constructor(axis: Axis, start: number, end: number);
+    constructor(axis: Axis);
+    total(): number;
     length(): number;
+    isFull(): boolean;
     resize(start: number, end: number): boolean;
 }
 declare abstract class Axis extends ChartItem implements IAxis {
@@ -1772,13 +1850,13 @@ declare abstract class Axis extends ChartItem implements IAxis {
     _ticks: IAxisTick[];
     _markPoints: number[];
     _vlen: number;
+    _zoom: AxisZoom;
     _minPad: number;
     _maxPad: number;
     _values: number[];
     protected _min: number;
     protected _max: number;
     protected _single: boolean;
-    _zoom: AxisZoom;
     _runPos: AxisPosition;
     _labelArgs: IAxisLabelArgs;
     constructor(chart: IChart, isX: boolean, name?: string);
@@ -1804,6 +1882,9 @@ declare abstract class Axis extends ChartItem implements IAxis {
     marginNear: number;
     marginFar: number;
     unit: string;
+    tooltipHeader: string;
+    tooltipRow: string;
+    tooltipFooter: string;
     isEmpty(): boolean;
     getBaseValue(): number;
     length(): number;
@@ -1815,6 +1896,7 @@ declare abstract class Axis extends ChartItem implements IAxis {
     getStartAngle(): number;
     getTotalAngle(): number;
     isArced(): boolean;
+    getVisibleSeries(): ISeries[];
     protected abstract _createTickModel(): AxisTick;
     protected abstract _createLabelModel(): AxisLabel;
     protected abstract _doPrepareRender(): void;
@@ -1834,6 +1916,7 @@ declare abstract class Axis extends ChartItem implements IAxis {
     incStep(value: number, step: any): number;
     contains(value: number): boolean;
     resetZoom(): void;
+    _prepareZoom(): AxisZoom;
     zoom(start: number, end: number): boolean;
     isZoomed(): boolean;
     hasBreak(): boolean;
@@ -2199,6 +2282,7 @@ declare class RcChartControl {
     get inverted(): boolean;
     get polar(): boolean;
     scroll(axis: RcChartAxis, pos: number): void;
+    exportImage(options?: ImageExportOptions): void;
     setParam(param: string, value: any, redraw?: boolean): void;
 }