Package org.pepstock.charba.client.geo
Class SizeLogarithmicAxis
- java.lang.Object
-
- org.pepstock.charba.client.configuration.Axis
-
- org.pepstock.charba.client.configuration.CartesianAxis<CartesianLogarithmicTick>
-
- org.pepstock.charba.client.configuration.CartesianLogarithmicAxis
-
- org.pepstock.charba.client.geo.SizeLogarithmicAxis
-
- All Implemented Interfaces:
IsNumericAxis
public final class SizeLogarithmicAxis extends CartesianLogarithmicAxis
The scale is used to map the values to symbol radius size, for logarithmic data.
Provides the elements, as colored legend, which can provide the how the values are distributed on map.- Author:
- Andrea "Stock" Stocchero
-
-
Constructor Summary
Constructors Constructor Description SizeLogarithmicAxis(IsChart chart)
Builds the object storing the chart instance and axis type.
-
Method Summary
All Methods Instance Methods Concrete Methods Default Methods Modifier and Type Method Description IsChart
getChart()
Returns the chart instanceprotected T
getConfiguration()
Returns the configuration element.default Legend
getLegend()
Returns the legend configuration.org.pepstock.charba.client.geo.SizeAxisMapper
getMapper()
default MinMaxCallback<T>
getMaxCallback()
Returns the callback to set the user defined maximum number for the scale, overrides maximum value from data.default MinMaxCallback<T>
getMinCallback()
Returns the callback to set the user defined minimum number for the scale, overrides minimum value from data.default double
getMissingRadius()
Returns the radius to render for missing values.default RadiusCallback<ScaleContext>
getMissingRadiusCallback()
Returns the radius callback 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 ModeCallback
getModeCallback()
Returns the operation modes callback 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.default RangeCallback
getRangeCallback()
Returns the radius range callback, 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.default double
getSizeForValue(double value)
Returns the size for a specific data value.default MinMaxCallback<T>
getSuggestedMaxCallback()
Returns the callback to set the adjustment used when calculating the maximum data value.default MinMaxCallback<T>
getSuggestedMinCallback()
Returns the callback to set the adjustment used when calculating the minimum data value.ChartEnvelop<NativeObject>
loadNativeObject(ChartEnvelop<NativeObject> envelop)
Returns the native object instance inside an envelop.
It can be called only fromorg.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
setMax(MinMaxCallback<T> maxCallback)
Sets the callback to set the user defined maximum number for the scale, overrides maximum value from data.default void
setMax(NativeCallback maxCallback)
Sets the callback to set the user defined maximum number for the scale, overrides maximum value from data.default void
setMin(MinMaxCallback<T> minCallback)
Sets the callback to set the user defined minimum number for the scale, overrides minimum value from data.default void
setMin(NativeCallback minCallback)
Sets the callback to set the user defined minimum number for the scale, overrides minimum value from data.default void
setMissingRadius(double missingRadius)
Sets the radius to render for missing values.default void
setMissingRadius(RadiusCallback<ScaleContext> missingRadiusCallback)
Sets the radius to render for missing values.default void
setMode(ModeCallback modeCallback)
Sets the operation modes for the scale, area means that the area is linearly increasing whereas radius the radius is.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.default void
setRange(RangeCallback rangeCallback)
Sets the radius range callback, 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.default void
setSuggestedMax(MinMaxCallback<T> suggestedMaxCallback)
Sets the callback to set the adjustment used when calculating the maximum data value.default void
setSuggestedMax(NativeCallback suggestedMaxCallback)
Sets the callback to set the adjustment used when calculating the maximum data value.default void
setSuggestedMin(MinMaxCallback<T> suggestedMinCallback)
Sets the callback to set the adjustment used when calculating the minimum data value.default void
setSuggestedMin(NativeCallback suggestedMinCallback)
Sets the callback to set the adjustment used when calculating the minimum data value.String
toJSON()
Returns the JSON representation of the object.-
Methods inherited from class org.pepstock.charba.client.configuration.CartesianLogarithmicAxis
getAxisElement, getMinMaxCallbacksHandler, getTicks
-
Methods inherited from class org.pepstock.charba.client.configuration.CartesianAxis
getBounds, getBoundsCallback, getGrid, getOffsetCallback, getPosition, getPositionCallback, getStack, getStackCallback, getStackedCallback, getStackWeight, getStackWeightCallback, getTitle, isOffset, isSingleStacked, isStacked, setBounds, setBounds, setBounds, setOffset, setOffset, setOffset, setPosition, setPosition, setPosition, setSingleStacked, setStack, setStack, setStack, setStacked, setStacked, setStacked, setStackWeight, setStackWeight, setStackWeight
-
Methods inherited from class org.pepstock.charba.client.configuration.Axis
getAlignToPixelsCallback, getAxis, getAxisBuildTicksCallback, getAxisCalculateLabelRotationCallback, getAxisDataLimitsCallback, getAxisDimensionsCallback, getAxisFitCallback, getAxisTickToLabelConversionCallback, getAxisUpdateCallback, getBackgroundColor, getBackgroundColorAsString, getBackgroundColorCallback, getCharbaId, getDisplay, getDisplayCallback, getId, getReverseCallback, getType, getWeight, getWeightCallback, isAlignToPixels, isReverse, setAlignToPixels, setAlignToPixels, setAlignToPixels, setAxisBuildTicksCallback, setAxisCalculateLabelRotationCallback, setAxisDataLimitsCallback, setAxisDimensionsCallback, setAxisFitCallback, setAxisTickToLabelConversionCallback, setAxisUpdateCallback, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setDisplay, setDisplay, setDisplay, setDisplay, setReverse, setReverse, setReverse, setWeight, setWeight, 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.IsNumericAxis
getMax, getMin, getSuggestedMax, getSuggestedMin, setMax, setMin, setSuggestedMax, setSuggestedMin
-
-
-
-
Field Detail
-
TYPE
public static final AxisType TYPE
Size axis type.
-
-
Constructor Detail
-
SizeLogarithmicAxis
public SizeLogarithmicAxis(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()
-
setMissingRadius
public default void setMissingRadius(double missingRadius)
Sets the radius to render for missing values.- Parameters:
missingRadius
- the radius to render for missing values
-
getMissingRadius
public default double getMissingRadius()
Returns the radius to render for missing values.- Returns:
- the radius to render for missing values
-
setMode
public 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.- Parameters:
mode
- the operation modes for the scale, area means that the area is linearly increasing whereas radius the radius is
-
getMode
public default 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 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.- Parameters:
min
- minimum range in pixelmax
- maximum range in pixel
-
getRange
public 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.- 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
-
setMissingRadius
public default void setMissingRadius(RadiusCallback<ScaleContext> missingRadiusCallback)
Sets the radius to render for missing values.- Parameters:
missingRadiusCallback
- the radius to render for missing values
-
getMissingRadiusCallback
public default RadiusCallback<ScaleContext> getMissingRadiusCallback()
Returns the radius callback to render for missing values.- Returns:
- the radius callback to render for missing values
-
setMode
public default void setMode(ModeCallback modeCallback)
Sets the operation modes for the scale, area means that the area is linearly increasing whereas radius the radius is.- Parameters:
modeCallback
- the operation modes callback for the scale, area means that the area is linearly increasing whereas radius the radius is
-
getModeCallback
public default ModeCallback getModeCallback()
Returns the operation modes callback for the scale, area means that the area is linearly increasing whereas radius the radius is.- Returns:
- the operation modes callback for the scale, area means that the area is linearly increasing whereas radius the radius is
-
setRange
public default void setRange(RangeCallback rangeCallback)
Sets the radius range callback, 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:
rangeCallback
- the radius range callback, 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.
-
getRangeCallback
public default RangeCallback getRangeCallback()
Returns the radius range callback, 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 callback, 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
-
getSizeForValue
public default double getSizeForValue(double value)
Returns the size for a specific data value.- Parameters:
value
- to use for searching- Returns:
- the size of the value
-
getLegend
public default Legend getLegend()
Returns the legend configuration.- Returns:
- the legend configuration
-
getMinCallback
public default MinMaxCallback<T> getMinCallback()
Returns the callback to set the user defined minimum number for the scale, overrides minimum value from data.- Returns:
- the callback to set the user defined minimum number for the scale, overrides minimum value from data.
-
setMin
public default void setMin(MinMaxCallback<T> minCallback)
Sets the callback to set the user defined minimum number for the scale, overrides minimum value from data.- Parameters:
minCallback
- the callback to set the user defined minimum number for the scale, overrides minimum value from data.
-
setMin
public default void setMin(NativeCallback minCallback)
Sets the callback to set the user defined minimum number for the scale, overrides minimum value from data.- Parameters:
minCallback
- the callback to set the user defined minimum number for the scale, overrides minimum value from data.
-
setMax
public default void setMax(MinMaxCallback<T> maxCallback)
Sets the callback to set the user defined maximum number for the scale, overrides maximum value from data.- Parameters:
maxCallback
- the callback to set the user defined maximum number for the scale, overrides maximum value from data.
-
setMax
public default void setMax(NativeCallback maxCallback)
Sets the callback to set the user defined maximum number for the scale, overrides maximum value from data.- Parameters:
maxCallback
- the callback to set the user defined maximum number for the scale, overrides maximum value from data.
-
getMaxCallback
public default MinMaxCallback<T> getMaxCallback()
Returns the callback to set the user defined maximum number for the scale, overrides maximum value from data.- Returns:
- the callback to set the user defined maximum number for the scale, overrides maximum value from data.
-
getSuggestedMinCallback
public default MinMaxCallback<T> getSuggestedMinCallback()
Returns the callback to set the adjustment used when calculating the minimum data value.- Returns:
- the callback to set the adjustment used when calculating the minimum data value.
-
setSuggestedMin
public default void setSuggestedMin(MinMaxCallback<T> suggestedMinCallback)
Sets the callback to set the adjustment used when calculating the minimum data value.- Parameters:
suggestedMinCallback
- the callback to set the adjustment used when calculating the minimum data value.
-
setSuggestedMin
public default void setSuggestedMin(NativeCallback suggestedMinCallback)
Sets the callback to set the adjustment used when calculating the minimum data value.- Parameters:
suggestedMinCallback
- the callback to set the adjustment used when calculating the minimum data value.
-
getSuggestedMaxCallback
public default MinMaxCallback<T> getSuggestedMaxCallback()
Returns the callback to set the adjustment used when calculating the maximum data value.- Returns:
- the callback to set the adjustment used when calculating the maximum data value.
-
setSuggestedMax
public default void setSuggestedMax(MinMaxCallback<T> suggestedMaxCallback)
Sets the callback to set the adjustment used when calculating the maximum data value.- Parameters:
suggestedMaxCallback
- the callback to set the adjustment used when calculating the maximum data value.
-
setSuggestedMax
public default void setSuggestedMax(NativeCallback suggestedMaxCallback)
Sets the callback to set the adjustment used when calculating the maximum data value.- Parameters:
suggestedMaxCallback
- the callback to set the adjustment used when calculating the maximum data value.
-
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 addproperty
- 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 fromorg.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
-
-