com.esri.core.portal
Class WebMapLayer

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

public class WebMapLayer
extends Object

This class represents an operational layer within a WebMap

Nested Class Summary

static class	WebMapLayer.Mode The operational mode of an ArcGIS Feature layer
static class	WebMapLayer.Type The type of layer in a WebMap

Field Summary

boolean

_isBaseLayer

Method Summary

Map<Integer,PopupInfo>	getAllPopUpInfos()
int[]	getBandIds() The list of band ids.
int[]	getDisplayLevels() The list of display levels.
ArrayList<FeatureSet>	getFeatureSets() Returns the feature set of a feature collection
String	getItemId() Returns the Item id of the data represented by this operational layer in the WebMap
String	getLayerDefinitionOverride()
ArrayList<String>	getLayerDefinitions() Returns the layer definitions of a feature collection
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
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[]	getVisibleLayers() The list of visible layers.
boolean	hasSubLayerIds() Returns true if the layer specified the sub-layer ids.
boolean	isFeatureCollection() Tells if this layer is a feature collection.
boolean	isReference() Tells if this layer is a reference layer.
boolean	isVisible() Returns the default visibility of this layer

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_isBaseLayer

public boolean _isBaseLayer

Method Detail

getUrl

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

isVisible

public boolean isVisible()

Returns the default visibility of this layer

Returns:

true if this layer is visible, false otherwise

getLayerDefinitionOverride

public String getLayerDefinitionOverride()

Returns:

the _layerDefinitionOverride

getOpacity

public float getOpacity()

Returns the opacity for this layer specified in the WebMap

Returns:

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

getTitle

public String getTitle()

Returns the title of this operational layer

Returns:

the title

getItemId

public String getItemId()

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

Returns:

the Item id

isReference

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

getVisibleLayers

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

getDisplayLevels

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

getBandIds

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

getMode

public WebMapLayer.Mode getMode()

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

Returns:

the WebMapLayer.Mode

getType

public WebMapLayer.Type getType()

Returns the type of this Web Map layer.

Returns:

the WebMapLayer.Type

getAllPopUpInfos

public Map<Integer,PopupInfo> getAllPopUpInfos()

isFeatureCollection

public boolean isFeatureCollection()

Tells if this layer is a feature collection.

Returns:

true if this layer is a feature collection, else false

getFeatureSets

public ArrayList<FeatureSet> getFeatureSets()

Returns the feature set of a feature collection

Returns:

the FeatureSet

getLayerDefinitions

public ArrayList<String> getLayerDefinitions()

Returns the layer definitions of a feature collection

Returns:

An ArrayList of layer definitions for a feature collection.

hasSubLayerIds

public boolean hasSubLayerIds()

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

Returns:

true if the layer specified the sub-layer ids.