Class HeatmapModel

The gauge chart model layer

Hierarchy (View Summary)

ChartModelCartesian
- HeatmapModel

Index

Constructors

constructor

Properties

allDataGroups axisFlavor colorClassNames colorScale services state

Constructors

constructor

new HeatmapModel(services: any): HeatmapModel
Parameters
- services: any
Returns HeatmapModel
Overrides ChartModelCartesian.constructor
- Defined in packages/core/src/model/heatmap.ts:19

Properties

`Protected`allDataGroups

allDataGroups: string[]

A list of all the data groups that have existed within the lifetime of the chart

axisFlavor

axisFlavor: interfaces.AxisFlavor = AxisFlavor.HOVERABLE

`Protected`colorClassNames

colorClassNames: any = {}

`Protected`colorScale

colorScale: any = {}

`Protected`services

services: any

`Protected`state

state: any = ...

Methods

`Protected`assignRangeAndDomains

assignRangeAndDomains(): {
    primaryDomain: any;
    primaryRange: any;
    secondaryDomain: any;
    secondaryRange: any;
}
Returns {
    primaryDomain: any;
    primaryRange: any;
    secondaryDomain: any;
    secondaryRange: any;
}
Inherited from ChartModelCartesian.assignRangeAndDomains
- Defined in packages/core/src/model/cartesian-charts.ts:18

exportToCSV

exportToCSV(): void
Returns void
Inherited from ChartModelCartesian.exportToCSV
- Defined in packages/core/src/model/model.ts:733

formatTable

formatTable(__namedParameters: { cells: any; headers: any }): any[]
Parameters
- __namedParameters: { cells: any; headers: any }
Returns any[]
Inherited from ChartModelCartesian.formatTable
- Defined in packages/core/src/model/model.ts:57

`Protected`generateDataGroups

generateDataGroups(data: any): { name: unknown; status: number }[]
Parameters
- data: any
Returns { name: unknown; status: number }[]
Inherited from ChartModelCartesian.generateDataGroups
- Defined in packages/core/src/model/model.ts:801

get

get(property?: string): any
Parameters
- Optionalproperty: string
Returns any
Inherited from ChartModelCartesian.get
- Defined in packages/core/src/model/model.ts:501

getActiveDataGroupNames

getActiveDataGroupNames(groups?: any): any
Parameters
- Optionalgroups: any
Returns any
Inherited from ChartModelCartesian.getActiveDataGroupNames
- Defined in packages/core/src/model/model.ts:223

getActiveDataGroups

getActiveDataGroups(groups?: any): any
Parameters
- Optionalgroups: any
Returns any
Inherited from ChartModelCartesian.getActiveDataGroups
- Defined in packages/core/src/model/model.ts:212

getAllDataFromDomain

getAllDataFromDomain(groups?: any): any
Parameters
- Optionalgroups: any
Returns any
Inherited from ChartModelCartesian.getAllDataFromDomain
- Defined in packages/core/src/model/model.ts:95

getAllDataGroupsNames

getAllDataGroupsNames(): string[]
Returns string[]
Inherited from ChartModelCartesian.getAllDataGroupsNames
- Defined in packages/core/src/model/model.ts:676

getBinConfigurations

getBinConfigurations(): { bins: Bin<number, number>[]; binsDomain: any[] }
Returns { bins: Bin<number, number>[]; binsDomain: any[] }
Inherited from ChartModelCartesian.getBinConfigurations
- Defined in packages/core/src/model/model.ts:232

getBinnedStackedData

getBinnedStackedData(): SeriesPoint<{ [key: string]: number }>[][]
Returns SeriesPoint<{ [key: string]: number }>[][]
Inherited from ChartModelCartesian.getBinnedStackedData
- Defined in packages/core/src/model/model.ts:292

getColorClassName

getColorClassName(
configs: { originalClassName?: string; value?: number },
): string
Parameters
- configs: { originalClassName?: string; value?: number }
Returns string
Overrides ChartModelCartesian.getColorClassName
- Defined in packages/core/src/model/heatmap.ts:267

