Interface IBarLineScatterCandleBubbleDataSet<T>

Created by philipp on 21/10/15.

interface IBarLineScatterCandleBubbleDataSet<T extends Entry> {
    axisDependency: AxisDependency;
    color: string | Color;
    colors: (string | Color)[];
    drawIconsEnabled: boolean;
    drawValuesEnabled: boolean;
    entryCount: number;
    fillShader: any;
    form: LegendForm;
    formLineDashEffect: DashPathEffect;
    formLineWidth: number;
    formSize: number;
    highlightColor: any;
    highlightEnabled: boolean;
    iconsOffset: MPPointF;
    label: string;
    needsFormatter: boolean;
    valueFormatter: IValueFormatter;
    values: T[] | ObservableArray<T>;
    valueTextColor: string | Color;
    valueTextColors: (string | Color)[];
    valueTextSize: number;
    valueTypeface: Font;
    visible: boolean;
    xMax: number;
    xMin: number;
    xProperty: string;
    yMax: number;
    yMin: number;
    yProperty: string;
    addEntry(e: T): boolean;
    addEntryOrdered(e: T): any;
    calcMinMax(): any;
    calcMinMaxYRange(fromX: number, toX: number): any;
    clear(): any;
    contains(entry: T): boolean;
    getColor(index?: number): string | Color;
    getEntriesAndIndexesForXValue(
        xValue: number,
    ): { entry: T; index: number }[];
    getEntriesForXValue(xValue: number): T[] | ObservableArray<T>;
    getEntryAndIndexForXValue(
        xValue: number,
        closestToY: number,
        rounding?: Rounding,
    ): { entry: T; index: number };
    getEntryForIndex(index: number): T;
    getEntryForXValue(
        xValue: number,
        closestToY: number,
        rounding?: Rounding,
    ): T;
    getEntryIndex(e: T): number;
    getEntryIndexForXValue(
        xValue: number,
        closestToY: number,
        rounding: Rounding,
    ): number;
    getEntryXValue(e: BaseEntry, entryIndex: number): number;
    getEntryYValue(e: T): number;
    getIndexInEntries(xIndex: number): number;
    init(): any;
    removeEntry(e: T): boolean;
    removeEntryAtIndex(index: number): boolean;
    removeEntryByXValue(xValue: number): boolean;
    removeFirst(): boolean;
    removeLast(): boolean;
}

Type Parameters

Hierarchy (View Summary)

Implemented by

Properties

axisDependency color colors drawIconsEnabled drawValuesEnabled entryCount fillShader form formLineDashEffect formLineWidth formSize highlightColor highlightEnabled iconsOffset label needsFormatter valueFormatter values valueTextColor valueTextColors valueTextSize valueTypeface visible xMax xMin xProperty yMax yMin yProperty

Methods

addEntry addEntryOrdered calcMinMax calcMinMaxYRange clear contains getColor getEntriesAndIndexesForXValue getEntriesForXValue getEntryAndIndexForXValue getEntryForIndex getEntryForXValue getEntryIndex getEntryIndexForXValue getEntryXValue getEntryYValue getIndexInEntries init removeEntry removeEntryAtIndex removeEntryByXValue removeFirst removeLast

Properties

axisDependency

axisDependency: AxisDependency

the axis this DataSet should be plotted against.

color

color: string | Color

colors

colors: (string | Color)[]

returns all the colors that are set for this DataSet

drawIconsEnabled

drawIconsEnabled: boolean

Set this to true to draw y-icons on the chart.

NOTE (for bar and line charts): if maxVisibleValueCount is reached, no icons will be drawn even if this is enabled

drawValuesEnabled

drawValuesEnabled: boolean

set this to true to draw y-values on the chart.

NOTE (for bar and line charts): if maxVisibleValueCount is reached, no values will be drawn even if this is enabled

Param: enabled

ReadonlyentryCount

entryCount: number

Returns the number of y-values this DataSet represents -> the size of the y-values array -> yvals.length

fillShader

fillShader: any

Returns the shader used for filling the area below the line.

form

form: LegendForm

The form to draw for this dataset in the legend.

Return `DEFAULT` to use the default legend form.

formLineDashEffect

