Package com.storedobject.chart

Class AbstractDataZoom

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.AbstractDataZoom

All Implemented Interfaces:

Component, ComponentPart, ComponentProperty

Direct Known Subclasses:

CoordinateSystemZoom, DataZoom

public abstract class AbstractDataZoom
extends AbstractPart
implements Component

Represents abstract "data zoom" component. Data zoom components allow the end-users to zoom in and to zoom out charts using mouse and/or touch devices.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
void	addAxis(Axis... axes)	Add list of axes.
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
final int	getEnd()	The end percentage of the window out of the data extent, in the range of 0 ~ 100.
final Object	getEndValue()	The absolute end value of the window.
final int	getFilterMode()	Get the filter mode.
final int	getMaxSpan()	The maximum span percentage value of the window out of the data extent, in the range of 0 ~ 100.
final Object	getMaxSpanValue()	The absolute maximum span value of the window.
final int	getMinSpan()	The minimum span percentage value of the window out of the data extent, in the range of 0 ~ 100.
final Object	getMinSpanValue()	The absolute minimum span value of the window.
final int	getStart()	The start percentage of the window out of the data extent, in the range of 0 ~ 100.
final Object	getStartValue()	The absolute start value of the window.
final boolean	isZoomLock()	Check whether zoom lock is set or not.
void	setEnd(int end)	The end percentage of the window out of the data extent, in the range of 0 ~ 100.
void	setEndValue(Number endValue)	The absolute end value of the window.
void	setEndValue(LocalDate endValue)	The absolute end value of the window.
void	setEndValue(LocalDateTime endValue)	The absolute end value of the window.
void	setFilterMode(int filterMode)	Set the filter mode.
void	setMaxSpan(int maxSpan)	The maximum span percentage value of the window out of the data extent, in the range of 0 ~ 100.
void	setMaxSpanValue(Number maxSpanValue)	The absolute maximum span value of the window.
void	setMaxSpanValue(LocalDate maxSpanValue)	The absolute maximum span value of the window.
void	setMaxSpanValue(LocalDateTime maxSpanValue)	The absolute maximum span value of the window.
void	setMinSpan(int minSpan)	The minimum span percentage value of the window out of the data extent, in the range of 0 ~ 100.
void	setMinSpanValue(Number minSpanValue)	The absolute minimum span value of the window.
void	setMinSpanValue(LocalDate minSpanValue)	The absolute minimum span value of the window.
void	setMinSpanValue(LocalDateTime minSpanValue)	The absolute minimum span value of the window.
void	setShowDetail(boolean showDetail)	Show details when dragging.
void	setStart(int start)	The start percentage of the window out of the data extent, in the range of 0 ~ 100.
void	setStartValue(Number startValue)	The absolute start value of the window.
void	setStartValue(LocalDate startValue)	The absolute start value of the window.
void	setStartValue(LocalDateTime startValue)	The absolute start value of the window.
void	setZoomLock(boolean zoomLock)	Set the zoom lock.
void	validate()	This method is invoked by SOChart to check if the component or part is valid or not.

Methods inherited from class com.storedobject.chart.AbstractPart

equals, getId, getLabelTag, getName, getSerial, getZ, hashCode, hasId, setSerial, setZ

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.storedobject.chart.Component

addParts

Methods inherited from interface com.storedobject.chart.ComponentPart

className, getId, getName, getRenderingIndex, getSerial, setName, setRenderingIndex, setSerial

Method Details

addAxis

public void addAxis(Axis... axes)

Add list of axes.

Parameters:

axes - Axis list.

validate

public void validate()
              throws ChartException

Description copied from interface: ComponentPart

This method is invoked by SOChart to check if the component or part is valid or not.

Specified by:

validate in interface ComponentPart

Throws:

ChartException - Raises exception if the component or part is not valid.

encodeJSON

public void encodeJSON(StringBuilder sb)

Description copied from interface: ComponentProperty

Encode the JSON string with the properties of this.

Specified by:

encodeJSON in interface ComponentProperty

Overrides:

encodeJSON in class AbstractPart

Parameters:

sb - Encoded JSON string to be appended to this.

setShowDetail

public void setShowDetail(boolean showDetail)

Show details when dragging.

Parameters:

showDetail - True/false.

getFilterMode

public final int getFilterMode()

Get the filter mode. (See setFilterMode(int)).

Returns:

Get the current filter mode.

setFilterMode

public void setFilterMode(int filterMode)

Set the filter mode.

0: Do not filter data.

1: Data that outside the window will be set to NaN, which will not lead to changes of the window of other axes.

2: Data that outside the window will be filtered, which may lead to some changes of windows of other axes. For each data item, it will be filtered only if all of the relevant dimensions are out of the same side of the window.

3: Data that outside the window will be filtered, which may lead to some changes of windows of other axes. For each data item, it will be filtered if one of the relevant dimensions is out of the window. This is the default value.

Note: Setting other values will be ignored.

Parameters:

filterMode - Filter mode.

getStart

public final int getStart()

The start percentage of the window out of the data extent, in the range of 0 ~ 100.

