All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

There is a newer version: 0.1.0-alpha2
Show newest version
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) Point specific options for the
 * draggable-points module. Overrides options on series.dragDrop.
 *
 * Requires the draggable-points module.
 *
 * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop
 * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop
 * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop
 *
 */
public interface SeriesScatterDataDragDropOptions extends Any {
  /**
   * (Highcharts, Highstock, Highmaps) Enable dragging in the X dimension.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.draggableX
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.draggableX
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.draggableX
   *
   * @implspec draggableX?: boolean;
   *
   */
  @JSProperty("draggableX")
  boolean getDraggableX();

  /**
   * (Highcharts, Highstock, Highmaps) Enable dragging in the X dimension.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.draggableX
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.draggableX
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.draggableX
   *
   * @implspec draggableX?: boolean;
   *
   */
  @JSProperty("draggableX")
  void setDraggableX(boolean value);

  /**
   * (Highcharts, Highstock, Highmaps) Enable dragging in the Y dimension.
   * Note that this is not supported for TreeGrid axes (the default axis type
   * in Gantt charts).
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.draggableY
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.draggableY
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.draggableY
   *
   * @implspec draggableY?: boolean;
   *
   */
  @JSProperty("draggableY")
  boolean getDraggableY();

  /**
   * (Highcharts, Highstock, Highmaps) Enable dragging in the Y dimension.
   * Note that this is not supported for TreeGrid axes (the default axis type
   * in Gantt charts).
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.draggableY
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.draggableY
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.draggableY
   *
   * @implspec draggableY?: boolean;
   *
   */
  @JSProperty("draggableY")
  void setDraggableY(boolean value);

  /**
   * (Highcharts, Highstock, Highmaps) Options for the drag handles.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.dragHandle
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.dragHandle
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.dragHandle
   *
   * @implspec dragHandle?: SeriesScatterDataDragDropDragHandleOptions;
   *
   */
  @JSProperty("dragHandle")
  @Nullable
  SeriesScatterDataDragDropDragHandleOptions getDragHandle();

  /**
   * (Highcharts, Highstock, Highmaps) Options for the drag handles.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.dragHandle
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.dragHandle
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.dragHandle
   *
   * @implspec dragHandle?: SeriesScatterDataDragDropDragHandleOptions;
   *
   */
  @JSProperty("dragHandle")
  void setDragHandle(SeriesScatterDataDragDropDragHandleOptions value);

  /**
   * (Highcharts, Highstock, Highmaps) Set the maximum X value the points can
   * be moved to.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.dragMaxX
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.dragMaxX
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.dragMaxX
   *
   * @implspec dragMaxX?: number;
   *
   */
  @JSProperty("dragMaxX")
  double getDragMaxX();

  /**
   * (Highcharts, Highstock, Highmaps) Set the maximum X value the points can
   * be moved to.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.dragMaxX
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.dragMaxX
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.dragMaxX
   *
   * @implspec dragMaxX?: number;
   *
   */
  @JSProperty("dragMaxX")
  void setDragMaxX(double value);

  /**
   * (Highcharts, Highstock, Highmaps) Set the maximum Y value the points can
   * be moved to.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.dragMaxY
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.dragMaxY
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.dragMaxY
   *
   * @implspec dragMaxY?: number;
   *
   */
  @JSProperty("dragMaxY")
  double getDragMaxY();

  /**
   * (Highcharts, Highstock, Highmaps) Set the maximum Y value the points can
   * be moved to.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.dragMaxY
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.dragMaxY
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.dragMaxY
   *
   * @implspec dragMaxY?: number;
   *
   */
  @JSProperty("dragMaxY")
  void setDragMaxY(double value);

  /**
   * (Highcharts, Highstock, Highmaps) Set the minimum X value the points can
   * be moved to.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.dragMinX
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.dragMinX
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.dragMinX
   *
   * @implspec dragMinX?: number;
   *
   */
  @JSProperty("dragMinX")
  double getDragMinX();

  /**
   * (Highcharts, Highstock, Highmaps) Set the minimum X value the points can
   * be moved to.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.dragMinX
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.dragMinX
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.dragMinX
   *
   * @implspec dragMinX?: number;
   *
   */
  @JSProperty("dragMinX")
  void setDragMinX(double value);

  /**
   * (Highcharts, Highstock, Highmaps) Set the minimum Y value the points can
   * be moved to.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.dragMinY
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.dragMinY
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.dragMinY
   *
   * @implspec dragMinY?: number;
   *
   */
  @JSProperty("dragMinY")
  double getDragMinY();

  /**
   * (Highcharts, Highstock, Highmaps) Set the minimum Y value the points can
   * be moved to.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.dragMinY
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.dragMinY
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.dragMinY
   *
   * @implspec dragMinY?: number;
   *
   */
  @JSProperty("dragMinY")
  void setDragMinY(double value);

  /**
   * (Highcharts, Highstock, Highmaps) The X precision value to drag to for
   * this series. Set to 0 to disable. By default this is disabled, except for
   * category axes, where the default is 1.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.dragPrecisionX
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.dragPrecisionX
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.dragPrecisionX
   *
   * @implspec dragPrecisionX?: number;
   *
   */
  @JSProperty("dragPrecisionX")
  double getDragPrecisionX();

