Package io.jmix.mapsui.component

Class HeatMapOptions

java.lang.Object
io.jmix.mapsui.component.HeatMapOptions
public class HeatMapOptions extends Object
Options for a heat map.

  • Constructor Details

    • HeatMapOptions

      public HeatMapOptions()

  • Method Details

    • getMaximumIntensity

      public Double getMaximumIntensity()

    • setMaximumIntensity

      @StudioProperty(defaultValue="1") public HeatMapOptions setMaximumIntensity(Double maximumIntensity)
      Sets the maximum point intensity. Default value is 1.
      Parameters:
      maximumIntensity -
      Returns:
      the instance of HeatMapOptions on which this method was called. Useful for a fluent API.

    • getBlur

      public Double getBlur()

    • setBlur

      @StudioProperty(defaultValue="15") public HeatMapOptions setBlur(Double blur)
      Sets the amount of blur in a point.

      Default value is 15.

      Parameters:
      blur -
      Returns:
      the instance of HeatMapOptions on which this method was called. Useful for a fluent API.

    • getRadius

      public Integer getRadius()

    • setRadius

      @StudioProperty(defaultValue="25") public HeatMapOptions setRadius(Integer radius)
      Sets the radius of each point of a heatmap.

      Default value is 25.

      Parameters:
      radius -
      Returns:
      the instance of HeatMapOptions on which this method was called. Useful for a fluent API.

    • getGradient

      public Map<Double,String> getGradient()

    • setGradient

      public HeatMapOptions setGradient(Map<Double,String> gradient)
      Sets the color gradient config.

      Each entry of a map should contain intensity value (from 0 to 1 by default) as a key and a color corresponding to the specified intensity as a value. For example: [0.4: 'blue', 0.65: 'lime', 1: 'red'].

      Parameters:
      gradient -
      Returns:
      the instance of HeatMapOptions on which this method was called. Useful for a fluent API.

    • getMinOpacity

      public Double getMinOpacity()

    • setMinOpacity

      @StudioProperty(defaultValue="0.05") public HeatMapOptions setMinOpacity(Double minOpacity)
      Sets the minimum opacity the heat will start at.

      Default value is 0.05.

      Parameters:
      minOpacity -
      Returns:
      the instance of HeatMapOptions on which this method was called. Useful for a fluent API.

    • getMaxZoom

      public Double getMaxZoom()

    • setMaxZoom

      @StudioProperty(name="maxIntensityZoom") public HeatMapOptions setMaxZoom(Double maxZoom)
      Sets the zoom level where the points reach maximum intensity (as intensity scales with zoom). By default, equals the maxZoom of a map.
      Parameters:
      maxZoom -
      Returns:
      the instance of HeatMapOptions on which this method was called. Useful for a fluent API.