• Home
• com.github.fluorumlabs.disconnect
• disconnect-highcharts
• 0.1.0-alpha1
• source code
• PlotPolygonLabelOptions.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.PlotPolygonLabelOptions Maven / Gradle / Ivy

package com.github.fluorumlabs.disconnect.highcharts;

import javax.annotation.Nullable;
import js.lang.Any;
import js.util.collections.Array;
import org.teavm.jso.JSProperty;

/**
 * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
 * series as possible in a natural way, seeking to avoid other series. The goal
 * of this feature is to make the chart more easily readable, like if a human
 * designer placed the labels in the optimal position.
 *
 * The series labels currently work with series types having a graph or an
 * area.
 *
 * Requires the series-label.js module.
 *
 * @see https://api.highcharts.com/highcharts/plotOptions.polygon.label
 * @see https://api.highcharts.com/highstock/plotOptions.polygon.label
 * @see https://api.highcharts.com/gantt/plotOptions.polygon.label
 *
 */
public interface PlotPolygonLabelOptions extends Any {
  /**
   * (Highcharts, Highstock, Gantt) An array of boxes to avoid when laying out
   * the labels. Each item has a left, right, top and bottom property.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.polygon.label.boxesToAvoid
   * @see https://api.highcharts.com/highstock/plotOptions.polygon.label.boxesToAvoid
   * @see https://api.highcharts.com/gantt/plotOptions.polygon.label.boxesToAvoid
   *
   * @implspec boxesToAvoid?: Array;
   *
   */
  @JSProperty("boxesToAvoid")
  @Nullable
  Array getBoxesToAvoid();

  /**
   * (Highcharts, Highstock, Gantt) An array of boxes to avoid when laying out
   * the labels. Each item has a left, right, top and bottom property.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.polygon.label.boxesToAvoid
   * @see https://api.highcharts.com/highstock/plotOptions.polygon.label.boxesToAvoid
   * @see https://api.highcharts.com/gantt/plotOptions.polygon.label.boxesToAvoid
   *
   * @implspec boxesToAvoid?: Array;
   *
   */
  @JSProperty("boxesToAvoid")
  void setBoxesToAvoid(Array value);

  /**
   * (Highcharts, Highstock, Gantt) Allow labels to be placed distant to the
   * graph if necessary, and draw a connector line to the graph. Setting this
   * option to true may decrease the performance significantly, since the
   * algorithm with systematically search for open spaces in the while plot
   * area. Visually, it may also result in a more cluttered chart, though more
   * of the series will be labeled.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.polygon.label.connectorAllowed
   * @see https://api.highcharts.com/highstock/plotOptions.polygon.label.connectorAllowed
   * @see https://api.highcharts.com/gantt/plotOptions.polygon.label.connectorAllowed
   *
   * @implspec connectorAllowed?: boolean;
   *
   */
  @JSProperty("connectorAllowed")
  boolean getConnectorAllowed();

  /**
   * (Highcharts, Highstock, Gantt) Allow labels to be placed distant to the
   * graph if necessary, and draw a connector line to the graph. Setting this
   * option to true may decrease the performance significantly, since the
   * algorithm with systematically search for open spaces in the while plot
   * area. Visually, it may also result in a more cluttered chart, though more
   * of the series will be labeled.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.polygon.label.connectorAllowed
   * @see https://api.highcharts.com/highstock/plotOptions.polygon.label.connectorAllowed
   * @see https://api.highcharts.com/gantt/plotOptions.polygon.label.connectorAllowed
   *
   * @implspec connectorAllowed?: boolean;
   *
   */
  @JSProperty("connectorAllowed")
  void setConnectorAllowed(boolean value);

  /**
   * (Highcharts, Highstock, Gantt) If the label is closer than this to a
   * neighbour graph, draw a connector.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.polygon.label.connectorNeighbourDistance
   * @see https://api.highcharts.com/highstock/plotOptions.polygon.label.connectorNeighbourDistance
   * @see https://api.highcharts.com/gantt/plotOptions.polygon.label.connectorNeighbourDistance
   *
   * @implspec connectorNeighbourDistance?: number;
   *
   */
  @JSProperty("connectorNeighbourDistance")
  double getConnectorNeighbourDistance();

  /**
   * (Highcharts, Highstock, Gantt) If the label is closer than this to a
   * neighbour graph, draw a connector.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.polygon.label.connectorNeighbourDistance
   * @see https://api.highcharts.com/highstock/plotOptions.polygon.label.connectorNeighbourDistance
   * @see https://api.highcharts.com/gantt/plotOptions.polygon.label.connectorNeighbourDistance
   *
   * @implspec connectorNeighbourDistance?: number;
   *
   */
  @JSProperty("connectorNeighbourDistance")
  void setConnectorNeighbourDistance(double value);