  /**
   * (Highcharts, Highstock, Highmaps) The X precision value to drag to for
   * this series. Set to 0 to disable. By default this is disabled, except for
   * category axes, where the default is 1.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.dragPrecisionX
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.dragPrecisionX
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.dragPrecisionX
   *
   * @implspec dragPrecisionX?: number;
   *
   */
  @JSProperty("dragPrecisionX")
  void setDragPrecisionX(double value);

  /**
   * (Highcharts, Highstock, Highmaps) The Y precision value to drag to for
   * this series. Set to 0 to disable. By default this is disabled, except for
   * category axes, where the default is 1.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.dragPrecisionY
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.dragPrecisionY
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.dragPrecisionY
   *
   * @implspec dragPrecisionY?: number;
   *
   */
  @JSProperty("dragPrecisionY")
  double getDragPrecisionY();

  /**
   * (Highcharts, Highstock, Highmaps) The Y precision value to drag to for
   * this series. Set to 0 to disable. By default this is disabled, except for
   * category axes, where the default is 1.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.dragPrecisionY
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.dragPrecisionY
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.dragPrecisionY
   *
   * @implspec dragPrecisionY?: number;
   *
   */
  @JSProperty("dragPrecisionY")
  void setDragPrecisionY(double value);

  /**
   * (Highcharts, Highstock, Highmaps) The amount of pixels to drag the
   * pointer before it counts as a drag operation. This prevents drag/drop to
   * fire when just clicking or selecting points.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.dragSensitivity
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.dragSensitivity
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.dragSensitivity
   *
   * @implspec dragSensitivity?: number;
   *
   */
  @JSProperty("dragSensitivity")
  double getDragSensitivity();

  /**
   * (Highcharts, Highstock, Highmaps) The amount of pixels to drag the
   * pointer before it counts as a drag operation. This prevents drag/drop to
   * fire when just clicking or selecting points.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.dragSensitivity
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.dragSensitivity
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.dragSensitivity
   *
   * @implspec dragSensitivity?: number;
   *
   */
  @JSProperty("dragSensitivity")
  void setDragSensitivity(double value);

  /**
   * (Highcharts, Highstock, Highmaps) Group the points by a property. Points
   * with the same property value will be grouped together when moving.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.groupBy
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.groupBy
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.groupBy
   *
   * @implspec groupBy?: string;
   *
   */
  @JSProperty("groupBy")
  @Nullable
  String getGroupBy();

  /**
   * (Highcharts, Highstock, Highmaps) Group the points by a property. Points
   * with the same property value will be grouped together when moving.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.groupBy
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.groupBy
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.groupBy
   *
   * @implspec groupBy?: string;
   *
   */
  @JSProperty("groupBy")
  void setGroupBy(String value);

  /**
   * (Highcharts, Highstock, Highmaps) Style options for the guide box. The
   * guide box has one state by default, the default state.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.guideBox
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.guideBox
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.guideBox
   *
   * @implspec guideBox?: (SeriesScatterDataDragDropGuideBoxOptions|Dictionary);
   *
   */
  @JSProperty("guideBox")
  @Nullable
  Unknown getGuideBox();

  /**
   * (Highcharts, Highstock, Highmaps) Style options for the guide box. The
   * guide box has one state by default, the default state.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.guideBox
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.guideBox
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.guideBox
   *
   * @implspec guideBox?: (SeriesScatterDataDragDropGuideBoxOptions|Dictionary);
   *
   */
  @JSProperty("guideBox")
  void setGuideBox(SeriesScatterDataDragDropGuideBoxOptions value);

  /**
   * (Highcharts, Highstock, Highmaps) Style options for the guide box. The
   * guide box has one state by default, the default state.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.guideBox
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.guideBox
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.guideBox
   *
   * @implspec guideBox?: (SeriesScatterDataDragDropGuideBoxOptions|Dictionary);
   *
   */
  @JSProperty("guideBox")
  void setGuideBox(Dictionary value);

  /**
   * (Highcharts, Highstock, Highmaps) Update points as they are dragged. If
   * false, a guide box is drawn to illustrate the new point size.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.liveRedraw
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.liveRedraw
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.liveRedraw
   *
   * @implspec liveRedraw?: boolean;
   *
   */
  @JSProperty("liveRedraw")
  boolean getLiveRedraw();

  /**
   * (Highcharts, Highstock, Highmaps) Update points as they are dragged. If
   * false, a guide box is drawn to illustrate the new point size.
   *
   * @see https://api.highcharts.com/highcharts/series.scatter.data.dragDrop.liveRedraw
   * @see https://api.highcharts.com/highstock/series.scatter.data.dragDrop.liveRedraw
   * @see https://api.highcharts.com/highmaps/series.scatter.data.dragDrop.liveRedraw
   *
   * @implspec liveRedraw?: boolean;
   *
   */
  @JSProperty("liveRedraw")
  void setLiveRedraw(boolean value);
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy