Class CombinedData

Data object that allows the combination of Line-, Bar-, Scatter-, Bubble- and CandleData. Used in the CombinedChart class.

Hierarchy (View Summary)

BarLineScatterCandleBubbleData<Entry, BarLineScatterCandleBubbleDataSet<Entry>>
- CombinedData

Index

Constructors

constructor

Properties

barData bubbleData candleData datasOrder lineData mDataSets mLeftAxisMax mLeftAxisMin mRightAxisMax mRightAxisMin mXMax mXMin mYMax mYMin scatterData

Constructors

constructor

new CombinedData(
dataSets?: BarLineScatterCandleBubbleDataSet<Entry>[],
): CombinedData
Constructor taking single or multiple DataSet objects.
Parameters
- OptionaldataSets: BarLineScatterCandleBubbleDataSet<Entry>[]
Returns CombinedData
Inherited from BarLineScatterCandleBubbleData.constructor
- Defined in packages/ui-chart/data/ChartData.d.ts:39

Properties

barData

barData: BarData

bubbleData

bubbleData: BubbleData

candleData

candleData: CandleData

datasOrder

datasOrder: string[]

lineData

lineData: LineData

`Protected`mDataSets

mDataSets: BarLineScatterCandleBubbleDataSet<Entry>[]

array that holds all DataSets the ChartData object represents

mLeftAxisMax

mLeftAxisMax: number

mLeftAxisMin

mLeftAxisMin: number

mRightAxisMax

mRightAxisMax: number

mRightAxisMin

mRightAxisMin: number

mXMax

mXMax: number

maximum x-value in the value array

mXMin

mXMin: number

minimum x-value in the value array

mYMax

mYMax: number

maximum y-value in the value array across all axes

mYMin

mYMin: number

the minimum y-value in the value array across all axes

scatterData

scatterData: ScatterData

Accessors

colors

get colors(): any[]
Returns all colors used across all DataSet objects this object represents.

Returns any[]
Inherited from BarLineScatterCandleBubbleData.colors
- Defined in packages/ui-chart/data/ChartData.d.ts:229

data

set data(data: BarData | BubbleData | CandleData | LineData | ScatterData): void
Parameters
- data: BarData | BubbleData | CandleData | LineData | ScatterData
Returns void
- Defined in packages/ui-chart/data/CombinedData.d.ts:23

datas

get datas(): {
    barData: BarData;
    bubbleData: BubbleData;
    candleData: CandleData;
    lineData: LineData;
    scatterData: ScatterData;
}
Returns all data as object.

Returns {
    barData: BarData;
    bubbleData: BubbleData;
    candleData: CandleData;
    lineData: LineData;
    scatterData: ScatterData;
}
- Defined in packages/ui-chart/data/CombinedData.d.ts:33

datasArray

get datasArray(): ChartData<any, any>[]
Returns all data objects in row: line-bar-scatter-candle-bubble if not null.

Returns ChartData<any, any>[]
- Defined in packages/ui-chart/data/CombinedData.d.ts:29

dataSetCount

get dataSetCount(): number
returns the number of LineDataSets this object contains

Returns number
Inherited from BarLineScatterCandleBubbleData.dataSetCount
- Defined in packages/ui-chart/data/ChartData.d.ts:62

dataSets

get dataSets(): T[]
Returns all DataSet objects this ChartData object holds.

Returns T[]
Inherited from BarLineScatterCandleBubbleData.dataSets
- Defined in packages/ui-chart/data/ChartData.d.ts:90

drawValuesEnabled

set drawValuesEnabled(enabled: any): void
Enables / disables drawing values (value-text) for all DataSets this data object contains.
Parameters
- enabled: any
Returns void
Inherited from BarLineScatterCandleBubbleData.drawValuesEnabled
- Defined in packages/ui-chart/data/ChartData.d.ts:287

entryCount

get entryCount(): number
Returns the total entry count across all DataSet objects this data object contains.

Returns number
Inherited from BarLineScatterCandleBubbleData.entryCount
- Defined in packages/ui-chart/data/ChartData.d.ts:315

highlightEnabled

get highlightEnabled(): boolean
Returns true if highlighting of all underlying values is enabled, false if not.

Returns boolean
Inherited from BarLineScatterCandleBubbleData.highlightEnabled
- Defined in packages/ui-chart/data/ChartData.d.ts:298