formLineDashEffect: DashPathEffect

The line dash path effect used for shapes that consist of lines.

Return `null` to use the default legend form line dash effect.

formLineWidth

formLineWidth: number

The line width for drawing the form of this dataset in the legend

Return `Float.NaN` to use the default legend form line width.

formSize

formSize: number

The form size to draw for this dataset in the legend.

Return `Float.NaN` to use the default legend form size.

highlightColor

highlightColor: any

Returns the color that is used for drawing the highlight indicators.

highlightEnabled

highlightEnabled: boolean

If set to true, value highlighting is enabled which means that values can be highlighted programmatically or by touch gesture.

iconsOffset

iconsOffset: MPPointF

Offset of icons drawn on the chart.

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.

label

label: string

the label string that describes the DataSet.

ReadonlyneedsFormatter

needsFormatter: boolean

Returns true if the valueFormatter object of this DataSet is null.

valueFormatter

valueFormatter: IValueFormatter

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.defaultValueFormatter to use the formatter calculated by the chart.

values

values: T[] | ObservableArray<T>

getEntryYValue

Returns the values that belong to DataSet.

valueTextColor

valueTextColor: string | Color

Sets the color the value-labels of this DataSet should have.

Param: color

valueTextColors

valueTextColors: (string | Color)[]

Sets a list of colors to be used as the colors for the drawn values.

valueTextSize

valueTextSize: number

Sets the text-size of the value-labels of this DataSet in dp.

valueTypeface

valueTypeface: Font

Sets a Typeface for the value-labels of this DataSet.

visible

visible: boolean

Set the visibility of this DataSet. If not visible, the DataSet will not be drawn to the chart upon refreshing it.

ReadonlyxMax

xMax: number

returns the maximum x-value this DataSet holds

ReadonlyxMin

xMin: number

returns the minimum x-value this DataSet holds

xProperty

xProperty: string

ReadonlyyMax

yMax: number

returns the maximum y-value this DataSet holds

ReadonlyyMin

yMin: number

returns the minimum y-value this DataSet holds

yProperty

yProperty: string

Methods

addEntry

  • addEntry(e: T): boolean

  • Adds an Entry to the DataSet dynamically. Entries are added to the end of the list. This will also recalculate the current minimum and maximum values of the DataSet and the value-sum.

    Parameters

    Returns boolean

addEntryOrdered

  • addEntryOrdered(e: T): any

  • Adds an Entry to the DataSet dynamically. Entries are added to their appropriate index in the values array respective to their x-position. This will also recalculate the current minimum and maximum values of the DataSet and the value-sum.

    Parameters

    Returns any

calcMinMax

  • calcMinMax(): any

  • Calculates the minimum and maximum x and y values (mXMin, this.mXMax, this.mYMin, this.mYMax).

    Returns any

calcMinMaxYRange

  • calcMinMaxYRange(fromX: number, toX: number): any

  • 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.

    Parameters

    • fromX: number
    • toX: number

    Returns any

clear

  • clear(): any

  • Removes all values from this DataSet and does all necessary recalculations.

    Returns any

contains

  • contains(entry: T): boolean

  • Checks if this DataSet contains the specified Entry. Returns true if so, false if not. NOTE: Performance is pretty bad on this one, do not over-use in performance critical situations.

    Parameters

    • entry: T

    Returns boolean

getColor

  • getColor(index?: number): string | Color

  • Returns the color at the given index of the DataSet's color array. Performs a IndexOutOfBounds check by modulus.

    Parameters

    • Optionalindex: number

    Returns string | Color

getEntriesAndIndexesForXValue

  • getEntriesAndIndexesForXValue(xValue: number): { entry: T; index: number }[]

  • Returns all Entry objects found at the given x-value with binary search. An empty array if no Entry object at that x-value. INFORMATION: This method does calculations at runtime. Do not over-use in performance critical situations.

    Parameters

    • xValue: number

    Returns { entry: T; index: number }[]

getEntriesForXValue

  • getEntriesForXValue(xValue: number): T[] | ObservableArray<T>

  • Returns all Entry objects found at the given x-value with binary search. An empty array if no Entry object at that x-value. INFORMATION: This method does calculations at runtime. Do not over-use in performance critical situations.

    Parameters

    • xValue: number

    Returns T[] | ObservableArray<T>

