realchart 1.1.2 → 1.1.3

package/dist/index.d.ts

@@ -2,8 +2,8 @@
  * RealReport-Chart 라이브러리 클래스 모델의 최상위 base 클래스.
  * <br>
  *
- * @see concepts.dev_guide 개발 가이드
- * @see concepts.about RealTouch 개요
+ * @see [개발 가이드](/guide/dev-guide)
+ * @see [RealChart 개요](/guide)
  */
 declare abstract class RcObject {
     static destroy(obj: RcObject): null;
@@ -23,6 +23,7 @@ declare abstract class RcObject {
     destroy(): null;
     protected _doDestroy(): void;
     get destroying(): boolean;
+    get orphaned(): boolean;
     get hash(): string;
     isMe(hash: string): boolean;
     toString(): string;
@@ -4142,8 +4143,9 @@ declare class ChartItem<OP extends ChartItemOptions = ChartItemOptions> extends
     set visible(value: boolean);
     protected _isVisible(): boolean;
     /** @internal */
-    load(source: any): OP;
-    save(): any;
+    _load(source: any): OP;
+    loadOptions(source: any): OP;
+    saveOptions(): any;
     /**
      * 하나 이상의 option 설정을 하고,
      * 차트가 다시 그려지도록 한다.<br/>
@@ -4175,7 +4177,7 @@ declare class ChartItem<OP extends ChartItemOptions = ChartItemOptions> extends
      */
     updateOption(prop: keyof OP, value: any, render?: boolean): this;
     /**
-     * Boolean 타입의 설정값을 변경한다.\
+     * Boolean 타입의 설정값을 변경한다.<br/>
      * 지정 가능한 설정 값 목록은 {@page config Configuration API 페이지}에서 확인할 수 있다.
      *
      * ```js
@@ -4494,6 +4496,8 @@ declare class LegendItem extends ChartItem<ChartItemOptions> {
  */
 declare class Legend extends Widget<LegendOptions> {
     static defaults: LegendOptions;
+    private _maxWidth;
+    private _maxHeight;
     private _items;
     private _maxWidthDim;
     private _maxHeightDim;
@@ -4925,7 +4929,7 @@ declare abstract class Series<OP extends SeriesOptions = SeriesOptions> extends
     protected _createFielder(f: any): (v: any) => any;
     private _createFielders;
     protected _defaultLoadAnimation(): SeriesLoadAnimation;
-    load(source: any): OP;
+    _load(source: any): OP;
     protected _doLoadData(src: any): any[];
     _loadPoints(data: any): void;
     protected _doLoadPoints(src: any): void;
@@ -5142,7 +5146,7 @@ declare abstract class MarkerSeries<OP extends MarkerSeriesOptions = MarkerSerie
 }
 
 /**
- * 데이터 포인트를 표시할 수 없는 값을 설정하면 null로 간주한다.
+ * 데이터 포인트를 표시할 수 없는 값을 설정하면 null로 간주한다.<br/>
  *
  * isNull과 visible은 다르다.
  * isNull이어도 자리를 차지한다.
@@ -5260,7 +5264,6 @@ declare class Crosshair extends ChartItem<CrosshairOptions> {
     protected _doInit(): void;
     /**
      * 축 상에 crosshair의 정보를 표시하는 view.
-     *
      */
     flag: CrosshairFlagOptions;
     isBar(): boolean;
@@ -5385,7 +5388,7 @@ declare class AxisGuideLabel extends IconedText<AxisGuideLabelOptions> {
     getDefaultIconPos(): IconPosition;
 }
 /**
- * 기본적으로 이 축에 연결된 모든 body에 모두 표시된다.
+ * 기본적으로 이 축에 연결된 모든 body에 모두 표시된다.<br/>
  * col, row를 지정해서 특정 body에만 표시되도록 할 수 있다.
  */
 declare abstract class AxisGuide<OP extends AxisGuideOptions = AxisGuideOptions> extends AxisItem<OP> {
@@ -5574,7 +5577,7 @@ declare abstract class Axis<OP extends AxisOptions = AxisOptions> extends ChartI
      */
     get isX(): boolean;
     /**
-     * 시리즈 연결 여부.\
+     * 시리즈 연결 여부.<br/>
      * 연결된 시리즈가 하나도 없으면 true.
      */
     isEmpty(): boolean;
@@ -5634,7 +5637,7 @@ declare abstract class Axis<OP extends AxisOptions = AxisOptions> extends ChartI
     setPrevRate(rate: number): void;
     prev(pos: number): number;
     abstract xValueAt(pos: number): number;
-    load(source: any): OP;
+    _load(source: any): OP;
     protected _doApply(options: AxisOptions): void;
     protected _setMinMax(min: number, max: number): void;
     protected abstract _createGrid(): AxisGrid;
@@ -8147,7 +8150,7 @@ declare abstract class GaugeBase<OP extends GaugeBaseOptions = GaugeBaseOptions>
     getRight(doamin: number): number;
     getTop(doamin: number): number;
     getBottom(doamin: number): number;
-    load(source: any): OP;
+    _load(source: any): OP;
     protected _doApply(options: GaugeBaseOptions): void;
 }
 declare abstract class GaugeItem<OP extends ChartItemOptions> extends ChartItem<OP> {
@@ -8162,11 +8165,6 @@ declare abstract class Gauge<OP extends GaugeOptions = GaugeOptions> extends Gau
     static _loadGauge(chart: IChart, src: any, defType?: string): Gauge;
     _group: GaugeGroup;
     _gindex: number;
-    /**
-     * Animation duration.
-     *
-     * @config
-     */
     setGroup(group: GaugeGroup, index: number): void;
 }
 /**
@@ -8534,7 +8532,7 @@ declare class Pane extends ChartItem<PaneOptions> {
     _prepareRender(): void;
 }
 /**
- * 다중 분할 panes.\
+ * 다중 분할 panes.<br/>
  * 각 pane에 해당하는 x, y축이 반드시 존재해야 한다.
  * axis는 {@page config.base.axis#row row}, {@page config.base.axis#col col} 속성으로 위치를 지정한다.
  * 시리즈는 {@page config.base.series#row row}, {@page config.base.series#col col} 속성으로 지정하거나, 아니면 axis 위치에 따라 자동으로 결정된다.
@@ -8564,7 +8562,7 @@ declare class Split extends ChartItem<SplitOptions> {
     getColumn(col: number): Pane[];
     protected _doLoadProp(prop: string, value: any): boolean;
     protected _doSetSimple(source: any): boolean;
-    load(source: any): ChartItem;
+    _load(source: any): ChartItem;
     protected _doPrepareRender(chart: IChart): void;
     getXLens(length: number): number[];
     getYLens(length: number): number[];
@@ -8767,10 +8765,6 @@ declare class ChartObject extends EventProvider<IChartEventListener> implements
     assignTemplates: (target: any) => any;
     _dataDirty: boolean;
     _loadAnimatable: boolean;
-    /**
-     *
-     * @param source
-     */
     constructor(config?: ChartConfiguration);
     private _initOptions;
     _createChart(config: any): IChart;
@@ -8779,8 +8773,8 @@ declare class ChartObject extends EventProvider<IChartEventListener> implements
     getTooltipContext(scope: TooltipScope, series: ISeries, point: DataPoint): ITooltipContext;
     get chart(): IChart;
     anchorByName(name: string): ChartItem;
-    get type(): "line" | "bar" | "barrange" | "bargroup" | "bellcurve" | "boxplot" | "bubble" | "bump" | "candlestick" | "circlebar" | "circlebargroup" | "dumbbell" | "equalizer" | "errorbar" | "funnel" | "heatmap" | "histogram" | "arearange" | "area" | "areagroup" | "linegroup" | "spline" | "lollipop" | "ohlc" | "pareto" | "pie" | "piegroup" | "scatter" | "treemap" | "vector" | "waterfall";
-    get gaugeType(): "linear" | "circle" | "bullet" | "clock";
+    get type(): "area" | "line" | "linegroup" | "spline" | "bellcurve" | "areagroup" | "barrange" | "bar" | "bargroup" | "piegroup" | "pie" | "boxplot" | "bubble" | "bump" | "candlestick" | "ohlc" | "circlebar" | "circlebargroup" | "dumbbell" | "equalizer" | "errorbar" | "funnel" | "heatmap" | "histogram" | "arearange" | "lollipop" | "pareto" | "scatter" | "treemap" | "vector" | "waterfall";
+    get gaugeType(): "circle" | "linear" | "bullet" | "clock";
     get polar(): boolean;
     get inverted(): boolean;
     get timeOffset(): number;
@@ -8867,7 +8861,6 @@ declare class ChartObject extends EventProvider<IChartEventListener> implements
 
 /**
  * Annotation 모델.<br/>
- *
  */
 declare abstract class Annotation<OP extends AnnotationOptions = AnnotationOptions> extends ChartItem<OP> {
     inBody: boolean;
@@ -8899,13 +8892,13 @@ declare abstract class Annotation<OP extends AnnotationOptions = AnnotationOptio
      */
     get name(): string;
     /**
-     * 처음 표시될 때 실행될 에니메이션 설정 정보.
+     * TODO: 처음 표시될 때 실행될 에니메이션 설정 정보.
      */
     getOffset(w: number, h: number): Point;
     getSize(wDomain: number, hDomain: number): Size;
     getPosition(inverted: boolean, left: number, top: number, wDomain: number, hDomain: number, width: number, height: number): Point;
     refresh(): void;
-    load(source: any): OP;
+    _load(source: any): OP;
     protected _doApply(options: AnnotationOptions): void;
     protected _doPrepareRender(chart: IChart): void;
 }
@@ -9239,10 +9232,10 @@ interface IRcLocale {
  */
 declare class Globals {
     /**
-     * RealChart 라이브러리 버전 정보를 리턴한다.
+     * RealChart 라이브러리의 버전 정보를 리턴한다.
      *
      * ```js
-     * console.log(RealChart.getVersion()); // '1.1.2'
+     * console.log(RealChart.getVersion()); // ex) '1.1.2'
      * ```
      *
      * @returns 버전 문자열
@@ -9251,7 +9244,7 @@ declare class Globals {
     static setLocale(lang: string, config?: IRcLocale): void;
     static registerLocale(lang: string, config: IRcLocale): void;
     /**
-     * true로 지정하면 차트 요소별 디버그 경계를 표시한다.\
+     * true로 지정하면 차트 요소별 디버그 경계를 표시한다.<br/>
      * 기본은 false 상태다.
      *
      * ```js
@@ -9262,15 +9255,16 @@ declare class Globals {
      */
     static setDebugging(debug: boolean): void;
     /**
-     * true로 지정하면 라이브러리 내부 메시지를 출력한다.
+     * true로 지정하면 라이브러리 내부 메시지를 출력한다.<br/>
+     * 기본값을 false다.
      *
      * @param logging 로그 메시지 표시 여부
      */
     static setLogging(logging: boolean): void;
     /**
      * false로 지정하면 시리즈 시작 애니메이션 등을 포함,
-     * 모든 애니메이션을 실행하지 않는다.\
-     * 기본은 animation이 가능한 상태다.
+     * 모든 애니메이션을 실행하지 않는다.<br/>
+     * 기본값은 true로 animation이 가능한 상태다.
      *
      * ```js
      * RealChart.setAnimatable(false);
@@ -9280,7 +9274,7 @@ declare class Globals {
      */
     static setAnimatable(value: boolean): void;
     /**
-     * 차트 설정 모델을 기빈으로 svg를 생성한 후,
+     * 차트 설정 모델을 기반으로 svg를 생성한 후,
      * 지정된 div 엘리먼트의 유일한 자식으로 포함시킨다.\
      * div 전체 영역의 크기로 표시된다.
      *
@@ -9294,6 +9288,7 @@ declare class Globals {
      * @param animate 첫 로딩 animation을 실행한다.
      * @param calllback 차트가 모두 로드되고 첫 렌더링이 완료된 후 호출되는 콜백 함수.
      * @returns 생성된 차트 객체
+     * @see {@link createData}
      */
     static createChart(doc: Document, container: string | HTMLDivElement, config: ChartConfiguration, animate?: boolean, callback?: () => void): Chart;
     /**
@@ -9598,7 +9593,6 @@ declare class TimeAxis extends ContinuousAxis<TimeAxisOptions> {
     axisValueAt(length: number, pos: number): any;
     value2Tooltip(value: number): any;
     getXValue(value: number): number | Date;
-    getPos(length: number, value: number): number;
 }
 
 declare class LogAxisTick extends ContinuousAxisTick<LogAxisTickOptions> {
@@ -9643,6 +9637,7 @@ interface IPointPos {
     isNull?: boolean;
     range?: ValueRange;
 }
+type PointLine = IPointPos[];
 declare class LineSeriesPoint extends DataPoint {
     radius: number;
     shape: Shape;
@@ -9662,8 +9657,8 @@ declare class LinePointLabel extends DataPointLabel<LinePointLabelOptions> {
     getAlignOffset(): number;
 }
 /**
- * 포인트 label들은 PointItemPosition.HEAD, FOOT, INSIDE에 위치할 수 있다.
- * 기본값은 AUTO(HEAD)이다.
+ * 포인트 label들은 'head', 'foot', 'inside'에 위치할 수 있다.
+ * 기본값은 'auto'('head'')이다.
  * pointLabel.align으로 수평 정렬을 설정할 수있다.
  */
 declare abstract class LineSeriesBase<OP extends LineSeriesBaseOptions = LineSeriesBaseOptions> extends Series<OP> {
@@ -9695,7 +9690,6 @@ declare abstract class LineSeriesBase<OP extends LineSeriesBaseOptions = LineSer
     abstract getLineType(): LineType;
     protected _doPrepareLines(pts: LineSeriesPoint[]): PointLine[];
 }
-type PointLine = IPointPos[];
 /**
  * Line 시리즈의 마지막 데이터포인트 옆에 표시되는 아이콘과 텍스트 설정 모델.<br/>
  * 마지막 포인트와의 간격은 {@page offset} 속성으로 지정한다.
@@ -10749,9 +10743,6 @@ declare class TreemapSeries extends Series<TreemapSeriesOptions> {
      */
     /**
      * @internal
-     * @param width
-     * @param height
-     * @returns
      */
     buildMap(width: number, height: number): {
         roots: TreeNode[];
@@ -11292,9 +11283,6 @@ declare class ShapeAnnotation extends Annotation<ShapeAnnotationOptions> {
     protected _doSetSimple(src: any): boolean;
 }
 
-/**
- * Globals
- */
 declare const getVersion: typeof Globals.getVersion;
 declare const setDebugging: typeof Globals.setDebugging;
 declare const setLogging: typeof Globals.setLogging;