com.github.fluorumlabs.disconnect.highcharts.SubtitleObject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of disconnect-highcharts Show documentation

Highcharts API bindings for Disconnect Zero

There is a newer version: 0.1.0-alpha2

Show newest version

package com.github.fluorumlabs.disconnect.highcharts;

/**
 * The chart subtitle. The subtitle has an update method that allows modifying
 * the options directly or indirectly via chart.update.
 *
 */
public interface SubtitleObject extends SVGElement {
  /**
   * Modify options for the subtitle.
   *
   * @param subtitleOptions
   * Options to modify.
   *
   * @param redraw
   * Wether to redraw the chart.
   *
   * @implspec update(subtitleOptions: SubtitleOptions, redraw?: boolean): void;
   *
   */
  void update(SubtitleOptions subtitleOptions);

  /**
   * Modify options for the subtitle.
   *
   * @param subtitleOptions
   * Options to modify.
   *
   * @param redraw
   * Wether to redraw the chart.
   *
   * @implspec update(subtitleOptions: SubtitleOptions, redraw?: boolean): void;
   *
   */
  void update(SubtitleOptions subtitleOptions, boolean redraw);
}