Initializes a new instance of the MapService class.
The URL to the REST endpoint of the MapService.
Occurs when initialization of this object fails.
Occurs when initialization succeeds with a response from the REST endpoint. Depending on the API, this response may actually be an error message served as a correct HTTP response.
Whether or not the map service is initially visible.
The URL, when available, where the layer's attribution data is stored.
The base map group that this service belongs to, if applicable.
The zero-based index of this map service within its base map group, if applicable.
Indicates whether the base map group that this service belongs to allows only one base map to be selected at a time.
The parameters supplied for creation of a Bing map through the connection string This object will be null for any MapService which is not a Bing map.
The catalog id
The clustering Layer object.
The initial opacity defined in the Site.
The initial visibility defined in the Site. This will be True if the default is to have the map service visible, false otherwise.
The attribution information for the layer.
The default data provider (e.g. "Oracle", "SqlServer") for all layers in this map service.
The default format string used for formatting date values originating from this map service.
The default format string used for formatting numeric values originating from this map service.
Description of the map service.
Whether or not to disable caching of the MapService on the client.
The display name of the MapService.
The drawing behavior of this map service. One of:
The Map that the MapService belongs to.
The Layer object for exploded clusters.
Any extensions of the MapService, as defined by the administrator on the server.
The failure action, which describes how the end user application should deal with a failed service.
The timeout (in seconds) before this mapService will be deemed to have failed
Boolean indicating whether the map service has timed out yet. This does not, in itself indicate an error. Subsequent resolution is possible.
Used to indicate what the MapService is capable of and is currently doing regarding clustering
The URL of the geometry service.
If the current map service has attribution data or not
Indicates whether this instance has layer catalog.
The heap map settings for this map service.
URI to an icon representation of this map service, for display in client applications.
The ID of the MapService.
Whether or not this mapService can be identified in the client application.
Format in which images will be drawn.
Observable indicating whether this map service is in the active theme or not.
Whether or not the catalog items for this mapService should be included in identify results or not.
Whether or not to include this map service in the layer lists of client applications.
Whether or not the mosaic dataset values for this mapService should be included in identify results or not.
Gets the error that occurred during initialization of the service layer, or null if there were no errors during initialization.
Indicates whether the map service is searchable through Instant Search.
Whether or not the map service will be expanded by default when shown in a layer list.
Whether or not the object was successfully initialized.
Indicates whether or not the service layer (Esri's native layer) has been loaded.
Boolean indicating whether this map service is time aware or not
Indicates whether or not a mapService was created by a user at runtime
A collection of LayerHyperlinks associated with this map service.
A collection containing the layer theme settings for this map service.
The collection of Layer objects.
A view of the layers which is filtered to only include the active layers in the application. This will change, when, for example, a layer theme is applied. If no filter (layer theme) has been applied, then this collection will be the same as the 'layers' collection
The logical function of the MapService, either Base or Operational.
The type of MapService.
The URL used to retrieve a map image. Maybe a templated URL, as in the case of WMTS using RESTful encoding. May also be used to define the url that should used for WMS GetMap requests.*
A maximum scale value that overrides the map service's defined maximum scale.
A minimum scale value that overrides the map service's defined minimum scale.
function invoked when the failure timeout threshold is exceeded
The opacity of the map service.
A value between 0 and 1 inclusive that is used to filter the opacity of the map service. The map service's opacity will be combined with the filter to produce the final opacity seen by the end user.
The runtime spatial reference to use that is compatible with the map's spatial reference. For now this is just used for WMS and WFS.
The original URL of the Essentials map service REST endpoint.
The properties of the MapService, as defined by the administrator on the server.
The proxy URL for this service.
The request encoding for a WMTS service. Can be KVP or RESTful.
The map server version for the service host.
The Esri map service Layer object.
A unique identifier for the service.
The security token that must be provided when requesting the service from ArcGIS Server.
The URL of the map service published by ArcGIS Server.
The short display name for the map service.
The {@link geocortex.essentials.Site} that this resource belongs to.
The set of subdomains to use in a WebTiledLayer tile request.
Whether or not the map service supports dynamic layers.
The collection of table objects.
The URL used to retrieve tile images in the case of a RESTful WMTS service, which may be a URL template.
Controls format of requests to time aware OGC services, as they don't follow the esri map settings. "Disabled", "Instant", or "Range"
The time information for this map service - if it is time aware.
The IANA ID of the time zone in which the data in this layer's fields are current.
The URL that this resource was initialized from.
The type of user created layer. One of:
Only applies to layers created at runtime.
Adds a Layer to the map service. Also manipulates the Esri Layer and adds appropriate layer info and drawing options for dynamic layers. Currently supports dynamic layers only.
A Layer to add to the map service
Adds the layers specified by the layer catalog details to the map service.
The details.
A list of the layers that were added.
Converts the map service to use to dynamic layers. This will only have an effect if the map service supports dynamic layers.
Populates the map service from a dynamic object which represents a map service.
An object which represents the map service.
Performs a callback function when this instance has been initialized. If this instance is already initialized when this function is called, the callback function will execute immediately.
The scope to using when executing the callback - i.e. the value of the 'this' variable in the callback function. This parameter may be ommitted in which cased the first parameter will be used as the callback function.
The callback function to execute when this instance has been initialized.
Find the Layer matching the specified Id.
The Id of the Layer to find.
Find the table matching both the name and id.
The name of the table
The id of the table
Find the Layer or Table matching the specified Id. If the specified Id matches both a Layer and Table, the Layer will be returned.
The Id of the Layer or Table to find.
Find the Layer or Table matching the specified name. If the specified name matches both a Layer and Table, the Layer will be returned.
The name of the Layer or Table to find.
Somewhat of a workaround for the fact that names are not constrained unique (outside of the ESRI ecosystem) and ids could change This only returns a result if they both match, and this match is then almost guaranteed to be correct. However, there are cases where this won't return a match when there is one to make.
Gets the access token for the map service, if there is one, by looking in a number of places.
Find the Table matching the specified Id.
The Id of the Table to find.
Find the Table matching the specified name.
The name of the Table to find.
Find the table matching both the name and id.
The name of the table
The id of the table
Gets the IDs of the visible layers which were configured by the REST manager in an array.
Note: If a layer is configured visible but is in fact not visible because its parent is not configured visible, that layer will not be included in the returned list of visible layers.
Gets the IDs of the layers which are visible by default in the Esri service layer. Note: If a layer is visible by default but is in fact not visible because its parent is not visible by default, that layer will not be included in the returned list of visible layers.
Gets a layers DynamicLayerInfo from the ServiceLayer by the layer's id. Works only when the underlying ServiceLayer is of esri.layers.ArcGISDynamicMapServiceLayer type.
The layer id.
A DynamicLayerInfo or null if not found.
Gets the feature layer associated with this service. Only applicable for single-layer service types such as feature layers and image services. For other types of services, use getFeatureLayer() on individual layers.
Retrieves the layer theme settings for this mapService by specified layer theme or layer theme id
Gets the IDs of the currently visible layers in an array. Note: If a layer is currently set visible but is in fact not visible because its parent is not visible, that layer will not be included in the returned list of visible layers.
Initializes the {@link geocortex.essentials.AsyncInitializable}. This is an asynchronous method, you may subscribe to the onInitialized and onInitializationFailed events for completion information.
Gets whether or not this map service is Tiled (i.e. instance of esri.layers.TiledMapServiceLayer).
true if this map service is tiled; false otherwise
Gets whether the MapService is currently visible.
Refreshes the map service by making a new request to the server.
An optional parameter which if specified, will cause the map refresh to occur after the specified timeout. Any previous refresh timeouts will be cancelled when a new refresh timeout is set - ensuring that only one request goes out within the speicfied threshold. If undefined, the map refreshes immediately.
An optional parameter which, if set will disable client caching on the service layer (if supported) prior to refreshing it. Defaults to false.
Refreshes the layersFilteredView collection.
Removes a Layer from the the map service. Also manipulates the Esri Layer and removes appropriate layer info and drawing options for the layer. Currently supports dynamic layers only.
A layer to remove from the map service
Sets the inActiveTheme property of the MapService. Raises the "MapServiceInActiveThemeChangedEvent" event.
The value to set.
Sets the opacity of the MapService.
The opacity to be set, between 0.0 and 1.0 inclusive.
Sets the opacity filter of the MapService.
The opacity filter to be set, between 0.0 and 1.0 inclusive.
Sets the visibility of the MapService.
The visibility to be set (true: visible, false: hidden).
Returns whether or not this service supports layer visibility.
Exports the state of the map service as a JSON object. This can be used to recreate the layer again via createFromDefinition().
Represents a map service defined in a Map. A MapService is related to an Esri map service layer. It contains a reference to that Esri service in the serviceLayer property.