Class LineDataSet

Created by Philpp Jahoda on 21/10/15.

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

axisDependency circleColors circleHighRes circleHoleColor circleHoleRadius circleRadius color colors cubicIntensity dashPathEffect drawCircleHoleEnabled drawCirclesEnabled drawFilledEnabled drawHorizontalHighlightIndicator drawIconsEnabled drawValuesEnabled drawVerticalHighlightIndicator fillAlpha fillColor fillDrawable fillFormatter fillShader form formLineDashEffect formLineWidth formSize highlightColor highlightDashPathEffect highlightEnabled highlightLineWidth iconProperty iconsOffset label lineWidth maxFilterNumber mCanCalculateMinMax mFilteredValues mFilterFunction mIgnoreFiltered mode mValues mXMax mXMin mYMax mYMin shader spaceBottom spaceTop useColorsForFill useColorsForLine valueColors valueFormatter valuesOffset valueTextSize valueTypeface visible xProperty yProperty

Accessors

circleColor drawHighlightIndicators entryCount filtered ignoreFiltered needsFormatter values valueTextColor valueTextColors xMax xMin yMax yMin

Methods

addColor addEntry addEntryOrdered applyFiltering batchEntryOperations calcMinMax calcMinMaxForEntry calcMinMaxX calcMinMaxY calcMinMaxYRange clear contains enableDashedLine enableHighlightDashPathEffect getCircleColor getColor getEntriesAndIndexesForXValue getEntriesForXValue getEntryAndIndexForXValue getEntryForIndex getEntryForXValue getEntryIcon getEntryIndex getEntryIndexForXValue getEntryXValue getEntryYValue getIndexInEntries getInternalValues getValueTextColor init initEntryData notifyDataSetChanged removeEntry removeEntryAtIndex removeEntryByXValue removeFirst removeLast resetColors setCircleColors setColor setColors toString updateGetEntryForIndex

Constructors

constructor

  • new LineDataSet(
        yVals: any,
        label: any,
        xProperty?: any,
        yProperty?: any,
    ): LineDataSet

  • Parameters

    • yVals: any
    • label: any
    • OptionalxProperty: any
    • OptionalyProperty: any

    Returns LineDataSet

Properties

axisDependency

axisDependency: AxisDependency

this specifies which axis this DataSet should be plotted against

circleColors

circleColors: string[] | Color[]

List representing all colors that are used for the circles

circleHighRes

circleHighRes: boolean

Property definining wheter circles are drawn in high res. Default true

circleHoleColor

circleHoleColor: Color

the color of the inner circles

circleHoleRadius

circleHoleRadius: number

the hole radius of the circle-shaped value indicators

circleRadius

circleRadius: number

the radius of the circle-shaped value indicators

color

color: string | Color

colors

colors: (string | Color)[]

List representing all colors that are used for this DataSet

cubicIntensity

cubicIntensity: number

sets the intensity of the cubic lines (if enabled). Max = 1 = very cubic, Min = 0.05f = low cubic effect, Default: 0.2f

dashPathEffect

dashPathEffect: DashPathEffect

the path effect of this DataSet that makes dashed lines possible

drawCircleHoleEnabled

drawCircleHoleEnabled: boolean

Returns true if drawing the circle-holes is enabled, false if not.

drawCirclesEnabled

drawCirclesEnabled: boolean

if true, drawing circles is enabled

drawFilledEnabled

drawFilledEnabled: boolean

if true, the data will also be drawn filled

drawHorizontalHighlightIndicator

drawHorizontalHighlightIndicator: boolean

Enables / disables the horizontal highlight-indicator. If disabled, the indicator is not drawn.

Param: enabled

drawIconsEnabled

drawIconsEnabled: boolean

if true, y-icons are drawn on the chart

drawValuesEnabled

drawValuesEnabled: boolean

if true, y-values are drawn on the chart

drawVerticalHighlightIndicator

drawVerticalHighlightIndicator: boolean

Enables / disables the vertical highlight-indicator. If disabled, the indicator is not drawn.

Param: enabled

fillAlpha

fillAlpha: number

transparency used for filling line surface

fillColor

fillColor: string | Color

the color that is used for filling the line surface

fillDrawable

fillDrawable: ImageSource

the drawable to be used for filling the line surface

fillFormatter

fillFormatter: IFillFormatter

formatter for customizing the position of the fill-line

fillShader

fillShader: any

the shader to be used for filling the line surface

form

form: LegendForm

The form to draw for this dataset in the legend.

Return `DEFAULT` to use the default legend form.

formLineDashEffect

formLineDashEffect: any

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: string | Color