getEntryAndIndexForXValue

  • getEntryAndIndexForXValue(
        xValue: number,
        closestToY: number,
        rounding?: Rounding,
    ): { entry: T; index: number }

  • Returns the first Entry object found at the given x-value with binary search. If the no Entry at the specified x-value is found, this method returns the Entry at the closest x-value according to the rounding. INFORMATION: This method does calculations at runtime. Do not over-use in performance critical situations.

    Parameters

    • xValue: number

      the x-value

    • closestToY: number

      If there are multiple y-values for the specified x-value,

    • Optionalrounding: Rounding

      determine whether to round up/down/closest if there is no Entry matching the provided x-value

    Returns { entry: T; index: number }

getEntryForIndex

  • getEntryForIndex(index: number): T

  • Returns the Entry object found at the given index (NOT xIndex) in the values array.

    Parameters

    • index: number

    Returns T

getEntryForXValue

  • getEntryForXValue(xValue: number, closestToY: number, rounding?: Rounding): T

  • Returns the first Entry object found at the given x-value with binary search. If the no Entry at the specified x-value is found, this method returns the Entry at the closest x-value according to the rounding. INFORMATION: This method does calculations at runtime. Do not over-use in performance critical situations.

    Parameters

    • xValue: number

      the x-value

    • closestToY: number

      If there are multiple y-values for the specified x-value,

    • Optionalrounding: Rounding

      determine whether to round up/down/closest if there is no Entry matching the provided x-value

    Returns T

getEntryIndex

  • getEntryIndex(e: T): number

  • Returns the position of the provided entry in the DataSets Entry array. Returns -1 if doesn't exist.

    Parameters

    Returns number

getEntryIndexForXValue

  • getEntryIndexForXValue(
        xValue: number,
        closestToY: number,
        rounding: Rounding,
    ): number

  • Returns the first Entry index found at the given x-value with binary search. If the no Entry at the specified x-value is found, this method returns the Entry at the closest x-value according to the rounding. INFORMATION: This method does calculations at runtime. Do not over-use in performance critical situations.

    Parameters

    • xValue: number

      the x-value

    • closestToY: number

      If there are multiple y-values for the specified x-value,

    • rounding: Rounding

      determine whether to round up/down/closest if there is no Entry matching the provided x-value

    Returns number

getEntryXValue

  • getEntryXValue(e: BaseEntry, entryIndex: number): number

  • Parameters

    • e: BaseEntry
    • entryIndex: number

    Returns number

getEntryYValue

  • getEntryYValue(e: T): number

  • Parameters

    Returns number

getIndexInEntries

  • getIndexInEntries(xIndex: number): number

  • This method returns the actual index in the Entry array of the DataSet for a given xIndex. IMPORTANT: This method does calculations at runtime, do not over-use in performance critical situations.

    Parameters

    • xIndex: number

    Returns number

init

  • init(): any

  • Initializes DataSet chart data.

    Returns any

removeEntry

  • removeEntry(e: T): boolean

  • Removes an Entry from the DataSets entries array. This will also recalculate the current minimum and maximum values of the DataSet and the value-sum. Returns true if an Entry was removed, false if no Entry could be removed.

    Parameters

    Returns boolean

removeEntryAtIndex

  • removeEntryAtIndex(index: number): boolean

  • Removes the Entry object at the given index in the values array from the DataSet. Returns true if an Entry was removed, false if no Entry could be removed.

    Parameters

    • index: number

    Returns boolean

removeEntryByXValue

  • removeEntryByXValue(xValue: number): boolean

  • Removes the Entry object closest to the given x-value from the DataSet. Returns true if an Entry was removed, false if no Entry could be removed.

    Parameters

    • xValue: number

    Returns boolean

removeFirst

  • removeFirst(): boolean

  • Removes the first Entry (at index 0) of this DataSet from the entries array. Returns true if successful, false if not.

    Returns boolean

removeLast

  • removeLast(): boolean

  • Removes the last Entry (at index size-1) of this DataSet from the entries array. Returns true if successful, false if not.

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods