@nativescript-community/ui-chart 1.2.35 → 2.0.0

package/components/ComponentBase.d.ts

@@ -1,25 +1,60 @@
 import { Font } from '@nativescript/core/ui/styling/font';
+/**
+ * This class encapsulates everything both Axis, Legend and LimitLines have in common.
+ *
+
+ */
 export declare abstract class ComponentBase {
-    protected mEnabled: boolean;
-    protected mXOffset: number;
-    protected mYOffset: number;
-    protected mTypeface: Font;
+    /**
+     * flag that indicates if this axis / legend is enabled or not
+     */
+    enabled: boolean;
+    /**
+     * the offset in pixels this component has on the x-axis
+     */
+    xOffset: number;
+    /**
+     * the offset in pixels this component has on the Y-axis
+     */
+    yOffset: number;
+    /**
+     * the typeface used for the labels
+     */
+    typeface: Font;
+    /**
+     * the text size of the labels
+     */
     protected mTextSize: number;
-    protected mTextColor: string;
+    /**
+     * the text color to use for the labels
+     */
+    textColor: string;
     ComponentBase(): void;
-    getXOffset(): number;
-    setXOffset(xOffset: number): void;
-    getYOffset(): number;
-    setYOffset(yOffset: any): void;
-    getTypeface(): Font;
-    setTypeface(tf: Font): void;
-    getFont(): Font;
-    setFont(tf: Font): void;
-    setTextSize(size: any): void;
-    getTextSize(): number;
-    setTextColor(color: any): void;
-    getTextColor(): string;
-    setEnabled(enabled: any): void;
-    isEnabled(): boolean;
+    /**
+     * returns the Typeface used for the labels, returns null if none is set
+     *
+     * @return {@link Font}
+     */
+    get font(): Font;
+    /**
+     * sets a specific Typeface for the labels
+     *
+     * @param tf
+     */
+    set font(tf: Font);
+    /**
+     * sets the size of the label text in density pixels min = 6f, max = 24f, default
+     * 10
+     *
+     * @param size the text size, in DP
+     */
+    set textSize(size: number);
+    /**
+     * returns the text size that is currently set for the labels, in pixels
+     */
+    get textSize(): number;
+    /**
+     * Defines if the renderer should ensure we always see the component fully
+     */
     ensureVisible: boolean;
 }

package/components/ComponentBase.js

@@ -1,65 +1,77 @@
 import { Font } from '@nativescript/core/ui/styling/font';
 const DEFAULT_FONT = Font.default.withFontSize(10);
