• Home
• com.github.fluorumlabs.disconnect
• disconnect-highcharts
• 0.1.0-alpha1
• source code
• LegendNavigationOptions.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

package com.github.fluorumlabs.disconnect.highcharts;

import java.lang.String;
import javax.annotation.Nullable;
import js.lang.Any;
import js.lang.Unknown;
import org.teavm.jso.JSProperty;

/**
 * (Highcharts, Highstock, Highmaps) Options for the paging or navigation
 * appearing when the legend is overflown. Navigation works well on screen, but
 * not in static exported images. One way of working around that is to increase
 * the chart height in export.
 *
 * @see https://api.highcharts.com/highcharts/legend.navigation
 * @see https://api.highcharts.com/highstock/legend.navigation
 * @see https://api.highcharts.com/highmaps/legend.navigation
 *
 */
public interface LegendNavigationOptions extends Any {
  /**
   * (Highcharts, Highstock, Highmaps) The color for the active up or down
   * arrow in the legend page navigation.
   *
   * @see https://api.highcharts.com/highcharts/legend.navigation.activeColor
   * @see https://api.highcharts.com/highstock/legend.navigation.activeColor
   * @see https://api.highcharts.com/highmaps/legend.navigation.activeColor
   *
   * @implspec activeColor?: ColorString;
   *
   */
  @JSProperty("activeColor")
  @Nullable
  String getActiveColor();

  /**
   * (Highcharts, Highstock, Highmaps) The color for the active up or down
   * arrow in the legend page navigation.
   *
   * @see https://api.highcharts.com/highcharts/legend.navigation.activeColor
   * @see https://api.highcharts.com/highstock/legend.navigation.activeColor
   * @see https://api.highcharts.com/highmaps/legend.navigation.activeColor
   *
   * @implspec activeColor?: ColorString;
   *
   */
  @JSProperty("activeColor")
  void setActiveColor(String value);

  /**
   * (Highcharts, Highstock, Highmaps) How to animate the pages when
   * navigating up or down. A value of true applies the default navigation
   * given in the chart.animation option. Additional options can be given as
   * an object containing values for easing and duration.
   *
   * @see https://api.highcharts.com/highcharts/legend.navigation.animation
   * @see https://api.highcharts.com/highstock/legend.navigation.animation
   * @see https://api.highcharts.com/highmaps/legend.navigation.animation
   *
   * @implspec animation?: (boolean|AnimationOptionsObject);
   *
   */
  @JSProperty("animation")
  @Nullable
  Unknown getAnimation();

  /**
   * (Highcharts, Highstock, Highmaps) How to animate the pages when
   * navigating up or down. A value of true applies the default navigation
   * given in the chart.animation option. Additional options can be given as
   * an object containing values for easing and duration.
   *
   * @see https://api.highcharts.com/highcharts/legend.navigation.animation
   * @see https://api.highcharts.com/highstock/legend.navigation.animation
   * @see https://api.highcharts.com/highmaps/legend.navigation.animation
   *
   * @implspec animation?: (boolean|AnimationOptionsObject);
   *
   */
  @JSProperty("animation")
  void setAnimation(boolean value);

  /**
   * (Highcharts, Highstock, Highmaps) How to animate the pages when
   * navigating up or down. A value of true applies the default navigation
   * given in the chart.animation option. Additional options can be given as
   * an object containing values for easing and duration.
   *
   * @see https://api.highcharts.com/highcharts/legend.navigation.animation
   * @see https://api.highcharts.com/highstock/legend.navigation.animation
   * @see https://api.highcharts.com/highmaps/legend.navigation.animation
   *
   * @implspec animation?: (boolean|AnimationOptionsObject);
   *
   */
  @JSProperty("animation")
  void setAnimation(AnimationOptionsObject value);

  /**
   * (Highcharts, Highstock, Highmaps) The pixel size of the up and down
   * arrows in the legend paging navigation.
   *
   * @see https://api.highcharts.com/highcharts/legend.navigation.arrowSize
   * @see https://api.highcharts.com/highstock/legend.navigation.arrowSize
   * @see https://api.highcharts.com/highmaps/legend.navigation.arrowSize
   *
   * @implspec arrowSize?: number;
   *
   */
  @JSProperty("arrowSize")
  double getArrowSize();

