Class BubbleDataSet

Created by philipp on 21/10/15.

Hierarchy (View Summary)

BarLineScatterCandleBubbleDataSet<BubbleEntry>
- BubbleDataSet

Implements

IBubbleDataSet

Index

Constructors

constructor

Accessors

entryCount maxSize needsFormatter values valueTextColor valueTextColors xMax xMin yMax yMin

Constructors

constructor

new BubbleDataSet(
    yVals: any,
    label: any,
    xProperty?: any,
    yProperty?: any,
    sizeProperty?: any,
): BubbleDataSet
Parameters
- yVals: any
- label: any
- OptionalxProperty: any
- OptionalyProperty: any
- OptionalsizeProperty: any
Returns BubbleDataSet
Overrides BarLineScatterCandleBubbleDataSet.constructor
- Defined in packages/ui-chart/data/BubbleDataSet.d.ts:13

Properties

axisDependency

axisDependency: AxisDependency

this specifies which axis this DataSet should be plotted against

color

color: string | Color

colors

colors: (string | Color)[]

List representing all colors that are used for this DataSet

drawIconsEnabled

drawIconsEnabled: boolean

if true, y-icons are drawn on the chart

drawValuesEnabled

drawValuesEnabled: boolean

if true, y-values are drawn on the chart

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.

highlightCircleWidth

highlightCircleWidth: number

Sets the width of the circle that surrounds the bubble when highlighted, in dp.

Param: width

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, ...).

highlightEnabled

highlightEnabled: boolean

if true, value highlightning is enabled

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

mCanCalculateMinMax

mCanCalculateMinMax: boolean

mMaxSize

mMaxSize: number

`Protected`mValues

mValues: BubbleEntry[] | ObservableArray<BubbleEntry>

the entries that this DataSet represents / holds together

`Protected`mXMax

mXMax: number

maximum x-value in the value array

`Protected`mXMin

mXMin: number

minimum x-value in the value array

`Protected`mYMax

mYMax: number

maximum y-value in the value array

`Protected`mYMin

mYMin: number

minimum y-value in the value array

normalizeSizeEnabled

normalizeSizeEnabled: boolean

sizeProperty

sizeProperty: string

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

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

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

entryCount

get entryCount(): number
Returns the number of y-values this DataSet represents -> the size of the y-values array -> yvals.length

Returns number
Implementation of IBubbleDataSet.entryCount
Inherited from BarLineScatterCandleBubbleDataSet.entryCount
- Defined in packages/ui-chart/data/DataSet.d.ts:68

maxSize

get maxSize(): number
Returns number
Implementation of IBubbleDataSet.maxSize
- Defined in packages/ui-chart/data/BubbleDataSet.d.ts:17

needsFormatter

get needsFormatter(): boolean
###### OTHER STYLING RELATED METHODS #####
Returns boolean
Implementation of IBubbleDataSet.needsFormatter
Inherited from BarLineScatterCandleBubbleDataSet.needsFormatter
- Defined in packages/ui-chart/data/BaseDataSet.d.ts:170

values

get values(): T[] | ObservableArray<T>
Returns the array of entries that this DataSet represents.

Returns T[] | ObservableArray<T>
Implementation of IBubbleDataSet.values
Inherited from BarLineScatterCandleBubbleDataSet.values
- Defined in packages/ui-chart/data/DataSet.d.ts:72
set values(values: T[] | ObservableArray<T>): void
Sets the array of entries that this DataSet represents, and calls notifyDataSetChanged()
Parameters
- values: T[] | ObservableArray<T>
Returns void
Implementation of IBubbleDataSet.values
Inherited from BarLineScatterCandleBubbleDataSet.values
- Defined in packages/ui-chart/data/DataSet.d.ts:76

valueTextColor

set valueTextColor(color: any): void
Sets the color the value-labels of this DataSet should have.
Parameters
- color: any
Returns void
Implementation of IBubbleDataSet.valueTextColor
Inherited from BarLineScatterCandleBubbleDataSet.valueTextColor
- Defined in packages/ui-chart/data/BaseDataSet.d.ts:171

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
Implementation of IBubbleDataSet.valueTextColors
Inherited from BarLineScatterCandleBubbleDataSet.valueTextColors
- Defined in packages/ui-chart/data/BaseDataSet.d.ts:172

xMax

get xMax(): number
returns the maximum x-value this DataSet holds

Returns number
Implementation of IBubbleDataSet.xMax
Inherited from BarLineScatterCandleBubbleDataSet.xMax
- Defined in packages/ui-chart/data/DataSet.d.ts:80

