Package org.pepstock.charba.client.geo

Class 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 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

      • DEFAULT_RANGE

        public static final List<Integer> DEFAULT_RANGE
        Default range options, [20, 20].

      • 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()

      • 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 pixel
        max - 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.

      • getBeginAtZeroCallback

        public default BeginAtZeroCallback getBeginAtZeroCallback()
        Returns the callback to set if true, scale will include 0 if it is not already included.
        Returns:
        the callback to set if true, scale will include 0 if it is not already included.

      • setBeginAtZero

        public default void setBeginAtZero​(BeginAtZeroCallback beginAtZeroCallback)
        Sets the callback to set if true, scale will include 0 if it is not already included.
        Parameters:
        beginAtZeroCallback - the callback to set if true, scale will include 0 if it is not already included.

      • setBeginAtZero

        public default void setBeginAtZero​(NativeCallback beginAtZeroCallback)
        Sets the callback to set if true, scale will include 0 if it is not already included.
        Parameters:
        beginAtZeroCallback - the callback to set if true, scale will include 0 if it is not already included.

      • 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