HeatMapLayer (Jmix-maps 1.1 API)

java.lang.Object
- io.jmix.mapsui.component.layer.HeatMapLayer

All Implemented Interfaces:

Layer, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware
```
public class HeatMapLayer
extends java.lang.Object
```
A layer providing a visual representation of data density across a set of geographical points.
The layer's data can be provided either by data container or by providing data delegate which builds a map of points and their intensity values.

Field Summary

Fields
Modifier and Type Field and Description

protected org.springframework.context.ApplicationContext applicationContext

Fields
Modifier and Type	Field and Description
`protected org.springframework.context.ApplicationContext`	`applicationContext`

Constructor Summary

Constructors
Constructor and Description

HeatMapLayer(java.lang.String id)

Constructors
Constructor and Description
`HeatMapLayer(java.lang.String id)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`fireLayerChangedEvent(LayerChangedEvent event)`
`io.jmix.ui.model.CollectionContainer<?>`	`getDataContainer()` Returns a data container which is used to obtain the heatmap points.
`java.util.function.Function<HeatMapLayer,java.util.Map<org.locationtech.jts.geom.Point,java.lang.Double>>`	`getDataDelegate()` Returns a function which will be used to load a map of points and their intensity values.
`java.lang.String`	`getId()`
`java.lang.String`	`getIntensityProperty()` Returns a property which value defines the intensity of the point on a heatmap.
`int`	`getMaxZoom()` Returns maximum layer zoom level.
`int`	`getMinZoom()` Returns minimum layer zoom level.
`HeatMapOptions`	`getOptions()` Returns heatmap options.
`boolean`	`isEditable()` Whether the layer is to be editable on a map.
`boolean`	`isVisible()` Whether the layer is to be visible on a map.
`void`	`refresh()` Notify clients that the layer has changed and need to be redrawn.
`void`	`setApplicationContext(org.springframework.context.ApplicationContext applicationContext)`
`void`	`setDataContainer(io.jmix.ui.model.CollectionContainer<?> dataContainer)` Sets a data container which will be used to obtain the heatmap points.
`void`	`setDataDelegate(java.util.function.Function<HeatMapLayer,java.util.Map<org.locationtech.jts.geom.Point,java.lang.Double>> dataDelegate)` Sets a function which will be used to load a map of points and their intensity values.
`void`	`setEditable(boolean editable)` Sets whether the layer is to be editable on a map.
`void`	`setIntensityProperty(java.lang.String intensityProperty)` Sets a property which value defines the intensity of the point on a heatmap.
`void`	`setMaxZoom(int maxZoom)` Sets maximum zoom level up to which the layer is visible (inclusive).
`void`	`setMinZoom(int minZoom)` Sets minimum zoom level down to which the layer is visible (inclusive).
`void`	`setOptions(HeatMapOptions options)` Sets custom heatmap options.
`void`	`setVisible(boolean visible)` Sets whether the layer should be visible on a map.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - applicationContext
```
protected org.springframework.context.ApplicationContext applicationContext
```
- Constructor Detail
  - HeatMapLayer
```
public HeatMapLayer(java.lang.String id)
```
- Method Detail
  - getOptions
```
public HeatMapOptions getOptions()
```
    Returns heatmap options.
  - setOptions
```
public void setOptions(HeatMapOptions options)
```
    Sets custom heatmap options.
  - getDataDelegate
```
public java.util.function.Function<HeatMapLayer,java.util.Map<org.locationtech.jts.geom.Point,java.lang.Double>> getDataDelegate()
```
    Returns a function which will be used to load a map of points and their intensity values.
  - setDataDelegate
```
public void setDataDelegate(java.util.function.Function<HeatMapLayer,java.util.Map<org.locationtech.jts.geom.Point,java.lang.Double>> dataDelegate)
```
    Sets a function which will be used to load a map of points and their intensity values.
    If this function is specified along with dataContainer, the dataContainer will be ignored and this function will be used to obtain the heatmap data.
  - getDataContainer
```
public io.jmix.ui.model.CollectionContainer<?> getDataContainer()
```
    Returns a data container which is used to obtain the heatmap points.
  - setDataContainer
```
@StudioProperty(type=COLLECTION_DATACONTAINER_REF)
public void setDataContainer(io.jmix.ui.model.CollectionContainer<?> dataContainer)
```
    Sets a data container which will be used to obtain the heatmap points.
    The items of the data container should be geo-objects having a Geometry property of Point type. The intensity value of each point equals 1 by default. If the intensity value should be taken from some other property (for example, 'amount'), this property can be specified in setIntensityProperty(String). If the intensity value should be calculated another way, consider using setDataDelegate(java.util.function.Function<io.jmix.mapsui.component.layer.HeatMapLayer, java.util.Map<org.locationtech.jts.geom.Point, java.lang.Double>>) instead of this method, to build your own map of points and their intensity values.
    The layer does not react to changes in the data container, so if you need to update the layer, invoke Layer.refresh() method.
  - getIntensityProperty
```
public java.lang.String getIntensityProperty()
```
    Returns a property which value defines the intensity of the point on a heatmap.
  - setIntensityProperty
```
@StudioProperty(type=STRING)
public void setIntensityProperty(java.lang.String intensityProperty)
```
    Sets a property which value defines the intensity of the point on a heatmap.
    Used in combination with setDataContainer(io.jmix.ui.model.CollectionContainer<?>) to mark the property of the data container's entity meta-class.
  - setApplicationContext
```
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException
```
    Specified by:
    
    setApplicationContext in interface org.springframework.context.ApplicationContextAware
    
    Throws:
    
    org.springframework.beans.BeansException
  - setMaxZoom
```
public void setMaxZoom(int maxZoom)
```
    Description copied from interface: Layer
    
    Sets maximum zoom level up to which the layer is visible (inclusive).
    
    Specified by:
    
    setMaxZoom in interface Layer
    
    Parameters:
    
    maxZoom - maximum layer zoom level
  - getMaxZoom
```
public int getMaxZoom()
```
    Description copied from interface: Layer
    
    Returns maximum layer zoom level.
    
    Specified by:
    
    getMaxZoom in interface Layer
    
    Returns:
    
    maximum layer zoom level
  - setMinZoom
```
public void setMinZoom(int minZoom)
```
    Description copied from interface: Layer
    
    Sets minimum zoom level down to which the layer is visible (inclusive).
    Default value: 0.
    
    Specified by:
    
    setMinZoom in interface Layer
    
    Parameters:
    
    minZoom - minimum layer zoom level
  - getMinZoom
```
public int getMinZoom()
```
    Description copied from interface: Layer
    
    Returns minimum layer zoom level.
    
    Specified by:
    
    getMinZoom in interface Layer
    
    Returns:
    
    minimum layer zoom level
  - getId
```
public java.lang.String getId()
```
    Specified by:
    
    getId in interface Layer
    
    Returns:
    
    ID of a layer
  - setVisible
```
public void setVisible(boolean visible)
```
    Description copied from interface: Layer
    
    Sets whether the layer should be visible on a map.
    Default value: true.
    
    Specified by:
    
    setVisible in interface Layer
    
    Parameters:
    
    visible - true/false
  - isVisible
```
public boolean isVisible()
```
    Description copied from interface: Layer
    
    Whether the layer is to be visible on a map.
    
    Specified by:
    
    isVisible in interface Layer
    
    Returns:
    
    true if the layer is set to be visible; otherwise false
  - setEditable
```
public void setEditable(boolean editable)
```
    Description copied from interface: Layer
    
    Sets whether the layer is to be editable on a map.
    Default value: false.
    
    Specified by:
    
    setEditable in interface Layer
    
    Parameters:
    
    editable - true/false
  - isEditable
```
public boolean isEditable()
```
    Description copied from interface: Layer
    
    Whether the layer is to be editable on a map.
    
    Specified by:
    
    isEditable in interface Layer
    
    Returns:
    
    true if the layer is set to be editable; otherwise false
  - fireLayerChangedEvent
```
protected void fireLayerChangedEvent(LayerChangedEvent event)
```
  - refresh
```
public void refresh()
```
    Description copied from interface: Layer
    
    Notify clients that the layer has changed and need to be redrawn.
    
    Specified by:
    
    refresh in interface Layer
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class HeatMapLayer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

applicationContext

Constructor Detail

HeatMapLayer

Method Detail

getOptions

setOptions

getDataDelegate

setDataDelegate

getDataContainer

setDataContainer

getIntensityProperty

setIntensityProperty

setApplicationContext

setMaxZoom

getMaxZoom

setMinZoom

getMinZoom

getId

setVisible

isVisible

setEditable

isEditable

fireLayerChangedEvent

refresh

toString