Class AppLayer

java.lang.Object
org.tailormap.api.viewer.model.AppLayer
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.SpringCodegen", comments="Generator version: 7.25.0") public class AppLayer extends Object implements Serializable
A map layer, but only enough information to draw the layer. For advanced functionality that required access to attributes the LayerDetails should be requested.
See Also:

  • Constructor Details

    • AppLayer

      public AppLayer()

  • Method Details

    • id

      public AppLayer id(String id)

    • getId

      @NotNull public @NotNull String getId()
      Unique id of this layer reference in the application. Another app layer may exist which references the same layerName of the same service, but with different settings.
      Returns:
      id

    • setId

      public void setId(String id)

    • serviceId

      public AppLayer serviceId(String serviceId)

    • getServiceId

      @NotNull public @NotNull String getServiceId()
      Get serviceId
      Returns:
      serviceId

    • setServiceId

      public void setServiceId(String serviceId)

    • layerName

      public AppLayer layerName(String layerName)

    • getLayerName

      @NotNull public @NotNull String getLayerName()
      Layer name as known by the service.
      Returns:
      layerName

    • setLayerName

      public void setLayerName(String layerName)

    • title

      public AppLayer title(String title)

    • getTitle

      @NotNull public @NotNull String getTitle()
      Layer title or display name.
      Returns:
      title

    • setTitle

      public void setTitle(String title)

    • url

      public AppLayer url(@Nullable String url)

    • getUrl

      public String getUrl()
      URL for this specific layer. If empty use URL from the service.
      Returns:
      url

    • setUrl

      public void setUrl(String url)

    • visible

      public AppLayer visible(Boolean visible)

    • getVisible

      @NotNull public @NotNull Boolean getVisible()
      Get visible
      Returns:
      visible

    • setVisible

      public void setVisible(Boolean visible)

    • opacity

      public AppLayer opacity(@Nullable Integer opacity)

    • getOpacity

      public Integer getOpacity()
      The opacity of the layer (in percentage, from 0-100, where 0 is \"transparent\" and 100 is \"opaque\").
      Returns:
      opacity

    • setOpacity

      public void setOpacity(Integer opacity)

    • minScale

      public AppLayer minScale(@Nullable Double minScale)

    • getMinScale

      public Double getMinScale()
      Minimum scale at which this layer should be shown or is not blank. When absent there is no minimum. As reported by the service (ScaleHint or MinScaleDenominator).
      Returns:
      minScale

    • setMinScale

      public void setMinScale(Double minScale)

    • maxScale

      public AppLayer maxScale(@Nullable Double maxScale)

    • getMaxScale

      public Double getMaxScale()
      Maximum scale denominator at which this layer should be shown or is not blank. When absent there is no maximum. As reported by the service (ScaleHint or MaxScaleDenominator).
      Returns:
      maxScale

    • setMaxScale

      public void setMaxScale(Double maxScale)

    • legendImageUrl

      public AppLayer legendImageUrl(@Nullable String legendImageUrl)

    • getLegendImageUrl

      public String getLegendImageUrl()
      URL to an image with the layer legend.
      Returns:
      legendImageUrl

    • setLegendImageUrl

      public void setLegendImageUrl(String legendImageUrl)

    • legendType

      public AppLayer legendType(@Nullable AppLayer.LegendTypeEnum legendType)

    • getLegendType

      public AppLayer.LegendTypeEnum getLegendType()
      Whether the legend is a static image or a dynamic WMS legend.
      Returns:
      legendType

    • setLegendType

      public void setLegendType(AppLayer.LegendTypeEnum legendType)

    • tilingDisabled

      public AppLayer tilingDisabled(@Nullable Boolean tilingDisabled)

    • getTilingDisabled

      public Boolean getTilingDisabled()
      Set to true to request a single tile for WMS (may result in errors when max size/mem exceeded)
      Returns:
      tilingDisabled

    • setTilingDisabled

      public void setTilingDisabled(Boolean tilingDisabled)

    • tilingGutter

      public AppLayer tilingGutter(@Nullable Integer tilingGutter)

    • getTilingGutter

      public Integer getTilingGutter()
      Gutter around tile to discard to avoid tile edge rendering artifacts
      Returns:
      tilingGutter

    • setTilingGutter

      public void setTilingGutter(Integer tilingGutter)

    • hiDpiDisabled

      public AppLayer hiDpiDisabled(@Nullable Boolean hiDpiDisabled)

    • getHiDpiDisabled

      public Boolean getHiDpiDisabled()
      Set to true to *not* render in high DPI when available
      Returns:
      hiDpiDisabled

    • setHiDpiDisabled

      public void setHiDpiDisabled(Boolean hiDpiDisabled)

    • hiDpiMode

      public AppLayer hiDpiMode(@Nullable TileLayerHiDpiMode hiDpiMode)

    • getHiDpiMode

      @Valid public @Valid TileLayerHiDpiMode getHiDpiMode()
      Get hiDpiMode
      Returns:
      hiDpiMode

    • setHiDpiMode

      public void setHiDpiMode(TileLayerHiDpiMode hiDpiMode)

    • hiDpiSubstituteLayer

      public AppLayer hiDpiSubstituteLayer(@Nullable String hiDpiSubstituteLayer)

    • getHiDpiSubstituteLayer

      public String getHiDpiSubstituteLayer()
      The layer name of this service to substitute when the device pixel ratio is higher
      Returns:
      hiDpiSubstituteLayer

    • setHiDpiSubstituteLayer

      public void setHiDpiSubstituteLayer(String hiDpiSubstituteLayer)

    • minZoom

      public AppLayer minZoom(@Nullable Integer minZoom)

    • getMinZoom

      public Integer getMinZoom()
      Minimum zoom for XYZ layer
      Returns:
      minZoom

    • setMinZoom

      public void setMinZoom(Integer minZoom)

    • maxZoom

      public AppLayer maxZoom(@Nullable Integer maxZoom)

    • getMaxZoom

      public Integer getMaxZoom()
      Maximum zoom for XYZ layer
      Returns:
      maxZoom

    • setMaxZoom

      public void setMaxZoom(Integer maxZoom)

    • tileSize

      public AppLayer tileSize(@Nullable Integer tileSize)

    • getTileSize

      public Integer getTileSize()
      Tile size for XYZ layer
      Returns:
      tileSize

    • setTileSize

      public void setTileSize(Integer tileSize)

    • tileGridExtent

      public AppLayer tileGridExtent(@Nullable Bounds tileGridExtent)

    • getTileGridExtent

      @Valid public @Valid Bounds getTileGridExtent()
      Get tileGridExtent
      Returns:
      tileGridExtent

    • setTileGridExtent

      public void setTileGridExtent(Bounds tileGridExtent)

    • hasAttributes

      public AppLayer hasAttributes(Boolean hasAttributes)

    • getHasAttributes

      @NotNull public @NotNull Boolean getHasAttributes()
      Whether this layer has attributes that can be accessed eg. for feature info or attribute list
      Returns:
      hasAttributes

    • setHasAttributes

      public void setHasAttributes(Boolean hasAttributes)

    • editable

      public AppLayer editable(@Nullable Boolean editable)

    • getEditable

      public Boolean getEditable()
      Whether this layer can be edited.
      Returns:
      editable

    • setEditable

      public void setEditable(Boolean editable)

    • attribution

      public AppLayer attribution(@Nullable String attribution)

    • getAttribution

      public String getAttribution()
      Attribution text to show for this layer.
      Returns:
      attribution

    • setAttribution

      public void setAttribution(String attribution)

    • description

      public AppLayer description(@Nullable String description)

    • getDescription

      public String getDescription()
      Description text to show for this layer, may contain some links and images (see htmlify pipe)
      Returns:
      description

    • setDescription

      public void setDescription(String description)

    • keywords

      public AppLayer keywords(@Nullable Set<String> keywords)

    • addKeywordsItem

      public AppLayer addKeywordsItem(String keywordsItem)

    • getKeywords

      public Set<String> getKeywords()
      Keywords for this layer, to be used for filtering layers
      Returns:
      keywords

    • setKeywords

      public void setKeywords(Set<String> keywords)

    • autoRefreshInSeconds

      public AppLayer autoRefreshInSeconds(@Nullable Double autoRefreshInSeconds)

    • getAutoRefreshInSeconds

      public Double getAutoRefreshInSeconds()
      Automatically refresh the layer (in seconds)
      Returns:
      autoRefreshInSeconds

    • setAutoRefreshInSeconds

      public void setAutoRefreshInSeconds(Double autoRefreshInSeconds)

    • searchIndex

      public AppLayer searchIndex(@Nullable LayerSearchIndex searchIndex)

    • getSearchIndex

      @Valid public @Valid LayerSearchIndex getSearchIndex()
      Get searchIndex
      Returns:
      searchIndex

    • setSearchIndex

      public void setSearchIndex(LayerSearchIndex searchIndex)

    • webMercatorAvailable

      public AppLayer webMercatorAvailable(@Nullable Boolean webMercatorAvailable)

    • getWebMercatorAvailable

      public Boolean getWebMercatorAvailable()
      Whether Web Mercator projection is available for this layer.
      Returns:
      webMercatorAvailable

    • setWebMercatorAvailable

      public void setWebMercatorAvailable(Boolean webMercatorAvailable)

    • tileset3dStyle

      public AppLayer tileset3dStyle(@Nullable Object tileset3dStyle)

    • getTileset3dStyle

      public Object getTileset3dStyle()
      The tileset style to use for this layer
      Returns:
      tileset3dStyle

    • setTileset3dStyle

      public void setTileset3dStyle(Object tileset3dStyle)

    • hiddenFunctionality

      public AppLayer hiddenFunctionality(@Nullable Set<HiddenLayerFunctionalityEnum> hiddenFunctionality)

    • addHiddenFunctionalityItem

      public AppLayer addHiddenFunctionalityItem(HiddenLayerFunctionalityEnum hiddenFunctionalityItem)

    • getHiddenFunctionality

      @Valid public @Valid Set<HiddenLayerFunctionalityEnum> getHiddenFunctionality()
      Functionality that should be hidden for a layer in the UI. The functionality is still available in the backend, so not a \"security\" setting.
      Returns:
      hiddenFunctionality

    • setHiddenFunctionality

      public void setHiddenFunctionality(Set<HiddenLayerFunctionalityEnum> hiddenFunctionality)

    • styles

      public AppLayer styles(@Nullable List<@Valid WMSStyle> styles)

    • addStylesItem

      public AppLayer addStylesItem(WMSStyle stylesItem)

    • getStyles

      @Valid public @Valid List<@Valid WMSStyle> getStyles()
      Configured WMS styles for this layer, if any.
      Returns:
      styles

    • setStyles

      public void setStyles(List<@Valid WMSStyle> styles)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object