BootstrapChartLegendSettings.OnClientCustomizeHint Property

Specifies a client callback function that returns the text for a hint that appears when a user hovers the mouse pointer over a legend item.

Namespace: DevExpress.Web.Bootstrap

Assembly: DevExpress.Web.Bootstrap.v18.2.dll

Declaration

C#

[DefaultValue("")]
public string OnClientCustomizeHint { get; set; }

VB.NET

<DefaultValue("")>
Public Property OnClientCustomizeHint As String

Property Value

Type	Default	Description
String	String.Empty	A string that represents either the name of a JavaScript function or the entire JavaScript function code that returns the text for the hint to display.

Property Paths

You can access this nested property as listed below:

Object Type	Path to OnClientCustomizeHint
BootstrapChart	.SettingsLegend.OnClientCustomizeHint
BootstrapChartBase	.SettingsLegend.OnClientCustomizeHint
BootstrapCoordinateSystemChart	.SettingsLegend.OnClientCustomizeHint
BootstrapPieChart	.SettingsLegend.OnClientCustomizeHint
BootstrapPolarChart	.SettingsLegend.OnClientCustomizeHint

Remarks

This property specifies a function that must return the required text. When implementing this function, use its parameter to access an object containing information on the series that corresponds to the legend item. This object contains the following fields.

• seriesName - The series’ name.
• seriesIndex - The series’ index.
• seriesColor - The series’ color.