xMin

get xMin(): number
returns the minimum x-value this DataSet holds

Returns number
Implementation of IBubbleDataSet.xMin
Inherited from BarLineScatterCandleBubbleDataSet.xMin
- Defined in packages/ui-chart/data/DataSet.d.ts:79

yMax

get yMax(): number
returns the maximum y-value this DataSet holds

Returns number
Implementation of IBubbleDataSet.yMax
Inherited from BarLineScatterCandleBubbleDataSet.yMax
- Defined in packages/ui-chart/data/DataSet.d.ts:78

yMin

get yMin(): number
returns the minimum y-value this DataSet holds

Returns number
Implementation of IBubbleDataSet.yMin
Inherited from BarLineScatterCandleBubbleDataSet.yMin
- Defined in packages/ui-chart/data/DataSet.d.ts:77

Methods

addColor

addColor(value: string | Color): void
Adds a new color to the colors array of the DataSet.
Parameters
- value: string | Color
Returns void
Inherited from BarLineScatterCandleBubbleDataSet.addColor
- Defined in packages/ui-chart/data/BaseDataSet.d.ts:148

addEntry

addEntry(e: BubbleEntry): 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
- e: BubbleEntry
Returns boolean
Implementation of IBubbleDataSet.addEntry
Inherited from BarLineScatterCandleBubbleDataSet.addEntry
- Defined in packages/ui-chart/data/DataSet.d.ts:83

addEntryOrdered

addEntryOrdered(e: BubbleEntry): 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
- e: BubbleEntry
Returns void
Implementation of IBubbleDataSet.addEntryOrdered
Inherited from BarLineScatterCandleBubbleDataSet.addEntryOrdered
- Defined in packages/ui-chart/data/DataSet.d.ts:81

batchEntryOperations

batchEntryOperations(cb: any): void
Parameters
- cb: any
Returns void
Inherited from BarLineScatterCandleBubbleDataSet.batchEntryOperations
- Defined in packages/ui-chart/data/DataSet.d.ts:55

calcMinMax

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

Returns void
Implementation of IBubbleDataSet.calcMinMax
Overrides BarLineScatterCandleBubbleDataSet.calcMinMax
- Defined in packages/ui-chart/data/BubbleDataSet.d.ts:15

calcMinMaxForEntry

calcMinMaxForEntry(e: BubbleEntry, index?: number): void
Updates the min and max x and y value of this DataSet based on the given Entry.
Parameters
- e: BubbleEntry
- Optionalindex: number
Returns void
Overrides BarLineScatterCandleBubbleDataSet.calcMinMaxForEntry
- Defined in packages/ui-chart/data/BubbleDataSet.d.ts:16

`Protected`calcMinMaxX

calcMinMaxX(e?: BubbleEntry, index?: number): void
Parameters
- Optionale: BubbleEntry
- Optionalindex: number
Returns void
Inherited from BarLineScatterCandleBubbleDataSet.calcMinMaxX
- Defined in packages/ui-chart/data/DataSet.d.ts:65

`Protected`calcMinMaxY

calcMinMaxY(e: BubbleEntry, index?: number): void
Parameters
- e: BubbleEntry
- Optionalindex: number
Returns void
Inherited from BarLineScatterCandleBubbleDataSet.calcMinMaxY
- Defined in packages/ui-chart/data/DataSet.d.ts:66

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
Implementation of IBubbleDataSet.calcMinMaxYRange
Inherited from BarLineScatterCandleBubbleDataSet.calcMinMaxYRange
- Defined in packages/ui-chart/data/DataSet.d.ts:58

clear

clear(): void
Removes all values from this DataSet and does all necessary recalculations.

Returns void
Implementation of IBubbleDataSet.clear
Inherited from BarLineScatterCandleBubbleDataSet.clear
- Defined in packages/ui-chart/data/DataSet.d.ts:82

contains

contains(e: BubbleEntry): 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
- e: BubbleEntry
Returns boolean
Implementation of IBubbleDataSet.contains
Inherited from BarLineScatterCandleBubbleDataSet.contains
- Defined in packages/ui-chart/data/BaseDataSet.d.ts:187

getColor