maxEntryCountSet

get maxEntryCountSet(): T
Returns the DataSet object with the maximum number of entries or null if there are no DataSets.

Returns T
Inherited from BarLineScatterCandleBubbleData.maxEntryCountSet
- Defined in packages/ui-chart/data/ChartData.d.ts:319

valueFormatter

set valueFormatter(f: IValueFormatter): void
Sets a custom IValueFormatter for all DataSets this data object contains.
Parameters
- f: IValueFormatter
Returns void
Inherited from BarLineScatterCandleBubbleData.valueFormatter
- Defined in packages/ui-chart/data/ChartData.d.ts:252

valueTextColor

set valueTextColor(color: any): void
Sets the color of the value-text (color in which the value-labels are drawn) for all DataSets this data object contains.
Parameters
- color: any
Returns void
Inherited from BarLineScatterCandleBubbleData.valueTextColor
- Defined in packages/ui-chart/data/ChartData.d.ts:259

valueTextColors

set valueTextColors(colors: any): void
Sets the same list of value-colors for all DataSets this data object contains.
Parameters
- colors: any
Returns void
Inherited from BarLineScatterCandleBubbleData.valueTextColors
- Defined in packages/ui-chart/data/ChartData.d.ts:266

valueTextSize

set valueTextSize(size: any): void
Sets the size (in dp) of the value-text for all DataSets this data object contains.
Parameters
- size: any
Returns void
Inherited from BarLineScatterCandleBubbleData.valueTextSize
- Defined in packages/ui-chart/data/ChartData.d.ts:280

valueTypeface

set valueTypeface(tf: any): void
Sets the Typeface for all value-labels for all DataSets this data object contains.
Parameters
- tf: any
Returns void
Inherited from BarLineScatterCandleBubbleData.valueTypeface
- Defined in packages/ui-chart/data/ChartData.d.ts:273

visibleDataSets

get visibleDataSets(): T[]
Returns T[]
Inherited from BarLineScatterCandleBubbleData.visibleDataSets
- Defined in packages/ui-chart/data/ChartData.d.ts:91

xMax

get xMax(): number
Returns the maximum x-value this data object contains.

Returns number
Inherited from BarLineScatterCandleBubbleData.xMax
- Defined in packages/ui-chart/data/ChartData.d.ts:86

xMin

get xMin(): number
Returns the minimum x-value this data object contains.

Returns number
Inherited from BarLineScatterCandleBubbleData.xMin
- Defined in packages/ui-chart/data/ChartData.d.ts:82

yMax

get yMax(): number
Returns number
Inherited from BarLineScatterCandleBubbleData.yMax
- Defined in packages/ui-chart/data/ChartData.d.ts:71

yMin

get yMin(): number
Returns number
Inherited from BarLineScatterCandleBubbleData.yMin
- Defined in packages/ui-chart/data/ChartData.d.ts:70

Methods

addDataSet

addDataSet(d: BarLineScatterCandleBubbleDataSet<Entry>): void
Adds a DataSet dynamically.
Parameters
- d: BarLineScatterCandleBubbleDataSet<Entry>
Returns void
Inherited from BarLineScatterCandleBubbleData.addDataSet
- Defined in packages/ui-chart/data/ChartData.d.ts:141

addEntry

addEntry(e: any, dataSetIndex: any): void
Adds an Entry to the DataSet at the specified index. Entries are added to the end of the list.
Parameters
- e: any
- dataSetIndex: any
Returns void
Inherited from BarLineScatterCandleBubbleData.addEntry
- Defined in packages/ui-chart/data/ChartData.d.ts:165

calcMinMax

calcMinMax(): void
Calc minimum and maximum values (both x and y) over all DataSets.

Returns void
Overrides BarLineScatterCandleBubbleData.calcMinMax
- Defined in packages/ui-chart/data/CombinedData.d.ts:24

`Protected`calcMinMaxForDataSet

calcMinMaxForDataSet(d: BarLineScatterCandleBubbleDataSet<Entry>): void
Adjusts the minimum and maximum values based on the given DataSet.
Parameters
- d: BarLineScatterCandleBubbleDataSet<Entry>
Returns void
Inherited from BarLineScatterCandleBubbleData.calcMinMaxForDataSet
- Defined in packages/ui-chart/data/ChartData.d.ts:178