getData

getData(): any
Returns any
Inherited from ChartModelCartesian.getData
- Defined in packages/core/src/model/model.ts:168

getDataGroupNames

getDataGroupNames(groups?: any): any
Parameters
- Optionalgroups: any
Returns any
Inherited from ChartModelCartesian.getDataGroupNames
- Defined in packages/core/src/model/model.ts:218

getDataGroups

getDataGroups(groups?: any): any
Parameters
- Optionalgroups: any
Returns any
Inherited from ChartModelCartesian.getDataGroups
- Defined in packages/core/src/model/model.ts:197

getDataValuesGroupedByKeys

getDataValuesGroupedByKeys(__namedParameters: StackKeysParams): any
Parameters
- __namedParameters: StackKeysParams
Returns any
Inherited from ChartModelCartesian.getDataValuesGroupedByKeys
- Defined in packages/core/src/model/model.ts:381

getDisplayData

getDisplayData(groups?: any): any
Charts that have group configs passed into them, only want to retrieve the display data relevant to that chart
Parameters
- Optionalgroups: any
  the included datasets for the particular chart
Returns any
Inherited from ChartModelCartesian.getDisplayData
- Defined in packages/core/src/model/model.ts:151

getFillColor

getFillColor(value: number): any
Parameters
- value: number
Returns any
string
Overrides ChartModelCartesian.getFillColor
- Defined in packages/core/src/model/heatmap.ts:76

getGroupedData

getGroupedData(groups?: any): { data: any; name: string }[]
Parameters
- Optionalgroups: any
Returns { data: any; name: string }[]
Inherited from ChartModelCartesian.getGroupedData
- Defined in packages/core/src/model/model.ts:318

getIsFilled

getIsFilled(group: any, key?: any, data?: any, defaultFilled?: boolean): any
Should the data point be filled?
Parameters
- group: any
- Optionalkey: any
- Optionaldata: any
- OptionaldefaultFilled: boolean
  the default for this chart
Returns any
Inherited from ChartModelCartesian.getIsFilled
- Defined in packages/core/src/model/model.ts:607

getMatrix

