io.jmix.mapsui.component

Class HeatMapOptions

java.lang.Object

io.jmix.mapsui.component.HeatMapOptions

public class HeatMapOptions
extends java.lang.Object

Options for a heat map.

Constructor Summary

Constructors

Constructor and Description
HeatMapOptions()

Method Summary

Modifier and Type	Method and Description
java.lang.Double	getBlur()
java.util.Map<java.lang.Double,java.lang.String>	getGradient()
java.lang.Double	getMaximumIntensity()
java.lang.Double	getMaxZoom()
java.lang.Double	getMinOpacity()
java.lang.Integer	getRadius()
HeatMapOptions	setBlur(java.lang.Double blur) Sets the amount of blur in a point.
HeatMapOptions	setGradient(java.util.Map<java.lang.Double,java.lang.String> gradient) Sets the color gradient config.
HeatMapOptions	setMaximumIntensity(java.lang.Double maximumIntensity) Sets the maximum point intensity.
HeatMapOptions	setMaxZoom(java.lang.Double maxZoom) Sets the zoom level where the points reach maximum intensity (as intensity scales with zoom).
HeatMapOptions	setMinOpacity(java.lang.Double minOpacity) Sets the minimum opacity the heat will start at.
HeatMapOptions	setRadius(java.lang.Integer radius) Sets the radius of each point of a heatmap.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeatMapOptions

public HeatMapOptions()

Method Detail

getMaximumIntensity

public java.lang.Double getMaximumIntensity()

setMaximumIntensity

@StudioProperty(defaultValue="1")
public HeatMapOptions setMaximumIntensity(java.lang.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 java.lang.Double getBlur()

setBlur

@StudioProperty(defaultValue="15")
public HeatMapOptions setBlur(java.lang.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 java.lang.Integer getRadius()

setRadius

@StudioProperty(defaultValue="25")
public HeatMapOptions setRadius(java.lang.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 java.util.Map<java.lang.Double,java.lang.String> getGradient()

setGradient

public HeatMapOptions setGradient(java.util.Map<java.lang.Double,java.lang.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 java.lang.Double getMinOpacity()

setMinOpacity

@StudioProperty(defaultValue="0.05")
public HeatMapOptions setMinOpacity(java.lang.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 java.lang.Double getMaxZoom()

setMaxZoom

@StudioProperty(name="maxIntensityZoom")
public HeatMapOptions setMaxZoom(java.lang.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.