New to Kendo UI for Angular? Start a free 30-day trial

SeriesHighlight

The configuration options of the series highlight.

border?

Border

The border of the highlighted Chart series. The color is computed automatically from the base point color. The border option is supported when series.type is set to "donut", "bubble", "pie", "candlestick", or "ohlc".

color?

string

The highlight color. Accepts a valid CSS color string, including hex and rgb. The color option is supported when series.type is set to "donut" or "pie".

inactiveOpacity?

number

The opacity of the series when another series is highlighted.

line?

HighlightLine

The line of the highlighted Chart series. The color is computed automatically from the base point color. The line option is supported when series.type is set to "candlestick" or "ohlc".

markers?

MarkersHighlight

The appearance of the highlighted point markers. The markers option is supported when series.type is set to "line", "area", "scatter", "scatterLine", or "rangeArea".

opacity?

number

The opacity of the highlighted points. The opacity option is supported when series.type is set to "bubble", "pie", or "donut".

toggle?

(e: HighlightToggleArgs) => void

A function for handling the toggling of the points highlight.

The available argument fields are:

  • preventDefaultA function that can be used to prevent the showing of the default highlight overlay.
  • showA Boolean value indicating whether the highlight has to be shown.
  • visualThe visual element that needs to be highlighted.
  • categoryThe point category.
  • dataItemThe point dataItem.
  • valueThe point value.
  • seriesThe point series.

visible?

boolean

If set to true, the Chart highlights the series when the user hovers over it with the mouse. By default, the highlighting of the Chart series is enabled.

visual?

(e: HighlightVisualArgs) => Element

A function for setting custom visuals for the point highlights.

The available argument fields are:

  • createVisualA function that can be used to get the default highlight visual.
  • rectThe geometry Rect that defines where the visual has to be rendered.
  • visualThe visual element that needs to be highlighted.
  • optionsThe point options.
  • categoryThe point category.
  • dataItemThe point dataItem.
  • valueThe point value.
  • senderThe Chart instance.
  • seriesThe point series.
  • stackValueThe cumulative point value on the stack. Available only for the stackable series.
  • percentageThe point value represented as a percentage value. Available only for the Donut, Pie, and 100% stacked charts.
  • runningTotalThe sum of point values since the last "runningTotal" summary point. Available for the Waterfall series.
  • totalThe sum of all previous series values. Available for the Waterfall series.
  • fromThe from point highlight visual options. Available for the RangeArea and VerticalRangeArea series.
  • toThe to point highlight visual options. Available for the RangeArea and VerticalRangeArea series.