Package com.storedobject.chart

Class DataZoom

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.AbstractDataZoom

com.storedobject.chart.DataZoom

All Implemented Interfaces:

Component, ComponentPart, ComponentProperty, HasPosition, VisibleProperty

public class DataZoom
extends AbstractDataZoom
implements HasPosition, VisibleProperty

Represents the "data zoom" component. Data zoom components allow the end-users to zoom in and to zoom out charts using mouse and/or touch devices. This component ignores the "width" and the "height" properties that are set via its Position.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataZoom.DataShadowStyle	Used to style the data shadow.
static class	DataZoom.HandleStyle	Used to style the handle.

Constructor Summary

Constructors

Constructor	Description
DataZoom(CoordinateSystem coordinateSystem, Axis... axis)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
final AbstractColor	getBackground()	Get the background color.
final AbstractColor	getBorderColor()	Get the border color.
DataZoom.DataShadowStyle	getDataShadowStyle(boolean create)	Get the style of the data shadow.
final AbstractColor	getFillerColor()	Get the filler color.
final DataZoom.HandleStyle	getHandleStyle(boolean create)	Get the handle style.
final Position	getPosition(boolean create)	Get the position of this on the chart display area.
boolean	isVisible()	Checks if this property is currently visible.
void	setBackground(AbstractColor background)	Set the background color.
void	setBorderColor(AbstractColor borderColor)	Set the border color.
void	setDataShadowStyle(DataZoom.DataShadowStyle dataShadowStyle)	Set the style of the data shadow.
void	setFillerColor(AbstractColor fillerColor)	Set the filler color to fill the selected area.
void	setHandleStyle(DataZoom.HandleStyle handleStyle)	Set the handle style.
final void	setPosition(Position position)	Set the position of this.
void	setVisible(boolean visible)	Sets the visibility of this property.

Methods inherited from class com.storedobject.chart.AbstractDataZoom

addAxis, getEnd, getEndValue, getFilterMode, getMaxSpan, getMaxSpanValue, getMinSpan, getMinSpanValue, getStart, getStartValue, isZoomLock, setEnd, setEndValue, setEndValue, setEndValue, setFilterMode, setMaxSpan, setMaxSpanValue, setMaxSpanValue, setMaxSpanValue, setMinSpan, setMinSpanValue, setMinSpanValue, setMinSpanValue, setShowDetail, setStart, setStartValue, setStartValue, setStartValue, setZoomLock, validate

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

Methods inherited from interface com.storedobject.chart.VisibleProperty

hide, show

Constructor Details

DataZoom

public DataZoom(CoordinateSystem coordinateSystem,
 Axis... axis)

Constructor.

Parameters:

coordinateSystem - Coordinate system.

axis - Axis list.

Method Details

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 AbstractDataZoom

Parameters:

sb - Encoded JSON string to be appended to this.

setVisible

public void setVisible(boolean visible)

Description copied from interface: VisibleProperty

Sets the visibility of this property.

Specified by:

setVisible in interface VisibleProperty

Parameters:

visible - A boolean indicating whether this property should be visible (true) or hidden (false).

isVisible

public boolean isVisible()

Description copied from interface: VisibleProperty

Checks if this property is currently visible.

Specified by:

isVisible in interface VisibleProperty

Returns:

true if the property is visible, false otherwise.

getPosition

public final Position getPosition(boolean create)

Description copied from interface: HasPosition

Get the position of this on the chart display area. (If true is passed as the parameter, a new position will be created if not already exists).

Specified by:

getPosition in interface HasPosition

Parameters:

create - Whether to create it or not.

Returns:

Position.

setPosition

public final void setPosition(Position position)

Description copied from interface: HasPosition

Set the position of this.

Specified by:

setPosition in interface HasPosition

Parameters:

position - Position to set.

getBackground

public final AbstractColor getBackground()

Get the background color.

Returns:

Background color.

setBackground

public void setBackground(AbstractColor background)

Set the background color.

Parameters:

background - Background color.

getFillerColor

public final AbstractColor getFillerColor()

Get the filler color.

Returns:

Filler color.

setFillerColor

public void setFillerColor(AbstractColor fillerColor)

Set the filler color to fill the selected area.

Parameters:

fillerColor - Filler color.

getBorderColor

public final AbstractColor getBorderColor()

Get the border color.

Returns:

Border color.

setBorderColor

public void setBorderColor(AbstractColor borderColor)

Set the border color.

Parameters:

borderColor - Border color.

getHandleStyle

public final DataZoom.HandleStyle getHandleStyle(boolean create)

Get the handle style.

Parameters:

create - Whether to create it or not.

Returns:

Handle style.

setHandleStyle

public void setHandleStyle(DataZoom.HandleStyle handleStyle)

Set the handle style.

Parameters:

handleStyle - Handle style.

getDataShadowStyle

public DataZoom.DataShadowStyle getDataShadowStyle(boolean create)

Get the style of the data shadow.

Parameters:

create - Whether to create it or not.

Returns:

Data shadow style.

setDataShadowStyle

public void setDataShadowStyle(DataZoom.DataShadowStyle dataShadowStyle)

Set the style of the data shadow.

Parameters:

dataShadowStyle - Data shadow style.