com.github.fluorumlabs.disconnect.highcharts.ChartEventsOptions 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, Highmaps) Event listeners for the chart.
*
* @see https://api.highcharts.com/highcharts/chart.events
* @see https://api.highcharts.com/highstock/chart.events
* @see https://api.highcharts.com/highmaps/chart.events
*
*/
public interface ChartEventsOptions extends Any {
/**
* (Highcharts, Highstock, Highmaps) Fires when a series is added to the
* chart after load time, using the addSeries method. One parameter,
* event, is passed to the function, containing common event information.
* Through event.options you can access the series options that was passed
* to the addSeries method. Returning false prevents the series from being
* added.
*
* @see https://api.highcharts.com/highcharts/chart.events.addSeries
* @see https://api.highcharts.com/highstock/chart.events.addSeries
* @see https://api.highcharts.com/highmaps/chart.events.addSeries
*
* @implspec addSeries?: () => void;
*
*/
@JSProperty("addSeries")
@Nullable
AddSeries getAddSeries();
/**
* (Highcharts, Highstock, Highmaps) Fires when a series is added to the
* chart after load time, using the addSeries method. One parameter,
* event, is passed to the function, containing common event information.
* Through event.options you can access the series options that was passed
* to the addSeries method. Returning false prevents the series from being
* added.
*
* @see https://api.highcharts.com/highcharts/chart.events.addSeries
* @see https://api.highcharts.com/highstock/chart.events.addSeries
* @see https://api.highcharts.com/highmaps/chart.events.addSeries
*
* @implspec addSeries?: () => void;
*
*/
@JSProperty("addSeries")
void setAddSeries(AddSeries value);
/**
* (Highcharts, Highstock, Highmaps) Fires after a chart is printed through
* the context menu item or the Chart.print method. Requires the exporting
* module.
*
* @see https://api.highcharts.com/highcharts/chart.events.afterPrint
* @see https://api.highcharts.com/highstock/chart.events.afterPrint
* @see https://api.highcharts.com/highmaps/chart.events.afterPrint
*
* @implspec afterPrint?: () => void;
*
*/
@JSProperty("afterPrint")
@Nullable
AfterPrint getAfterPrint();
/**
* (Highcharts, Highstock, Highmaps) Fires after a chart is printed through
* the context menu item or the Chart.print method. Requires the exporting
* module.
*
* @see https://api.highcharts.com/highcharts/chart.events.afterPrint
* @see https://api.highcharts.com/highstock/chart.events.afterPrint
* @see https://api.highcharts.com/highmaps/chart.events.afterPrint
*
* @implspec afterPrint?: () => void;
*
*/
@JSProperty("afterPrint")
void setAfterPrint(AfterPrint value);
/**
* (Highcharts, Highstock, Highmaps) Fires before a chart is printed through
* the context menu item or the Chart.print method. Requires the exporting
* module.
*
* @see https://api.highcharts.com/highcharts/chart.events.beforePrint
* @see https://api.highcharts.com/highstock/chart.events.beforePrint
* @see https://api.highcharts.com/highmaps/chart.events.beforePrint
*
* @implspec beforePrint?: () => void;
*
*/
@JSProperty("beforePrint")
@Nullable
BeforePrint getBeforePrint();
/**
* (Highcharts, Highstock, Highmaps) Fires before a chart is printed through
* the context menu item or the Chart.print method. Requires the exporting
* module.
*
* @see https://api.highcharts.com/highcharts/chart.events.beforePrint
* @see https://api.highcharts.com/highstock/chart.events.beforePrint
* @see https://api.highcharts.com/highmaps/chart.events.beforePrint
*
* @implspec beforePrint?: () => void;
*
*/
@JSProperty("beforePrint")
void setBeforePrint(BeforePrint value);
/**
* (Highcharts, Highstock, Highmaps) Fires when clicking on the plot
* background. One parameter, event, is passed to the function, containing
* common event information.
*
* Information on the clicked spot can be found through event.xAxis and
* event.yAxis, which are arrays containing the axes of each dimension and
* each axis' value at the clicked spot. The primary axes are
* event.xAxis[0] and event.yAxis[0]. Remember the unit of a datetime
* axis is milliseconds since 1970-01-01 00:00:00.
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/chart.events.click
* @see https://api.highcharts.com/highstock/chart.events.click
* @see https://api.highcharts.com/highmaps/chart.events.click
*
* @implspec click?: () => void;
*
*/
@JSProperty("click")
@Nullable
Click getClick();
/**
* (Highcharts, Highstock, Highmaps) Fires when clicking on the plot
* background. One parameter, event, is passed to the function, containing
* common event information.
*
* Information on the clicked spot can be found through event.xAxis and
* event.yAxis, which are arrays containing the axes of each dimension and
* each axis' value at the clicked spot. The primary axes are
* event.xAxis[0] and event.yAxis[0]. Remember the unit of a datetime
* axis is milliseconds since 1970-01-01 00:00:00.
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/chart.events.click
* @see https://api.highcharts.com/highstock/chart.events.click
* @see https://api.highcharts.com/highmaps/chart.events.click
*
* @implspec click?: () => void;
*
*/
@JSProperty("click")
void setClick(Click value);
/**
* (Highcharts, Highmaps) Fires when a drilldown point is clicked, before
* the new series is added. This event is also utilized for async drilldown,
* where the seriesOptions are not added by option, but rather loaded async.
* Note that when clicking a category label to trigger multiple series
* drilldown, one drilldown event is triggered per point in the category.
*
* Event arguments:
*
*
* -
*
category: If a category label was clicked, which index.
*
*
* -
*
originalEvent: The original browser event (usually click) that
* triggered the drilldown.
*
*
* -
*
point: The originating point.
*
*
* -
*
points: If a category label was clicked, this array holds all points
* corresponing to the category.
*
*
* -
*
seriesOptions: Options for the new series.
*
*
*
* @see https://api.highcharts.com/highcharts/chart.events.drilldown
* @see https://api.highcharts.com/highmaps/chart.events.drilldown
*
* @implspec drilldown?: DrilldownCallbackFunction;
*
*/
@JSProperty("drilldown")
@Nullable
DrilldownCallbackFunction getDrilldown();
/**
* (Highcharts, Highmaps) Fires when a drilldown point is clicked, before
* the new series is added. This event is also utilized for async drilldown,
* where the seriesOptions are not added by option, but rather loaded async.
* Note that when clicking a category label to trigger multiple series
* drilldown, one drilldown event is triggered per point in the category.
*
* Event arguments:
*
*
* -
*
category: If a category label was clicked, which index.
*
*
* -
*
originalEvent: The original browser event (usually click) that
* triggered the drilldown.
*
*
* -
*
point: The originating point.
*
*
* -
*
points: If a category label was clicked, this array holds all points
* corresponing to the category.
*
*
* -
*
seriesOptions: Options for the new series.
*
*
*
* @see https://api.highcharts.com/highcharts/chart.events.drilldown
* @see https://api.highcharts.com/highmaps/chart.events.drilldown
*
* @implspec drilldown?: DrilldownCallbackFunction;
*
*/
@JSProperty("drilldown")
void setDrilldown(DrilldownCallbackFunction value);
/**
* (Highcharts, Highmaps) Fires when drilling up from a drilldown series.
*
* @see https://api.highcharts.com/highcharts/chart.events.drillup
* @see https://api.highcharts.com/highmaps/chart.events.drillup
*
* @implspec drillup?: DrillupCallbackFunction;
*
*/
@JSProperty("drillup")
@Nullable
DrillupCallbackFunction getDrillup();
/**
* (Highcharts, Highmaps) Fires when drilling up from a drilldown series.
*
* @see https://api.highcharts.com/highcharts/chart.events.drillup
* @see https://api.highcharts.com/highmaps/chart.events.drillup
*
* @implspec drillup?: DrillupCallbackFunction;
*
*/
@JSProperty("drillup")
void setDrillup(DrillupCallbackFunction value);
/**
* (Highcharts, Highmaps) In a chart with multiple drilldown series, this
* event fires after all the series have been drilled up.
*
* @see https://api.highcharts.com/highcharts/chart.events.drillupall
* @see https://api.highcharts.com/highmaps/chart.events.drillupall
*
* @implspec drillupall?: DrillupAllCallbackFunction;
*
*/
@JSProperty("drillupall")
@Nullable
DrillupAllCallbackFunction getDrillupall();
/**
* (Highcharts, Highmaps) In a chart with multiple drilldown series, this
* event fires after all the series have been drilled up.
*
* @see https://api.highcharts.com/highcharts/chart.events.drillupall
* @see https://api.highcharts.com/highmaps/chart.events.drillupall
*
* @implspec drillupall?: DrillupAllCallbackFunction;
*
*/
@JSProperty("drillupall")
void setDrillupall(DrillupAllCallbackFunction value);
/**
* (Highcharts, Highstock, Highmaps) Fires when the chart is finished
* loading. Since v4.2.2, it also waits for images to be loaded, for example
* from point markers. One parameter, event, is passed to the function,
* containing common event information.
*
* There is also a second parameter to the chart constructor where a
* callback function can be passed to be executed on chart.load.
*
* @see https://api.highcharts.com/highcharts/chart.events.load
* @see https://api.highcharts.com/highstock/chart.events.load
* @see https://api.highcharts.com/highmaps/chart.events.load
*
* @implspec load?: () => void;
*
*/
@JSProperty("load")
@Nullable
Load getLoad();
/**
* (Highcharts, Highstock, Highmaps) Fires when the chart is finished
* loading. Since v4.2.2, it also waits for images to be loaded, for example
* from point markers. One parameter, event, is passed to the function,
* containing common event information.
*
* There is also a second parameter to the chart constructor where a
* callback function can be passed to be executed on chart.load.
*
* @see https://api.highcharts.com/highcharts/chart.events.load
* @see https://api.highcharts.com/highstock/chart.events.load
* @see https://api.highcharts.com/highmaps/chart.events.load
*
* @implspec load?: () => void;
*
*/
@JSProperty("load")
void setLoad(Load value);
/**
* (Highcharts, Highstock, Highmaps) Fires when the chart is redrawn, either
* after a call to chart.redraw() or after an axis, series or point is
* modified with the redraw option set to true. One parameter, event, is
* passed to the function, containing common event information.
*
* @see https://api.highcharts.com/highcharts/chart.events.redraw
* @see https://api.highcharts.com/highstock/chart.events.redraw
* @see https://api.highcharts.com/highmaps/chart.events.redraw
*
* @implspec redraw?: () => void;
*
*/
@JSProperty("redraw")
@Nullable
Redraw getRedraw();
/**
* (Highcharts, Highstock, Highmaps) Fires when the chart is redrawn, either
* after a call to chart.redraw() or after an axis, series or point is
* modified with the redraw option set to true. One parameter, event, is
* passed to the function, containing common event information.
*
* @see https://api.highcharts.com/highcharts/chart.events.redraw
* @see https://api.highcharts.com/highstock/chart.events.redraw
* @see https://api.highcharts.com/highmaps/chart.events.redraw
*
* @implspec redraw?: () => void;
*
*/
@JSProperty("redraw")
void setRedraw(Redraw value);
/**
* (Highcharts, Highstock, Highmaps) Fires after initial load of the chart
* (directly after the load event), and after each redraw (directly after
* the redraw event).
*
* @see https://api.highcharts.com/highcharts/chart.events.render
* @see https://api.highcharts.com/highstock/chart.events.render
* @see https://api.highcharts.com/highmaps/chart.events.render
*
* @implspec render?: () => void;
*
*/
@JSProperty("render")
@Nullable
Render getRender();
/**
* (Highcharts, Highstock, Highmaps) Fires after initial load of the chart
* (directly after the load event), and after each redraw (directly after
* the redraw event).
*
* @see https://api.highcharts.com/highcharts/chart.events.render
* @see https://api.highcharts.com/highstock/chart.events.render
* @see https://api.highcharts.com/highmaps/chart.events.render
*
* @implspec render?: () => void;
*
*/
@JSProperty("render")
void setRender(Render value);
/**
* (Highcharts, Highstock, Highmaps) Fires when an area of the chart has
* been selected. Selection is enabled by setting the chart's zoomType. One
* parameter, event, is passed to the function, containing common event
* information. The default action for the selection event is to zoom the
* chart to the selected area. It can be prevented by calling
* event.preventDefault() or return false.
*
* Information on the selected area can be found through event.xAxis and
* event.yAxis, which are arrays containing the axes of each dimension and
* each axis' min and max values. The primary axes are event.xAxis[0] and
* event.yAxis[0]. Remember the unit of a datetime axis is milliseconds
* since 1970-01-01 00:00:00.
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/chart.events.selection
* @see https://api.highcharts.com/highstock/chart.events.selection
* @see https://api.highcharts.com/highmaps/chart.events.selection
*
* @implspec selection?: ChartSelectionCallbackFunction;
*
*/
@JSProperty("selection")
@Nullable
ChartSelectionCallbackFunction getSelection();
/**
* (Highcharts, Highstock, Highmaps) Fires when an area of the chart has
* been selected. Selection is enabled by setting the chart's zoomType. One
* parameter, event, is passed to the function, containing common event
* information. The default action for the selection event is to zoom the
* chart to the selected area. It can be prevented by calling
* event.preventDefault() or return false.
*
* Information on the selected area can be found through event.xAxis and
* event.yAxis, which are arrays containing the axes of each dimension and
* each axis' min and max values. The primary axes are event.xAxis[0] and
* event.yAxis[0]. Remember the unit of a datetime axis is milliseconds
* since 1970-01-01 00:00:00.
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/chart.events.selection
* @see https://api.highcharts.com/highstock/chart.events.selection
* @see https://api.highcharts.com/highmaps/chart.events.selection
*
* @implspec selection?: ChartSelectionCallbackFunction;
*
*/
@JSProperty("selection")
void setSelection(ChartSelectionCallbackFunction value);
/**
*/
@JSFunctor
@FunctionalInterface
interface AddSeries extends Any {
void apply();
}
/**
*/
@JSFunctor
@FunctionalInterface
interface AfterPrint extends Any {
void apply();
}
/**
*/
@JSFunctor
@FunctionalInterface
interface BeforePrint extends Any {
void apply();
}
/**
*/
@JSFunctor
@FunctionalInterface
interface Click extends Any {
void apply();
}
/**
*/
@JSFunctor
@FunctionalInterface
interface Load extends Any {
void apply();
}
/**
*/
@JSFunctor
@FunctionalInterface
interface Redraw extends Any {
void apply();
}
/**
*/
@JSFunctor
@FunctionalInterface
interface Render extends Any {
void apply();
}
}