com.jongsoft.highchart.axis.AxisEvents Maven / Gradle / Ivy
/*
* The MIT License
*
* Copyright 2016 Jong Soft.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.jongsoft.highchart.axis;
import com.jongsoft.highchart.common.Function;
public class AxisEvents {
private Function afterBreaks;
private Function afterSetExtremes;
private Function pointBreak;
private Function setExtremes;
/**
* An event fired after the breaks have rendered.
*/
public AxisEvents setAfterBreaks(Function afterBreaks) {
this.afterBreaks = afterBreaks;
return this;
}
/**
* As opposed to the setExtremes event, this event fires after the final min and max values are
* computed and corrected for minRange.
*/
public AxisEvents setAfterSetExtremes(Function afterSetExtremes) {
this.afterSetExtremes = afterSetExtremes;
return this;
}
/**
* An event fired when a break from this axis occurs on a point.
*
* The this keyword refers to the Axis object.
*/
public AxisEvents setPointBreak(Function pointBreak) {
this.pointBreak = pointBreak;
return this;
}
/**
* Fires when the minimum and maximum is set for the axis, either by calling the .setExtremes() method or by
* selecting an area in the chart. One parameter, event, is passed to the function. This contains common event
* information based on jQuery.
*
* The new user set minimum and maximum values can be found by event.min and event.max. When an axis is zoomed
* all the way out from the "Reset zoom" button, event.min and event.max are null, and the new extremes are set
* based on this.dataMin and this.dataMax.
*
* The this keyword refers to the Axis object.
*/
public AxisEvents setSetExtremes(Function setExtremes) {
this.setExtremes = setExtremes;
return this;
}
public Function getAfterBreaks() {
return afterBreaks;
}
public Function getAfterSetExtremes() {
return afterSetExtremes;
}
public Function getPointBreak() {
return pointBreak;
}
public Function getSetExtremes() {
return setExtremes;
}
}