@nativescript-community/ui-chart 1.2.36 → 2.0.0

package/data/CandleDataSet.d.ts

@@ -1,42 +1,76 @@
 import { CandleEntry } from './CandleEntry';
 import { ICandleDataSet } from '../interfaces/datasets/ICandleDataSet';
 import { LineScatterCandleRadarDataSet } from './LineScatterCandleRadarDataSet';
+import { Color } from '@nativescript/core';
 export declare class CandleDataSet extends LineScatterCandleRadarDataSet<CandleEntry> implements ICandleDataSet {
+    /**
+     * property to access the "high" value of an entry for this set
+     *
+     */
     highProperty: string;
+    /**
+     * property to access the "low" value of an entry for this set
+     *
+     */
     lowProperty: string;
+    /**
+     * property to access the "close" value of an entry for this set
+     *
+     */
     closeProperty: string;
+    /**
+     * property to access the "open" value of an entry for this set
+     *
+     */
     openProperty: string;
-    private mShadowWidth;
-    private mShowCandleBar;
-    private mBarSpace;
-    private mShadowColorSameAsCandle;
-    protected mIncreasingPaintStyle: globalAndroid.graphics.Paint.Style;
-    protected mDecreasingPaintStyle: globalAndroid.graphics.Paint.Style;
-    protected mNeutralColor: import("@nativescript/core").Color;
-    protected mIncreasingColor: import("@nativescript/core").Color;
-    protected mDecreasingColor: import("@nativescript/core").Color;
-    protected mShadowColor: import("@nativescript/core").Color;
+    /**
+     * the width of the shadow of the candle
+     */
+    shadowWidth: number;
+    /**
+     * should the candle bars show?
+     * when false, only "ticks" will show
+     * <p/>
+     * - default: true
+     */
+    showCandleBar: boolean;
+    /**
+     * the space between the candle entries, default 0.1 (10%)
+     */
+    barSpace: number;
+    /**
+     * use candle color for the shadow
+     */
+    shadowColorSameAsCandle: boolean;
+    /**
+     * palet style when open < close
+     * increasing candlesticks are traditionally hollow
+     */
+    increasingPaintStyle: globalAndroid.graphics.Paint.Style;
+    /**
+     * palet style when open > close
+     * descreasing candlesticks are traditionally filled
+     */
+    decreasingPaintStyle: globalAndroid.graphics.Paint.Style;
+    /**
+     * color for open === close
+     */
+    neutralColor: Color | string;
+    /**
+     * color for open < close
+     */
+    increasingColor: Color | string;
+    /**
+     * color for open > close
+     */
+    decreasingColor: Color | string;
+    /**
+     * shadow line color, set -1 for backward compatibility and uses default
+     * color
+     */
+    shadowColor: Color | string;
     constructor(yVals: any, label: any, xProperty?: any, yProperty?: any, highProperty?: any, lowProperty?: any, openProperty?: any, closeProperty?: any);
+    getEntryYValue(e: CandleEntry): number;
     protected calcMinMaxForEntry(e?: CandleEntry, index?: number): void;
     protected calcMinMaxY(e: CandleEntry): void;
-    setBarSpace(space: any): void;
-    getBarSpace(): number;
-    setShadowWidth(width: any): void;
-    getShadowWidth(): number;
-    setShowCandleBar(showCandleBar: any): void;
-    getShowCandleBar(): boolean;
-    setNeutralColor(color: any): void;
-    getNeutralColor(): import("@nativescript/core").Color;
-    setIncreasingColor(color: any): void;
-    getIncreasingColor(): import("@nativescript/core").Color;
-    setDecreasingColor(color: any): void;
-    getDecreasingColor(): import("@nativescript/core").Color;
-    getIncreasingPaintStyle(): globalAndroid.graphics.Paint.Style;
-    setIncreasingPaintStyle(paintStyle: any): void;
-    getDecreasingPaintStyle(): globalAndroid.graphics.Paint.Style;
-    setDecreasingPaintStyle(decreasingPaintStyle: any): void;
-    getShadowColor(): import("@nativescript/core").Color;
-    setShadowColor(shadowColor: any): void;
-    getShadowColorSameAsCandle(): boolean;
-    setShadowColorSameAsCandle(shadowColorSameAsCandle: any): void;
 }