Sets the color that is used for drawing the highlight indicators. Dont forget to resolve the color using getResources().getColor(...) or new Color(255, ...).

highlightDashPathEffect

highlightDashPathEffect: any

the path effect for dashed highlight-lines

highlightEnabled

highlightEnabled: boolean

if true, value highlightning is enabled

highlightLineWidth

highlightLineWidth: number

the width of the highlight indicator lines

iconProperty

iconProperty: string

property to access the "icon" value of an entry for this set

iconsOffset

iconsOffset: { x: number; y: number }

the offset for drawing icons (in dp)

label

label: string

label that describes the DataSet or the data the DataSet represents

lineWidth

lineWidth: number

the width of the drawn data lines thinner line === better performance, thicker line === worse performance

maxFilterNumber

maxFilterNumber: number

the max number allowed point before filtering. <= O means disabled

mCanCalculateMinMax

mCanCalculateMinMax: boolean

ProtectedmFilteredValues

mFilteredValues: Entry[]

ProtectedmFilterFunction

mFilterFunction: any

mIgnoreFiltered

mIgnoreFiltered: boolean

mode

mode: Mode

Drawing mode for this line dataset

ProtectedmValues

mValues: Entry[] | ObservableArray<Entry>

the entries that this DataSet represents / holds together

ProtectedmXMax

mXMax: number

maximum x-value in the value array

ProtectedmXMin

mXMin: number

minimum x-value in the value array

ProtectedmYMax

mYMax: number

maximum y-value in the value array

ProtectedmYMin

mYMin: number

minimum y-value in the value array

shader

shader: Shader

the path effect of this DataSet that makes dashed lines possible

spaceBottom

spaceBottom: number

data space from the smallest value to the bottom in percent of the total axis range

spaceTop

spaceTop: number

data space from the highest value to the top in percent of the total axis range

useColorsForFill

useColorsForFill: boolean

useColorsForLine

useColorsForLine: boolean

valueColors

valueColors: (string | Color)[]

List representing all colors that are used for drawing the actual values for this DataSet

valueFormatter

valueFormatter: ValueFormatter

custom formatter that is used instead of the auto-formatter if set

valuesOffset

valuesOffset: { x: number; y: number }

the offset for drawing values (in dp)

valueTextSize

valueTextSize: number

the size of the value-text labels

valueTypeface

valueTypeface: Font

the typeface used for the value text

visible

visible: boolean

flag that indicates if the DataSet is visible or not

xProperty

xProperty: string

property to access the "x" value of an entry for this set

yProperty

yProperty: string

property to access the "y" value of an entry for this set

Accessors

circleColor

  • set circleColor(color: any): void

  • Sets the one and ONLY color that should be used for this DataSet. Internally, this recreates the colors array and adds the specified color.

    Parameters

    • color: any

    Returns void

drawHighlightIndicators

  • set drawHighlightIndicators(enabled: any): void

  • Enables / disables both vertical and horizontal highlight-indicators.

    Parameters

    • enabled: any

    Returns void

entryCount

  • get entryCount(): number

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

    Returns number

filtered

  • get filtered(): boolean

  • Returns boolean

ignoreFiltered

  • get ignoreFiltered(): boolean

  • Returns boolean

  • set ignoreFiltered(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

needsFormatter

  • get needsFormatter(): boolean
  • ###### OTHER STYLING RELATED METHODS #####

    Returns boolean

values

  • set values(values: any): void

  • Returns the array of entries that this DataSet represents.

    Parameters

    • values: any

    Returns void

valueTextColor

  • set valueTextColor(color: any): void

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

    Parameters

    • color: any

    Returns void

valueTextColors

  • set valueTextColors(colors: any): void

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

    Parameters

    • colors: any

    Returns void

xMax

  • get xMax(): number

  • returns the maximum x-value this DataSet holds

    Returns number

xMin

  • get xMin(): number

  • returns the minimum x-value this DataSet holds

    Returns number

yMax

  • get yMax(): number

  • returns the maximum y-value this DataSet holds

    Returns number

yMin

  • get yMin(): number

  • returns the minimum y-value this DataSet holds

    Returns number

Methods

addColor

  • addColor(value: string | Color): void

  • Adds a new color to the colors array of the DataSet.

    Parameters

    • value: string | Color

    Returns void

addEntry

  • addEntry(e: Entry): 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: Entry): void

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

applyFiltering

  • applyFiltering(scaleX: number): void

  • Parameters

    • scaleX: number

    Returns void

batchEntryOperations

calcMinMax

  • calcMinMax(): void

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

    Returns void

