@nativescript-community/ui-chart 1.2.35 → 2.0.0

package/interfaces/datasets/IDataSet.d.ts

@@ -4,7 +4,6 @@ import { DashPathEffect } from '@nativescript-community/ui-canvas';
 import { Entry } from '../../data/Entry';
 import { Rounding } from '../../data/DataSet';
 import { AxisDependency } from '../../components/YAxis';
-import { GradientColor } from '../../model/GradientColor';
 import { IValueFormatter } from '../../formatter/IValueFormatter';
 import { ValueFormatter } from '../../formatter/ValueFormatter';
 import { MPPointF } from '../../utils/MPPointF';
@@ -25,52 +24,43 @@ export interface IDataSet<T extends Entry> {
 
     /**
      * returns the minimum y-value this DataSet holds
-     *
-     * @return
      */
-    getYMin(): number;
+    readonly yMin: number;
 
     /**
      * returns the maximum y-value this DataSet holds
-     *
-     * @return
      */
-    getYMax(): number;
+    readonly yMax: number;
 
     /**
      * returns the minimum x-value this DataSet holds
-     *
-     * @return
      */
-    getXMin(): number;
+    readonly xMin: number;
 
     /**
      * returns the maximum x-value this DataSet holds
-     *
-     * @return
      */
-    getXMax(): number;
+    readonly xMax: number;
 
     /**
      * Returns the number of y-values this DataSet represents -> the size of the y-values array
      * -> yvals.length
-     *
-     * @return
      */
-    getEntryCount(): number;
+    readonly entryCount: number;
 
-    /**
-     * Returns the values that belong to DataSet.
+    /**getEntryYValue
      *
-     * @return
+     * Returns the values that belong to DataSet.
      */
-    getValues(): T[] | ObservableArray<T>;
+    values: T[] | ObservableArray<T>;
 
     /**
      * Calculates the minimum and maximum x and y values (mXMin, this.mXMax, this.mYMin, this.mYMax).
      */
     calcMinMax();
 
+    getEntryYValue(e: T): number;
+
     /**
      * Calculates the min and max y-values from the Entry closest to the given fromX to the Entry closest to the given toX value.
      * This is only needed for the autoScaleMinMax feature.
@@ -207,16 +197,12 @@ export interface IDataSet<T extends Entry> {
     /**
      * Removes the first Entry (at index 0) of this DataSet from the entries array.
      * Returns true if successful, false if not.
-     *
-     * @return
      */
     removeFirst(): boolean;
 
     /**
      * Removes the last Entry (at index size-1) of this DataSet from the entries array.
      * Returns true if successful, false if not.
-     *
-     * @return
      */
     removeLast(): boolean;
 
@@ -265,40 +251,20 @@ export interface IDataSet<T extends Entry> {
     /** ###### ###### STYLING RELATED (& OTHER) METHODS ###### ###### */
 
     /**
-     * Returns the label string that describes the DataSet.
-     *
-     * @return
+     * the label string that describes the DataSet.
      */
-    getLabel(): string;
+    label: string;
 
     /**
-     * Sets the label string that describes the DataSet.
-     *
-     * @param label
+     * the axis this DataSet should be plotted against.
      */
-    setLabel(label: string);
-
-    /**
-     * Returns the axis this DataSet should be plotted against.
-     *
-     * @return
-     */
-    getAxisDependency(): AxisDependency;
-
-    /**
-     * Set the y-axis this DataSet should be plotted against (either LEFT or
-     * RIGHT). Default: LEFT
-     *
-     * @param dependency
-     */
-    setAxisDependency(dependency: AxisDependency);
+    axisDependency: AxisDependency;
 
     /**
      * returns all the colors that are set for this DataSet
-     *
-     * @return
      */
-    getColors(): (string | Color)[];
+    colors: (string | Color)[];
+    color: string | Color;
 
     /**
      * Returns the color at the given index of the DataSet's color array.
@@ -309,157 +275,93 @@ export interface IDataSet<T extends Entry> {
      */
     getColor(index?: number): string | Color;
 
-    /**
-     * returns true if highlighting of values is enabled, false if not
-     *
-     * @return
-     */
-    isHighlightEnabled(): boolean;
-
     /**
      * If set to true, value highlighting is enabled which means that values can
      * be highlighted programmatically or by touch gesture.
-     *
-     * @param enabled
      */
-    setHighlightEnabled(enabled: boolean);
+    highlightEnabled: boolean;
 
     /**
      * Sets the formatter to be used for drawing the values inside the chart. If
      * no formatter is set, the chart will automatically determine a reasonable
      * formatting (concerning decimals) for all the values that are drawn inside
-     * the chart. Use chart.getDefaultValueFormatter() to use the formatter
+     * the chart. Use chart.defaultValueFormatter to use the formatter
      * calculated by the chart.
-     *
-     * @param f
      */
-    setValueFormatter(f: IValueFormatter);
-
-    /**
-     * Returns the formatter used for drawing the values inside the chart.
-     *
-     * @return
-     */
-    getValueFormatter(): IValueFormatter;
+    valueFormatter: IValueFormatter;
 
     /**
      * Returns true if the valueFormatter object of this DataSet is null.
-     *
-     * @return
      */
-    needsFormatter(): boolean;
+    readonly needsFormatter: boolean;
 
     /**
      * Sets the color the value-labels of this DataSet should have.
      *
      * @param color
      */
-    setValueTextColor(color: number);
+    valueTextColor: Color | string;
 
     /**
      * Sets a list of colors to be used as the colors for the drawn values.
-     *
-     * @param colors
      */
-    setValueTextColors(colors: number[]);
+    valueTextColors: (Color | string)[];
 
     /**
      * Sets a Typeface for the value-labels of this DataSet.
-     *
-     * @param tf
      */
-    setValueTypeface(tf: string);
+    valueTypeface: Font;
 
     /**
      * Sets the text-size of the value-labels of this DataSet in dp.
-     *
-     * @param size
-     */
-    setValueTextSize(size: number);
-
-    /**
-     * Returns the color at the specified index that is used for drawing the values inside the chart.
-     * Uses modulus internally.
-     *
-     * @param index
-     * @return
-     */
-    getValueTextColor(index?: number): string | Color;
-
-    /**
-     * Returns the typeface that is used for drawing the values inside the chart
-     *
-     * @return
-     */
-    getValueTypeface(): Font;
-
-    /**
-     * Returns the text size that is used for drawing the values inside the chart
-     *
-     * @return
      */
-    getValueTextSize(): number;
+    valueTextSize: number;
 
     /**
      * The form to draw for this dataset in the legend.
      * <p/>
      * Return `DEFAULT` to use the default legend form.
      */
-    getForm(): LegendForm;
+    form: LegendForm;
 
     /**
      * The form size to draw for this dataset in the legend.
      * <p/>
      * Return `Float.NaN` to use the default legend form size.
      */
-    getFormSize(): number;
+    formSize: number;
 
     /**
      * The line width for drawing the form of this dataset in the legend
      * <p/>
      * Return `Float.NaN` to use the default legend form line width.
      */
-    getFormLineWidth(): number;
+    formLineWidth: number;
 
     /**
      * The line dash path effect used for shapes that consist of lines.
      * <p/>
      * Return `null` to use the default legend form line dash effect.
      */
-    getFormLineDashEffect(): DashPathEffect;
+    formLineDashEffect: DashPathEffect;
 
     /**
      * set this to true to draw y-values on the chart.
      *
-     * NOTE (for bar and line charts): if `maxVisibleCount` is reached, no values will be drawn even
+     * NOTE (for bar and line charts): if `maxVisibleValueCount` is reached, no values will be drawn even
      * if this is enabled
      * @param enabled
      */
-    setDrawValues(enabled: boolean);
-
-    /**
-     * Returns true if y-value drawing is enabled, false if not
-     *
-     * @return
-     */
-    isDrawValuesEnabled(): boolean;
+    drawValuesEnabled: boolean;
 
     /**
      * Set this to true to draw y-icons on the chart.
      *
-     * NOTE (for bar and line charts): if `maxVisibleCount` is reached, no icons will be drawn even
+     * NOTE (for bar and line charts): if `maxVisibleValueCount` is reached, no icons will be drawn even
      * if this is enabled
-     *
-     * @param enabled
      */
-    setDrawIcons(enabled: boolean);
 
-    /**
-     * Returns true if y-icon drawing is enabled, false if not
-     *
-     * @return
-     */
-    isDrawIconsEnabled(): boolean;
+    drawIconsEnabled: boolean;
 
     /**
      * Offset of icons drawn on the chart.
@@ -467,35 +369,17 @@ export interface IDataSet<T extends Entry> {
      * For all charts except Pie and Radar it will be ordinary (x offset,y offset).
      *
      * For Pie and Radar chart it will be (y offset, distance from center offset); so if you want icon to be rendered under value, you should increase X component of CGPoint, and if you want icon to be rendered closet to center, you should decrease height component of CGPoint.
-     * @param offset
      */
-    setIconsOffset(offset: MPPointF);
-
-    /**
-     * Get the offset for drawing icons.
-     */
-    getIconsOffset(): MPPointF;
+    iconsOffset: MPPointF;
 
     /**
      * Set the visibility of this DataSet. If not visible, the DataSet will not
      * be drawn to the chart upon refreshing it.
-     *
-     * @param visible
      */
-    setVisible(visible: boolean);
-
-    /**
-     * Returns true if this DataSet is visible inside the chart, or false if it
-     * is currently hidden.
-     *
-     * @return
-     */
-    isVisible(): boolean;
+    visible: boolean;
 
     /**
      * Returns the shader used for filling the area below the line.
-     *
-     * @return
      */
-    getFillShader();
+    fillShader: any;
 }

package/interfaces/datasets/ILineDataSet.d.ts

@@ -1,3 +1,5 @@
+import { Mode } from 'src/ui-chart/data/LineDataSet';
+import { IFillFormatter } from 'src/ui-chart/formatter/IFillFormatter';
 import { Entry } from '../../data/Entry';
 import { ILineRadarDataSet } from './ILineRadarDataSet';
 
@@ -7,30 +9,23 @@ import { ILineRadarDataSet } from './ILineRadarDataSet';
 export interface ILineDataSet extends ILineRadarDataSet<Entry> {
     /**
      * Returns the drawing mode for this line dataset
-     *
-     * @return
      */
-    getMode();
+    mode: Mode;
 
     /**
      * Returns the intensity of the cubic lines (the effect intensity).
      * Max = 1 = very cubic, Min = 0.05f = low cubic effect, Default: 0.2f
-     *
-     * @return
      */
-    getCubicIntensity();
+    cubicIntensity: number;
 
-    isDrawCubicEnabled();
-
-    isDrawSteppedEnabled();
-
-    getUseColorsForFill(): boolean;
-    setUseColorsForFill(value: boolean);
+    useColorsForFill: boolean;
+    useColorsForFill: boolean;
 
+    circleColors: string[] | Color[];
     /**
      * Returns the size of the drawn circles.
      */
-    getCircleRadius();
+    circleRadius: number;
 
     /**
      * Defines whether the circle are drawn in high res (better rendering but slower drawing)
@@ -40,67 +35,33 @@ export interface ILineDataSet extends ILineRadarDataSet<Entry> {
     /**
      * Returns the hole radius of the drawn circles.
      */
-    getCircleHoleRadius();
-
-    /**
-     * Returns the color at the given index of the DataSet's circle-color array.
-     * Performs a IndexOutOfBounds check by modulus.
-     *
-     * @param index
-     * @return
-     */
-    getCircleColor(index);
-
-    /**
-     * Returns the number of colors in this DataSet's circle-color array.
-     *
-     * @return
-     */
-    getCircleColorCount();
+    circleHoleRadius: number;
 
     /**
      * Returns true if drawing circles for this DataSet is enabled, false if not
-     *
-     * @return
      */
-    isDrawCirclesEnabled();
+    drawCirclesEnabled: boolean;
 
     /**
      * Returns the color of the inner circle (the circle-hole).
-     *
-     * @return
      */
-    getCircleHoleColor();
+    circleHoleColor: string | Color;
 
     /**
      * Returns true if drawing the circle-holes is enabled, false if not.
-     *
-     * @return
      */
-    isDrawCircleHoleEnabled();
+    drawCircleHoleEnabled: boolean;
 
     /**
      * Returns the DashPathEffect that is used for drawing the lines.
-     *
-     * @return
-     */
-    getDashPathEffect();
-
-    /**
-     * Returns true if the dashed-line effect is enabled, false if not.
-     * If the DashPathEffect object is null, also return false here.
-     *
-     * @return
      */
-    isDashedLineEnabled();
+    dashPathEffect: DashPathEffect;
 
     /**
      * Returns the IFillFormatter that is set for this DataSet.
-     *
-     * @return
      */
-    getFillFormatter();
+    fillFormatter: IFillFormatter;
 
     applyFiltering(scaleX: number);
-    setMaxFilterNumber(value: number);
+    maxFilterNumber: number;
 }

package/interfaces/datasets/ILineRadarDataSet.d.ts

@@ -9,48 +9,27 @@ import { ImageSource } from '@nativescript/core';
 export interface ILineRadarDataSet<T extends Entry> extends ILineScatterCandleRadarDataSet<T> {
     /**
      * Returns the color that is used for filling the line surface area.
-     *
-     * @return
      */
-    getFillColor();
+    fillColor: Color | string;
 
     /**
      * Returns the drawable used for filling the area below the line.
-     *
-     * @return
      */
-    getFillDrawable(): ImageSource;
+    fillDrawable: ImageSource;
 
     /**
      * Returns the alpha value that is used for filling the line surface,
      * default: 85
-     *
-     * @return
      */
-    getFillAlpha();
+    fillAlpha: number;
 
     /**
-     * Returns the stroke-width of the drawn line
-     *
-     * @return
+     * the stroke-width of the drawn line
      */
-    getLineWidth();
+    lineWidth: number;
 
     /**
-     * Returns true if filled drawing is enabled, false if not
-     *
-     * @return
+     * Rtrue if filled drawing is enabled, false if not
      */
-    isDrawFilledEnabled();
-
-    /**
-     * Set to true if the DataSet should be drawn filled (surface), and not just
-     * as a line, disabling this will give great performance boost. Please note that this method
-     * uses the canvas.clipPath(...) method for drawing the filled area.
-     * For devices with API level < 18 (Android 4.3), hardware acceleration of the chart should
-     * be turned off. Default: false
-     *
-     * @param enabled
-     */
-    setDrawFilled(enabled);
+    drawFilledEnabled: boolean;
 }

package/interfaces/datasets/ILineScatterCandleRadarDataSet.d.ts

@@ -1,3 +1,4 @@
+import { PathEffect } from '@nativescript-community/ui-canvas';
 import { Entry } from '../../data/Entry';
 import { IBarLineScatterCandleBubbleDataSet } from './IBarLineScatterCandleBubbleDataSet';
 
@@ -9,23 +10,23 @@ export interface ILineScatterCandleRadarDataSet<T extends Entry> extends IBarLin
      * Returns true if vertical highlight indicator lines are enabled (drawn)
      * @return
      */
-    isVerticalHighlightIndicatorEnabled();
+    drawVerticalHighlightIndicator: boolea;
 
     /**
      * Returns true if vertical highlight indicator lines are enabled (drawn)
      * @return
      */
-    isHorizontalHighlightIndicatorEnabled();
+    drawHorizontalHighlightIndicator: boolean;
 
     /**
      * Returns the line-width in which highlight lines are to be drawn.
      * @return
      */
-    getHighlightLineWidth();
+    highlightLineWidth: number;
 
     /**
      * Returns the DashPathEffect that is used for highlighting.
      * @return
      */
-    getDashPathEffectHighlight();
+    highlightDashPathEffect: PathEffect;
 }

