com.github.fluorumlabs.disconnect.highcharts

Interface PlotAreaPointEventsOptions

All Superinterfaces:

Any, org.teavm.jso.JSObject

public interface PlotAreaPointEventsOptions
extends Any

(Highcharts, Highstock) Events for each single point.

See Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events, https://api.highcharts.com/highstock/plotOptions.area.point.events

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PlotAreaPointEventsOptions.MouseOut
static interface	PlotAreaPointEventsOptions.MouseOver
static interface	PlotAreaPointEventsOptions.Remove
static interface	PlotAreaPointEventsOptions.Select
static interface	PlotAreaPointEventsOptions.Unselect
static interface	PlotAreaPointEventsOptions.Update

Method Summary

Modifier and Type	Method and Description
SeriesPointClickCallbackFunction	getClick() (Highcharts, Highstock) Fires when a point is clicked.
SeriesPointDragCallbackFunction	getDrag() (Highcharts, Highstock) Callback that fires while dragging a point.
SeriesPointDragStartCallbackFunction	getDragStart() (Highcharts, Highstock) Callback that fires when starting to drag a point.
SeriesPointDropCallbackFunction	getDrop() (Highcharts, Highstock) Callback that fires when the point is dropped.
PlotAreaPointEventsOptions.MouseOut	getMouseOut() (Highcharts, Highstock) Fires when the mouse leaves the area close to the point.
PlotAreaPointEventsOptions.MouseOver	getMouseOver() (Highcharts, Highstock) Fires when the mouse enters the area close to the point.
PlotAreaPointEventsOptions.Remove	getRemove() (Highcharts, Highstock) Fires when the point is removed using the .remove() method.
PlotAreaPointEventsOptions.Select	getSelect() (Highcharts, Highstock) Fires when the point is selected either programmatically or following a click on the point.
PlotAreaPointEventsOptions.Unselect	getUnselect() (Highcharts, Highstock) Fires when the point is unselected either programmatically or following a click on the point.
PlotAreaPointEventsOptions.Update	getUpdate() (Highcharts, Highstock) Fires when the point is updated programmatically through the .update() method.
void	setClick(SeriesPointClickCallbackFunction value) (Highcharts, Highstock) Fires when a point is clicked.
void	setDrag(SeriesPointDragCallbackFunction value) (Highcharts, Highstock) Callback that fires while dragging a point.
void	setDragStart(SeriesPointDragStartCallbackFunction value) (Highcharts, Highstock) Callback that fires when starting to drag a point.
void	setDrop(SeriesPointDropCallbackFunction value) (Highcharts, Highstock) Callback that fires when the point is dropped.
void	setMouseOut(PlotAreaPointEventsOptions.MouseOut value) (Highcharts, Highstock) Fires when the mouse leaves the area close to the point.
void	setMouseOver(PlotAreaPointEventsOptions.MouseOver value) (Highcharts, Highstock) Fires when the mouse enters the area close to the point.
void	setRemove(PlotAreaPointEventsOptions.Remove value) (Highcharts, Highstock) Fires when the point is removed using the .remove() method.
void	setSelect(PlotAreaPointEventsOptions.Select value) (Highcharts, Highstock) Fires when the point is selected either programmatically or following a click on the point.
void	setUnselect(PlotAreaPointEventsOptions.Unselect value) (Highcharts, Highstock) Fires when the point is unselected either programmatically or following a click on the point.
void	setUpdate(PlotAreaPointEventsOptions.Update value) (Highcharts, Highstock) Fires when the point is updated programmatically through the .update() method.

Methods inherited from interface js.lang.Any

empty

Methods inherited from interface org.teavm.jso.JSObject

cast

Method Detail

getClick

@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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.click, https://api.highcharts.com/highstock/plotOptions.area.point.events.click

setClick

void setClick(SeriesPointClickCallbackFunction value)

(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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.click, https://api.highcharts.com/highstock/plotOptions.area.point.events.click

getDrag

@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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.drag, https://api.highcharts.com/highstock/plotOptions.area.point.events.drag

setDrag

void setDrag(SeriesPointDragCallbackFunction 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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.drag, https://api.highcharts.com/highstock/plotOptions.area.point.events.drag

getDragStart

@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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.dragStart, https://api.highcharts.com/highstock/plotOptions.area.point.events.dragStart

setDragStart

void setDragStart(SeriesPointDragStartCallbackFunction 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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.dragStart, https://api.highcharts.com/highstock/plotOptions.area.point.events.dragStart

getDrop

@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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.drop, https://api.highcharts.com/highstock/plotOptions.area.point.events.drop

setDrop

void setDrop(SeriesPointDropCallbackFunction 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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.drop, https://api.highcharts.com/highstock/plotOptions.area.point.events.drop

getMouseOut

@Nullable
PlotAreaPointEventsOptions.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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.mouseOut, https://api.highcharts.com/highstock/plotOptions.area.point.events.mouseOut

setMouseOut

void setMouseOut(PlotAreaPointEventsOptions.MouseOut 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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.mouseOut, https://api.highcharts.com/highstock/plotOptions.area.point.events.mouseOut

getMouseOver

@Nullable
PlotAreaPointEventsOptions.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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.mouseOver, https://api.highcharts.com/highstock/plotOptions.area.point.events.mouseOver

setMouseOver

void setMouseOver(PlotAreaPointEventsOptions.MouseOver 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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.mouseOver, https://api.highcharts.com/highstock/plotOptions.area.point.events.mouseOver

getRemove

@Nullable
PlotAreaPointEventsOptions.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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.remove, https://api.highcharts.com/highstock/plotOptions.area.point.events.remove

setRemove

void setRemove(PlotAreaPointEventsOptions.Remove 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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.remove, https://api.highcharts.com/highstock/plotOptions.area.point.events.remove

getSelect

@Nullable
PlotAreaPointEventsOptions.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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.select, https://api.highcharts.com/highstock/plotOptions.area.point.events.select

setSelect

void setSelect(PlotAreaPointEventsOptions.Select 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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.select, https://api.highcharts.com/highstock/plotOptions.area.point.events.select

getUnselect

@Nullable
PlotAreaPointEventsOptions.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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.unselect, https://api.highcharts.com/highstock/plotOptions.area.point.events.unselect

setUnselect

void setUnselect(PlotAreaPointEventsOptions.Unselect 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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.unselect, https://api.highcharts.com/highstock/plotOptions.area.point.events.unselect

getUpdate

@Nullable
PlotAreaPointEventsOptions.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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.update, https://api.highcharts.com/highstock/plotOptions.area.point.events.update

setUpdate

void setUpdate(PlotAreaPointEventsOptions.Update 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 Also:

https://api.highcharts.com/highcharts/plotOptions.area.point.events.update, https://api.highcharts.com/highstock/plotOptions.area.point.events.update