getMatrix(): any
Generates a matrix (If doesn't exist) and returns it

Returns any
Object
- Defined in packages/core/src/model/heatmap.ts:146

getMatrixAsArray

getMatrixAsArray(): object[]
Converts Object matrix into a single array

Returns object[]
object[]
- Defined in packages/core/src/model/heatmap.ts:212

getOptions

getOptions(): any
Retrieves the current options from the instance's state.

Returns any
- The current options stored in the instance's state.
Inherited from ChartModelCartesian.getOptions
- Defined in packages/core/src/model/model.ts:486

getStackedData

getStackedData(__namedParameters: StackKeysParams): any[][]
Parameters
- __namedParameters: StackKeysParams
Returns any[][]
Inherited from ChartModelCartesian.getStackedData
- Defined in packages/core/src/model/model.ts:431

getStackKeys

getStackKeys(__namedParameters?: StackKeysParams): any
Parameters
- __namedParameters: StackKeysParams = ...
Returns any
Inherited from ChartModelCartesian.getStackKeys
- Defined in packages/core/src/model/model.ts:338

getStatus

getStatus(): any
For charts that might hold an associated status for their dataset

Returns any
Inherited from ChartModelCartesian.getStatus
- Defined in packages/core/src/model/model.ts:672

getStrokeColor

getStrokeColor(group: any, key?: any, data?: any): any
Parameters
- group: any
- Optionalkey: any
- Optionaldata: any
Returns any
Inherited from ChartModelCartesian.getStrokeColor
- Defined in packages/core/src/model/model.ts:627

`Protected`getTabularData

getTabularData(data: any): any[]
Parameters
- data: any
Returns any[]
Inherited from ChartModelCartesian.getTabularData
- Defined in packages/core/src/model/model.ts:760

getTabularDataArray

getTabularDataArray(): any[]
Generate tabular data from display data

Returns any[]
Array
Overrides ChartModelCartesian.getTabularDataArray
Defined in packages/core/src/model/heatmap.ts:243
getUniqueDomain
getUniqueDomain(): string[]
Generate a list of all unique domains

Returns string[]
String[]

Defined in packages/core/src/model/heatmap.ts:84
getUniqueRanges
getUniqueRanges(): string[]
Generates a list of all unique ranges

Returns string[]
String[]

Defined in packages/core/src/model/heatmap.ts:115
getValueDomain
getValueDomain(): number[]
Get min and maximum value of the display data

Returns number[]
Array consisting of smallest and largest values in data

Defined in packages/core/src/model/heatmap.ts:44
getZoomBarData
getZoomBarData(): any
Returns any
Inherited from ChartModelCartesian.getZoomBarData
Defined in packages/core/src/model/cartesian-charts.ts:158
isDataEmpty
isDataEmpty(): boolean
Returns boolean
Inherited from ChartModelCartesian.isDataEmpty
Defined in packages/core/src/model/model.ts:172
isUserProvidedColorScaleValid
isUserProvidedColorScaleValid(): any
Returns any
Inherited from ChartModelCartesian.isUserProvidedColorScaleValid
Defined in packages/core/src/model/model.ts:638
Protectedsanitize
sanitize(data: any): any
Parameters
data: any
Returns any
Inherited from ChartModelCartesian.sanitize
Defined in packages/core/src/model/cartesian-charts.ts:197
ProtectedsanitizeDateValues
sanitizeDateValues(data: any): any
Parameters
data: any
Returns any
Inherited from ChartModelCartesian.sanitizeDateValues
Defined in packages/core/src/model/cartesian-charts.ts:162
set
set(newState: any, configs?: any): void
Parameters
newState: any
Optionalconfigs: any
Returns void
Inherited from ChartModelCartesian.set
Defined in packages/core/src/model/model.ts:490
ProtectedsetColorClassNames
setColorClassNames(): void
Returns void
Overrides ChartModelCartesian.setColorClassNames
Defined in packages/core/src/model/heatmap.ts:271
ProtectedsetCustomColorScale
setCustomColorScale(): void
Returns void
Inherited from ChartModelCartesian.setCustomColorScale
Defined in packages/core/src/model/model.ts:833
setData
setData(newData: any): any
Sets the data for the current instance.

This method sanitizes the provided data, generates data groups, and updates the instance's state with the sanitized data and data groups. It also resets the _domains, _ranges, and _matrix attributes to their empty states.

Parameters
newData: any
The new data to be set. This data will be cloned and sanitized.

Returns any

The sanitized version of the provided data.

Overrides ChartModelCartesian.setData
Defined in packages/core/src/model/heatmap.ts:191
setOptions
setOptions(newOptions: any): void
Updates the current options for the instance.

This method retrieves the existing options, updates the legend additional items, and merges the new options with the existing ones. The instance's state is then updated with the merged options.

Parameters
newOptions: any
The new options to be set. These options will be merged with the existing options.

Returns void
Inherited from ChartModelCartesian.setOptions
Defined in packages/core/src/model/model.ts:518
setZoomBarData
setZoomBarData(newZoomBarData?: any): void
Sets the zoom bar data for the current instance.

This method sanitizes the provided zoom bar data or uses the display data if no explicit zoom data is provided. It normalizes the zoom bar data by aggregating values based on unique dates and updates the instance's state with the normalized data.

Parameters
OptionalnewZoomBarData: any
The new zoom bar data to be set. If not provided, the display data will be used.

Returns void
Inherited from ChartModelCartesian.setZoomBarData
Defined in packages/core/src/model/cartesian-charts.ts:122
toggleDataLabel
toggleDataLabel(changedLabel: string): void
Parameters
changedLabel: string
Returns void
Inherited from ChartModelCartesian.toggleDataLabel
Defined in packages/core/src/model/model.ts:547
ProtectedtransformToTabularData
transformToTabularData(data: any): interfaces.ChartTabularData
Converts data provided in the older format to tabular

Parameters
data: any
Returns interfaces.ChartTabularData
Inherited from ChartModelCartesian.transformToTabularData
Defined in packages/core/src/model/model.ts:684
update
update(animate?: boolean): void
Updates miscellanous information within the model such as the color scales, or the legend data labels

Parameters
animate: boolean = true
Returns void
Inherited from ChartModelCartesian.update
Defined in packages/core/src/model/model.ts:532
ProtectedupdateAllDataGroups
updateAllDataGroups(): void
Returns void
Inherited from ChartModelCartesian.updateAllDataGroups
Defined in packages/core/src/model/model.ts:778
Settings
Member Visibility
Protected
Inherited
External
Theme
On This Page
Constructors
constructor
Properties
allDataGroups axisFlavor colorClassNames colorScale services state
Methods
assignRangeAndDomains exportToCSV formatTable generateDataGroups get getActiveDataGroupNames getActiveDataGroups getAllDataFromDomain getAllDataGroupsNames getBinConfigurations getBinnedStackedData getColorClassName getData getDataGroupNames getDataGroups getDataValuesGroupedByKeys getDisplayData getFillColor getGroupedData getIsFilled getMatrix getMatrixAsArray getOptions getStackedData getStackKeys getStatus getStrokeColor getTabularData getTabularDataArray getUniqueDomain getUniqueRanges getValueDomain getZoomBarData isDataEmpty isUserProvidedColorScaleValid sanitize sanitizeDateValues set setColorClassNames setCustomColorScale setData setOptions setZoomBarData toggleDataLabel transformToTabularData update updateAllDataGroups
@carbon/charts
Loading...
Generated using TypeDoc

Class HeatmapModel

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns HeatmapModel

Properties

ProtectedallDataGroups

axisFlavor

ProtectedcolorClassNames

ProtectedcolorScale

Protectedservices

Protectedstate

Methods

ProtectedassignRangeAndDomains

Returns { primaryDomain: any; primaryRange: any; secondaryDomain: any; secondaryRange: any;}

exportToCSV

Returns void

formatTable

Parameters

Returns any[]

ProtectedgenerateDataGroups

Parameters

Returns { name: unknown; status: number }[]

get

Parameters

Returns any

getActiveDataGroupNames

Parameters

Returns any

getActiveDataGroups

Parameters

Returns any

getAllDataFromDomain

Parameters

Returns any

getAllDataGroupsNames

Returns string[]

getBinConfigurations

Returns { bins: Bin<number, number>[]; binsDomain: any[] }

getBinnedStackedData

Returns SeriesPoint<{ [key: string]: number }>[][]

getColorClassName

Parameters

Returns string

getData

Returns any

getDataGroupNames

Parameters

Returns any

getDataGroups

Parameters

Returns any

getDataValuesGroupedByKeys

Parameters

Returns any

getDisplayData

Parameters

Returns any

getFillColor

Parameters

Returns any

getGroupedData

Parameters

Returns { data: any; name: string }[]

getIsFilled

Parameters

Returns any

getMatrix

Returns any

getMatrixAsArray

Returns object[]

getOptions

Returns any

getStackedData

Parameters

`Protected`allDataGroups

`Protected`colorClassNames

`Protected`colorScale

`Protected`services

`Protected`state

`Protected`assignRangeAndDomains

Returns {
primaryDomain: any;
primaryRange: any;
secondaryDomain: any;
secondaryRange: any;
}

`Protected`generateDataGroups

`Protected`getTabularData

`Protected`sanitize

`Protected`sanitizeDateValues

`Protected`setColorClassNames

`Protected`setCustomColorScale

`Protected`transformToTabularData

`Protected`updateAllDataGroups