Box
Map
Vue
A newer version of this page is available. Switch to the current version.

JavaScript/jQuery PolarChart - title.subtitle

Configures the UI component's subtitle.

Type:

Object

|

String

If you need to specify the subtitle's text only, assign it directly to this property. Otherwise, set this property to an object with the text and other fields specified.

font

Specifies font properties for the subtitle.

Type:

Object

offset

Specifies the distance between the title and subtitle in pixels.

Type:

Number

Default Value: 0

text

Specifies text for the subtitle.

Type:

String

Default Value: null

textOverflow

Specifies what to do with the subtitle when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing.

Type:

String

Default Value: 'ellipsis'
Accepted Values: 'ellipsis' | 'hide' | 'none'

wordWrap

Specifies how to wrap the subtitle if it does not fit into a single line.

Type:

String

Default Value: 'normal'
Accepted Values: 'normal' | 'breakWord' | 'none'

The following modes are available:

  • "normal"
    Text breaks only at allowed breakpoints (for example, a space between two words).

  • "breakWord"
    Words can be broken if there are no available breakpoints in the line.

  • "none"
    Word wrap is disabled.

If the text overflows the container even after word wrap, the UI component applies the textOverflow property.