Package org.pepstock.charba.client.geo

Class ColorAxis

  • All Implemented Interfaces:
    IsLinearAxis, IsNumericAxis
    public final class ColorAxis
extends CartesianLinearAxis
    The coloring of the nodes will be done with a special color scale.
    Provides the elements, as colored legend, which can provide the how the values are distributed on map.
    Author:
    Andrea "Stock" Stocchero

    • Field Detail

      • DEFAULT_QUANTIZE

        public static final int DEFAULT_QUANTIZE
        Default quantize options, 0.
        See Also:
        Constant Field Values

      • ID

        public static final ScaleId ID
        Projection axis id.

      • TYPE

        public static final AxisType TYPE
        Projection axis type.

    • Constructor Detail

      • ColorAxis

        public ColorAxis​(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.ColorAxisMapper getMapper()

      • setMissingColor

        public default void setMissingColor​(IsColor missingColor)
        Sets the missing color.
        Parameters:
        missingColor - the missing color.

      • setMissingColor

        public default void setMissingColor​(String missingColor)
        Sets the missing color.
        Parameters:
        missingColor - the missing color.

      • getMissingColorAsString

        public default String getMissingColorAsString()
        Returns the missing color.
        Returns:
        the missing color.

      • getMissingColor

        public default IsColor getMissingColor()
        Returns the missing color.
        Returns:
        the missing color.

      • setQuantize

        public default void setQuantize​(int quantize)
        Sets the amount of pieces to allow to split the color scale in N quantized equal bins.
        Parameters:
        quantize - the amount of pieces to allow to split the color scale in N quantized equal bins

      • getQuantize

        public default int getQuantize()
        Returns the amount of pieces to allow to split the color scale in N quantized equal bins.
        Returns:
        the amount of pieces to allow to split the color scale in N quantized equal bins

      • setInterpolate

        public default void setInterpolate​(Interpolate interpolate)
        Sets the color interpolation of the scale.
        Parameters:
        interpolate - the color interpolation of the scale

      • getInterpolate

        public default Interpolate getInterpolate()
        Returns the color interpolation of the scale.
        Returns:
        the color interpolation of the scale

      • setInterpolate

        public default void setInterpolate​(InterpolateCallback interpolateCallback)
        Sets the color interpolation callback of the scale.
        Parameters:
        interpolateCallback - the color interpolation callback of the scale

      • getInterpolateCallback

        public default InterpolateCallback getInterpolateCallback()
        Returns the color interpolation callback of the scale.
        Returns:
        the color interpolation callback of the scale

      • setQuantize

        public default void setQuantize​(QuantizeCallback quantizeCallback)
        Sets the callback to get the amount of pieces to allow to split the color scale in N quantized equal bins.
        Parameters:
        quantizeCallback - the callback to get the amount of pieces to allow to split the color scale in N quantized equal bins

      • getQuantizeCallback

        public default QuantizeCallback getQuantizeCallback()
        Returns the callback to get the amount of pieces to allow to split the color scale in N quantized equal bins.
        Returns:
        the callback to get the amount of pieces to allow to split the color scale in N quantized equal bins

      • setMissingColor

        public default void setMissingColor​(ColorCallback<ScaleContext> missingColorCallback)
        Sets the missing color callback.
        Parameters:
        missingColorCallback - the missing color callback

      • getMissingColorCallback

        public default ColorCallback<ScaleContext> getMissingColorCallback()
        Returns the missing color callback.
        Returns:
        the missing color callback

      • getColorForValueAsString

        public default String getColorForValueAsString​(double value)
        Returns the color for a specific data value.
        Parameters:
        value - to use for searching
        Returns:
        a color a string or Undefined.STRING if not recognized the value by the chart.

      • getColorForValue

        public default IsColor getColorForValue​(double value)
        Returns the color for a specific data value.
        Parameters:
        value - to use for searching
        Returns:
        a color or null if not recognized the value by the chart.

      • 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