`Protected`calcMinMaxForEntry

calcMinMaxForEntry(
    set: IDataSet<Entry>,
    e: Entry,
    entryIndex: number,
    axis: AxisDependency,
): void
Adjusts the current minimum and maximum values based on the provided Entry object.
Parameters
- set: IDataSet<Entry>
- e: Entry
- entryIndex: number
- axis: AxisDependency
Returns void
Inherited from BarLineScatterCandleBubbleData.calcMinMaxForEntry
- Defined in packages/ui-chart/data/ChartData.d.ts:172

calcMinMaxYRange

calcMinMaxYRange(fromX: any, toX: any): void
Calc minimum and maximum y-values over all DataSets. Tell DataSets to recalculate their min and max y-values, this is only needed for autoScaleMinMax.
Parameters
- fromX: any
  the x-value to start the calculation from
- toX: any
  the x-value to which the calculation should be performed
Returns void
Inherited from BarLineScatterCandleBubbleData.calcMinMaxYRange
- Defined in packages/ui-chart/data/ChartData.d.ts:53

clearValues

clearValues(): void
Clears this data object from all DataSets and removes all Entries. Don't forget to invalidate the chart after this.

Returns void
Inherited from BarLineScatterCandleBubbleData.clearValues
- Defined in packages/ui-chart/data/ChartData.d.ts:303

contains

contains(dataSet: any): boolean
Checks if this data object contains the specified DataSet. Returns true if so, false if not.
Parameters
- dataSet: any
Returns boolean
Inherited from BarLineScatterCandleBubbleData.contains
- Defined in packages/ui-chart/data/ChartData.d.ts:311

getDataByIndex

getDataByIndex(index: any): ChartData<any, any>
Parameters
- index: any
Returns ChartData<any, any>
- Defined in packages/ui-chart/data/CombinedData.d.ts:40

getDataIndex

getDataIndex(data: ChartData<any, any>): number
Parameters
- data: ChartData<any, any>
Returns number
- Defined in packages/ui-chart/data/CombinedData.d.ts:56

getDataSetAndIndexForEntry

getDataSetAndIndexForEntry(
e: Entry,
): { index: number; set: BarLineScatterCandleBubbleDataSet<Entry> }
Returns the DataSet that contains the provided Entry and the entry index, or null, if no DataSet contains this Entry.
Parameters
- e: Entry
Returns { index: number; set: BarLineScatterCandleBubbleDataSet<Entry> }
Inherited from BarLineScatterCandleBubbleData.getDataSetAndIndexForEntry
- Defined in packages/ui-chart/data/ChartData.d.ts:221

getDataSetByHighlight

getDataSetByHighlight(
highlight: Highlight<Entry>,
): BarLineScatterCandleBubbleDataSet<any>
Get dataset for highlight
Parameters
- highlight: Highlight<Entry>
  current highlight
Returns BarLineScatterCandleBubbleDataSet<any>
dataset related to highlight
- Defined in packages/ui-chart/data/CombinedData.d.ts:55

getDataSetByIndex

getDataSetByIndex(index: number): BarLineScatterCandleBubbleDataSet<Entry>
Parameters
- index: number
Returns BarLineScatterCandleBubbleDataSet<Entry>
Inherited from BarLineScatterCandleBubbleData.getDataSetByIndex
- Defined in packages/ui-chart/data/ChartData.d.ts:135

getDataSetByLabel

getDataSetByLabel(
label: string,
ignorecase?: boolean,
): BarLineScatterCandleBubbleDataSet<Entry>
Returns the DataSet object with the given label. Search can be case sensitive or not. IMPORTANT: This method does calculations at runtime. Use with care in performance critical situations.
Parameters
- label: string
- Optionalignorecase: boolean
Returns BarLineScatterCandleBubbleDataSet<Entry>
Inherited from BarLineScatterCandleBubbleData.getDataSetByLabel
- Defined in packages/ui-chart/data/ChartData.d.ts:134

getDataSetForEntry

getDataSetForEntry(e: Entry): BarLineScatterCandleBubbleDataSet<Entry>
Returns the DataSet that contains the provided Entry, or null, if no DataSet contains this Entry.
Parameters
- e: Entry
Returns BarLineScatterCandleBubbleDataSet<Entry>
Inherited from BarLineScatterCandleBubbleData.getDataSetForEntry
- Defined in packages/ui-chart/data/ChartData.d.ts:213

