Interface: CaptionObject

Highcharts. CaptionObject

The chart caption. The caption has an update method that allows modifying the options directly or indirectly via chart.update.

Extends

Methods

fadeIn( [animation])

A general fadeIn method.

Parameters:
Name Type Argument Description
animation boolean | Highcharts.AnimationOptionsObject <optional>

The animation options for the element fade.

Inherited From:
Requires:
  • module:modules/drilldown

update(captionOptions [, redraw])

Modify options for the caption.

Parameters:
Name Type Argument Default Description
captionOptions Highcharts.CaptionOptions

Options to modify.

redraw boolean <optional>
true

Whether to redraw the chart after the caption is altered. If doing more operations on the chart, it is a good idea to set redraw to false and call Highcharts.Chart#redraw after.