getColor(index?: number): string | Color
###### COLOR GETTING RELATED METHODS #####
Parameters
- Optionalindex: number
Returns string | Color
Implementation of IBubbleDataSet.getColor
Inherited from BarLineScatterCandleBubbleDataSet.getColor
- Defined in packages/ui-chart/data/BaseDataSet.d.ts:142

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[]
Implementation of IBubbleDataSet.getEntriesAndIndexesForXValue
Inherited from BarLineScatterCandleBubbleDataSet.getEntriesAndIndexesForXValue
- Defined in packages/ui-chart/data/DataSet.d.ts:97

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[]
Implementation of IBubbleDataSet.getEntriesForXValue
Inherited from BarLineScatterCandleBubbleDataSet.getEntriesForXValue
- Defined in packages/ui-chart/data/DataSet.d.ts:96

getEntryAndIndexForXValue

getEntryAndIndexForXValue(
    xValue: any,
    closestToY: any,
    rounding?: Rounding,
): { entry: BubbleEntry; 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: BubbleEntry; index: number }
Implementation of IBubbleDataSet.getEntryAndIndexForXValue
Inherited from BarLineScatterCandleBubbleDataSet.getEntryAndIndexForXValue
- Defined in packages/ui-chart/data/DataSet.d.ts:89

getEntryForIndex

getEntryForIndex(index: any): BubbleEntry
Returns the Entry object found at the given index (NOT xIndex) in the values array.
Parameters
- index: any
Returns BubbleEntry
Implementation of IBubbleDataSet.getEntryForIndex
Inherited from BarLineScatterCandleBubbleDataSet.getEntryForIndex
- Defined in packages/ui-chart/data/DataSet.d.ts:94

getEntryForXValue

getEntryForXValue(
    xValue: any,
    closestToY: any,
    rounding?: Rounding,
): BubbleEntry
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 BubbleEntry
Implementation of IBubbleDataSet.getEntryForXValue
Inherited from BarLineScatterCandleBubbleDataSet.getEntryForXValue
- Defined in packages/ui-chart/data/DataSet.d.ts:88

getEntryIcon

getEntryIcon(e: BubbleEntry): any
Parameters
- e: BubbleEntry
Returns any
Inherited from BarLineScatterCandleBubbleDataSet.getEntryIcon
- Defined in packages/ui-chart/data/BaseDataSet.d.ts:134

getEntryIndex

getEntryIndex(e: BubbleEntry): number
Returns the position of the provided entry in the DataSets Entry array. Returns -1 if doesn't exist.
Parameters
- e: BubbleEntry
Returns number
Implementation of IBubbleDataSet.getEntryIndex
Inherited from BarLineScatterCandleBubbleDataSet.getEntryIndex
- Defined in packages/ui-chart/data/DataSet.d.ts:86

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
Implementation of IBubbleDataSet.getEntryIndexForXValue
Inherited from BarLineScatterCandleBubbleDataSet.getEntryIndexForXValue
- Defined in packages/ui-chart/data/DataSet.d.ts:95

getEntryXValue

getEntryXValue(e: BubbleEntry, entryIndex: number): any
Parameters
- e: BubbleEntry
- entryIndex: number
Returns any
Implementation of IBubbleDataSet.getEntryXValue
Inherited from BarLineScatterCandleBubbleDataSet.getEntryXValue
- Defined in packages/ui-chart/data/BaseDataSet.d.ts:133

getEntryYValue

getEntryYValue(e: BubbleEntry): any
Parameters
- e: BubbleEntry
Returns any
Implementation of IBubbleDataSet.getEntryYValue
Inherited from BarLineScatterCandleBubbleDataSet.getEntryYValue
- Defined in packages/ui-chart/data/DataSet.d.ts:87

getIndexInEntries

getIndexInEntries(xIndex: any): number
###### DATA RELATED METHODS ######
Parameters
- xIndex: any
Returns number
Implementation of IBubbleDataSet.getIndexInEntries
Inherited from BarLineScatterCandleBubbleDataSet.getIndexInEntries
- Defined in packages/ui-chart/data/BaseDataSet.d.ts:181

`Protected`getInternalValues

getInternalValues(): BubbleEntry[] | ObservableArray<BubbleEntry>
Returns BubbleEntry[] | ObservableArray<BubbleEntry>
Inherited from BarLineScatterCandleBubbleDataSet.getInternalValues
- Defined in packages/ui-chart/data/DataSet.d.ts:67

getValueTextColor

getValueTextColor(index?: number): string | Color
Parameters
- Optionalindex: number
Returns string | Color
Inherited from BarLineScatterCandleBubbleDataSet.getValueTextColor
- Defined in packages/ui-chart/data/BaseDataSet.d.ts:173

init

init(): void
Initializes DataSet chart data.