package/interfaces/datasets/IPieDataSet.d.ts

@@ -4,64 +4,46 @@ import { ValuePosition } from '../../data/PieDataSet';
 
 export interface IPieDataSet extends IDataSet<PieEntry> {
     /**
-     * Returns the space that is set to be between the piechart-slices of this
-     * DataSet, in pixels.
-     *
-     * @return
+     * the space in pixels between the chart-slices, default 0
      */
-    getSliceSpace();
+    sliceSpace: number;
 
     /**
      * When enabled, slice spacing will be 0.0 when the smallest value is going to be
-     *   smaller than the slice spacing itself.
-     *
-     * @return
+     * smaller than the slice spacing itself.
      */
-    isAutomaticallyDisableSliceSpacingEnabled();
+    automaticallyDisableSliceSpacing: boolean;
 
     /**
-     * Returns the distance a highlighted piechart slice is "shifted" away from
-     * the chart-center in dp.
-     *
-     * @return
+     * indicates the selection distance of a pie slice
      */
-    getSelectionShift();
-
-    getXValuePosition(): ValuePosition;
-    getYValuePosition(): ValuePosition;
-
-    /**
-     * When valuePosition is OutsideSlice, use slice colors as line color if true
-     * */
-    isUsingSliceColorAsValueLineColor();
+    selectionShift: number;
 
+    xValuePosition: ValuePosition;
+    yValuePosition: ValuePosition;
+    usingSliceColorAsValueLineColor: boolean;
     /**
      * When valuePosition is OutsideSlice, indicates line color
-     * */
-    getValueLineColor();
-
+     */
+    valueLineColor: Color | string;
     /**
-     *  When valuePosition is OutsideSlice, indicates line width
-     *  */
-    getValueLineWidth();
-
+     * When valuePosition is OutsideSlice, indicates line width
+     */
+    valueLineWidth: number;
     /**
      * When valuePosition is OutsideSlice, indicates offset as percentage out of the slice size
-     * */
-    getValueLinePart1OffsetPercentage();
-
+     */
+    valueLinePart1OffsetPercentage: number;
     /**
      * When valuePosition is OutsideSlice, indicates length of first half of the line
-     * */
-    getValueLinePart1Length();
-
+     */
+    valueLinePart1Length: number;
     /**
      * When valuePosition is OutsideSlice, indicates length of second half of the line
-     * */
-    getValueLinePart2Length();
-
+     */
+    valueLinePart2Length: number;
     /**
      * When valuePosition is OutsideSlice, this allows variable line length
-     * */
-    isValueLineVariableLength();
+     */
+    valueLineVariableLength: boolean;
 }

package/interfaces/datasets/IRadarDataSet.d.ts

@@ -6,22 +6,16 @@ import { RadarEntry } from '../../data/RadarEntry';
  */
 export interface IRadarDataSet extends ILineRadarDataSet<RadarEntry> {
     /// flag indicating whether highlight circle should be drawn or not
-    isDrawHighlightCircleEnabled(): boolean;
+    drawHighlightCircleEnabled: boolean;
 
-    /// Sets whether highlight circle should be drawn or not
-    setDrawHighlightCircleEnabled(enabled: boolean);
-
-    getHighlightCircleFillColor(): string | Color;
+    highlightCircleFillColor: string | Color;
 
     /// The stroke color for highlight circle.
     /// If Utils.COLOR_NONE, the color of the dataset is taken.
-    getHighlightCircleStrokeColor(): string | Color;
-
-    getHighlightCircleStrokeAlpha(): number;
-
-    getHighlightCircleInnerRadius(): number;
-
-    getHighlightCircleOuterRadius(): number;
+    highlightCircleStrokeColor: string | Color;
 
-    getHighlightCircleStrokeWidth(): number;
+    highlightCircleStrokeAlpha: number;
+    highlightCircleInnerRadius: number;
+    highlightCircleOuterRadius: number;
+    highlightCircleStrokeWidth: number;
 }