Package org.vaadin.addons.componentfactory.leaflet.plugins.heatmap

Class HeatLayerOptions

java.lang.Object
org.vaadin.addons.componentfactory.leaflet.plugins.heatmap.HeatLayerOptions
All Implemented Interfaces:
Serializable
public class HeatLayerOptions extends Object implements Serializable
Possible heatmap options
  • minOpacity - the minimum opacity the heat will start at
  • maxZoom - zoom level where the points reach maximum intensity (as intensity scales with zoom), equals maxZoom of the map by default
  • max - maximum point intensity, 1.0 by default
  • radius - radius of each "point" of the heatmap, 25 by default
  • blur - amount of blur, 15 by default
  • gradient - color gradient config, e.g. {0.4: 'blue', 0.65: 'lime', 1: 'red'}
*
Since:
2020-05-25
Version:
1.0
Author:
Gabor Kokeny Email: kokeny19@gmail.com
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    HeatLayerOptions()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static Map<Double,String>
    defaultGradient()
    Builds the default color gradient, mapping intensity ratios to colors (blue, cyan, lime, yellow and red).
    double
    getBlur()
    Returns the amount of blur applied to the heatmap.
    Map<Double,String>
    getGradient()
    Returns the color gradient configuration mapping intensity ratios to colors.
    double
    getMax()
    Returns the maximum point intensity.
    int
    getMaxZoom()
    Returns the zoom level at which the points reach maximum intensity.
    double
    getMinOpacity()
    Returns the minimum opacity the heat will start at.
    double
    getRadius()
    Returns the radius of each point of the heatmap.
    void
    setBlur(double blur)
    Sets the amount of blur applied to the heatmap.
    void
    setGradient(Map<Double,String> gradient)
    Sets the color gradient configuration mapping intensity ratios to colors, e.g.
    void
    setMax(double max)
    Sets the maximum point intensity.
    void
    setMaxZoom(int maxZoom)
    Sets the zoom level at which the points reach maximum intensity (as intensity scales with zoom).
    void
    setMinOpacity(double minOpacity)
    Sets the minimum opacity the heat will start at.
    void
    setRadius(double radius)
    Sets the radius of each point of the heatmap.
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • HeatLayerOptions

      public HeatLayerOptions()

  • Method Details

    • getMinOpacity

      public double getMinOpacity()
      Returns the minimum opacity the heat will start at.
      Returns:
      the minimum opacity

    • defaultGradient

      public static Map<Double,String> defaultGradient()
      Builds the default color gradient, mapping intensity ratios to colors (blue, cyan, lime, yellow and red).
      Returns:
      the default color gradient configuration

    • setMinOpacity

      public void setMinOpacity(double minOpacity)
      Sets the minimum opacity the heat will start at.
      Parameters:
      minOpacity - the minimum opacity

    • getMaxZoom

      public int getMaxZoom()
      Returns the zoom level at which the points reach maximum intensity.
      Returns:
      the maximum zoom level

    • setMaxZoom

      public void setMaxZoom(int maxZoom)
      Sets the zoom level at which the points reach maximum intensity (as intensity scales with zoom).
      Parameters:
      maxZoom - the maximum zoom level

    • getMax

      public double getMax()
      Returns the maximum point intensity.
      Returns:
      the maximum point intensity

    • setMax

      public void setMax(double max)
      Sets the maximum point intensity.
      Parameters:
      max - the maximum point intensity

    • getRadius

      public double getRadius()
      Returns the radius of each point of the heatmap.
      Returns:
      the point radius

    • setRadius

      public void setRadius(double radius)
      Sets the radius of each point of the heatmap.
      Parameters:
      radius - the point radius

    • getBlur

      public double getBlur()
      Returns the amount of blur applied to the heatmap.
      Returns:
      the blur amount

    • setBlur

      public void setBlur(double blur)
      Sets the amount of blur applied to the heatmap.
      Parameters:
      blur - the blur amount

    • setGradient

      public void setGradient(Map<Double,String> gradient)
      Sets the color gradient configuration mapping intensity ratios to colors, e.g. {0.4: 'blue', 0.65: 'lime', 1: 'red'}.
      Parameters:
      gradient - the color gradient configuration

    • getGradient

      public Map<Double,String> getGradient()
      Returns the color gradient configuration mapping intensity ratios to colors.
      Returns:
      the color gradient configuration

    • toString

      public String toString()
      Overrides:
      toString in class Object