Vue PieChart - commonSeriesSettings.label

An object defining the label configuration options.

Type:

Object

Each series point can be accompanied by a text label that represents data related to the point. These are called series point labels. Use the label object's properties to set label options for the series.

View Demo

argumentFormat

Formats the point argument before it is displayed in the point label. To format the point value, use the format option.

Type:

Format

Default Value: undefined

NOTE
DevExtreme widgets provide a wide choice of predefined formats. If you are, however, going to use custom formats, link the Globalize library to your project. Learn how to do this from topics in the Installation section.
See Also
  • format - provides a comprehensive overview of formatting capabilities.
  • Data Formatting - shows how to apply formatting to various widget elements.

argumentPrecision Deprecated

Use the series.label.argumentFormat.precision instead.

Specifies a precision for formatted point arguments displayed in point labels.

Type:

Number

Default Value: undefined

backgroundColor

Colors the point labels' background. The default color is inherited from the points.

Type:

String

Default Value: undefined

This option supports the following colors:

You can remove the label's background by setting this option to "none". In this case, the label's text is the same color as the point.

border

Specifies border options for point labels.

Type:

Object

Use this object to make the borders of point labels visible/invisible and set up border options such as color and width.

connector

Specifies connector options for series point labels.

Type:

Object

A series point label can be placed separately near the represented point. To make the relationship between a label and its respective point clear, use a connector. Set the connector's visibility and appearance options using the connector object.

customizeText

Specifies a callback function that returns the text to be displayed by point labels.

Type:

Function

Function parameters:
pointInfo:

Object

Information on the series point.

Return Value:

String

The text for the label to display.

Cannot be used in themes.

When implementing a callback function for this property, use the point value to be displayed in a label. In addition, you can use the argument of the currently displayed value. These values can be accessed using the following properties of the this object.

  • value
    Specifies the value of the currently represented point.
  • valueText
    Specifies the value of the currently represented point with applied formatting if the format property is specified.
  • argument
    Specifies the argument value of the currently represented point.
  • argumentText
    Specifies the argument value of the currently represented point with applied formatting if the argumentFormat property is specified.
  • percent
    Specifies the proportional value of the currently represented point in a floating point format.
  • percentText
    Specifies the value of the currently represented point as a percentage with a precision of the format.percentPrecision option.
  • point.tag
    Specifies the tag of the currently represented point.
NOTE
As an alternative to the function’s parameter you can use the this keyword.
See Also

font

Specifies font options for the text displayed in point labels.

Type:

Object

format

Formats a value before it is displayed in a point label.

Type:

Format

Default Value: undefined

See the format section for details on accepted values.

See Also

percentPrecision Deprecated

Use the series.label.format.percentPrecision instead.

Specifies a precision for the percentage values displayed in labels.

Type:

Number

Default Value: undefined

position

Specifies a label position relative to the chart.

Type:

String

Default Value: 'outside'
Accepted Values: 'columns' | 'inside' | 'outside'

When using the widget as an ASP.NET MVC Control, specify this option using the PieChartLabelPosition enum. This enum accepts the following values: Outside, Inside and Columns.

View Demo

precision Deprecated

Use the series.label.format.precision option instead.

Specifies a precision for formatted point values displayed in point labels.

Type:

Number

Default Value: undefined

radialOffset

Specifies how to shift labels from their initial position in a radial direction in pixels.

Type:

Number

Default Value: 0

rotationAngle

Specifies the angle used to rotate point labels from their initial position.

Type:

Number

Default Value: 0

visible

Specifies the visibility of point labels.

Type:

Boolean

Default Value: false