chartjs-chart-geo

Appearance

chartjs-chart-geo / IChoroplethControllerDatasetOptions

Interface: IChoroplethControllerDatasetOptions ​

Defined in: work/chartjs-chart-geo/chartjs-chart-geo/src/controllers/ChoroplethController.ts:155

Extends ​

  • ControllerDatasetOptions.IGeoChartOptions.ScriptableAndArrayOptions<IGeoFeatureOptions, ScriptableContext<"choropleth">>.ScriptableAndArrayOptions<CommonHoverOptions, ScriptableContext<"choropleth">>.AnimationOptions<"choropleth">

Indexable ​

[key: string]: unknown

Properties ​

borderWidth ​

borderWidth: ScriptableAndArray<number, ScriptableContext<"choropleth">>

Defined in: work/chartjs-chart-geo/chartjs-chart-geo/src/elements/GeoFeature.ts:21

Width of the border

Default ​

ts
0

Inherited from ​

IGeoFeatureOptions.borderWidth

clipMap ​

clipMap: boolean | "outline" | "graticule" | "outline+graticule" | "items"

Defined in: work/chartjs-chart-geo/chartjs-chart-geo/src/controllers/GeoController.ts:250

option whether to clip the rendering to the chartArea of the graph

Default ​

ts
choropleth: true bubbleMap: 'outline+graticule'

Inherited from ​

IGeoChartOptions.clipMap

graticuleBorderColor ​

graticuleBorderColor: ScriptableAndArray<string, ScriptableContext<"choropleth">>

Defined in: work/chartjs-chart-geo/chartjs-chart-geo/src/elements/GeoFeature.ts:43

border color for the graticule

Default ​

ts
#CCCCCC

Inherited from ​

IGeoFeatureOptions.graticuleBorderColor

graticuleBorderWidth ​

graticuleBorderWidth: ScriptableAndArray<number, ScriptableContext<"choropleth">>

Defined in: work/chartjs-chart-geo/chartjs-chart-geo/src/elements/GeoFeature.ts:48

border width for the graticule

Default ​

ts
0

Inherited from ​

IGeoFeatureOptions.graticuleBorderWidth

outline ​

outline: any[]

Defined in: work/chartjs-chart-geo/chartjs-chart-geo/src/controllers/GeoController.ts:228

Outline used to scale and centralize the projection in the chart area. By default a sphere is used

Default ​

ts
{ type: 'Sphere" }

Inherited from ​

IGeoChartOptions.outline

outlineBackgroundColor ​

outlineBackgroundColor: ScriptableAndArray<null | string, ScriptableContext<"choropleth">>

Defined in: work/chartjs-chart-geo/chartjs-chart-geo/src/elements/GeoFeature.ts:27

background color for the outline

Default ​

ts
null

Inherited from ​

ScriptableAndArrayOptions.outlineBackgroundColor

outlineBorderColor ​

outlineBorderColor: ScriptableAndArray<string, ScriptableContext<"choropleth">>

Defined in: work/chartjs-chart-geo/chartjs-chart-geo/src/elements/GeoFeature.ts:32

border color for the outline

Default ​

ts
defaultColor of Chart.js

Inherited from ​

IGeoFeatureOptions.outlineBorderColor

outlineBorderWidth ​

outlineBorderWidth: ScriptableAndArray<number, ScriptableContext<"choropleth">>

Defined in: work/chartjs-chart-geo/chartjs-chart-geo/src/elements/GeoFeature.ts:37

border width for the outline

Default ​

ts
0

Inherited from ​

IGeoFeatureOptions.outlineBorderWidth

showGraticule ​

showGraticule: boolean | { stepMajor: [number, number]; stepMinor: [number, number]; }

Defined in: work/chartjs-chart-geo/chartjs-chart-geo/src/controllers/GeoController.ts:239

option to render a graticule in the background, see also the outline... styling option

Default ​

ts
false

Inherited from ​

IGeoChartOptions.showGraticule

showOutline ​

showOutline: boolean

Defined in: work/chartjs-chart-geo/chartjs-chart-geo/src/controllers/GeoController.ts:233

option to render the outline in the background, see also the outline... styling option

Default ​

ts
false

Inherited from ​

IGeoChartOptions.showOutline