com.github.fluorumlabs.disconnect.highcharts.PlotSplineDragDropOptions 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
Show all versions of disconnect-highcharts Show documentation
Highcharts API bindings for Disconnect Zero
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) The draggable-points module allows points to be moved
* around or modified in the chart. In addition to the options mentioned under
* the dragDrop API structure, the module fires three events, point.dragStart,
* point.drag and point.drop.
*
* It requires the modules/draggable-points.js file to be loaded.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop
*
*/
public interface PlotSplineDragDropOptions extends Any {
/**
* (Highcharts, Highstock) Enable dragging in the X dimension.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop.draggableX
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.draggableX
*
* @implspec draggableX?: boolean;
*
*/
@JSProperty("draggableX")
boolean getDraggableX();
/**
* (Highcharts, Highstock) Enable dragging in the X dimension.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop.draggableX
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.draggableX
*
* @implspec draggableX?: boolean;
*
*/
@JSProperty("draggableX")
void setDraggableX(boolean value);
/**
* (Highcharts, Highstock) 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/plotOptions.spline.dragDrop.draggableY
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.draggableY
*
* @implspec draggableY?: boolean;
*
*/
@JSProperty("draggableY")
boolean getDraggableY();
/**
* (Highcharts, Highstock) 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/plotOptions.spline.dragDrop.draggableY
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.draggableY
*
* @implspec draggableY?: boolean;
*
*/
@JSProperty("draggableY")
void setDraggableY(boolean value);
/**
* (Highcharts, Highstock) Options for the drag handles.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop.dragHandle
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.dragHandle
*
* @implspec dragHandle?: PlotSplineDragDropDragHandleOptions;
*
*/
@JSProperty("dragHandle")
@Nullable
PlotSplineDragDropDragHandleOptions getDragHandle();
/**
* (Highcharts, Highstock) Options for the drag handles.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop.dragHandle
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.dragHandle
*
* @implspec dragHandle?: PlotSplineDragDropDragHandleOptions;
*
*/
@JSProperty("dragHandle")
void setDragHandle(PlotSplineDragDropDragHandleOptions value);
/**
* (Highcharts, Highstock) Set the maximum X value the points can be moved
* to.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop.dragMaxX
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.dragMaxX
*
* @implspec dragMaxX?: number;
*
*/
@JSProperty("dragMaxX")
double getDragMaxX();
/**
* (Highcharts, Highstock) Set the maximum X value the points can be moved
* to.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop.dragMaxX
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.dragMaxX
*
* @implspec dragMaxX?: number;
*
*/
@JSProperty("dragMaxX")
void setDragMaxX(double value);
/**
* (Highcharts, Highstock) Set the maximum Y value the points can be moved
* to.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop.dragMaxY
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.dragMaxY
*
* @implspec dragMaxY?: number;
*
*/
@JSProperty("dragMaxY")
double getDragMaxY();
/**
* (Highcharts, Highstock) Set the maximum Y value the points can be moved
* to.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop.dragMaxY
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.dragMaxY
*
* @implspec dragMaxY?: number;
*
*/
@JSProperty("dragMaxY")
void setDragMaxY(double value);
/**
* (Highcharts, Highstock) Set the minimum X value the points can be moved
* to.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop.dragMinX
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.dragMinX
*
* @implspec dragMinX?: number;
*
*/
@JSProperty("dragMinX")
double getDragMinX();
/**
* (Highcharts, Highstock) Set the minimum X value the points can be moved
* to.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop.dragMinX
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.dragMinX
*
* @implspec dragMinX?: number;
*
*/
@JSProperty("dragMinX")
void setDragMinX(double value);
/**
* (Highcharts, Highstock) Set the minimum Y value the points can be moved
* to.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop.dragMinY
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.dragMinY
*
* @implspec dragMinY?: number;
*
*/
@JSProperty("dragMinY")
double getDragMinY();
/**
* (Highcharts, Highstock) Set the minimum Y value the points can be moved
* to.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop.dragMinY
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.dragMinY
*
* @implspec dragMinY?: number;
*
*/
@JSProperty("dragMinY")
void setDragMinY(double value);
/**
* (Highcharts, Highstock) 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/plotOptions.spline.dragDrop.dragPrecisionX
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.dragPrecisionX
*
* @implspec dragPrecisionX?: number;
*
*/
@JSProperty("dragPrecisionX")
double getDragPrecisionX();
/**
* (Highcharts, Highstock) 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/plotOptions.spline.dragDrop.dragPrecisionX
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.dragPrecisionX
*
* @implspec dragPrecisionX?: number;
*
*/
@JSProperty("dragPrecisionX")
void setDragPrecisionX(double value);
/**
* (Highcharts, Highstock) 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/plotOptions.spline.dragDrop.dragPrecisionY
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.dragPrecisionY
*
* @implspec dragPrecisionY?: number;
*
*/
@JSProperty("dragPrecisionY")
double getDragPrecisionY();
/**
* (Highcharts, Highstock) 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/plotOptions.spline.dragDrop.dragPrecisionY
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.dragPrecisionY
*
* @implspec dragPrecisionY?: number;
*
*/
@JSProperty("dragPrecisionY")
void setDragPrecisionY(double value);
/**
* (Highcharts, Highstock) 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/plotOptions.spline.dragDrop.dragSensitivity
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.dragSensitivity
*
* @implspec dragSensitivity?: number;
*
*/
@JSProperty("dragSensitivity")
double getDragSensitivity();
/**
* (Highcharts, Highstock) 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/plotOptions.spline.dragDrop.dragSensitivity
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.dragSensitivity
*
* @implspec dragSensitivity?: number;
*
*/
@JSProperty("dragSensitivity")
void setDragSensitivity(double value);
/**
* (Highcharts, Highstock) Group the points by a property. Points with the
* same property value will be grouped together when moving.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop.groupBy
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.groupBy
*
* @implspec groupBy?: string;
*
*/
@JSProperty("groupBy")
@Nullable
String getGroupBy();
/**
* (Highcharts, Highstock) Group the points by a property. Points with the
* same property value will be grouped together when moving.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop.groupBy
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.groupBy
*
* @implspec groupBy?: string;
*
*/
@JSProperty("groupBy")
void setGroupBy(String value);
/**
* (Highcharts, Highstock) Style options for the guide box. The guide box
* has one state by default, the default state.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop.guideBox
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.guideBox
*
* @implspec guideBox?: (PlotSplineDragDropGuideBoxOptions|Dictionary);
*
*/
@JSProperty("guideBox")
@Nullable
Unknown getGuideBox();
/**
* (Highcharts, Highstock) Style options for the guide box. The guide box
* has one state by default, the default state.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop.guideBox
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.guideBox
*
* @implspec guideBox?: (PlotSplineDragDropGuideBoxOptions|Dictionary);
*
*/
@JSProperty("guideBox")
void setGuideBox(PlotSplineDragDropGuideBoxOptions value);
/**
* (Highcharts, Highstock) Style options for the guide box. The guide box
* has one state by default, the default state.
*
* @see https://api.highcharts.com/highcharts/plotOptions.spline.dragDrop.guideBox
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.guideBox
*
* @implspec guideBox?: (PlotSplineDragDropGuideBoxOptions|Dictionary);
*
*/
@JSProperty("guideBox")
void setGuideBox(Dictionary value);
/**
* (Highcharts, Highstock) 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/plotOptions.spline.dragDrop.liveRedraw
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.liveRedraw
*
* @implspec liveRedraw?: boolean;
*
*/
@JSProperty("liveRedraw")
boolean getLiveRedraw();
/**
* (Highcharts, Highstock) 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/plotOptions.spline.dragDrop.liveRedraw
* @see https://api.highcharts.com/highstock/plotOptions.spline.dragDrop.liveRedraw
*
* @implspec liveRedraw?: boolean;
*
*/
@JSProperty("liveRedraw")
void setLiveRedraw(boolean value);
}