New to Telerik UI for ASP.NET Core? Download free 30-day trial

ChartSeriesHighlightSettingsBuilder

Defines the fluent API for configuring ChartSeriesHighlightSettings

Methods

Border(System.Action)

The border of the highlighted chart series. The color is computed automatically from the base point color.

Parameters

configurator - System.Action<ChartSeriesHighlightBorderSettingsBuilder>

The configurator for the border setting.

Color(System.String)

The highlight color. Accepts a valid CSS color string, including hex and rgb.

Parameters

value - System.String

The value for Color

InactiveOpacity(System.Double)

The opacity of the series when another series is highlighted.

Parameters

value - System.Double

The value for InactiveOpacity

Line(System.Action)

The line of the highlighted chart series. The color is computed automatically from the base point color.

Parameters

configurator - System.Action<ChartSeriesHighlightLineSettingsBuilder>

The configurator for the line setting.

Opacity(System.Double)

The opacity of the highlighted points.

Parameters

value - System.Double

The value for Opacity

Toggle(System.String)

A function that can be used to handle toggling the points highlight. The available argument fields are: preventDefault - a function that can be used to prevent showing the default highlight overlay.; show - a boolean value indicating whether the highlight should be shown.; visual - the visual element that should be highlighted.; category - the point category.; dataItem - the point dataItem.; value - the point value. or series - the point series..

Parameters

handler - System.String

The name of the JavaScript function that will be evaluated.

Toggle(System.Func)

A function that can be used to handle toggling the points highlight. The available argument fields are: preventDefault - a function that can be used to prevent showing the default highlight overlay.; show - a boolean value indicating whether the highlight should be shown.; visual - the visual element that should be highlighted.; category - the point category.; dataItem - the point dataItem.; value - the point value. or series - the point series..

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

Visible(System.Boolean)

If set to true the chart will highlight the series when the user hovers it with the mouse. By default chart series highlighting is enabled.

Parameters

value - System.Boolean

The value for Visible

Visual(System.String)

A function that can be used to set custom visual for the point highlight.The available argument fields are: createVisual - a function that can be used to get the default highlight visual.; rect - the kendo.geometry.Rect that defines where the visual should be rendered.; visual - the visual element that should be highlighted.; options - the point options.; category - the point category.; dataItem - the point dataItem.; value - the point value.; sender - the chart instance.; series - the point series.; stackValue - the cumulative point value on the stack. Available only for stackable series.; percentage - the point value represented as a percentage value. Available only for donut, pie and 100% stacked charts.; runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series.; total - the sum of all previous series values. Available for waterfall series.; from - the "from" point highlight visual options. Available for "rangeArea" and "verticalRangeArea" series. or to - the "to" point highlight visual options. Available for "rangeArea" and "verticalRangeArea" series..

Parameters

handler - System.String

The name of the JavaScript function that will be evaluated.

Visual(System.Func)

A function that can be used to set custom visual for the point highlight.The available argument fields are: createVisual - a function that can be used to get the default highlight visual.; rect - the kendo.geometry.Rect that defines where the visual should be rendered.; visual - the visual element that should be highlighted.; options - the point options.; category - the point category.; dataItem - the point dataItem.; value - the point value.; sender - the chart instance.; series - the point series.; stackValue - the cumulative point value on the stack. Available only for stackable series.; percentage - the point value represented as a percentage value. Available only for donut, pie and 100% stacked charts.; runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series.; total - the sum of all previous series values. Available for waterfall series.; from - the "from" point highlight visual options. Available for "rangeArea" and "verticalRangeArea" series. or to - the "to" point highlight visual options. Available for "rangeArea" and "verticalRangeArea" series..

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

In this article
Not finding the help you need?