Returns:

Start percentage.

setStart

public void setStart(int start)

The start percentage of the window out of the data extent, in the range of 0 ~ 100. (Value set by setStartValue(...) methods will not be effective if this method is invoked).

Parameters:

start - Start percentage.

getEnd

public final int getEnd()

The end percentage of the window out of the data extent, in the range of 0 ~ 100.

Returns:

End percentage.

setEnd

public void setEnd(int end)

The end percentage of the window out of the data extent, in the range of 0 ~ 100.

Parameters:

end - End percentage.

getStartValue

public final Object getStartValue()

The absolute start value of the window.

Returns:

Start value.

setStartValue

public void setStartValue(Number startValue)

The absolute start value of the window. (Value set by setStart(int) will not be effective if this method is invoked).

Parameters:

startValue - Start value. (Can be index value for category data).

setStartValue

public void setStartValue(LocalDate startValue)

The absolute start value of the window. (Value set by setStart(int) will not be effective if this method is invoked).

Parameters:

startValue - Start value. (Used for DataType.DATE).

setStartValue

public void setStartValue(LocalDateTime startValue)

The absolute start value of the window. (Value set by setStart(int) will not be effective if this method is invoked).

Parameters:

startValue - Start value. (Used for DataType.TIME).

getEndValue

public final Object getEndValue()

The absolute end value of the window.

Returns:

End value.

setEndValue

public void setEndValue(Number endValue)

The absolute end value of the window. (Value set by setEnd(int) will not be effective if this method is invoked).

Parameters:

endValue - End value. (Can be index value for category data).

setEndValue

public void setEndValue(LocalDate endValue)

The absolute end value of the window. (Value set by setEnd(int) will not be effective if this method is invoked).

Parameters:

endValue - End value. (Used for DataType.DATE).

setEndValue

public void setEndValue(LocalDateTime endValue)

The absolute end value of the window. (Value set by setEnd(int) will not be effective if this method is invoked).

Parameters:

endValue - End value. (Used for DataType.TIME).

getMinSpan

public final int getMinSpan()

The minimum span percentage value of the window out of the data extent, in the range of 0 ~ 100.

Returns:

Minimum span percentage value.

setMinSpan

public void setMinSpan(int minSpan)

The minimum span percentage value of the window out of the data extent, in the range of 0 ~ 100. (Value set by setMinSpanValue(...) methods will not be effective if this method is invoked).

Parameters:

minSpan - Minimum span percentage value.

getMaxSpan

public final int getMaxSpan()

The maximum span percentage value of the window out of the data extent, in the range of 0 ~ 100.

Returns:

MaxSpan Maximum span percentage value.

setMaxSpan

public void setMaxSpan(int maxSpan)

The maximum span percentage value of the window out of the data extent, in the range of 0 ~ 100.

Parameters:

maxSpan - Maximum span percentage value.

getMinSpanValue

public final Object getMinSpanValue()

The absolute minimum span value of the window.

Returns:

Minimum span value.

setMinSpanValue

public void setMinSpanValue(Number minSpanValue)

The absolute minimum span value of the window. (Value set by setMinSpan(int) will not be effective if this method is invoked).

Parameters:

minSpanValue - Minimum span value.

setMinSpanValue

public void setMinSpanValue(LocalDate minSpanValue)

The absolute minimum span value of the window. (Value set by setMinSpan(int) will not be effective if this method is invoked).

Parameters:

minSpanValue - Minimum span value. (Used for DataType.DATE).

setMinSpanValue

public void setMinSpanValue(LocalDateTime minSpanValue)

The absolute minimum span value of the window. (Value set by setMinSpan(int) will not be effective if this method is invoked).

Parameters:

minSpanValue - Minimum span value. (Used for DataType.TIME).

getMaxSpanValue

public final Object getMaxSpanValue()

The absolute maximum span value of the window.

Returns:

Maximum span value.

setMaxSpanValue

public void setMaxSpanValue(Number maxSpanValue)

The absolute maximum span value of the window. (Value set by setMaxSpan(int) will not be effective if this method is invoked).

Parameters:

maxSpanValue - Maximum span value.

setMaxSpanValue

public void setMaxSpanValue(LocalDate maxSpanValue)

The absolute maximum span value of the window. (Value set by setMaxSpan(int) will not be effective if this method is invoked).

Parameters:

maxSpanValue - Maximum span value. (Used for DataType.DATE).

setMaxSpanValue

public void setMaxSpanValue(LocalDateTime maxSpanValue)

The absolute maximum span value of the window. (Value set by setMaxSpan(int) will not be effective if this method is invoked).

Parameters:

maxSpanValue - Maximum span value. (Used for DataType.TIME).

isZoomLock

public final boolean isZoomLock()

Check whether zoom lock is set or not. (See setZoomLock(boolean) for details).

Returns:

True or false.

setZoomLock

public void setZoomLock(boolean zoomLock)

Set the zoom lock.

When set as true, the size of window is locked, that is, only the translation (by mouse drag or touch drag) is available.

Parameters:

zoomLock - True or false.