BootstrapChartBase.OnClientCustomizeLabel Property

Customizes the appearance of an individual point label on the client side.

Namespace: DevExpress.Web.Bootstrap

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

Declaration

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

Property Value

Type Default Description
String

String.Empty

An object providing information about the series point that the label belongs to.

Remarks

All point labels in a chart are identical by default, but you can specify a unique appearance for individual labels using the customizeLabel function. This function should return an object with options that will be changed for a certain label. See the BootstrapChartSeriesLabelSettings object for information about all options available for changing.

The OnClientCustomizeLabel 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.

Examples

This example demonstrates how you can use the OnClientCustomizeLabel property to make the label's background transparent.

function OnCustomizeLabel(pointInfo) {     
    return {
        backgroundColor: "transparent",
        font: {
            color: "black"
        }
    };
}
See Also