package/data/CandleDataSet.js

@@ -4,20 +4,72 @@ import { ColorTemplate } from '../utils/ColorTemplate';
 export class CandleDataSet extends LineScatterCandleRadarDataSet {
     constructor(yVals, label, xProperty, yProperty, highProperty, lowProperty, openProperty, closeProperty) {
         super(yVals, label, xProperty, yProperty);
+        /**
+         * property to access the "high" value of an entry for this set
+         *
+         */
         this.highProperty = 'high';
+        /**
+         * property to access the "low" value of an entry for this set
+         *
+         */
         this.lowProperty = 'low';
+        /**
+         * property to access the "close" value of an entry for this set
+         *
+         */
         this.closeProperty = 'close';
+        /**
+         * property to access the "open" value of an entry for this set
+         *
+         */
         this.openProperty = 'open';
-        this.mShadowWidth = 3;
-        this.mShowCandleBar = true;
-        this.mBarSpace = 0.1;
-        this.mShadowColorSameAsCandle = false;
-        this.mIncreasingPaintStyle = Style.STROKE;
-        this.mDecreasingPaintStyle = Style.FILL;
-        this.mNeutralColor = ColorTemplate.COLOR_SKIP;
-        this.mIncreasingColor = ColorTemplate.COLOR_SKIP;
-        this.mDecreasingColor = ColorTemplate.COLOR_SKIP;
-        this.mShadowColor = ColorTemplate.COLOR_SKIP;
+        /**
+         * the width of the shadow of the candle
+         */
+        this.shadowWidth = 3;
+        /**
+         * should the candle bars show?
+         * when false, only "ticks" will show
+         * <p/>
+         * - default: true
+         */
+        this.showCandleBar = true;
+        /**
+         * the space between the candle entries, default 0.1 (10%)
+         */
+        this.barSpace = 0.1;
+        /**
+         * use candle color for the shadow
+         */
+        this.shadowColorSameAsCandle = false;
+        /**
+         * palet style when open < close
+         * increasing candlesticks are traditionally hollow
+         */
+        this.increasingPaintStyle = Style.STROKE;
+        /**
+         * palet style when open > close
+         * descreasing candlesticks are traditionally filled
+         */
+        this.decreasingPaintStyle = Style.FILL;
+        /**
+         * color for open === close
+         */
+        this.neutralColor = ColorTemplate.COLOR_SKIP;
+        /**
+         * color for open < close
+         */
+        this.increasingColor = ColorTemplate.COLOR_SKIP;
+        /**
+         * color for open > close
+         */
+        this.decreasingColor = ColorTemplate.COLOR_SKIP;
+        /**
+         * shadow line color, set -1 for backward compatibility and uses default
+         * color
+         */
+        this.shadowColor = ColorTemplate.COLOR_SKIP;
         if (highProperty) {
             this.highProperty = highProperty;
         }
@@ -32,6 +84,11 @@ export class CandleDataSet extends LineScatterCandleRadarDataSet {
         }
         this.init();
     }
+    getEntryYValue(e) {
+        const lowValue = e[this.lowProperty] || 0;
+        const highValue = e[this.highProperty] || 0;
+        return (lowValue + highValue) / 2;
+    }
     calcMinMaxForEntry(e, index) {
         if (!e)
             return;
@@ -55,69 +112,5 @@ export class CandleDataSet extends LineScatterCandleRadarDataSet {
         if (low > this.mYMax)
             this.mYMax = low;
     }
-    setBarSpace(space) {
-        if (space < 0)
-            space = 0;
-        if (space > 0.45)
-            space = 0.45;
-        this.mBarSpace = space;
-    }
-    getBarSpace() {
-        return this.mBarSpace;
-    }
-    setShadowWidth(width) {
-        this.mShadowWidth = width;
-    }
-    getShadowWidth() {
-        return this.mShadowWidth;
-    }
-    setShowCandleBar(showCandleBar) {
-        this.mShowCandleBar = showCandleBar;
-    }
-    getShowCandleBar() {
-        return this.mShowCandleBar;
-    }
-    setNeutralColor(color) {
-        this.mNeutralColor = color;
-    }
-    getNeutralColor() {
-        return this.mNeutralColor;
-    }
-    setIncreasingColor(color) {
-        this.mIncreasingColor = color;
-    }
-    getIncreasingColor() {
-        return this.mIncreasingColor;
-    }
-    setDecreasingColor(color) {
-        this.mDecreasingColor = color;
-    }
-    getDecreasingColor() {
-        return this.mDecreasingColor;
-    }
-    getIncreasingPaintStyle() {
-        return this.mIncreasingPaintStyle;
-    }
-    setIncreasingPaintStyle(paintStyle) {
-        this.mIncreasingPaintStyle = paintStyle;
-    }
-    getDecreasingPaintStyle() {
-        return this.mDecreasingPaintStyle;
-    }
-    setDecreasingPaintStyle(decreasingPaintStyle) {
-        this.mDecreasingPaintStyle = decreasingPaintStyle;
-    }
-    getShadowColor() {
-        return this.mShadowColor;
-    }
-    setShadowColor(shadowColor) {
-        this.mShadowColor = shadowColor;
-    }
-    getShadowColorSameAsCandle() {
-        return this.mShadowColorSameAsCandle;
-    }
-    setShadowColorSameAsCandle(shadowColorSameAsCandle) {
-        this.mShadowColorSameAsCandle = shadowColorSameAsCandle;
-    }
 }
 //# sourceMappingURL=CandleDataSet.js.map

package/data/CandleDataSet.js.map

@@ -1 +1 @@
-{"version":3,"file":"CandleDataSet.js","sourceRoot":"../src/","sources":["data/CandleDataSet.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAChF,OAAO,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAGvD,MAAM,OAAO,aAAc,SAAQ,6BAA0C;IA+EzE,YAAY,KAAK,EAAE,KAAK,EAAE,SAAU,EAAE,SAAU,EAAE,YAAa,EAAE,WAAY,EAAE,YAAa,EAAE,aAAc;QACxG,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QA3E9C,iBAAY,GAAW,MAAM,CAAC;QAK9B,gBAAW,GAAW,KAAK,CAAC;QAK5B,kBAAa,GAAW,OAAO,CAAC;QAMhC,iBAAY,GAAW,MAAM,CAAC;QAKtB,iBAAY,GAAG,CAAC,CAAC;QAQjB,mBAAc,GAAG,IAAI,CAAC;QAKtB,cAAS,GAAG,GAAG,CAAC;QAKhB,6BAAwB,GAAG,KAAK,CAAC;QAM/B,0BAAqB,GAAG,KAAK,CAAC,MAAM,CAAC;QAMrC,0BAAqB,GAAG,KAAK,CAAC,IAAI,CAAC;QAKnC,kBAAa,GAAG,aAAa,CAAC,UAAU,CAAC;QAKzC,qBAAgB,GAAG,aAAa,CAAC,UAAU,CAAC;QAK5C,qBAAgB,GAAG,aAAa,CAAC,UAAU,CAAC;QAM5C,iBAAY,GAAG,aAAa,CAAC,UAAU,CAAC;QAI9C,IAAI,YAAY,EAAE;YACd,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;SACpC;QACD,IAAI,WAAW,EAAE;YACb,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;SAClC;QACD,IAAI,YAAY,EAAE;YACd,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;SACpC;QACD,IAAI,aAAa,EAAE;YACf,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;SACtC;QACD,IAAI,CAAC,IAAI,EAAE,CAAC;IAChB,CAAC;IAES,kBAAkB,CAAC,CAAe,EAAE,KAAc;QACxD,IAAI,CAAC,CAAC;YAAE,OAAO;QACf,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAClC,MAAM,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAEhC,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;QAEvC,IAAI,IAAI,GAAG,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAEzC,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAC/B,CAAC;IAES,WAAW,CAAC,CAAc;QAChC,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAClC,MAAM,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChC,IAAI,IAAI,GAAG,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAEzC,IAAI,IAAI,GAAG,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAEzC,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;QAEvC,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;IAC3C,CAAC;IAQM,WAAW,CAAC,KAAK;QACpB,IAAI,KAAK,GAAG,CAAC;YAAE,KAAK,GAAG,CAAC,CAAC;QACzB,IAAI,KAAK,GAAG,IAAI;YAAE,KAAK,GAAG,IAAI,CAAC;QAE/B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IAC3B,CAAC;IAEM,WAAW;QACd,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAOM,cAAc,CAAC,KAAK;QACvB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC9B,CAAC;IAEM,cAAc;QACjB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAOM,gBAAgB,CAAC,aAAa;QACjC,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACxC,CAAC;IAEM,gBAAgB;QACnB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IAoBM,eAAe,CAAC,KAAK;QACxB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;IAC/B,CAAC;IAEM,eAAe;QAClB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC9B,CAAC;IAQM,kBAAkB,CAAC,KAAK;QAC3B,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;IAClC,CAAC;IAEM,kBAAkB;QACrB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;IAQM,kBAAkB,CAAC,KAAK;QAC3B,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;IAClC,CAAC;IAEM,kBAAkB;QACrB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;IAEM,uBAAuB;QAC1B,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACtC,CAAC;IAOM,uBAAuB,CAAC,UAAU;QACrC,IAAI,CAAC,qBAAqB,GAAG,UAAU,CAAC;IAC5C,CAAC;IAEM,uBAAuB;QAC1B,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACtC,CAAC;IAOM,uBAAuB,CAAC,oBAAoB;QAC/C,IAAI,CAAC,qBAAqB,GAAG,oBAAoB,CAAC;IACtD,CAAC;IAEM,cAAc;QACjB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAOM,cAAc,CAAC,WAAW;QAC7B,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IACpC,CAAC;IAEM,0BAA0B;QAC7B,OAAO,IAAI,CAAC,wBAAwB,CAAC;IACzC,CAAC;IAOM,0BAA0B,CAAC,uBAAuB;QACrD,IAAI,CAAC,wBAAwB,GAAG,uBAAuB,CAAC;IAC5D,CAAC;CACJ"}
+{"version":3,"file":"CandleDataSet.js","sourceRoot":"","sources":["../../../src/ui-chart/data/CandleDataSet.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAChF,OAAO,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAIvD,MAAM,OAAO,aAAc,SAAQ,6BAA0C;IA+EzE,YAAY,KAAK,EAAE,KAAK,EAAE,SAAU,EAAE,SAAU,EAAE,YAAa,EAAE,WAAY,EAAE,YAAa,EAAE,aAAc;QACxG,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QA/E9C;;;WAGG;QACH,iBAAY,GAAW,MAAM,CAAC;QAC9B;;;WAGG;QACH,gBAAW,GAAW,KAAK,CAAC;QAC5B;;;WAGG;QACH,kBAAa,GAAW,OAAO,CAAC;QAEhC;;;WAGG;QACH,iBAAY,GAAW,MAAM,CAAC;QAE9B;;WAEG;QACH,gBAAW,GAAG,CAAC,CAAC;QAEhB;;;;;WAKG;QACH,kBAAa,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,aAAQ,GAAG,GAAG,CAAC;QAEf;;WAEG;QACH,4BAAuB,GAAG,KAAK,CAAC;QAEhC;;;WAGG;QACH,yBAAoB,GAAG,KAAK,CAAC,MAAM,CAAC;QAEpC;;;WAGG;QACH,yBAAoB,GAAG,KAAK,CAAC,IAAI,CAAC;QAElC;;WAEG;QACH,iBAAY,GAAmB,aAAa,CAAC,UAAU,CAAC;QAExD;;WAEG;QACH,oBAAe,GAAmB,aAAa,CAAC,UAAU,CAAC;QAE3D;;WAEG;QACH,oBAAe,GAAmB,aAAa,CAAC,UAAU,CAAC;QAE3D;;;WAGG;QACH,gBAAW,GAAmB,aAAa,CAAC,UAAU,CAAC;QAInD,IAAI,YAAY,EAAE,CAAC;YACf,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACrC,CAAC;QACD,IAAI,WAAW,EAAE,CAAC;YACd,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QACnC,CAAC;QACD,IAAI,YAAY,EAAE,CAAC;YACf,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACrC,CAAC;QACD,IAAI,aAAa,EAAE,CAAC;YAChB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,IAAI,EAAE,CAAC;IAChB,CAAC;IAEM,cAAc,CAAC,CAAc;QAChC,MAAM,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC1C,MAAM,SAAS,GAAG,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC5C,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IAES,kBAAkB,CAAC,CAAe,EAAE,KAAc;QACxD,IAAI,CAAC,CAAC;YAAE,OAAO;QACf,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAClC,MAAM,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAEhC,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;QAEvC,IAAI,IAAI,GAAG,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAEzC,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAC/B,CAAC;IAES,WAAW,CAAC,CAAc;QAChC,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAClC,MAAM,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChC,IAAI,IAAI,GAAG,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAEzC,IAAI,IAAI,GAAG,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAEzC,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;QAEvC,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;IAC3C,CAAC;CAGJ"}

package/data/CandleEntry.d.ts

@@ -1,7 +1,11 @@
 import { Entry } from './Entry';
 export interface CandleEntry extends Entry {
+    /** shadow-high value */
     high: number;
+    /** shadow-low value */
     low: number;
+    /** close value */
     close: number;
+    /** open value */
     open: number;
 }

package/data/CandleEntry.js.map

@@ -1 +1 @@
-{"version":3,"file":"CandleEntry.js","sourceRoot":"../src/","sources":["data/CandleEntry.ts"],"names":[],"mappings":""}
+{"version":3,"file":"CandleEntry.js","sourceRoot":"","sources":["../../../src/ui-chart/data/CandleEntry.ts"],"names":[],"mappings":""}

package/data/ChartData.d.ts

@@ -4,62 +4,317 @@ import { IValueFormatter } from '../formatter/IValueFormatter';
 import { Highlight } from '../highlight/Highlight';
 import { IDataSet } from '../interfaces/datasets/IDataSet';
 export declare abstract class ChartData<U extends Entry, T extends IDataSet<U>> {
+    /**
+     * maximum y-value in the value array across all axes
+     */
     mYMax: number;
+    /**
+     * the minimum y-value in the value array across all axes
+     */
     mYMin: number;
+    /**
+     * maximum x-value in the value array
+     */
     mXMax: number;
+    /**
+     * minimum x-value in the value array
+     */
     mXMin: number;
     mLeftAxisMax: number;
     mLeftAxisMin: number;
     mRightAxisMax: number;
     mRightAxisMin: number;
+    /**
+     * array that holds all DataSets the ChartData object represents
+     */
     protected mDataSets: T[];
+    /**
+     * Default constructor.
+     */
+    /**
+     * Constructor taking single or multiple DataSet objects.
+     *
+     * @param dataSets
+     */
     constructor(dataSets?: T[]);
+    /**
+     * Call this method to let the ChartData know that the underlying data has
+     * changed. Calling this performs all necessary recalculations needed when
+     * the contained data has changed.
+     */
     notifyDataChanged(): void;
+    /**
+     * Calc minimum and maximum y-values over all DataSets.
+     * Tell DataSets to recalculate their min and max y-values, this is only needed for autoScaleMinMax.
+     *
+     * @param fromX the x-value to start the calculation from
+     * @param toX   the x-value to which the calculation should be performed
+     */
     calcMinMaxYRange(fromX: any, toX: any): void;
+    /**
+     * Calc minimum and maximum values (both x and y) over all DataSets.
+     */
     calcMinMax(): void;
-    getDataSetCount(): number;
+    /** ONLY GETTERS AND SETTERS BELOW THIS */
+    /**
+     * returns the number of LineDataSets this object contains
+     */
+    get dataSetCount(): number;
+    /**
+     * Returns the minimum y-value for the specified axis.
+     *
+     * @param axis
+     * @return
+     */
     getYMin(axis?: any): number;
+    get yMin(): number;
+    get yMax(): number;
+    /**
+     * Returns the maximum y-value for the specified axis.
+     *
+     * @param axis
+     * @return
+     */
     getYMax(axis?: AxisDependency): number;
-    getXMin(): number;
-    getXMax(): number;
-    getDataSets(): T[];
-    getVisibleDataSets(): T[];
+    /**
+     * Returns the minimum x-value this data object contains.
+     */
+    get xMin(): number;
+    /**
+     * Returns the maximum x-value this data object contains.
+     */
+    get xMax(): number;
+    /**
+     * Returns all DataSet objects this ChartData object holds.
+     */
+    get dataSets(): T[];
+    get visibleDataSets(): T[];
+    /**
+     * Retrieve the index of a DataSet with a specific label from the ChartData.
+     * Search can be case sensitive or not. IMPORTANT: This method does
+     * calculations at runtime, do not over-use in performance critical
+     * situations.
+     *
+     * @param dataSets   the DataSet array to search
+     * @param label
+     * @param ignorecase if true, the search is not case-sensitive
+     * @return
+     */
     protected getDataSetIndexByLabel(dataSets: T[], label: string, ignorecase: any): number;
+    /**
+     * Returns the labels of all DataSets as a string array.
+     */
     getDataSetLabels(): any[];
+    /**
+     * Get the Entry for a corresponding highlight object
+     *
+     * @param highlight
+     * @return the entry that is highlighted
+     */
     getEntryForHighlight(highlight: Highlight): Entry;
+    /**
+     * Get the Entry for a corresponding highlight object
+     *
+     * @param highlight
+     * @return the entry that is highlighted
+     */
     getEntryAndIndexForHighlight(highlight: Highlight): {
         entry: Entry;
         index: number;
     };
+    /**
+     * Returns the DataSet object with the given label. Search can be case
+     * sensitive or not. IMPORTANT: This method does calculations at runtime.
+     * Use with care in performance critical situations.
+     *
+     * @param label
+     * @param ignorecase
+     * @return
+     */
     getDataSetByLabel(label: any, ignorecase: any): T;
     getDataSetByIndex(index: number): T;
+    /**
+     * Adds a DataSet dynamically.
+     *
+     * @param d
+     */
     addDataSet(d: T): void;
+    /**
+     * Removes the given DataSet from this data object. Also recalculates all
+     * minimum and maximum values. Returns true if a DataSet was removed, false
+     * if no DataSet could be removed.
+     *
+     * @param d
+     */
     removeDataSet(d: T): boolean;
+    /**
+     * Removes the DataSet at the given index in the DataSet array from the data
+     * object. Also recalculates all minimum and maximum values. Returns true if
+     * a DataSet was removed, false if no DataSet could be removed.
+     *
+     * @param index
+     */
     removeDataSetAtIndex(index: any): boolean;
+    /**
+     * Adds an Entry to the DataSet at the specified index.
+     * Entries are added to the end of the list.
+     *
+     * @param e
+     * @param dataSetIndex
+     */
     addEntry(e: any, dataSetIndex: any): void;
+    /**
+     * Adjusts the current minimum and maximum values based on the provided Entry object.
+     *
+     * @param e
+     * @param axis
+     */
     protected calcMinMaxForEntry(set: IDataSet<Entry>, e: Entry, entryIndex: number, axis: AxisDependency): void;
+    /**
+     * Adjusts the minimum and maximum values based on the given DataSet.
+     *
+     * @param d
+     */
     protected calcMinMaxForDataSet(d: T): void;
+    /**
+     * Removes the given Entry object from the DataSet at the specified index.
+     *
+     * @param e
+     * @param dataSetIndex
+     */
     removeEntry(e: any, dataSetIndex: any): boolean;
+    /**
+     * Removes the Entry object closest to the given DataSet at the
+     * specified index. Returns true if an Entry was removed, false if no Entry
+     * was found that meets the specified requirements.
+     *
+     * @param xValue
+     * @param dataSetIndex
+     * @return
+     */
     removeEntryForXValue(xValue: any, dataSetIndex: any): boolean;
+    /**
+     * Removes the Entry object closest to the given DataSet at the
+     * specified index. Returns true if an Entry was removed, false if no Entry
+     * was found that meets the specified requirements.
+     *
+     * @param xValue
+     * @param dataSetIndex
+     * @return
+     */
+    removeEntryAtIndex(index: any, dataSetIndex: any): boolean;
+    /**
+     * Returns the DataSet that contains the provided Entry, or null, if no
+     * DataSet contains this Entry.
+     *
+     * @param e
+     * @return
+     */
     getDataSetForEntry(e: Entry): T;
+    /**
+     * Returns the DataSet that contains the provided Entry and the entry index, or null, if no
+     * DataSet contains this Entry.
+     *
+     * @param e
+     * @return
+     */
     getDataSetAndIndexForEntry(e: Entry): {
         set: T;
         index: number;
     };
-    getColors(): any[];
-    getIndexOfDataSet(dataSet: any): number;
-    protected getFirstLeft(sets: any): any;
-    getFirstRight(sets: any): any;
-    setValueFormatter(f: IValueFormatter): void;
-    setValueTextColor(color: any): void;
-    setValueTextColors(colors: any): void;
-    setValueTypeface(tf: any): void;
-    setValueTextSize(size: any): void;
-    setDrawValues(enabled: any): void;
+    /**
+     * Returns all colors used across all DataSet objects this object
+     * represents.
+     */
+    get colors(): any[];
+    /**
+     * Returns the index of the provided DataSet in the DataSet array of this data object, or -1 if it does not exist.
+     *
+     * @param dataSet
+     * @return
+     */
+    getIndexOfDataSet(dataSet: T): number;
+    /**
+     * Returns the first DataSet from the datasets-array that has it's dependency on the left axis.
+     * Returns null if no DataSet with left dependency could be found.
+     */
+    protected getFirstLeft(sets: T[]): T;
+    /**
+     * Returns the first DataSet from the datasets-array that has it's dependency on the right axis.
+     * Returns null if no DataSet with right dependency could be found.
+     */
+    getFirstRight(sets: T[]): T;
+    /**
+     * Sets a custom IValueFormatter for all DataSets this data object contains.
+     *
+     * @param f
+     */
+    set valueFormatter(f: IValueFormatter);
+    /**
+     * Sets the color of the value-text (color in which the value-labels are
+     * drawn) for all DataSets this data object contains.
+     *
+     * @param color
+     */
+    set valueTextColor(color: any);
+    /**
+     * Sets the same list of value-colors for all DataSets this
+     * data object contains.
+     *
+     * @param colors
+     */
+    set valueTextColors(colors: any);
+    /**
+     * Sets the Typeface for all value-labels for all DataSets this data object
+     * contains.
+     *
+     * @param tf
+     */
+    set valueTypeface(tf: any);
+    /**
+     * Sets the size (in dp) of the value-text for all DataSets this data object
+     * contains.
+     *
+     * @param size
+     */
+    set valueTextSize(size: any);
+    /**
+     * Enables / disables drawing values (value-text) for all DataSets this data
+     * object contains.
+     *
+     * @param enabled
+     */
+    set drawValuesEnabled(enabled: any);
+    /**
+     * Enables / disables highlighting values for all DataSets this data object
+     * contains. If set to true, this means that values can
+     * be highlighted programmatically or by touch gesture.
+     */
     setHighlightEnabled(enabled: any): void;
-    isHighlightEnabled(): boolean;
+    /**
+     * Returns true if highlighting of all underlying values is enabled, false
+     * if not.
+     */
+    get highlightEnabled(): boolean;
+    /**
+     * Clears this data object from all DataSets and removes all Entries. Don't
+     * forget to invalidate the chart after this.
+     */
     clearValues(): void;
+    /**
+     * Checks if this data object contains the specified DataSet. Returns true
+     * if so, false if not.
+     *
+     * @param dataSet
+     * @return
+     */
     contains(dataSet: any): boolean;
-    getEntryCount(): number;
-    getMaxEntryCountSet(): T;
+    /**
+     * Returns the total entry count across all DataSet objects this data object contains.
+     */
+    get entryCount(): number;
+    /**
+     * Returns the DataSet object with the maximum number of entries or null if there are no DataSets.
+     */
+    get maxEntryCountSet(): T;
 }