Class ChoroplethModel

Base thematic maps chart model layer

Hierarchy (View Summary)

ChartModel
- ChoroplethModel

Constructors

constructor

new ChoroplethModel(services: any): ChoroplethModel
Parameters
- services: any
Returns ChoroplethModel
Overrides ChartModel.constructor
- Defined in packages/core/src/model/choropleth.ts:19

Properties

`Protected`allDataGroups

allDataGroups: string[]

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

`Protected`colorClassNames

colorClassNames: any = {}

`Protected`colorScale

colorScale: any = {}

`Protected`services

services: any

`Protected`state

state: any = ...

Methods

exportToCSV

exportToCSV(): void
Returns void
Inherited from ChartModel.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 ChartModel.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 ChartModel.generateDataGroups
- Defined in packages/core/src/model/model.ts:801

get

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

getActiveDataGroupNames

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

getActiveDataGroups

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

getAllDataFromDomain

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

getAllDataGroupsNames

getAllDataGroupsNames(): string[]
Returns string[]
Inherited from ChartModel.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 ChartModel.getBinConfigurations
- Defined in packages/core/src/model/model.ts:232

getBinnedStackedData

getBinnedStackedData(): SeriesPoint<{ [key: string]: number }>[][]
Returns SeriesPoint<{ [key: string]: number }>[][]
Inherited from ChartModel.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 ChartModel.getColorClassName
- Defined in packages/core/src/model/choropleth.ts:86

getCombinedData

getCombinedData(): {}
Helper function that will generate a dictionary

Returns {}
- Defined in packages/core/src/model/choropleth.ts:35

getData

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

getDataGroupNames

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

getDataGroups

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

getDataValuesGroupedByKeys

getDataValuesGroupedByKeys(__namedParameters: StackKeysParams): any
Parameters
- __namedParameters: StackKeysParams
Returns any
Inherited from ChartModel.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 ChartModel.getDisplayData
- Defined in packages/core/src/model/model.ts:151

getFillColor

getFillColor(value: number): any
Parameters
- value: number
Returns any
string
Overrides ChartModel.getFillColor
- Defined in packages/core/src/model/choropleth.ts:28

getGroupedData

getGroupedData(groups?: any): { data: any; name: string }[]
Parameters
- Optionalgroups: any
Returns { data: any; name: string }[]
Inherited from ChartModel.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 ChartModel.getIsFilled
- Defined in packages/core/src/model/model.ts:607

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 ChartModel.getOptions
- Defined in packages/core/src/model/model.ts:486

getStackedData

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

getStackKeys

getStackKeys(__namedParameters?: StackKeysParams): any
Parameters
- __namedParameters: StackKeysParams = ...
Returns any
Inherited from ChartModel.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 ChartModel.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 ChartModel.getStrokeColor
- Defined in packages/core/src/model/model.ts:627

`Protected`getTabularData

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

getTabularDataArray

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

Returns any[]
Array
Overrides ChartModel.getTabularDataArray
Defined in packages/core/src/model/choropleth.ts:69
isDataEmpty
isDataEmpty(): boolean
Returns boolean
Inherited from ChartModel.isDataEmpty
Defined in packages/core/src/model/model.ts:172
isUserProvidedColorScaleValid
isUserProvidedColorScaleValid(): any
Returns any
Inherited from ChartModel.isUserProvidedColorScaleValid
Defined in packages/core/src/model/model.ts:638
Protectedsanitize
sanitize(data: any): any
Parameters
data: any
Returns any
Inherited from ChartModel.sanitize
Defined in packages/core/src/model/model.ts:769
set
set(newState: any, configs?: any): void
Parameters
newState: any
Optionalconfigs: any
Returns void
Inherited from ChartModel.set
Defined in packages/core/src/model/model.ts:490
ProtectedsetColorClassNames
setColorClassNames(): void
Returns void
Overrides ChartModel.setColorClassNames
Defined in packages/core/src/model/choropleth.ts:90
ProtectedsetCustomColorScale
setCustomColorScale(): void
Returns void
Inherited from ChartModel.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.

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.

Inherited from ChartModel.setData
Defined in packages/core/src/model/model.ts:185
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 ChartModel.setOptions
Defined in packages/core/src/model/model.ts:518
toggleDataLabel
toggleDataLabel(changedLabel: string): void
Parameters
changedLabel: string
Returns void
Inherited from ChartModel.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 ChartModel.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 ChartModel.update
Defined in packages/core/src/model/model.ts:532
ProtectedupdateAllDataGroups
updateAllDataGroups(): void
Returns void
Inherited from ChartModel.updateAllDataGroups
Defined in packages/core/src/model/model.ts:778
Settings
Member Visibility
Protected
Inherited
External
Theme
On This Page
Constructors
constructor
Properties
allDataGroups colorClassNames colorScale services state
Methods
exportToCSV formatTable generateDataGroups get getActiveDataGroupNames getActiveDataGroups getAllDataFromDomain getAllDataGroupsNames getBinConfigurations getBinnedStackedData getColorClassName getCombinedData getData getDataGroupNames getDataGroups getDataValuesGroupedByKeys getDisplayData getFillColor getGroupedData getIsFilled getOptions getStackedData getStackKeys getStatus getStrokeColor getTabularData getTabularDataArray isDataEmpty isUserProvidedColorScaleValid sanitize set setColorClassNames setCustomColorScale setData setOptions toggleDataLabel transformToTabularData update updateAllDataGroups
@carbon/charts
Loading...
Generated using TypeDoc

Class ChoroplethModel

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ChoroplethModel

Properties

ProtectedallDataGroups

ProtectedcolorClassNames

ProtectedcolorScale

Protectedservices

Protectedstate

Methods

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

getCombinedData

Returns {}

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

getOptions

Returns any

getStackedData

Parameters

Returns any[][]

getStackKeys

Parameters

Returns any

getStatus

`Protected`allDataGroups

`Protected`colorClassNames

`Protected`colorScale

`Protected`services

`Protected`state

`Protected`generateDataGroups

`Protected`getTabularData

`Protected`sanitize

`Protected`setColorClassNames

`Protected`setCustomColorScale

`Protected`transformToTabularData

`Protected`updateAllDataGroups