BootstrapChartBase.OnClientCustomizePoint Property

Specifies a client-side callback function that customizes the appearance of an individual series point on the client side.

Namespace: DevExpress.Web.Bootstrap

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

Declaration

[DefaultValue("")]
public string OnClientCustomizePoint { get; set; }
<DefaultValue("")>
Public Property OnClientCustomizePoint As String

Property Value

Type Default Description
String

String.Empty

A string specifying a JavaScript function that returns an object providing information about the series point.

Remarks

By default, all series points in a chart are identical, but you can specify a unique appearance for individual points using the OnClientCustomizePoint function. This function should return an object with options that will be changed for a certain point. See the BootstrapChartPointSettings object for information about all options available for changing.

Note

The BootstrapChartLegendSettings.HoverMode and BootstrapChartBase.PointSelectionMode properties cannot be changed using the OnClientCustomizePoint function, because they do not have anything to do with the appearance of series points.

The OnClientCustomizePoint function accepts an object providing information about the series point that the label belongs to. This object contains the following fields.

Field

Description

argument

The argument of the series point.

value

The value of the series point.

In the range bar and range area series, the value field is replaced by the BootstrapChartRangeSeriesBase.RangeValue1Field and BootstrapChartRangeSeriesBase.RangeValue2Field fields.

In the financial series (candlestick and stock), the value field is replaced by the BootstrapChartFinancialSeriesBase.OpenValueField, BootstrapChartFinancialSeriesBase.CloseValueField, BootstrapChartFinancialSeriesBase.LowValueField and BootstrapChartFinancialSeriesBase.HighValueField fields.

tag

The tag of the series point.

series

The series that includes the series point.

index

The index of the series point in the points array.

See Also