Skip to main content

GaugeChartOptions

Options for a Gauge chart.

Extends​

Properties​

colorGenerator?​

optional colorGenerator: ColorGenerator

Optional function to call in order to establish the color to be used for each series

Inherited from​

BaseChartOptions.colorGenerator

data?​

optional data: ObjectData[]

Optional data to load into the chart.

Inherited from​

BaseChartOptions.data

dataSource?​

optional dataSource: DataSource

Optional data source (of type DataSource, meaning both VisuallyJsModel and Selection are supported) from which to retrieve data to load into the chart.

Inherited from​

BaseChartOptions.dataSource

dataSourceFilter?​

optional dataSourceFilter: ChartModelFilter

When you provide dataSource, you can also provide a filter which accepts or rejects specific nodes/groups in the data source.

Inherited from​

BaseChartOptions.dataSourceFilter

defaultColor?​

optional defaultColor: string

Optional color to use for every series. Overrides any colorGenerator.

Inherited from​

BaseChartOptions.defaultColor

emptyMessage?​

optional emptyMessage: string

Message to display when the chart has no data. Defaults to "No data".

Inherited from​

BaseChartOptions.emptyMessage

endAngle?​

optional endAngle: number

The end angle of the gauge in degrees. Typically 135 for a speedometer style.

height?​

optional height: number

Height for the chart. If omitted, height is computed from the width of the chart's container

Inherited from​

BaseChartOptions.height

innerRadius?​

optional innerRadius: number

Inner radius ratio (0 to 1). A higher value (e.g. 0.8) creates a thin arc. 0 creates a semi-circle.

labels?​

optional labels: object

Configuration for the scale labels.

distance?​

optional distance: number

Distance beyond the outer radius in pixels.

interval?​

optional interval: number

Interval between labels (e.g. 20).

values?​

optional values: number[]

Explicit values to label. If provided, interval is ignored.

legend?​

optional legend: boolean | LegendSpec

Either a boolean true/false, indicating the legend should be shown/hidden, or a spec for a legend.

Inherited from​

BaseChartOptions.legend

max?​

optional max: number

The maximum value on the scale. Defaults to 100.

min?​

optional min: number

The minimum value on the scale. Defaults to 0.

outerRadius?​

optional outerRadius: number

Outer radius ratio (0 to 1). Defaults to 1.

resizeObserver?​

optional resizeObserver: boolean

Defaults to true, meaning the chart will redraw when its container element resizes.

Inherited from​

BaseChartOptions.resizeObserver

showNeedle?​

optional showNeedle: boolean

Whether to show a needle/pointer. Defaults to true. When false, the zones are painted up to the value.

startAngle?​

optional startAngle: number

The start angle of the gauge in degrees. 0 is the top. Typically -135 for a speedometer style.

style?​

optional style: ChartStyleOptions

Styles for legend and grid.

Inherited from​

BaseChartOptions.style

subtitle?​

optional subtitle: SubtitleSpec

Subtitle for the chart.

Inherited from​

BaseChartOptions.subtitle

ticks?​

optional ticks: object

Configuration for tick marks.

color?​

optional color: string

Color to draw the ticks in

interval?​

optional interval: number

Interval between ticks (e.g. 10).

values?​

optional values: number[]

Explicit values at which to draw tick marks. If provided, interval is ignored.

width?​

optional width: number

Stroke width for the ticks. Defaults to 1.

title?​

optional title: ChartTitleSpec

Title for the chart.

Inherited from​

BaseChartOptions.title

titlePadding?​

optional titlePadding: number

Padding to leave underneath the title

Inherited from​

BaseChartOptions.titlePadding

tooltip?​

optional tooltip: TooltipOptions

Options for a tooltip for the chart.

Inherited from​

BaseChartOptions.tooltip

url?​

optional url: string

Optional URL from which to retrieve data to load into the chart

Inherited from​

BaseChartOptions.url

value?​

optional value: number

Current value. If not provided, the gauge will use the computed min (which you may have provided, but if not, will be set to 0)

width?​

optional width: number

Width for the chart. If omitted, width is computed from the width of the chart's container

Inherited from​

BaseChartOptions.width

zones?​

optional zones: GaugeChartZone[]

Optional segments to color the background arc

zoom?​

optional zoom: object

Optional zoom configuration.

enabled?​

optional enabled: boolean

Whether or not zoom is enabled.

initialValue?​

optional initialValue: number

Initial zoom value. Defaults to 1.

range?​

optional range: [number, number]

Zoom range to support. Defaults to [0.05, 3]

Inherited from​

BaseChartOptions.zoom