Description

live example

Explore the API in the live example.

api reference

Description()

Component implementing the widget description feature. A description is a static pop-up label shown when the context menu is opened (historically on right mouse click). The description disappears once the mouse leaves the widget. When this component is available for a widget, its API is exposed directly via the widget's own namespace.

Description.description([content])

Enables/disables description for the current widget.

Parameters

Name	Type	Description
content	string	optionalContent of the description. Can be HTML formatted. If not provided, description is disabled.

Returns

Widget

Reference to the Widget's API.

Examples

// Enable description with the content 'Beautiful data'.
chart.description('Beautiful data')

// Disable description.
chart.description()