`Protected`getDataSetIndexByLabel

getDataSetIndexByLabel(
    dataSets: BarLineScatterCandleBubbleDataSet<Entry>[],
    label: string,
    ignorecase?: boolean,
): number
Retrieve the index of a DataSet with a specific label from the ChartData. Search can be case sensitive or not. IMPORTANT: This method does calculations at runtime, do not over-use in performance critical situations.
Parameters
- dataSets: BarLineScatterCandleBubbleDataSet<Entry>[]
  the DataSet array to search
- label: string
- Optionalignorecase: boolean
  if true, the search is not case-sensitive
Returns number
Inherited from BarLineScatterCandleBubbleData.getDataSetIndexByLabel
- Defined in packages/ui-chart/data/ChartData.d.ts:103

getDataSetLabels

getDataSetLabels(): any[]
Returns the labels of all DataSets as a string array.

Returns any[]
Inherited from BarLineScatterCandleBubbleData.getDataSetLabels
- Defined in packages/ui-chart/data/ChartData.d.ts:107

getEntryAndIndexForHighlight

getEntryAndIndexForHighlight(
highlight: Highlight<Entry>,
): { entry: Entry; index: number }
Get the Entry for a corresponding highlight object
Parameters
- highlight: Highlight<Entry>
Returns { entry: Entry; index: number }
the entry that is highlighted
Inherited from BarLineScatterCandleBubbleData.getEntryAndIndexForHighlight
- Defined in packages/ui-chart/data/ChartData.d.ts:121

getEntryForHighlight

getEntryForHighlight(highlight: Highlight<Entry>): any
Get the Entry for a corresponding highlight object
Parameters
- highlight: Highlight<Entry>
Returns any
the entry that is highlighted
Overrides BarLineScatterCandleBubbleData.getEntryForHighlight
- Defined in packages/ui-chart/data/CombinedData.d.ts:48

`Protected`getFirstLeft

getFirstLeft(
sets: BarLineScatterCandleBubbleDataSet<Entry>[],
): BarLineScatterCandleBubbleDataSet<Entry>
Returns the first DataSet from the datasets-array that has it's dependency on the left axis. Returns null if no DataSet with left dependency could be found.
Parameters
- sets: BarLineScatterCandleBubbleDataSet<Entry>[]
Returns BarLineScatterCandleBubbleDataSet<Entry>
Inherited from BarLineScatterCandleBubbleData.getFirstLeft
- Defined in packages/ui-chart/data/ChartData.d.ts:241

getFirstRight

getFirstRight(
sets: BarLineScatterCandleBubbleDataSet<Entry>[],
): BarLineScatterCandleBubbleDataSet<Entry>
Returns the first DataSet from the datasets-array that has it's dependency on the right axis. Returns null if no DataSet with right dependency could be found.
Parameters
- sets: BarLineScatterCandleBubbleDataSet<Entry>[]
Returns BarLineScatterCandleBubbleDataSet<Entry>
Inherited from BarLineScatterCandleBubbleData.getFirstRight
- Defined in packages/ui-chart/data/ChartData.d.ts:246

getIndexOfDataSet

getIndexOfDataSet(dataSet: BarLineScatterCandleBubbleDataSet<Entry>): number
Returns the index of the provided DataSet in the DataSet array of this data object, or -1 if it does not exist.
Parameters
- dataSet: BarLineScatterCandleBubbleDataSet<Entry>
Returns number
Inherited from BarLineScatterCandleBubbleData.getIndexOfDataSet
- Defined in packages/ui-chart/data/ChartData.d.ts:236

getYMax

getYMax(axis?: AxisDependency): number
Returns the maximum y-value for the specified axis.
Parameters
- Optionalaxis: AxisDependency
Returns number
Inherited from BarLineScatterCandleBubbleData.getYMax
- Defined in packages/ui-chart/data/ChartData.d.ts:78

getYMin

getYMin(axis?: any): number
Returns the minimum y-value for the specified axis.
Parameters
- Optionalaxis: any
Returns number
Inherited from BarLineScatterCandleBubbleData.getYMin
- Defined in packages/ui-chart/data/ChartData.d.ts:69

notifyDataChanged

notifyDataChanged(): void
Call this method to let the ChartData know that the underlying data has changed. Calling this performs all necessary recalculations needed when the contained data has changed.