+/**
+ * This class encapsulates everything both Axis, Legend and LimitLines have in common.
+ *
+
+ */
 export class ComponentBase {
     constructor() {
-        this.mEnabled = true;
-        this.mXOffset = 5;
-        this.mYOffset = 5;
-        this.mTypeface = DEFAULT_FONT;
+        /**
+         * flag that indicates if this axis / legend is enabled or not
+         */
+        this.enabled = true;
+        /**
+         * the offset in pixels this component has on the x-axis
+         */
+        this.xOffset = 5;
+        /**
+         * the offset in pixels this component has on the Y-axis
+         */
+        this.yOffset = 5;
+        /**
+         * the typeface used for the labels
+         */
+        this.typeface = DEFAULT_FONT;
+        /**
+         * the text size of the labels
+         */
         this.mTextSize = 10;
-        this.mTextColor = 'black';
+        /**
+         * the text color to use for the labels
+         */
+        this.textColor = 'black';
+        /**
+         * Defines if the renderer should ensure we always see the component fully
+         */
         this.ensureVisible = false;
     }
     ComponentBase() { }
-    getXOffset() {
-        return this.mXOffset;
+    /**
+     * returns the Typeface used for the labels, returns null if none is set
+     *
+     * @return {@link Font}
+     */
+    get font() {
+        return this.typeface;
     }
-    setXOffset(xOffset) {
-        this.mXOffset = xOffset;
-    }
-    getYOffset() {
-        return this.mYOffset;
-    }
-    setYOffset(yOffset) {
-        this.mYOffset = yOffset;
-    }
-    getTypeface() {
-        return this.getFont();
-    }
-    setTypeface(tf) {
-        this.setFont(tf);
-    }
-    getFont() {
-        return this.mTypeface;
-    }
-    setFont(tf) {
-        if (!tf.fontSize) {
-            tf = tf.withFontSize(this.mTextSize);
+    /**
+     * sets a specific Typeface for the labels
+     *
+     * @param tf
+     */
+    set font(tf) {
+        if (tf.fontSize <= 0) {
+            tf = tf.withFontSize(this.textSize);
         }
-        this.mTypeface = tf;
+        this.typeface = tf;
     }
-    setTextSize(size) {
-        if (size > 24)
-            size = 24;
-        if (size < 6)
-            size = 6;
+    /**
+     * sets the size of the label text in density pixels min = 6f, max = 24f, default
+     * 10
+     *
+     * @param size the text size, in DP
+     */
+    set textSize(size) {
         this.mTextSize = size;
-        this.mTypeface = this.mTypeface.withFontSize(size);
+        // this bit is important to make sure we dont create crazy amount of native fonts on render
+        this.typeface = this.typeface.withFontSize(size);
     }
-    getTextSize() {
+    /**
+     * returns the text size that is currently set for the labels, in pixels
+     */
+    get textSize() {
         return this.mTextSize;
     }
-    setTextColor(color) {
-        this.mTextColor = color;
-    }
-    getTextColor() {
-        return this.mTextColor;
-    }
-    setEnabled(enabled) {
-        this.mEnabled = enabled;
-    }
-    isEnabled() {
-        return this.mEnabled;
-    }
 }
 //# sourceMappingURL=ComponentBase.js.map

package/components/ComponentBase.js.map

@@ -1 +1 @@
-{"version":3,"file":"ComponentBase.js","sourceRoot":"../src/","sources":["components/ComponentBase.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,oCAAoC,CAAC;AAE1D,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;AAMnD,MAAM,OAAgB,aAAa;IAAnC;QAIc,aAAQ,GAAY,IAAI,CAAC;QAKzB,aAAQ,GAAW,CAAC,CAAC;QAKrB,aAAQ,GAAW,CAAC,CAAC;QAKrB,cAAS,GAAS,YAAY,CAAC;QAK/B,cAAS,GAAW,EAAE,CAAC;QAKvB,eAAU,GAAW,OAAO,CAAC;QAuJhC,kBAAa,GAAG,KAAK,CAAC;IACjC,CAAC;IAtJU,aAAa,KAAI,CAAC;IAQlB,UAAU;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAOM,UAAU,CAAC,OAAe;QAC7B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC5B,CAAC;IAQM,UAAU;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IASM,UAAU,CAAC,OAAO;QACrB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC5B,CAAC;IAQM,WAAW;QACd,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAQM,WAAW,CAAC,EAAQ;QACvB,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACrB,CAAC;IAOM,OAAO;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAOM,OAAO,CAAC,EAAQ;QACnB,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE;YACd,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACxC;QACD,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;IACxB,CAAC;IAQM,WAAW,CAAC,IAAI;QACnB,IAAI,IAAI,GAAG,EAAE;YAAE,IAAI,GAAG,EAAE,CAAC;QACzB,IAAI,IAAI,GAAG,CAAC;YAAE,IAAI,GAAG,CAAC,CAAC;QAEvB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC;IAOM,WAAW;QACd,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAQM,YAAY,CAAC,KAAK;QACrB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;IAC5B,CAAC;IAOM,YAAY;QACf,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IASM,UAAU,CAAC,OAAO;QACrB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC5B,CAAC;IAOM,SAAS;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;CAMJ"}
+{"version":3,"file":"ComponentBase.js","sourceRoot":"","sources":["../../../src/ui-chart/components/ComponentBase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,oCAAoC,CAAC;AAE1D,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;AACnD;;;;GAIG;AACH,MAAM,OAAgB,aAAa;IAAnC;QACI;;WAEG;QACH,YAAO,GAAY,IAAI,CAAC;QAExB;;WAEG;QACH,YAAO,GAAW,CAAC,CAAC;QAEpB;;WAEG;QACH,YAAO,GAAW,CAAC,CAAC;QAEpB;;WAEG;QACH,aAAQ,GAAS,YAAY,CAAC;QAE9B;;WAEG;QACO,cAAS,GAAW,EAAE,CAAC;QAEjC;;WAEG;QACH,cAAS,GAAW,OAAO,CAAC;QA2C5B;;WAEG;QACI,kBAAa,GAAG,KAAK,CAAC;IACjC,CAAC;IA7CU,aAAa,KAAI,CAAC;IAEzB;;;;OAIG;IACH,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,IAAW,IAAI,CAAC,EAAQ;QACpB,IAAI,EAAE,CAAC,QAAQ,IAAI,CAAC,EAAE,CAAC;YACnB,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;IACvB,CAAC;IACD;;;;;OAKG;IACH,IAAI,QAAQ,CAAC,IAAI;QACb,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,2FAA2F;QAC3F,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;CAMJ"}

package/components/Description.d.ts

@@ -1,13 +1,22 @@
 import { ComponentBase } from './ComponentBase';
+/**
+ * Created by Philipp Jahoda on 17/09/16.
+ */
 export declare class Description extends ComponentBase {
-    private text;
-    private mPosition;
-    private mTextAlign;
+    /**
+     * the text used in the description
+     */
+    text: string;
+    /**
+     * the custom position of the description text
+     */
+    position: {
+        x: number;
+        y: number;
+    };
+    /**
+     * the alignment of the description text
+     */
+    textAlign: globalAndroid.graphics.Paint.Align;
     constructor();
-    setText(text: any): void;
-    getText(): string;
-    setPosition(x: any, y: any): void;
-    getPosition(): any;
-    setTextAlign(align: any): void;
-    getTextAlign(): globalAndroid.graphics.Paint.Align;
 }

package/components/Description.js

@@ -1,35 +1,21 @@
 import { ComponentBase } from './ComponentBase';
 import { Align } from '@nativescript-community/ui-canvas';
+/**
+ * Created by Philipp Jahoda on 17/09/16.
+ */
 export class Description extends ComponentBase {
     constructor() {
         super();
+        /**
+         * the text used in the description
+         */
         this.text = 'Description Label';
-        this.mTextAlign = Align.RIGHT;
-        this.mTextSize = 8;
-    }
-    setText(text) {
-        this.text = text;
-    }
-    getText() {
-        return this.text;
-    }
-    setPosition(x, y) {
-        if (this.mPosition == null) {
-            this.mPosition = { x, y };
-        }
-        else {
-            this.mPosition.x = x;
-            this.mPosition.y = y;
-        }
-    }
-    getPosition() {
-        return this.mPosition;
-    }
-    setTextAlign(align) {
-        this.mTextAlign = align;
-    }
-    getTextAlign() {
-        return this.mTextAlign;
+        /**
+         * the alignment of the description text
+         */
+        this.textAlign = Align.RIGHT;
+        // default size
+        this.textSize = 8;
     }
 }
 //# sourceMappingURL=Description.js.map

package/components/Description.js.map

@@ -1 +1 @@
-{"version":3,"file":"Description.js","sourceRoot":"../src/","sources":["components/Description.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAC;AAM1D,MAAM,OAAO,WAAY,SAAQ,aAAa;IAgB1C;QACI,KAAK,EAAE,CAAC;QAbJ,SAAI,GAAG,mBAAmB,CAAC;QAU3B,eAAU,GAAG,KAAK,CAAC,KAAK,CAAC;QAM7B,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;IACvB,CAAC;IAQM,OAAO,CAAC,IAAI;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;IAOM,OAAO;QACV,OAAO,IAAI,CAAC,IAAI,CAAC;IACrB,CAAC;IAQM,WAAW,CAAC,CAAC,EAAE,CAAC;QACnB,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,EAAE;YACxB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;SAC7B;aAAM;YACH,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC;YACrB,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC;SACxB;IACL,CAAC;IAOM,WAAW;QACd,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAOM,YAAY,CAAC,KAAK;QACrB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;IAC5B,CAAC;IAOM,YAAY;QACf,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;CACJ"}
+{"version":3,"file":"Description.js","sourceRoot":"","sources":["../../../src/ui-chart/components/Description.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAC;AAG1D;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,aAAa;IAgB1C;QACI,KAAK,EAAE,CAAC;QAhBZ;;WAEG;QACH,SAAI,GAAG,mBAAmB,CAAC;QAO3B;;WAEG;QACH,cAAS,GAAG,KAAK,CAAC,KAAK,CAAC;QAIpB,eAAe;QACf,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;IACtB,CAAC;CACJ"}

package/components/IMarker.d.ts

@@ -3,8 +3,37 @@ import { Entry } from '../data/Entry';
 import { MPPointF } from '../utils/MPPointF';
 import { Canvas } from '@nativescript-community/ui-canvas';
 export interface IMarker {
-    getOffset(): MPPointF;
+    /**
+     * @return The desired (general) offset you wish the IMarker to have on the x- and y-axis.
+     *         By returning x: -(width / 2) you will center the IMarker horizontally.
+     *         By returning y: -(height / 2) you will center the IMarker vertically.
+     */
+    readonly offset: MPPointF;
+    /**
+     * @return The offset for drawing at the specific `point`. This allows conditional adjusting of the Marker position.
+     *         If you have no adjustments to make, return getOffset().
+     *
+     * @param posX This is the X position at which the marker wants to be drawn.
+     *             You can adjust the offset conditionally based on this argument.
+     * @param posY This is the X position at which the marker wants to be drawn.
+     *             You can adjust the offset conditionally based on this argument.
+     */
     getOffsetForDrawingAtPoint(posX: any, posY: any): MPPointF;
+    /**
+     * This method enables a specified custom IMarker to update it's content every time the IMarker is redrawn.
+     *
+     * @param e         The Entry the IMarker belongs to. This can also be any subclass of Entry, like BarEntry or
+     *                  CandleEntry, simply cast it at runtime.
+     * @param highlight The highlight object contains information about the highlighted value such as it's dataset-index, the
+     *                  selected range or stack-index (only stacked bar entries).
+     */
     refreshContent(e: Entry, highlight: Highlight): any;
+    /**
+     * Draws the IMarker on the given position on the screen with the given Canvas object.
+     *
+     * @param canvas
+     * @param posX
+     * @param posY
+     */
     draw(canvas: Canvas, posX: any, posY: any): any;
 }

package/components/IMarker.js.map

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

package/components/Legend.d.ts

@@ -2,11 +2,29 @@ import { ComponentBase } from './ComponentBase';
 import { LegendEntry } from './LegendEntry';
 import { DashPathEffect, Paint } from '@nativescript-community/ui-canvas';
 export declare enum LegendForm {
+    /**
+     * Avoid drawing a form
+     */
     NONE = 0,
+    /**
+     * Do not draw the a form, but leave space for it
+     */
     EMPTY = 1,
+    /**
+     * Use default (default dataset's form to the legend's form)
+     */
     DEFAULT = 2,
+    /**
+     * Draw a square
+     */
     SQUARE = 3,
+    /**
+     * Draw a circle
+     */
     CIRCLE = 4,
+    /**
+     * Draw a horizontal line
+     */
     LINE = 5
 }
 export declare enum LegendHorizontalAlignment {
@@ -27,75 +45,154 @@ export declare enum LegendDirection {
     LEFT_TO_RIGHT = 0,
     RIGHT_TO_LEFT = 1
 }
+/**
+ * Class representing the legend of the chart. The legend will contain one entry
+ * per color and DataSet. Multiple colors in one DataSet are grouped together.
+ * The legend object is NOT available before setting data to the chart.
+ *
+
+ */
 export declare class Legend extends ComponentBase {
-    private mEntries;
-    private mExtraEntries;
-    private mIsLegendCustom;
-    private mHorizontalAlignment;
-    private mVerticalAlignment;
-    private mOrientation;
-    private mDrawInside;
-    private mDirection;
-    private mShape;
-    private mFormSize;
-    private mFormLineWidth;
-    private mFormLineDashEffect;
-    private mXEntrySpace;
-    private mYEntrySpace;
-    private mFormToTextSpace;
-    private mStackSpace;
-    private mMaxSizePercent;
+    /**
+     * The legend entries array
+     */
+    entries: LegendEntry[];
+    /**
+     * Entries that will be appended to the end of the auto calculated entries after calculating the legend.
+     * (if the legend has already been calculated, you will need to call notifyDataSetChanged() to let the changes take effect)
+     */
+    extraEntries: LegendEntry[];
+    /**
+     * Are the legend labels/colors a custom value or auto calculated? If false,
+     * then it's auto, if true, then custom. default false (automatic legend)
+     */
+    mIsLegendCustom: boolean;
+    horizontalAlignment: LegendHorizontalAlignment;
+    verticalAlignment: LegendVerticalAlignment;
+    orientation: LegendOrientation;
+    drawInside: boolean;
+    /**
+     * the text direction for the legend
+     */
+    direction: LegendDirection;
+    /**
+     * the shape/form the legend colors are drawn in
+     */
+    form: LegendForm;
+    /**
+     * the size of the legend forms/shapes
+     */
+    formSize: number;
+    /**
+     * the size of the legend forms/shapes
+     */
+    formLineWidth: number;
+    /**
+     * Line dash path effect used for shapes that consist of lines.
+     */
+    formLineDashEffect: DashPathEffect;
+    /**
+     * the space between the legend entries on a horizontal axis, default 6f
+     */
+    xEntrySpace: number;
+    /**
+     * the space between the legend entries on a vertical axis, default 5f
+     */
+    yEntrySpace: number;
+    /**
+     * the space between the legend entries on a vertical axis, default 2f
+     * private float this.mYEntrySpace = 2f; /** the space between the form and the
+     * actual label/text
+     */
+    formToTextSpace: number;
+    /**
+     * the space that should be left between stacked forms
+     */
+    stackSpace: number;
+    /**
+     * The maximum relative size out of the whole chart view. / If the legend is
+     * to the right/left of the chart, then this affects the width of the
+     * legend. / If the legend is to the top/bottom of the chart, then this
+     * affects the height of the legend. / If the legend is the center of the
+     * piechart, then this defines the size of the rectangular bounds out of the
+     * size of the "hole". / default: 0.95f (95%)
+     */
+    maxSizePercent: number;
+    /**
+     * Constructor. Provide entries for the legend.
+     *
+     * @param entries
+     */
     constructor(entries?: LegendEntry[]);
-    setEntries(entries: LegendEntry[]): void;
-    getEntries(): LegendEntry[];
+    /**
+     * returns the maximum length in pixels across all legend labels + formsize
+     * + formtotextspace
+     *
+     * @param p the paint object used for rendering the text
+     * @return
+     */
     getMaximumEntryWidth(p: Paint): number;
+    /**
+     * returns the maximum height in pixels across all legend labels
+     *
+     * @param p the paint object used for rendering the text
+     * @return
+     */
     getMaximumEntryHeight(p: Paint): number;
-    getExtraEntries(): LegendEntry[];
-    setExtraEntries(entries: any): void;
+    /**
+     * Entries that will be appended to the end of the auto calculated
+     *   entries after calculating the legend.
+     * (if the legend has already been calculated, you will need to call notifyDataSetChanged()
+     *   to let the changes take effect)
+     */
     setExtra(colors: any, labels: any): void;
+    /**
+     * Sets a custom legend's entries array.
+     * * A null label will start a group.
+     * This will disable the feature that automatically calculates the legend
+     *   entries from the datasets.
+     * Call resetCustom() to re-enable automatic calculation (and then
+     *   notifyDataSetChanged() is needed to auto-calculate the legend again)
+     */
     setCustom(entries: any): void;
+    /**
+     * Calling this will disable the custom legend entries (set by
+     * setCustom(...)). Instead, the entries will again be calculated
+     * automatically (after notifyDataSetChanged() is called).
+     */
     resetCustom(): void;
+    /**
+     * @return true if a custom legend entries has been set default
+     * false (automatic legend)
+     */
     isLegendCustom(): boolean;
-    getHorizontalAlignment(): LegendHorizontalAlignment;
-    setHorizontalAlignment(value: any): void;
-    getVerticalAlignment(): LegendVerticalAlignment;
-    setVerticalAlignment(value: any): void;
-    getOrientation(): LegendOrientation;
-    setOrientation(value: any): void;
-    isDrawInsideEnabled(): boolean;
-    setDrawInside(value: any): void;
-    getDirection(): LegendDirection;
-    setDirection(pos: any): void;
-    getForm(): LegendForm;
-    setForm(shape: any): void;
-    setFormSize(size: any): void;
-    getFormSize(): number;
-    setFormLineWidth(size: any): void;
-    getFormLineWidth(): number;
-    setFormLineDashEffect(dashPathEffect: any): void;
-    getFormLineDashEffect(): DashPathEffect;
-    getXEntrySpace(): number;
-    setXEntrySpace(space: any): void;
-    getYEntrySpace(): number;
-    setYEntrySpace(space: any): void;
-    getFormToTextSpace(): number;
-    setFormToTextSpace(space: any): void;
-    getStackSpace(): number;
-    setStackSpace(space: any): void;
+    /**
+     * the total width of the legend (needed width space)
+     */
     mNeededWidth: number;
+    /**
+     * the total height of the legend (needed height space)
+     */
     mNeededHeight: number;
     mTextHeightMax: number;
     mTextWidthMax: number;
-    private mWordWrapEnabled;
-    setWordWrapEnabled(enabled: any): void;
-    isWordWrapEnabled(): boolean;
-    getMaxSizePercent(): number;
-    setMaxSizePercent(maxSize: any): void;
-    private mCalculatedLabelSizes;
-    private mCalculatedLabelBreakPoints;
-    private mCalculatedLineSizes;
-    getCalculatedLabelSizes(): any[];
-    getCalculatedLabelBreakPoints(): any[];
-    getCalculatedLineSizes(): any[];
+    /**
+     * Should the legend word wrap? / this is currently supported only for:
+     * BelowChartLeft, BelowChartRight, BelowChartCenter. / note that word
+     * wrapping a legend takes a toll on performance. / you may want to set
+     * maxSizePercent when word wrapping, to set the point where the text wraps.
+     * / default: false
+     */
+    wordWrapEnabled: boolean;
+    calculatedLabelSizes: any[];
+    calculatedLabelBreakPoints: any[];
+    calculatedLineSizes: any[];
+    /**
+     * Calculates the dimensions of the Legend. This includes the maximum width
+     * and height of a single entry, as well as the total width and height of
+     * the Legend.
+     *
+     * @param labelpaint
+     */
     calculateDimensions(labelpaint: Paint, viewPortHandler: any): void;
 }