com.github.fluorumlabs.disconnect.highcharts.PlotWaterfallEventsOptions 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) General event handlers for the series items. These event hooks
* can also be attached to the series at run time using the
* Highcharts.addEvent function.
*
* @see https://api.highcharts.com/highcharts/plotOptions.waterfall.events
*
*/
public interface PlotWaterfallEventsOptions extends Any {
/**
* (Highcharts, Highstock, Gantt) Fires after the series has finished its
* initial animation, or in case animation is disabled, immediately as the
* series is displayed.
*
* @see https://api.highcharts.com/highcharts/plotOptions.waterfall.events.afterAnimate
* @see https://api.highcharts.com/highstock/plotOptions.waterfall.events.afterAnimate
* @see https://api.highcharts.com/gantt/plotOptions.waterfall.events.afterAnimate
*
* @implspec afterAnimate?: SeriesAfterAnimateCallbackFunction;
*
*/
@JSProperty("afterAnimate")
@Nullable
SeriesAfterAnimateCallbackFunction getAfterAnimate();
/**
* (Highcharts, Highstock, Gantt) Fires after the series has finished its
* initial animation, or in case animation is disabled, immediately as the
* series is displayed.
*
* @see https://api.highcharts.com/highcharts/plotOptions.waterfall.events.afterAnimate
* @see https://api.highcharts.com/highstock/plotOptions.waterfall.events.afterAnimate
* @see https://api.highcharts.com/gantt/plotOptions.waterfall.events.afterAnimate
*
* @implspec afterAnimate?: SeriesAfterAnimateCallbackFunction;
*
*/
@JSProperty("afterAnimate")
void setAfterAnimate(SeriesAfterAnimateCallbackFunction value);
/**
* (Highcharts) Fires when the checkbox next to the series' name in the
* legend is clicked. One parameter, event, is passed to the function. The
* state of the checkbox is found by event.checked. The checked item is
* found by event.item. Return false to prevent the default action which
* is to toggle the select state of the series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.waterfall.events.checkboxClick
*
* @implspec checkboxClick?: SeriesCheckboxClickCallbackFunction;
*
*/
@JSProperty("checkboxClick")
@Nullable
SeriesCheckboxClickCallbackFunction getCheckboxClick();
/**
* (Highcharts) Fires when the checkbox next to the series' name in the
* legend is clicked. One parameter, event, is passed to the function. The
* state of the checkbox is found by event.checked. The checked item is
* found by event.item. Return false to prevent the default action which
* is to toggle the select state of the series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.waterfall.events.checkboxClick
*
* @implspec checkboxClick?: SeriesCheckboxClickCallbackFunction;
*
*/
@JSProperty("checkboxClick")
void setCheckboxClick(SeriesCheckboxClickCallbackFunction value);
/**
* (Highcharts) Fires when the series is clicked. One parameter, event, is
* passed to the function, containing common event information.
* Additionally, event.point holds a pointer to the nearest point on the
* graph.
*
* @see https://api.highcharts.com/highcharts/plotOptions.waterfall.events.click
*
* @implspec click?: SeriesClickCallbackFunction;
*
*/
@JSProperty("click")
@Nullable
SeriesClickCallbackFunction getClick();
/**
* (Highcharts) Fires when the series is clicked. One parameter, event, is
* passed to the function, containing common event information.
* Additionally, event.point holds a pointer to the nearest point on the
* graph.
*
* @see https://api.highcharts.com/highcharts/plotOptions.waterfall.events.click
*
* @implspec click?: SeriesClickCallbackFunction;
*
*/
@JSProperty("click")
void setClick(SeriesClickCallbackFunction value);
/**
* (Highcharts) Fires when the series is hidden after chart generation time,
* either by clicking the legend item or by calling .hide().
*
* @see https://api.highcharts.com/highcharts/plotOptions.waterfall.events.hide
*
* @implspec hide?: () => void;
*
*/
@JSProperty("hide")
@Nullable
Hide getHide();
/**
* (Highcharts) Fires when the series is hidden after chart generation time,
* either by clicking the legend item or by calling .hide().
*
* @see https://api.highcharts.com/highcharts/plotOptions.waterfall.events.hide
*
* @implspec hide?: () => void;
*
*/
@JSProperty("hide")
void setHide(Hide value);
/**
* (Highcharts) Fires when the legend item belonging to the series is
* clicked. One parameter, event, is passed to the function. The default
* action is to toggle the visibility of the series. This can be prevented
* by returning false or calling event.preventDefault().
*
* @see https://api.highcharts.com/highcharts/plotOptions.waterfall.events.legendItemClick
*
* @implspec legendItemClick?: () => void;
*
*/
@JSProperty("legendItemClick")
@Nullable
LegendItemClick getLegendItemClick();
/**
* (Highcharts) Fires when the legend item belonging to the series is
* clicked. One parameter, event, is passed to the function. The default
* action is to toggle the visibility of the series. This can be prevented
* by returning false or calling event.preventDefault().
*
* @see https://api.highcharts.com/highcharts/plotOptions.waterfall.events.legendItemClick
*
* @implspec legendItemClick?: () => void;
*
*/
@JSProperty("legendItemClick")
void setLegendItemClick(LegendItemClick value);
/**
* (Highcharts) Fires when the mouse leaves the graph. One parameter,
* event, is passed to the function, containing common event information.
* If the stickyTracking option is true, mouseOut doesn't happen before
* the mouse enters another graph or leaves the plot area.
*
* @see https://api.highcharts.com/highcharts/plotOptions.waterfall.events.mouseOut
*
* @implspec mouseOut?: () => void;
*
*/
@JSProperty("mouseOut")
@Nullable
MouseOut getMouseOut();
/**
* (Highcharts) Fires when the mouse leaves the graph. One parameter,
* event, is passed to the function, containing common event information.
* If the stickyTracking option is true, mouseOut doesn't happen before
* the mouse enters another graph or leaves the plot area.
*
* @see https://api.highcharts.com/highcharts/plotOptions.waterfall.events.mouseOut
*
* @implspec mouseOut?: () => void;
*
*/
@JSProperty("mouseOut")
void setMouseOut(MouseOut value);
/**
* (Highcharts) Fires when the mouse enters the graph. One parameter,
* event, is passed to the function, containing common event information.
*
* @see https://api.highcharts.com/highcharts/plotOptions.waterfall.events.mouseOver
*
* @implspec mouseOver?: () => void;
*
*/
@JSProperty("mouseOver")
@Nullable
MouseOver getMouseOver();
/**
* (Highcharts) Fires when the mouse enters the graph. One parameter,
* event, is passed to the function, containing common event information.
*
* @see https://api.highcharts.com/highcharts/plotOptions.waterfall.events.mouseOver
*
* @implspec mouseOver?: () => void;
*
*/
@JSProperty("mouseOver")
void setMouseOver(MouseOver value);
/**
* (Highcharts) Fires when the series is shown after chart generation time,
* either by clicking the legend item or by calling .show().
*
* @see https://api.highcharts.com/highcharts/plotOptions.waterfall.events.show
*
* @implspec show?: () => void;
*
*/
@JSProperty("show")
@Nullable
Show getShow();
/**
* (Highcharts) Fires when the series is shown after chart generation time,
* either by clicking the legend item or by calling .show().
*
* @see https://api.highcharts.com/highcharts/plotOptions.waterfall.events.show
*
* @implspec show?: () => void;
*
*/
@JSProperty("show")
void setShow(Show value);
/**
*/
@JSFunctor
@FunctionalInterface
interface Hide extends Any {
void apply();
}
/**
*/
@JSFunctor
@FunctionalInterface
interface LegendItemClick extends Any {
void apply();
}
/**
*/
@JSFunctor
@FunctionalInterface
interface MouseOut extends Any {
void apply();
}
/**
*/
@JSFunctor
@FunctionalInterface
interface MouseOver extends Any {
void apply();
}
/**
*/
@JSFunctor
@FunctionalInterface
interface Show extends Any {
void apply();
}
}