Class ChoroplethModel

Base thematic maps chart model layer

Hierarchy (view full)

ChartModel
- ChoroplethModel

Constructors

constructor

new ChoroplethModel(services): 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): any[]
Parameters
- __namedParameters: {
  cells: any;
  headers: any;
  }
  - cells: any
  - headers: any
Returns any[]
Inherited from ChartModel.formatTable
- Defined in packages/core/src/model/model.ts:57

`Protected`generateDataGroups

generateDataGroups(data): {
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?): any
Parameters
- Optionalproperty: string
Returns any
Inherited from ChartModel.get
- Defined in packages/core/src/model/model.ts:501

getActiveDataGroupNames

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

getActiveDataGroups

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

getAllDataFromDomain

getAllDataFromDomain(groups?): 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[];
}
- 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): string
Parameters
- configs: {
  originalClassName?: string;
  value?: number;
  }
  - OptionaloriginalClassName?: string
  - Optionalvalue?: 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
Parameters
- Optionalgroups: any
Returns any
Inherited from ChartModel.getDataGroupNames
- Defined in packages/core/src/model/model.ts:218

getDataGroups

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

getDataValuesGroupedByKeys

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

getDisplayData

getDisplayData(groups?): 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): any
Parameters
- value: number
Returns any
string
Overrides ChartModel.getFillColor
- Defined in packages/core/src/model/choropleth.ts:28

getGroupedData

getGroupedData(groups?): {
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, key?, data?, defaultFilled?): 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): any[][]
Parameters
- __namedParameters: StackKeysParams
Returns any[][]
Inherited from ChartModel.getStackedData
- Defined in packages/core/src/model/model.ts:431

getStackKeys

getStackKeys(__namedParameters?): 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, key?, data?): 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[]
Parameters
- data: any
Returns any[]
Inherited from ChartModel.getTabularData
- Defined in packages/core/src/model/model.ts:760

getTabularDataArray