BootstrapChartLegendSettings.OnClientCustomizeText Property

Specifies a client callback function that returns the text to be displayed by a legend item.

Namespace: DevExpress.Web.Bootstrap

Assembly: DevExpress.Web.Bootstrap.v20.1.dll

Declaration

[DefaultValue("")]
public string OnClientCustomizeText { get; set; }
<DefaultValue("")>
Public Property OnClientCustomizeText 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 legend item to display.

Property Paths

You can access this nested property as listed below:

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

Remarks

By default, legend items identify series by color and name. You can also provide other information instead of the series name. To do this, implement a callback function for this property, and return the required text. Use the fields of the object passed as the function's parameter in the returned text. For instance, you can use the series name or index if it is more appropriate in your case. The object has the following structure:

  • seriesName - The series' name.
  • seriesIndex - The series' index.
  • seriesColor - The series' color.
See Also