chartjs-chart-geo

Appearance

chartjs-chart-geo v4.3.4 / ISizeScaleOptions

Interface: ISizeScaleOptions ​

Extends ​

  • ILegendScaleOptions

Properties ​

display ​

display: boolean

whether to render a color legend

Default ​

ts
true

Inherited from ​

ILegendScaleOptions.display

Defined in ​

work/chartjs-chart-geo/chartjs-chart-geo/src/scales/LegendScale.ts:15

legend ​

legend: object

align ​

align: "left" | "top" | "bottom" | "right"

alignment of the scale, e.g., right means that it is a vertical scale with the ticks on the right side

Default ​
ts
right

indicatorWidth ​

indicatorWidth: number

how many pixels should be used for the color bar

Default ​
ts
10

length ​

length: number

length of the legend, i.e., for a horizontal scale the width if a value < 1 is given, is it assume to be a ratio of the corresponding chart area

Default ​
ts
100

margin ​

margin: number | ChartArea

margin pixels such that it doesn't stick to the edge of the chart

Default ​
ts
8

position ​

position: "left" | "top" | "bottom" | "right" | object | "top-left" | "top-right" | "bottom-right" | "bottom-left"

location of the legend on the chart area

Default ​
ts
bottom-right

width ​

width: number

how wide the scale is, i.e., for a horizontal scale the height if a value < 1 is given, is it assume to be a ratio of the corresponding chart area

Default ​
ts
50

Inherited from ​

ILegendScaleOptions.legend

Defined in ​

work/chartjs-chart-geo/chartjs-chart-geo/src/scales/LegendScale.ts:23

missing ​

missing: number

radius to render for missing values

Default ​

ts
1

Defined in ​

work/chartjs-chart-geo/chartjs-chart-geo/src/scales/SizeScale.ts:29

mode ​

mode: "area" | "radius"

operation mode for the scale, area means that the area is linearly increasing whereas radius the radius is. The area one is the default since it gives a better visual comparison of values

Default ​

ts
area

Defined in ​

work/chartjs-chart-geo/chartjs-chart-geo/src/scales/SizeScale.ts:23

property ​

property: string

the property name that stores the value in the data elements

Default ​

ts
value

Inherited from ​

ILegendScaleOptions.property

Defined in ​

work/chartjs-chart-geo/chartjs-chart-geo/src/scales/LegendScale.ts:21

range ​

range: [number, number]

radius range in pixel, the minimal data value will be mapped to the first entry, the maximal one to the second and a linear interpolation for all values in between.

Default ​

ts
[2, 20]

Defined in ​

work/chartjs-chart-geo/chartjs-chart-geo/src/scales/SizeScale.ts:16