New to KendoReact? Start a free 30-day trial

GaugeConfig

Interface

Gauge-specific visualization configuration. Unlike Grid/Chart, a Gauge shows a single aggregated value (e.g. total revenue against a target), not per-row data.

Definition

Package:@progress/kendo-react-datainsights-composer

Properties

How valueField is aggregated across all rows into that single value.

color?

string

Color of the value pointer. Ignored when colors is set.

Color ranges applied to the value pointer based on the current value.

endAngle?

number

Angle in degrees where the scale ends. Arc, Circular and Radial only; ignored for Linear.

Scopes which rows feed the gauge's aggregate — e.g. a single entity ("SalesPerson is Amy Alberts") rather than every row. Unlike Grid/Chart's dataset.filter, a Gauge has no sort/take/aggregates (it reduces itself via aggregate instead), so this is a plain filter, not a nested dataset.

Which gauge shape renders the value. Falls back to 'Arc' when absent/unknown.

label?

string

Optional label shown below the gauge (e.g. units or context).

Distance between major scale ticks. Must be a positive number.

max

number

The maximum value of the gauge scale. Ignored in favor of targetField's aggregated value when that's set and computes to something greater than min.

min

number

The minimum value of the gauge scale.

Distance between minor scale ticks. Must be a positive number.

mirror?

boolean

Whether a Linear gauge mirrors its labels and ticks to the other side of the scale. Ignored for other shapes.

Direction of a Linear gauge. Defaults to 'Vertical'; ignored for other shapes.

Shape of a Linear gauge's pointer. Ignored for other shapes.

Thickness in pixels of the colored scale ranges.

reverse?

boolean

Whether to reverse the gauge scale direction.

Angle in degrees where the scale starts. Arc, Circular and Radial only; ignored for Linear.

Optional field aggregated the same way as valueField (same aggregate, same filter) to use as the gauge's dynamic max/target instead of the static max — e.g. compare SalesYTD against SalesQuota so the scale always matches the real target rather than a guessed round number.

Color of the unfilled track behind the value. Accepts valid CSS color strings.

The data field aggregated into the single value the gauge displays.