  /**
   * (Highcharts, Highstock, Highmaps) The pixel size of the up and down
   * arrows in the legend paging navigation.
   *
   * @see https://api.highcharts.com/highcharts/legend.navigation.arrowSize
   * @see https://api.highcharts.com/highstock/legend.navigation.arrowSize
   * @see https://api.highcharts.com/highmaps/legend.navigation.arrowSize
   *
   * @implspec arrowSize?: number;
   *
   */
  @JSProperty("arrowSize")
  void setArrowSize(double value);

  /**
   * (Highcharts, Highstock, Highmaps) Whether to enable the legend
   * navigation. In most cases, disabling the navigation results in an
   * unwanted overflow.
   *
   * See also the adapt chart to legend plugin for a solution to extend the
   * chart height to make room for the legend, optionally in exported charts
   * only.
   *
   * @see https://api.highcharts.com/highcharts/legend.navigation.enabled
   * @see https://api.highcharts.com/highstock/legend.navigation.enabled
   * @see https://api.highcharts.com/highmaps/legend.navigation.enabled
   *
   * @implspec enabled?: boolean;
   *
   */
  @JSProperty("enabled")
  boolean getEnabled();

  /**
   * (Highcharts, Highstock, Highmaps) Whether to enable the legend
   * navigation. In most cases, disabling the navigation results in an
   * unwanted overflow.
   *
   * See also the adapt chart to legend plugin for a solution to extend the
   * chart height to make room for the legend, optionally in exported charts
   * only.
   *
   * @see https://api.highcharts.com/highcharts/legend.navigation.enabled
   * @see https://api.highcharts.com/highstock/legend.navigation.enabled
   * @see https://api.highcharts.com/highmaps/legend.navigation.enabled
   *
   * @implspec enabled?: boolean;
   *
   */
  @JSProperty("enabled")
  void setEnabled(boolean value);

  /**
   * (Highcharts, Highstock, Highmaps) The color of the inactive up or down
   * arrow in the legend page navigation. .
   *
   * @see https://api.highcharts.com/highcharts/legend.navigation.inactiveColor
   * @see https://api.highcharts.com/highstock/legend.navigation.inactiveColor
   * @see https://api.highcharts.com/highmaps/legend.navigation.inactiveColor
   *
   * @implspec inactiveColor?: ColorString;
   *
   */
  @JSProperty("inactiveColor")
  @Nullable
  String getInactiveColor();

  /**
   * (Highcharts, Highstock, Highmaps) The color of the inactive up or down
   * arrow in the legend page navigation. .
   *
   * @see https://api.highcharts.com/highcharts/legend.navigation.inactiveColor
   * @see https://api.highcharts.com/highstock/legend.navigation.inactiveColor
   * @see https://api.highcharts.com/highmaps/legend.navigation.inactiveColor
   *
   * @implspec inactiveColor?: ColorString;
   *
   */
  @JSProperty("inactiveColor")
  void setInactiveColor(String value);

  /**
   * (Highcharts, Highstock, Highmaps) Text styles for the legend page
   * navigation.
   *
   * @see https://api.highcharts.com/highcharts/legend.navigation.style
   * @see https://api.highcharts.com/highstock/legend.navigation.style
   * @see https://api.highcharts.com/highmaps/legend.navigation.style
   *
   * @implspec style?: CSSObject;
   *
   */
  @JSProperty("style")
  @Nullable
  CSSObject getStyle();

  /**
   * (Highcharts, Highstock, Highmaps) Text styles for the legend page
   * navigation.
   *
   * @see https://api.highcharts.com/highcharts/legend.navigation.style
   * @see https://api.highcharts.com/highstock/legend.navigation.style
   * @see https://api.highcharts.com/highmaps/legend.navigation.style
   *
   * @implspec style?: CSSObject;
   *
   */
  @JSProperty("style")
  void setStyle(CSSObject value);
}