io.jmix.mapsui.component.leaflet.translators

Interface LeafletLayerTranslator

All Known Implementing Classes:

HeatMapLayerLeafletLayerTranslator, ImageLayerLeafletLayerTranslator, TileLayerLeafletLayerTranslator, VectorLayerLeafletLayerTranslator, WMSTileLayerLeafletLayerTranslator

public interface LeafletLayerTranslator

Component that translates a Layer of type specified in the LayerTranslator annotation to LeafletLayerHolder, containing Leaflet representation of the layer.

An implementation of the interface should be annotated with LayerTranslator with specified the type of a layer that it can operate with.

When implementing a custom translator be sure to specify the correct Order to override the component's implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static int	HIGHEST_PLATFORM_PRECEDENCE Defines the highest precedence for Ordered Leaflet layer translators of the platform.
static int	LOWEST_PLATFORM_PRECEDENCE Defines the lowest precedence for Ordered Leaflet layer translators of the platform.

Method Summary

Modifier and Type	Method and Description
LeafletLayerHolder<? extends LeafletLayer>	translateLayer(Layer layer) Returns an instance of LeafletLayerHolder, containing Leaflet representation of the given layer.

Field Detail

HIGHEST_PLATFORM_PRECEDENCE

static final int HIGHEST_PLATFORM_PRECEDENCE

Defines the highest precedence for Ordered Leaflet layer translators of the platform.

See Also:

Constant Field Values

LOWEST_PLATFORM_PRECEDENCE

static final int LOWEST_PLATFORM_PRECEDENCE

Defines the lowest precedence for Ordered Leaflet layer translators of the platform.

See Also:

Constant Field Values

Method Detail

translateLayer

LeafletLayerHolder<? extends LeafletLayer> translateLayer(Layer layer)

Returns an instance of LeafletLayerHolder, containing Leaflet representation of the given layer.

Parameters:

layer - to be translated

Returns:

LeafletLayerHolder