com.github.fluorumlabs.disconnect.highcharts.PlotScatterPointEventsOptions 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.FunctionalInterface;
import javax.annotation.Nullable;
import js.lang.Any;
import org.teavm.jso.JSFunctor;
import org.teavm.jso.JSProperty;
/**
* (Highcharts, Highstock) Events for each single point.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events
*
*/
public interface PlotScatterPointEventsOptions extends Any {
/**
* (Highcharts, Highstock) Fires when a point is clicked. One parameter,
* event, is passed to the function, containing common event information.
*
* If the series.allowPointSelect option is true, the default action for
* the point's click event is to toggle the point's select state. Returning
* false cancels this action.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.click
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.click
*
* @implspec click?: SeriesPointClickCallbackFunction;
*
*/
@JSProperty("click")
@Nullable
SeriesPointClickCallbackFunction getClick();
/**
* (Highcharts, Highstock) Fires when a point is clicked. One parameter,
* event, is passed to the function, containing common event information.
*
* If the series.allowPointSelect option is true, the default action for
* the point's click event is to toggle the point's select state. Returning
* false cancels this action.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.click
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.click
*
* @implspec click?: SeriesPointClickCallbackFunction;
*
*/
@JSProperty("click")
void setClick(SeriesPointClickCallbackFunction value);
/**
* (Highcharts, Highstock) Callback that fires while dragging a point. The
* mouse event is passed in as parameter. The original data can be accessed
* from e.origin, and the new point values can be accessed from
* e.newPoints. If there is only a single point being updated, it can be
* accessed from e.newPoint for simplicity, and its ID can be accessed
* from e.newPointId. The this context is the point being dragged. To
* stop the default drag action, return false. See drag and drop options.
*
* Requires the draggable-points module.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.drag
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.drag
*
* @implspec drag?: SeriesPointDragCallbackFunction;
*
*/
@JSProperty("drag")
@Nullable
SeriesPointDragCallbackFunction getDrag();
/**
* (Highcharts, Highstock) Callback that fires while dragging a point. The
* mouse event is passed in as parameter. The original data can be accessed
* from e.origin, and the new point values can be accessed from
* e.newPoints. If there is only a single point being updated, it can be
* accessed from e.newPoint for simplicity, and its ID can be accessed
* from e.newPointId. The this context is the point being dragged. To
* stop the default drag action, return false. See drag and drop options.
*
* Requires the draggable-points module.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.drag
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.drag
*
* @implspec drag?: SeriesPointDragCallbackFunction;
*
*/
@JSProperty("drag")
void setDrag(SeriesPointDragCallbackFunction value);
/**
* (Highcharts, Highstock) Callback that fires when starting to drag a
* point. The mouse event object is passed in as an argument. If a drag
* handle is used, e.updateProp is set to the data property being dragged.
* The this context is the point. See drag and drop options.
*
* Requires the draggable-points module.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.dragStart
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.dragStart
*
* @implspec dragStart?: SeriesPointDragStartCallbackFunction;
*
*/
@JSProperty("dragStart")
@Nullable
SeriesPointDragStartCallbackFunction getDragStart();
/**
* (Highcharts, Highstock) Callback that fires when starting to drag a
* point. The mouse event object is passed in as an argument. If a drag
* handle is used, e.updateProp is set to the data property being dragged.
* The this context is the point. See drag and drop options.
*
* Requires the draggable-points module.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.dragStart
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.dragStart
*
* @implspec dragStart?: SeriesPointDragStartCallbackFunction;
*
*/
@JSProperty("dragStart")
void setDragStart(SeriesPointDragStartCallbackFunction value);
/**
* (Highcharts, Highstock) Callback that fires when the point is dropped.
* The parameters passed are the same as for drag. To stop the default drop
* action, return false. See drag and drop options.
*
* Requires the draggable-points module.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.drop
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.drop
*
* @implspec drop?: SeriesPointDropCallbackFunction;
*
*/
@JSProperty("drop")
@Nullable
SeriesPointDropCallbackFunction getDrop();
/**
* (Highcharts, Highstock) Callback that fires when the point is dropped.
* The parameters passed are the same as for drag. To stop the default drop
* action, return false. See drag and drop options.
*
* Requires the draggable-points module.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.drop
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.drop
*
* @implspec drop?: SeriesPointDropCallbackFunction;
*
*/
@JSProperty("drop")
void setDrop(SeriesPointDropCallbackFunction value);
/**
* (Highcharts, Highstock) Fires when the mouse leaves the area close to the
* point. One parameter, event, is passed to the function, containing
* common event information.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.mouseOut
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.mouseOut
*
* @implspec mouseOut?: () => void;
*
*/
@JSProperty("mouseOut")
@Nullable
MouseOut getMouseOut();
/**
* (Highcharts, Highstock) Fires when the mouse leaves the area close to the
* point. One parameter, event, is passed to the function, containing
* common event information.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.mouseOut
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.mouseOut
*
* @implspec mouseOut?: () => void;
*
*/
@JSProperty("mouseOut")
void setMouseOut(MouseOut value);
/**
* (Highcharts, Highstock) Fires when the mouse enters the area close to the
* point. One parameter, event, is passed to the function, containing
* common event information.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.mouseOver
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.mouseOver
*
* @implspec mouseOver?: () => void;
*
*/
@JSProperty("mouseOver")
@Nullable
MouseOver getMouseOver();
/**
* (Highcharts, Highstock) Fires when the mouse enters the area close to the
* point. One parameter, event, is passed to the function, containing
* common event information.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.mouseOver
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.mouseOver
*
* @implspec mouseOver?: () => void;
*
*/
@JSProperty("mouseOver")
void setMouseOver(MouseOver value);
/**
* (Highcharts, Highstock) Fires when the point is removed using the
* .remove() method. One parameter, event, is passed to the function.
* Returning false cancels the operation.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.remove
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.remove
*
* @implspec remove?: () => void;
*
*/
@JSProperty("remove")
@Nullable
Remove getRemove();
/**
* (Highcharts, Highstock) Fires when the point is removed using the
* .remove() method. One parameter, event, is passed to the function.
* Returning false cancels the operation.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.remove
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.remove
*
* @implspec remove?: () => void;
*
*/
@JSProperty("remove")
void setRemove(Remove value);
/**
* (Highcharts, Highstock) Fires when the point is selected either
* programmatically or following a click on the point. One parameter,
* event, is passed to the function. Returning false cancels the
* operation.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.select
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.select
*
* @implspec select?: () => void;
*
*/
@JSProperty("select")
@Nullable
Select getSelect();
/**
* (Highcharts, Highstock) Fires when the point is selected either
* programmatically or following a click on the point. One parameter,
* event, is passed to the function. Returning false cancels the
* operation.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.select
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.select
*
* @implspec select?: () => void;
*
*/
@JSProperty("select")
void setSelect(Select value);
/**
* (Highcharts, Highstock) Fires when the point is unselected either
* programmatically or following a click on the point. One parameter,
* event, is passed to the function. Returning false cancels the
* operation.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.unselect
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.unselect
*
* @implspec unselect?: () => void;
*
*/
@JSProperty("unselect")
@Nullable
Unselect getUnselect();
/**
* (Highcharts, Highstock) Fires when the point is unselected either
* programmatically or following a click on the point. One parameter,
* event, is passed to the function. Returning false cancels the
* operation.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.unselect
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.unselect
*
* @implspec unselect?: () => void;
*
*/
@JSProperty("unselect")
void setUnselect(Unselect value);
/**
* (Highcharts, Highstock) Fires when the point is updated programmatically
* through the .update() method. One parameter, event, is passed to the
* function. The new point options can be accessed through event.options.
* Returning false cancels the operation.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.update
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.update
*
* @implspec update?: () => void;
*
*/
@JSProperty("update")
@Nullable
Update getUpdate();
/**
* (Highcharts, Highstock) Fires when the point is updated programmatically
* through the .update() method. One parameter, event, is passed to the
* function. The new point options can be accessed through event.options.
* Returning false cancels the operation.
*
* @see https://api.highcharts.com/highcharts/plotOptions.scatter.point.events.update
* @see https://api.highcharts.com/highstock/plotOptions.scatter.point.events.update
*
* @implspec update?: () => void;
*
*/
@JSProperty("update")
void setUpdate(Update value);
/**
*/
@JSFunctor
@FunctionalInterface
interface MouseOut extends Any {
void apply();
}
/**
*/
@JSFunctor
@FunctionalInterface
interface MouseOver extends Any {
void apply();
}
/**
*/
@JSFunctor
@FunctionalInterface
interface Remove extends Any {
void apply();
}
/**
*/
@JSFunctor
@FunctionalInterface
interface Select extends Any {
void apply();
}
/**
*/
@JSFunctor
@FunctionalInterface
interface Unselect extends Any {
void apply();
}
/**
*/
@JSFunctor
@FunctionalInterface
interface Update extends Any {
void apply();
}
}