Returns void
Overrides BarLineScatterCandleBubbleData.notifyDataChanged
- Defined in packages/ui-chart/data/CombinedData.d.ts:41

removeDataSet

removeDataSet(d: BarLineScatterCandleBubbleDataSet<any>): boolean
Removes the given DataSet from this data object. Also recalculates all minimum and maximum values. Returns true if a DataSet was removed, false if no DataSet could be removed.
Parameters
- d: BarLineScatterCandleBubbleDataSet<any>
Returns boolean
Overrides BarLineScatterCandleBubbleData.removeDataSet
- Defined in packages/ui-chart/data/CombinedData.d.ts:57

removeDataSetAtIndex

removeDataSetAtIndex(index: number): boolean
Removes the DataSet at the given index in the DataSet array from the data object. Also recalculates all minimum and maximum values. Returns true if a DataSet was removed, false if no DataSet could be removed.
Parameters
- index: number
Returns boolean
Overrides BarLineScatterCandleBubbleData.removeDataSetAtIndex
- Defined in packages/ui-chart/data/CombinedData.d.ts:58

removeEntry

removeEntry(e: Entry, dataSetIndex: number): boolean
Removes the given Entry object from the DataSet at the specified index.
Parameters
- e: Entry
- dataSetIndex: number
Returns boolean
Overrides BarLineScatterCandleBubbleData.removeEntry
- Defined in packages/ui-chart/data/CombinedData.d.ts:59

removeEntryAtIndex

removeEntryAtIndex(index: any, dataSetIndex: any): boolean
Removes the Entry object closest to the given DataSet at the specified index. Returns true if an Entry was removed, false if no Entry was found that meets the specified requirements.
Parameters
- index: any
- dataSetIndex: any
Returns boolean
Inherited from BarLineScatterCandleBubbleData.removeEntryAtIndex
- Defined in packages/ui-chart/data/ChartData.d.ts:205

removeEntryForXValue

removeEntryForXValue(xValue: number, dataSetIndex: number): boolean
Removes the Entry object closest to the given DataSet at the specified index. Returns true if an Entry was removed, false if no Entry was found that meets the specified requirements.
Parameters
- xValue: number
- dataSetIndex: number
Returns boolean
Overrides BarLineScatterCandleBubbleData.removeEntryForXValue
- Defined in packages/ui-chart/data/CombinedData.d.ts:60

setHighlightEnabled

setHighlightEnabled(enabled: any): void
Enables / disables highlighting values for all DataSets this data object contains. If set to true, this means that values can be highlighted programmatically or by touch gesture.
Parameters
- enabled: any
Returns void
Inherited from BarLineScatterCandleBubbleData.setHighlightEnabled
- Defined in packages/ui-chart/data/ChartData.d.ts:293

Class CombinedData

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CombinedData

Properties

barData

bubbleData

candleData

datasOrder

lineData

ProtectedmDataSets

mLeftAxisMax

mLeftAxisMin

mRightAxisMax

mRightAxisMin

mXMax

mXMin

mYMax

mYMin

scatterData

Accessors

colors

Returns any[]

data

Parameters

Returns void

datas

Returns { barData: BarData; bubbleData: BubbleData; candleData: CandleData; lineData: LineData; scatterData: ScatterData;}

datasArray

Returns ChartData<any, any>[]

dataSetCount

Returns number

dataSets

Returns T[]

drawValuesEnabled

Parameters

Returns void

entryCount

Returns number

highlightEnabled

Returns boolean

maxEntryCountSet

Returns T

valueFormatter

Parameters

Returns void

valueTextColor

Parameters

Returns void

valueTextColors

Parameters

Returns void

valueTextSize

Parameters

Returns void

valueTypeface

Parameters

Returns void

visibleDataSets

Returns T[]

xMax

Returns number

xMin

Returns number

yMax

Returns number

yMin

Returns number

Methods

addDataSet

Parameters

Returns void

addEntry

`Protected`mDataSets

Returns {
barData: BarData;
bubbleData: BubbleData;
candleData: CandleData;
lineData: LineData;
scatterData: ScatterData;
}

`Protected`calcMinMaxForDataSet

`Protected`calcMinMaxForEntry

`Protected`getDataSetIndexByLabel

`Protected`getFirstLeft