public class

WebMapLayer

extends Object
java.lang.Object
   ↳ com.esri.core.portal.WebMapLayer

Class Overview

This class represents an operational layer within a WebMap.

Summary

Nested Classes
enum WebMapLayer.Mode The operational mode of an ArcGIS Feature layer. 
enum WebMapLayer.Type The type of layer in a WebMap. 
Fields
public boolean _isBaseLayer
Protected Constructors
WebMapLayer()
Constructs an empty WebMapLayer.
WebMapLayer(String title, String url)
Constructs a WebMapLayer with the specified title and the URL.
Public Methods
String fetchOwningSystemURL()
Gets the OwingSystemURL of the layer.
int[] getBandIds()
The list of band ids.
String getCapabilitiesOverride()
Gets the capabilities override.
String getColumnDelimiter()
Gets the column delimiter.
String getCopyright()
Gets the copyright.
int[] getDisplayLevels()
The list of display levels.
Envelope getExtent()
Gets the extent.
FeatureCollection getFeatureCollection()
Gets the feature collection.
String getFormat()
Gets the format.
String getID()
Gets the id.
int[] getInvisibleLegendLayers()
Returns a list of ID number whose legend is not shown.
String getItemId()
Returns the Item id of the data represented by this operational layer in the WebMap.
String getLatitudeFieldName()
Gets the latitude field name.
String getLayerDefinitionOverride()
Gets the layer definition override.
ArrayList<String> getLayerDefinitions()
Returns the layer definitions of a feature collection.
List<WebMapSubLayer> getLayers()
Returns a list of WebMapSubLayer objects which represents the sub-layers of this layer.
String getLocationType()
Gets the location type.
String getLongitudeFieldName()
Gets the longitude field name.
String getMapUrl()
Map URL string for WMS service.
double getMaxScale()
Returns the maximum scale.
double getMinScale()
Returns the minimum scale.
WebMapLayer.Mode getMode()
Returns the mode that an ArcGIS Feature Layer is configured to work in.
float getOpacity()
Returns the opacity for this layer specified in the WebMap.
List<SpatialReference> getSpatialRefs()
Gets the spatial refs.
String getTitle()
Returns the title of this operational layer.
WebMapLayer.Type getType()
Returns the type of this Web Map layer.
String getUrl()
Returns the URL of a GIS Service layer.
int[] getVisibleFolders()
Gets the visible folder's ids.
int[] getVisibleLayers()
The list of visible layers.
WebMapPopupInfo getWebMapPopupInfo()
Gets the PopupInfo object.
String getWmsVersion()
Gets the wms version.
List<String> getWmsVisibleLayers()
The list of visible WMS layers.
boolean hasSubLayerIds()
This method is deprecated. No replacement.
boolean isFeatureCollection()
This method is deprecated. No replacement.
boolean isReference()
Tells if this layer is a reference layer.
boolean isShowLegend()
Indicates whether the webmap should show the features from this service in the legend.
boolean isVisible()
Returns the default visibility of this layer
Protected Methods
static WebMapLayer fromJson(JsonParser parser)
Constructs and sets the internal state of this WebMapLayer from a response received from the server.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public boolean _isBaseLayer

Protected Constructors

protected WebMapLayer ()

Constructs an empty WebMapLayer. Users will never explicitly create an instance of a WebMapLayer.

protected WebMapLayer (String title, String url)

Constructs a WebMapLayer with the specified title and the URL. This constructor is invoked when a Web Map does not contain any layers and the base layer is specified in the Item info

Public Methods

public String fetchOwningSystemURL ()

Gets the OwingSystemURL of the layer.

Returns
  • the OwingSystemURL as a string.
Throws
Exception if the action can not be completed.

public int[] getBandIds ()

The list of band ids. This property is applicable only when the URL obtained through getUrl() represents an Image Service Layer.

Returns
  • an array of band ids

public String getCapabilitiesOverride ()

Gets the capabilities override.

Returns
  • the capabilities override

public String getColumnDelimiter ()

Gets the column delimiter.

Returns
  • the column delimiter

public String getCopyright ()

Gets the copyright.

Returns
  • the copyright text

public int[] getDisplayLevels ()

The list of display levels. This property is applicable only when the URL obtained through getUrl() represents a Tiled Map Service Layer.

Returns
  • an array of display levels

public Envelope getExtent ()

Gets the extent.

Returns
  • the extent

public FeatureCollection getFeatureCollection ()

Gets the feature collection.

Returns
  • the feature collection

public String getFormat ()

Gets the format.

Returns
  • the image format

public String getID ()

Gets the id.

Returns
  • the id

public int[] getInvisibleLegendLayers ()

Returns a list of ID number whose legend is not shown.

Returns
  • an array of layer id.

public String getItemId ()

Returns the Item id of the data represented by this operational layer in the WebMap.

Returns
  • the Item id

public String getLatitudeFieldName ()

Gets the latitude field name.

Returns
  • the latitude field name

public String getLayerDefinitionOverride ()

Gets the layer definition override.

Returns
  • the _layerDefinitionOverride

public ArrayList<String> getLayerDefinitions ()

Returns the layer definitions of a feature collection.

Returns
  • An ArrayList of layer definitions for a feature collection.

public List<WebMapSubLayer> getLayers ()

Returns a list of WebMapSubLayer objects which represents the sub-layers of this layer. For example, if the layer is the tiled map service layer, a sub-layer may have a layer ID, an optional Popup information. If the layer is a feature collection, a sub-layer may have a layer ID, layer definition and feature set.

Returns
  • A list of sub-layers.

public String getLocationType ()

Gets the location type.

Returns
  • the location type

public String getLongitudeFieldName ()

Gets the longitude field name.

Returns
  • the longitude field name

public String getMapUrl ()

Map URL string for WMS service.

Returns
  • Map URL string.

public double getMaxScale ()

Returns the maximum scale.

Returns
  • the maximum scale.

public double getMinScale ()

Returns the minimum scale.

Returns
  • the minimum scale.

public WebMapLayer.Mode getMode ()

Returns the mode that an ArcGIS Feature Layer is configured to work in.

Returns

public float getOpacity ()

Returns the opacity for this layer specified in the WebMap.

Returns
  • the opacity. 0 meaning fully transparent, 1 meaning opaque.

public List<SpatialReference> getSpatialRefs ()

Gets the spatial refs.

Returns
  • the spatial refs

public String getTitle ()

Returns the title of this operational layer.

Returns
  • the title

public WebMapLayer.Type getType ()

Returns the type of this Web Map layer.

Returns

public String getUrl ()

Returns the URL of a GIS Service layer. It is the responsibility of the application to infer the type of service (Dynamic Map Service layer, Tiled Map Service layer, etc) the URL represents. If the Service is either BingMaps or OpenStreetMap then the Url string is the name of the layer.

Returns
  • the Url string of a GIS Service layer

public int[] getVisibleFolders ()

Gets the visible folder's ids. Only applicable to the KML Layer type.

Returns
  • visible folder's ids.

public int[] getVisibleLayers ()

The list of visible layers. This property is applicable only when the URL obtained through getUrl() represents a Dynamic Map Service Layer.

Returns
  • an array of visible layers

public WebMapPopupInfo getWebMapPopupInfo ()

Gets the PopupInfo object. Only applicable to feature layer.

Returns
  • PopupInfo object.

public String getWmsVersion ()

Gets the wms version.

Returns
  • the wms version

public List<String> getWmsVisibleLayers ()

The list of visible WMS layers. The getLayers() method returns all layers regardless of visibility. Use this method to get a list of the layers that are initially visible. If this returns null then all of the layers will be visible.

Returns
  • an array of visible WMS layers

public boolean hasSubLayerIds ()

This method is deprecated.
No replacement.

Returns true if the layer specified the sub-layer ids.

Returns
  • true if the layer specified the sub-layer ids.

public boolean isFeatureCollection ()

This method is deprecated.
No replacement.

Tells if this layer is a feature collection.

Returns
  • true if this layer is a feature collection, else false

public boolean isReference ()

Tells if this layer is a reference layer. This property is applicable only to base map layers within a WebMap

Returns
  • true if this layer is a reference layer, else false

public boolean isShowLegend ()

Indicates whether the webmap should show the features from this service in the legend.

Returns
  • boolean.

public boolean isVisible ()

Returns the default visibility of this layer

Returns
  • true if this layer is visible, false otherwise

Protected Methods

protected static WebMapLayer fromJson (JsonParser parser)

Constructs and sets the internal state of this WebMapLayer from a response received from the server.

Returns
  • an initialized WebMap
Throws
PortalException if the action can not be completed.