ProtectedcalcMinMaxForEntry

  • calcMinMaxForEntry(e?: Entry, index?: number): void

  • Updates the min and max x and y value of this DataSet based on the given Entry.

    Parameters

    • Optionale: Entry
    • Optionalindex: number

    Returns void

ProtectedcalcMinMaxX

  • calcMinMaxX(e?: Entry, index?: number): void

  • Parameters

    • Optionale: Entry
    • Optionalindex: number

    Returns void

ProtectedcalcMinMaxY

  • calcMinMaxY(e: Entry, index?: number): void

  • Parameters

    • e: Entry
    • Optionalindex: number

    Returns void

calcMinMaxYRange

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

  • 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: any
    • toX: any

    Returns void

clear

  • clear(): void

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

    Returns void

contains

  • contains(e: Entry): 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

    Returns boolean

enableDashedLine

  • enableDashedLine(lineLength: any, spaceLength: any, phase: any): void

  • Enables the line to be drawn in dashed mode, e.g. like this "- - - - - -". THIS ONLY WORKS IF HARDWARE-ACCELERATION IS TURNED OFF. Keep in mind that hardware acceleration boosts performance.

    Parameters

    • lineLength: any

      the length of the line pieces

    • spaceLength: any

      the length of space in between the pieces

    • phase: any

      offset, in degrees (normally, use 0)

    Returns void

enableHighlightDashPathEffect

  • enableHighlightDashPathEffect(
        lineLength: any,
        spaceLength: any,
        phase: any,
    ): void

  • Enables the highlight-line to be drawn in dashed mode, e.g. like this "- - - - - -"

    Parameters

    • lineLength: any

      the length of the line pieces

    • spaceLength: any

      the length of space inbetween the line-pieces

    • phase: any

      offset, in degrees (normally, use 0)

    Returns void

getCircleColor

  • getCircleColor(index: any): string | Color

  • Parameters

    • index: any

    Returns string | Color

getColor

  • getColor(index?: number): string | Color
  • ###### COLOR GETTING RELATED METHODS #####

    Parameters

    • Optionalindex: number

    Returns string | Color

getEntriesAndIndexesForXValue

  • getEntriesAndIndexesForXValue(xValue: any): any[]

  • 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: any

    Returns any[]

getEntriesForXValue

  • getEntriesForXValue(xValue: any): any[]

  • 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: any

    Returns any[]

getEntryAndIndexForXValue

  • getEntryAndIndexForXValue(
        xValue: any,
        closestToY: any,
        rounding?: Rounding,
    ): { entry: Entry; 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: any

      the x-value

    • closestToY: any

      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: Entry; index: number }

getEntryForIndex

getEntryForXValue

  • getEntryForXValue(xValue: any, closestToY: any, rounding?: Rounding): Entry

  • 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: any

      the x-value

    • closestToY: any

      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

getEntryIcon

getEntryIndex

getEntryIndexForXValue

  • getEntryIndexForXValue(xValue: any, closestToY: any, rounding: any): 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: any

      the x-value

    • closestToY: any

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

    • rounding: any

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

    Returns number

getEntryXValue

getEntryYValue

getIndexInEntries

ProtectedgetInternalValues

getValueTextColor

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

  • Parameters

    • Optionalindex: number

    Returns string | Color

init

ProtectedinitEntryData

notifyDataSetChanged

  • notifyDataSetChanged(): void

  • Use this method to tell the data set that the underlying data has changed.

    Returns void

removeEntry

  • removeEntry(e: Entry): 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: any): any

  • 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: any

    Returns any

removeFirst

  • removeFirst(): any

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

    Returns any

removeLast

  • removeLast(): any

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

    Returns any

resetColors

  • resetColors(): void

  • Resets all colors of this DataSet and recreates the colors array.

    Returns void

setCircleColors

  • setCircleColors(colors: string[] | Color[]): void

  • Sets the colors that should be used for the circles of this DataSet. Colors are reused as soon as the number of Entries the DataSet represents is higher than the size of the colors array. Make sure that the colors are already prepared (by calling getResources().getColor(...)) before adding them to the DataSet.

    Parameters

    • colors: string[] | Color[]

    Returns void

setColor

  • setColor(color: string | Color, alpha?: number): void

  • Sets a color with a specific alpha value.

    Parameters

    • color: string | Color
    • Optionalalpha: number

      from 0-255

    Returns void

setColors

  • setColors(colors: any, alpha?: number): void

  • Sets colors with a specific alpha value.

    Parameters

    • colors: any
    • Optionalalpha: number

    Returns void

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

ProtectedupdateGetEntryForIndex

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods