realchart 0.9.25 → 0.9.26

package/dist/index.d.ts

@@ -1,3 +1,76 @@
+declare class DatetimeFormatter {
+    private static readonly Formatters;
+    static getFormatter(format: string): DatetimeFormatter;
+    static get Default(): DatetimeFormatter;
+    private _format;
+    private _baseYear;
+    private _preserveTime;
+    private _tokens;
+    private _hasAmPm;
+    private _formatString;
+    constructor(format: string);
+    get format(): string;
+    get formatString(): string;
+    set formatString(value: string);
+    toStr(date: Date, startOfWeek: number): string;
+    private parseDateFormatTokens;
+    private parse;
+}
+
+declare class NumberFormatter {
+    static readonly DEFAULT_FORMAT = "";
+    private static readonly Formatters;
+    static getFormatter(format: string): NumberFormatter;
+    static get Default(): NumberFormatter;
+    private _format;
+    private _options;
+    constructor(format: string);
+    get format(): string;
+    toStr(value: number | bigint): string;
+    private $_parse;
+}
+
+interface ISize {
+    width: number;
+    height: number;
+}
+
+interface IRect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+
+declare class Sides {
+    top: number;
+    bottom: number;
+    left: number;
+    right: number;
+    static readonly Empty: Readonly<Sides>;
+    static Temp: Sides;
+    static create(top: number, bottom?: number, left?: number, right?: number): Sides;
+    static createFrom(value: string): Sides;
+    constructor(top?: number, bottom?: number, left?: number, right?: number);
+    clone(): Sides;
+    applyPadding(cs: CSSStyleDeclaration): Sides;
+    applyMargin(cs: CSSStyleDeclaration): Sides;
+    shrink(r: IRect): IRect;
+    toString(): string;
+}
+
+declare class TextFormatter {
+    private static readonly Formatters;
+    static getFormatter(format: string): TextFormatter;
+    private _format;
+    private _pattern;
+    private _replace;
+    constructor(format: string);
+    get format(): string;
+    toStr(text: string): string;
+    $_parse(fmt: string): void;
+}
+
 type Path = string | any[];
 type RtPercentSize = string | number;
 interface SVGStyles {
@@ -72,6 +145,10 @@ interface IValueRanges {
     labels?: string[];
     styles?: SVGStyleOrClass[];
 }
+interface IAnnotationAnimation {
+    type: string;
+    duration?: number;
+}
 
 declare abstract class RcObject {
     static destroy(obj: RcObject): null;
@@ -104,35 +181,6 @@ interface IPoint {
     y: number;
 }
 
-interface ISize {
-    width: number;
-    height: number;
-}
-
-interface IRect {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}
-
-declare class Sides {
-    top: number;
-    bottom: number;
-    left: number;
-    right: number;
-    static readonly Empty: Readonly<Sides>;
-    static Temp: Sides;
-    static create(top: number, bottom?: number, left?: number, right?: number): Sides;
-    static createFrom(value: string): Sides;
-    constructor(top?: number, bottom?: number, left?: number, right?: number);
-    clone(): Sides;
-    applyPadding(cs: CSSStyleDeclaration): Sides;
-    applyMargin(cs: CSSStyleDeclaration): Sides;
-    shrink(r: IRect): IRect;
-    toString(): string;
-}
-
 interface IPointerHandler {
     handleDown(ev: PointerEvent): void;
     handleUp(ev: PointerEvent): void;
@@ -279,7 +327,7 @@ declare class RcElement extends RcObject {
     set height(value: number);
     get visible(): boolean;
     set visible(value: boolean);
-    setVisible(value: boolean): boolean;
+    setVis(value: boolean): boolean;
     get rotation(): number;
     set rotation(value: number);
     setRotation(originX: number, originY: number, rotation: number): RcElement;
@@ -431,14 +479,21 @@ declare class TextElement extends RcElement {
     stain(): void;
 }
 
-type RichTextParamCallback = (target: any, param: string, format: string) => string;
+type RichTextParamCallback = (target: any, param: string) => any;
+interface IRichTextDomain {
+    callback?: RichTextParamCallback;
+    numberFormatter?: NumberFormatter;
+    timeFormatter?: DatetimeFormatter;
+    textFormatter?: TextFormatter;
+    startOfWeek?: number;
+}
 declare class Word {
     text: string;
     private _literals;
     get type(): string;
     parse(str: string): Word;
-    getText(target: any, callback: RichTextParamCallback): string;
-    prepareSpan(span: SVGTSpanElement, target: any, domain: RichTextParamCallback): SVGTSpanElement;
+    getText(target: any, domain: IRichTextDomain): string;
+    prepareSpan(span: SVGTSpanElement, target: any, domain: IRichTextDomain): SVGTSpanElement;
     protected _doParse(str: string): Word;
 }
 declare class SvgLine {
@@ -453,12 +508,13 @@ declare class SvgRichText {
     constructor(format?: string);
     setFormat(value: string): void;
     lines(): SvgLine[];
-    build(view: TextElement, maxWidth: number, maxHeight: number, target: any, domain: RichTextParamCallback): void;
+    build(view: TextElement, maxWidth: number, maxHeight: number, target: any, domain: IRichTextDomain): void;
     layout(view: TextElement, align: Align, width: number, height: number, padding: Sides): void;
     $_parse(fmt: string): void;
 }
 
 declare class ChartItem extends RcObject {
+    static readonly UPDATED = "updated";
     readonly chart: IChart;
     private _visible;
     constructor(chart: IChart, visible: boolean);
@@ -486,6 +542,11 @@ declare enum ChartTextEffect {
     OUTLINE = "outline",
     BACKGROUND = "background"
 }
+declare enum ChartTextOverflow {
+    CLIP = "clip",
+    ELLIPSIS = "ellipsis",
+    WRAP = "wrap"
+}
 declare abstract class ChartText extends ChartItem {
     private _outlineThickness;
     _outlineWidth: string;
@@ -502,7 +563,7 @@ declare abstract class FormattableText extends ChartText {
     private _numberFormat;
     private _text;
     private _numSymbols;
-    private _numberFormatter;
+    protected _numberFormatter: NumberFormatter;
     protected _richTextImpl: SvgRichText;
     constructor(chart: IChart, visible: boolean);
     prefix: string;
@@ -517,7 +578,7 @@ declare abstract class FormattableText extends ChartText {
     setText(value: string): FormattableText;
     prepareRich(text: string): void;
     isVisible(): boolean;
-    buildSvg(view: TextElement, outline: TextElement, maxWidth: number, maxHeight: number, target: any, callback: RichTextParamCallback): void;
+    buildSvg(view: TextElement, outline: TextElement, maxWidth: number, maxHeight: number, target: any, domain: IRichTextDomain): void;
     protected _doLoadSimple(source: any): boolean;
     private $_getNumberText;
     protected _getText(text: string, value: any, useSymbols: boolean, forceSymbols?: boolean): string;
@@ -579,8 +640,8 @@ declare class DataPoint {
     getProp(fld: string | number): any;
     parse(series: ISeries): void;
     getLabel(index: number): any;
-    getValueOf: (traget: any, param: string) => any;
     swap(): void;
+    getTooltipPos(): IPoint;
     protected _assignTo(proxy: any): any;
     protected _readArray(series: ISeries, v: any[]): void;
     protected _readObject(series: ISeries, v: any): void;
@@ -618,6 +679,10 @@ interface ILegendSource {
 declare class Tooltip extends ChartItem {
     series: ISeries;
     static readonly HIDE_DELAY = 700;
+    private _numberFormat;
+    private _timeFormat;
+    private _series;
+    private _domain;
     constructor(series: ISeries);
     html: string;
     text: string;
@@ -626,9 +691,11 @@ declare class Tooltip extends ChartItem {
     minWidth: number;
     minHeight: number;
     followPointer: boolean;
-    numberFormat: string;
-    timeFormat: string;
-    getValue(series: Series, point: DataPoint, param: string, format: string): string;
+    get numberFormat(): string;
+    set numberFormat(value: string);
+    get timeFormat(): string;
+    set timeFormat(value: string);
+    getTextDomain(series: Series): IRichTextDomain;
     protected _doLoadSimple(source: any): boolean;
 }
 
@@ -643,16 +710,21 @@ declare enum PointItemPosition {
 }
 declare class DataPointLabel extends FormattableText {
     private static readonly OFFSET;
+    private _point;
+    _domain: IRichTextDomain;
+    constructor(chart: IChart);
     position: PointItemPosition;
+    textAlign: Align;
     offset: number;
     distance: number;
     textCallback: (point: any) => string;
     visibleCallback: (point: any) => boolean;
     styleCallback: (point: any) => SVGStyleOrClass;
-    constructor(chart: IChart);
+    getTextDomain(p: DataPoint): IRichTextDomain;
     getText(value: any): string;
     getOffset(): number;
     protected _doLoadSimple(source: any): boolean;
+    protected _doPrepareRender(chart: IChart): void;
 }
 interface IPlottingItem {
     _row: number;
@@ -746,7 +818,7 @@ interface ISeries extends IPlottingItem {
     isVisible(p: DataPoint): boolean;
 }
 interface IDataPointCallbackArgs {
-    series: string | number;
+    series: object;
     count: number;
     vcount: number;
     yMin: number;
@@ -796,6 +868,7 @@ declare abstract class Series extends ChartItem implements ISeries, ILegendSourc
     private _argsPoint;
     constructor(chart: IChart, name?: string);
     protected _initProps(): void;
+    protected _createLabel(chart: IChart): DataPointLabel;
     abstract _type(): string;
     readonly name: string;
     label: string;
@@ -1003,7 +1076,9 @@ declare abstract class Annotation extends ChartItem {
     rotation: number;
     scope: AnnotationScope;
     series: string;
+    loadAnimation: IAnnotationAnimation;
     getPosition(inverted: boolean, left: number, top: number, wDomain: number, hDomain: number, width: number, height: number): IPoint;
+    update(): void;
     protected _doPrepareRender(chart: IChart): void;
 }
 
@@ -1023,6 +1098,13 @@ declare class BodySplit extends ChartItem {
     constructor(body: Body);
     size: number;
 }
+interface IPolar {
+    start: number;
+    total: number;
+    cx: number;
+    cy: number;
+    rd: number;
+}
 declare class Body extends ChartItem {
     private _radius;
     private _centerX;
@@ -1050,16 +1132,11 @@ declare class Body extends ChartItem {
     canZoom(): boolean;
     calcRadius(width: number, height: number): number;
     setPolar(width: number, height: number): Body;
-    getPolar(axis: Axis): {
-        start: number;
-        total: number;
-        cx: number;
-        cy: number;
-        rd: number;
-    };
+    getPolar(axis: Axis): IPolar;
     isZoomed(): boolean;
     '@config annotation': Annotation[];
     getAnnotations(): Annotation[];
+    getAnnotation(name: string): Annotation;
     protected _doLoadProp(prop: string, value: any): boolean;
     protected _doPrepareRender(chart: IChart): void;
     private $_loadAnnotations;
@@ -1264,8 +1341,10 @@ declare class GaugeRangeBand extends ChartItem {
     private $_internalRanges;
 }
 declare abstract class GaugeLabel extends FormattableText {
+    _domain: IRichTextDomain;
     constructor(chart: IChart);
     animatable: boolean;
+    protected _doPrepareRender(chart: IChart): void;
 }
 declare class CircularGaugeLabel extends GaugeLabel {
     private _offsetXDim;
@@ -1382,6 +1461,7 @@ declare class Split extends ChartItem {
     constructor(chart: IChart);
     rows: number | (number | `${number}*` | '*')[];
     cols: number | (number | `${number}*` | '*')[];
+    gap: number;
     count(): number;
     rowCount(): number;
     colCount(): number;
@@ -1399,6 +1479,7 @@ declare class Split extends ChartItem {
     private $_calcAxesPoints;
     calcAxesPoints(xLens: number[], yLens: number[]): void;
     calcSizes(width: number, height: number): void;
+    getAnnotation(name: string): Annotation;
     private $_parseSizes;
     private $_parsePanes;
     private $_loadPanes;
@@ -1406,7 +1487,11 @@ declare class Split extends ChartItem {
     private $_calcSizes;
 }
 
+interface IChartProxy {
+    getChartObject(model: any): object;
+}
 interface IChart {
+    _proxy: IChartProxy;
     type: string;
     gaugeType: string;
     _xPaneAxes: PaneXAxisMatrix;
@@ -1450,6 +1535,8 @@ interface IChart {
     _modelChanged(item: ChartItem, tag?: any): void;
     prepareRender(): void;
     layoutAxes(width: number, height: number, inverted: boolean, phase: number): void;
+    getParam(target: any, param: string): any;
+    setParam(param: string, value: any, redraw?: boolean): void;
 }
 declare class Credits extends ChartItem {
     text: string;
@@ -1484,21 +1571,30 @@ declare class CrosshairFlag extends ChartItem {
     textStyles: SVGStyleOrClass;
     minWidth: number;
 }
+interface ICrosshairCallbackArgs {
+    axis: object;
+    pos: number;
+    flag: string;
+}
 declare class Crosshair extends ChartItem {
     axis: IAxis;
     readonly flag: CrosshairFlag;
+    _args: ICrosshairCallbackArgs;
     constructor(axis: IAxis);
     type: CrosshairType;
     showAlways: boolean;
     followPointer: boolean;
     numberFormat: string;
     timeFormat: string;
+    onChange: any;
     isBar(): boolean;
     getFlag(length: number, pos: number): string;
+    moved(pos: number, flag: string): void;
+    protected _doLoadSimple(source: any): boolean;
 }
 
 interface IAxis {
-    type(): string;
+    _type(): string;
     chart: IChart;
     row: number;
     col: number;
@@ -1516,6 +1612,7 @@ interface IAxis {
     length(): number;
     zoom(start: number, end: number): boolean;
     getValue(value: any): number;
+    getXValue(value: number): any;
     contains(value: number): boolean;
     incStep(value: number, step: any): number;
     getPosition(length: number, value: number, point?: boolean): number;
@@ -1588,7 +1685,7 @@ declare enum AxisLabelArrange {
     ROWS = "rows"
 }
 interface IAxisLabelArgs {
-    axis: string | number;
+    axis: object;
     count: number;
     index: number;
     value: number;
@@ -1596,14 +1693,14 @@ interface IAxisLabelArgs {
 declare abstract class AxisLabel extends FormattableText {
     axis: Axis;
     _paramTick: IAxisTick;
-    _getParam: (target: any, param: string, format: string) => any;
+    _domain: IRichTextDomain;
     constructor(axis: Axis);
     step: number;
     startStep: number;
     rows: number;
     rotation: number;
     autoArrange: AxisLabelArrange;
-    wrap: boolean;
+    overflow: ChartTextOverflow;
     firstText: string;
     lastText: string;
     firstStyle: SVGStyleOrClass;
@@ -1614,6 +1711,7 @@ declare abstract class AxisLabel extends FormattableText {
     protected _getParamValue(tick: IAxisTick, param: string): any;
     getLabelText(tick: IAxisTick, count: number): string;
     getLabelStyle(tick: IAxisTick, count: number): any;
+    protected _doPrepareRender(chart: IChart): void;
 }
 interface IAxisTick {
     index: number;
@@ -1684,10 +1782,11 @@ declare abstract class Axis extends ChartItem implements IAxis {
     _runPos: AxisPosition;
     _labelArgs: IAxisLabelArgs;
     constructor(chart: IChart, isX: boolean, name?: string);
-    abstract type(): string;
+    abstract _type(): string;
     readonly name: string;
     readonly title: AxisTitle;
     readonly line: AxisLine;
+    readonly sectorLine: AxisLine;
     readonly tick: AxisTick;
     readonly label: AxisLabel;
     readonly grid: AxisGrid;
@@ -1740,6 +1839,7 @@ declare abstract class Axis extends ChartItem implements IAxis {
     hasBreak(): boolean;
     isBreak(pos: number): boolean;
     getTickLabelArgs(index: number, value: any): IAxisLabelArgs;
+    getXValue(value: number): any;
     protected _doLoadProp(prop: string, value: any): boolean;
     protected _setMinMax(min: number, max: number): void;
     protected _createGrid(): AxisGrid;
@@ -1899,6 +1999,8 @@ declare abstract class RcChartAxis extends RcChartObject {
     private _crosshair;
     private _scrollBar;
     protected _doInit(proxy: Axis): void;
+    get xy(): 'x' | 'y';
+    get isX(): boolean;
     get title(): RcChartObject;
     get line(): RcChartObject;
     get grid(): RcChartObject;
@@ -1922,7 +2024,10 @@ declare class RcLogAxis extends RcContinuousAxis {
 }
 declare class RcPointLabel extends RcChartAxis {
 }
-declare abstract class RcChartSeries extends RcChartObject {
+declare abstract class RcNamedObject extends RcChartObject {
+    get name(): string;
+}
+declare abstract class RcChartSeries extends RcNamedObject {
     private _pointLabel;
     private _trendLine;
     private _tooltip;
@@ -1933,7 +2038,7 @@ declare abstract class RcChartSeries extends RcChartObject {
     getValueAt(xValue: number): number;
     updateData(data: any): void;
 }
-declare abstract class RcSeriesGroup extends RcChartObject {
+declare abstract class RcSeriesGroup extends RcNamedObject {
 }
 declare abstract class RcLineSeriesBase extends RcChartSeries {
 }
@@ -1989,7 +2094,7 @@ declare class RcPieSeriesGroup extends RcSeriesGroup {
 }
 declare class RcBumpSeriesGroup extends RcSeriesGroup {
 }
-declare abstract class RcChartGaugeBase extends RcChartObject {
+declare abstract class RcChartGaugeBase extends RcNamedObject {
 }
 declare abstract class RcChartGauge extends RcChartGaugeBase {
 }
@@ -2065,10 +2170,14 @@ declare class RcLegend extends RcChartObject {
 }
 declare class RcBody extends RcChartObject {
 }
+declare abstract class RcAnnotation extends RcNamedObject {
+    update(): void;
+}
 
 declare class RcChartControl {
     private $_p;
     private _objects;
+    private _proxy;
     private constructor();
     load(config: any, animate?: boolean): void;
     render(now?: boolean): void;
@@ -2080,6 +2189,7 @@ declare class RcChartControl {
     getSeries(name: string): RcChartSeries;
     get gauge(): RcChartGauge;
     getGauge(name: string): RcChartGauge;
+    getAnnotation(name: string): RcAnnotation;
     get title(): RcTitle;
     get subtitle(): RcSubtitle;
     get legend(): RcLegend;
@@ -2089,6 +2199,7 @@ declare class RcChartControl {
     get inverted(): boolean;
     get polar(): boolean;
     scroll(axis: RcChartAxis, pos: number): void;
+    setParam(param: string, value: any, redraw?: boolean): void;
 }
 
 declare class Globals {
@@ -2096,7 +2207,7 @@ declare class Globals {
     static setDebugging(debug: boolean): void;
     static setLogging(logging: boolean): void;
     static setAnimatable(value: boolean): void;
-    static createChart(doc: Document, container: string | HTMLDivElement, config: any): RcChartControl;
+    static createChart(doc: Document, container: string | HTMLDivElement, config: any, animate?: boolean): RcChartControl;
 }
 
 declare const getVersion: typeof Globals.getVersion;