org.pepstock.charba.client.geo

Class SizeAxis

java.lang.Object

org.pepstock.charba.client.configuration.Axis

org.pepstock.charba.client.configuration.CartesianAxis<CartesianLinearTick>

org.pepstock.charba.client.configuration.CartesianLinearAxis

org.pepstock.charba.client.geo.SizeAxis

All Implemented Interfaces:

IsLinearAxis, IsNumericAxis

public final class SizeAxis
extends CartesianLinearAxis

The scale is used to map the values to symbol radius size.
Provides the elements, as colored legend, which can provide the how the values are distributed on map.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAXIMUM_RANGE Default maximum range options, 20.
static int	DEFAULT_MINIMUM_RANGE Default minimum range options, 2.
static double	DEFAULT_MISSING_RADIUS Default missing radius options, 1.0.
static ScaleId	ID Size axis id.
static AxisType	TYPE Size axis type.

Constructor Summary

Constructors

Constructor and Description
SizeAxis(IsChart chart) Builds the object storing the chart instance and axis type.

Method Summary

Modifier and Type	Method and Description
IsChart	getChart() Returns the chart instance
protected T	getConfiguration() Returns the configuration element.
default Legend	getLegend() Returns the legend configuration.
org.pepstock.charba.client.geo.SizeAxisMapper	getMapper() Returns the size axis mapper.
default double	getMissingRadius() Returns the radius to render for missing values.
default Mode	getMode() Returns the operation modes for the scale, area means that the area is linearly increasing whereas radius the radius is.
default List<Integer>	getRange() Returns the radius range in pixel, the minimal data value will be mapped to the first entry, the maximal one to the second and a linear interpolation for all values in between.
ChartEnvelop<NativeObject>	loadNativeObject(ChartEnvelop<NativeObject> envelop) Returns the native object instance inside an envelop. It can be called only from org.pepstock.charba.client package.
void	merge(NativeObjectContainer source, String property) Merge a native object in the this one with a specific property name. This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration in the options of chart.
protected void	setConfiguration(T configuration)
default void	setMissingRadius(double missingRadius) Sets the radius to render for missing values.
default void	setMode(Mode mode) Sets the operation modes for the scale, area means that the area is linearly increasing whereas radius the radius is.
default void	setRange(int min, int max) Sets the radius range in pixel, the minimal data value will be mapped to the first entry, the maximal one to the second and a linear interpolation for all values in between.
String	toJSON() Returns the JSON representation of the object.

Methods inherited from class org.pepstock.charba.client.configuration.CartesianLinearAxis

getAxisElement, getGrace, getGraceAsPercentage, getTicks, setGrace, setGraceAsPercentage

Methods inherited from class org.pepstock.charba.client.configuration.CartesianAxis

getBounds, getGrid, getPosition, getStack, getStackWeight, getTitle, isOffset, isSingleStacked, isStacked, setBounds, setOffset, setPosition, setSingleStacked, setStack, setStacked, setStackWeight

Methods inherited from class org.pepstock.charba.client.configuration.Axis

getAxis, getAxisBuildTicksCallback, getAxisCalculateLabelRotationCallback, getAxisDataLimitsCallback, getAxisDimensionsCallback, getAxisFitCallback, getAxisTickToLabelConversionCallback, getAxisUpdateCallback, getBackgroundColor, getBackgroundColorAsString, getCharbaId, getDisplay, getId, getType, getWeight, isAlignToPixels, isReverse, setAlignToPixels, setAxisBuildTicksCallback, setAxisCalculateLabelRotationCallback, setAxisDataLimitsCallback, setAxisDimensionsCallback, setAxisFitCallback, setAxisTickToLabelConversionCallback, setAxisUpdateCallback, setBackgroundColor, setBackgroundColor, setDisplay, setDisplay, setReverse, setWeight

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepstock.charba.client.configuration.IsLinearAxis

isBeginAtZero, setBeginAtZero

Methods inherited from interface org.pepstock.charba.client.configuration.IsNumericAxis

getMax, getMin, getSuggestedMax, getSuggestedMin, setMax, setMin, setSuggestedMax, setSuggestedMin

Field Detail

DEFAULT_MISSING_RADIUS

public static final double DEFAULT_MISSING_RADIUS

Default missing radius options, 1.0.

See Also:

Constant Field Values

DEFAULT_MINIMUM_RANGE

public static final int DEFAULT_MINIMUM_RANGE

Default minimum range options, 2.

See Also:

Constant Field Values

DEFAULT_MAXIMUM_RANGE

public static final int DEFAULT_MAXIMUM_RANGE

Default maximum range options, 20.

See Also:

Constant Field Values

ID

public static final ScaleId ID

Size axis id.

TYPE

public static final AxisType TYPE

Size axis type.

Constructor Detail

SizeAxis

public SizeAxis(IsChart chart)

Builds the object storing the chart instance and axis type.

Parameters:

chart - chart instance

Method Detail

getMapper

public org.pepstock.charba.client.geo.SizeAxisMapper getMapper()

Returns the size axis mapper.

Returns:

the lize axis mapper

setMissingRadius

public void setMissingRadius(double missingRadius)

Sets the radius to render for missing values.

Parameters:

missingRadius - the radius to render for missing values

getMissingRadius

public double getMissingRadius()

Returns the radius to render for missing values.

Returns:

the radius to render for missing values

setMode

public void setMode(Mode mode)

Sets the operation modes for the scale, area means that the area is linearly increasing whereas radius the radius is.

Parameters:

mode - the operation modes for the scale, area means that the area is linearly increasing whereas radius the radius is

getMode

public Mode getMode()

Returns the operation modes for the scale, area means that the area is linearly increasing whereas radius the radius is.

Returns:

the operation modes for the scale, area means that the area is linearly increasing whereas radius the radius is

setRange

public void setRange(int min,
                     int max)

Sets the radius range in pixel, the minimal data value will be mapped to the first entry, the maximal one to the second and a linear interpolation for all values in between.

Parameters:

min - minimum range in pixel

max - maximum range in pixel

getRange

public List<Integer> getRange()

Returns the radius range in pixel, the minimal data value will be mapped to the first entry, the maximal one to the second and a linear interpolation for all values in between.

Returns:

the radius range in pixel, the minimal data value will be mapped to the first entry, the maximal one to the second and a linear interpolation for all values in between

getLegend

public Legend getLegend()

Returns the legend configuration.

Returns:

the legend configuration

setConfiguration

protected final void setConfiguration(T configuration)

Parameters:

configuration - the configuration to set

getConfiguration

protected final T getConfiguration()

Returns the configuration element.

Returns:

the configuration element.

merge

public final void merge(NativeObjectContainer source,
                        String property)

Merge a native object in the this one with a specific property name.
This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration in the options of chart.

Parameters:

source - native object container to add

property - property name

toJSON

public final String toJSON()

Returns the JSON representation of the object.

Returns:

the JSON representation of the object.

loadNativeObject

public final ChartEnvelop<NativeObject> loadNativeObject(ChartEnvelop<NativeObject> envelop)

Returns the native object instance inside an envelop.
It can be called only from org.pepstock.charba.client package.

Parameters:

envelop - envelop instance which will contain the native object

Returns:

the envelop, passed as argument, loaded with the native object

getChart

public final IsChart getChart()

Returns the chart instance

Returns:

the chart