Package io.jmix.mapsui.component.layer

Class TileLayer

java.lang.Object
io.jmix.mapsui.component.layer.RasterLayer
io.jmix.mapsui.component.layer.TileLayer
All Implemented Interfaces:
Layer, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware
Direct Known Subclasses:
WMSTileLayer
public class TileLayer extends RasterLayer
A class representing raster layer based on tiles.

This class contains parameters needed to connect to a tile service.

  • Field Details

    • applicationContext

      protected org.springframework.context.ApplicationContext applicationContext

  • Constructor Details

    • TileLayer

      public TileLayer(String id)

    • TileLayer

      public TileLayer(String id, String urlPattern)

  • Method Details

    • getUrl

      public String getUrl()
      Returns URL of a service.
      Returns:
      String URL of a service

    • setUrl

      @StudioProperty(name="urlPattern") public void setUrl(String url)
      Sets URL of a service.
      Parameters:
      url - String URL of a service

    • getAttributionString

      public String getAttributionString()
      Returns attribution string.
      Returns:
      attribution string

    • setAttributionString

      @StudioProperty(name="attribution") public void setAttributionString(String attributionString)
      Sets attribution string.
      Parameters:
      attributionString - String parameter

    • getSubDomains

      public String[] getSubDomains()
      Returns explicitly defined subdomain values for the url pattern.

    • setSubDomains

      @StudioProperty(type=STRING) public void setSubDomains(String[] subDomains)
      Sets possible values for the {s} placeholder in the url pattern of xyz tiles. These values are used sequentially to help with browser parallel requests per domain limitation.

      Can be omitted in most cases. By default: a, b, c.

    • setMaxZoom

      public void setMaxZoom(int maxZoom)
      Sets maximum zoom level up to which the layer is visible (inclusive).

      Default value: 18.

      Specified by:
      setMaxZoom in interface Layer
      Parameters:
      maxZoom - maximum layer zoom level

    • 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

    • 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 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 String toString()
      Overrides:
      toString in class Object