  /**
   * (Highcharts, Highstock, Gantt) Enable the series label per series.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.polygon.label.enabled
   * @see https://api.highcharts.com/highstock/plotOptions.polygon.label.enabled
   * @see https://api.highcharts.com/gantt/plotOptions.polygon.label.enabled
   *
   * @implspec enabled?: boolean;
   *
   */
  @JSProperty("enabled")
  boolean getEnabled();

  /**
   * (Highcharts, Highstock, Gantt) Enable the series label per series.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.polygon.label.enabled
   * @see https://api.highcharts.com/highstock/plotOptions.polygon.label.enabled
   * @see https://api.highcharts.com/gantt/plotOptions.polygon.label.enabled
   *
   * @implspec enabled?: boolean;
   *
   */
  @JSProperty("enabled")
  void setEnabled(boolean value);

  /**
   * (Highcharts, Highstock, Gantt) For area-like series, allow the font size
   * to vary so that small areas get a smaller font size. The default applies
   * this effect to area-like series but not line-like series.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.polygon.label.maxFontSize
   * @see https://api.highcharts.com/highstock/plotOptions.polygon.label.maxFontSize
   * @see https://api.highcharts.com/gantt/plotOptions.polygon.label.maxFontSize
   *
   * @implspec maxFontSize?: (number|null);
   *
   */
  @JSProperty("maxFontSize")
  double getMaxFontSize();

  /**
   * (Highcharts, Highstock, Gantt) For area-like series, allow the font size
   * to vary so that small areas get a smaller font size. The default applies
   * this effect to area-like series but not line-like series.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.polygon.label.maxFontSize
   * @see https://api.highcharts.com/highstock/plotOptions.polygon.label.maxFontSize
   * @see https://api.highcharts.com/gantt/plotOptions.polygon.label.maxFontSize
   *
   * @implspec maxFontSize?: (number|null);
   *
   */
  @JSProperty("maxFontSize")
  void setMaxFontSize(double value);

  /**
   * (Highcharts, Highstock, Gantt) For area-like series, allow the font size
   * to vary so that small areas get a smaller font size. The default applies
   * this effect to area-like series but not line-like series.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.polygon.label.minFontSize
   * @see https://api.highcharts.com/highstock/plotOptions.polygon.label.minFontSize
   * @see https://api.highcharts.com/gantt/plotOptions.polygon.label.minFontSize
   *
   * @implspec minFontSize?: (number|null);
   *
   */
  @JSProperty("minFontSize")
  double getMinFontSize();

  /**
   * (Highcharts, Highstock, Gantt) For area-like series, allow the font size
   * to vary so that small areas get a smaller font size. The default applies
   * this effect to area-like series but not line-like series.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.polygon.label.minFontSize
   * @see https://api.highcharts.com/highstock/plotOptions.polygon.label.minFontSize
   * @see https://api.highcharts.com/gantt/plotOptions.polygon.label.minFontSize
   *
   * @implspec minFontSize?: (number|null);
   *
   */
  @JSProperty("minFontSize")
  void setMinFontSize(double value);

  /**
   * (Highcharts, Highstock, Gantt) Draw the label on the area of an area
   * series. By default it is drawn on the area. Set it to false to draw it
   * next to the graph instead.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.polygon.label.onArea
   * @see https://api.highcharts.com/highstock/plotOptions.polygon.label.onArea
   * @see https://api.highcharts.com/gantt/plotOptions.polygon.label.onArea
   *
   * @implspec onArea?: (boolean|null);
   *
   */
  @JSProperty("onArea")
  boolean getOnArea();

  /**
   * (Highcharts, Highstock, Gantt) Draw the label on the area of an area
   * series. By default it is drawn on the area. Set it to false to draw it
   * next to the graph instead.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.polygon.label.onArea
   * @see https://api.highcharts.com/highstock/plotOptions.polygon.label.onArea
   * @see https://api.highcharts.com/gantt/plotOptions.polygon.label.onArea
   *
   * @implspec onArea?: (boolean|null);
   *
   */
  @JSProperty("onArea")
  void setOnArea(boolean value);

  /**
   * (Highcharts, Highstock, Gantt) Styles for the series label. The color
   * defaults to the series color, or a contrast color if onArea.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.polygon.label.style
   * @see https://api.highcharts.com/highstock/plotOptions.polygon.label.style
   * @see https://api.highcharts.com/gantt/plotOptions.polygon.label.style
   *
   * @implspec style?: CSSObject;
   *
   */
  @JSProperty("style")
  @Nullable
  CSSObject getStyle();

  /**
   * (Highcharts, Highstock, Gantt) Styles for the series label. The color
   * defaults to the series color, or a contrast color if onArea.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.polygon.label.style
   * @see https://api.highcharts.com/highstock/plotOptions.polygon.label.style
   * @see https://api.highcharts.com/gantt/plotOptions.polygon.label.style
   *
   * @implspec style?: CSSObject;
   *
   */
  @JSProperty("style")
  void setStyle(CSSObject value);
}