Returns void
Implementation of IBubbleDataSet.init
Overrides BarLineScatterCandleBubbleDataSet.init
- Defined in packages/ui-chart/data/BubbleDataSet.d.ts:14

`Protected`initEntryData

initEntryData(e: BubbleEntry): void
Parameters
- e: BubbleEntry
Returns void
Inherited from BarLineScatterCandleBubbleDataSet.initEntryData
- Defined in packages/ui-chart/data/DataSet.d.ts:57

notifyDataSetChanged

notifyDataSetChanged(): void
Use this method to tell the data set that the underlying data has changed.

Returns void
Inherited from BarLineScatterCandleBubbleDataSet.notifyDataSetChanged
- Defined in packages/ui-chart/data/BaseDataSet.d.ts:138

removeEntry

removeEntry(e: BubbleEntry): 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
- e: BubbleEntry
Returns boolean
Implementation of IBubbleDataSet.removeEntry
Inherited from BarLineScatterCandleBubbleDataSet.removeEntry
- Defined in packages/ui-chart/data/DataSet.d.ts:84

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
Implementation of IBubbleDataSet.removeEntryAtIndex
Inherited from BarLineScatterCandleBubbleDataSet.removeEntryAtIndex
- Defined in packages/ui-chart/data/DataSet.d.ts:85

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
Implementation of IBubbleDataSet.removeEntryByXValue
Inherited from BarLineScatterCandleBubbleDataSet.removeEntryByXValue
- Defined in packages/ui-chart/data/BaseDataSet.d.ts:184

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
Implementation of IBubbleDataSet.removeFirst
Inherited from BarLineScatterCandleBubbleDataSet.removeFirst
- Defined in packages/ui-chart/data/BaseDataSet.d.ts:182

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
Implementation of IBubbleDataSet.removeLast
Inherited from BarLineScatterCandleBubbleDataSet.removeLast
- Defined in packages/ui-chart/data/BaseDataSet.d.ts:183

resetColors

resetColors(): void
Resets all colors of this DataSet and recreates the colors array.

Returns void
Inherited from BarLineScatterCandleBubbleDataSet.resetColors
- Defined in packages/ui-chart/data/BaseDataSet.d.ts:166

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
Inherited from BarLineScatterCandleBubbleDataSet.setColor
- Defined in packages/ui-chart/data/BaseDataSet.d.ts:155

setColors

setColors(colors: any, alpha?: number): void
Sets colors with a specific alpha value.
Parameters
- colors: any
- Optionalalpha: number
Returns void
Inherited from BarLineScatterCandleBubbleDataSet.setColors
- Defined in packages/ui-chart/data/BaseDataSet.d.ts:162

toString

toString(): string
Returns a string representation of an object.

Returns string
Inherited from BarLineScatterCandleBubbleDataSet.toString
- Defined in packages/ui-chart/data/DataSet.d.ts:52

`Protected`updateGetEntryForIndex

updateGetEntryForIndex(): void
Returns void
Inherited from BarLineScatterCandleBubbleDataSet.updateGetEntryForIndex
- Defined in packages/ui-chart/data/DataSet.d.ts:93

Class BubbleDataSet

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BubbleDataSet

Properties

axisDependency

color

colors

drawIconsEnabled

drawValuesEnabled

fillShader

form

formLineDashEffect

formLineWidth

formSize

highlightCircleWidth

Param: width

highlightColor

highlightEnabled

iconProperty

iconsOffset

label

mCanCalculateMinMax

mMaxSize

ProtectedmValues

ProtectedmXMax

ProtectedmXMin

ProtectedmYMax

ProtectedmYMin

normalizeSizeEnabled

sizeProperty

spaceBottom

spaceTop

valueColors

valueFormatter

valuesOffset

valueTextSize

valueTypeface

visible

xProperty

yProperty

Accessors

entryCount

Returns number

maxSize

Returns number

needsFormatter

###### OTHER STYLING RELATED METHODS #####

Returns boolean

values

Returns T[] | ObservableArray<T>

Parameters

Returns void

valueTextColor

Parameters

Returns void

valueTextColors

Parameters

Returns void

xMax

Returns number

xMin

Returns number

yMax

Returns number

yMin

Returns number

Methods

addColor

Parameters

Returns void

addEntry

`Protected`mValues

`Protected`mXMax

`Protected`mXMin

`Protected`mYMax

`Protected`mYMin

`Protected`calcMinMaxX

`Protected`calcMinMaxY

`Protected`getInternalValues