| Package | com.esri.baserver.tasks.rendering |
| Class | public final class AddLayersToMapTask |
| Inheritance | AddLayersToMapTask  BAServerTask BATask AbstractTask flash.events.EventDispatcher |
A layer is added to the map under the name specified with the layerName
parameter of its LayerItem instance. If this parameter is missing, the name
of the repository item is used as the layer name.
Layers temporary added to the default map are removed when the Business Analyst Server Map Service restarts.
The result of this task is a Boolean variable whose value is always true.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BAServerTask | |
| concurrency : String
Value that indicates how to handle multiple calls to the same task. | AbstractTask | |
| disableClientCaching : Boolean
If true, adds a timestamp parameter ("_ts") to the REST request to prevent the request from
being loaded from the browser's cache. | AbstractTask | |
| isFullErrorMessage : Boolean
Produce an error message with stack trace (true) or without stack trace (false). | BAServerTask | |
| lastResult : Boolean [read-only]
The last result of executing the Add Layers to Map task. | AddLayersToMapTask | ||
| proxyURL : String
The URL to proxy the request through. | AbstractTask | |
| requestTimeout : Number
The request timeout in seconds. | AbstractTask | |
| showBusyCursor : Boolean
If true, a busy cursor is displayed while a service is executing. | AbstractTask | |
| token : String
Token for accessing a secure task. | AbstractTask | |
| tokenProvider : ITokenProvider
Provider responsible for updating the security token if the last one expires. | BATask | |
| url : String
URL of the task. | AbstractTask | |
| Method | Defined By | ||
|---|---|---|---|
AddLayersToMapTask(urlOrClient:Object = null)
Creates a new instance of the AddLayersToMapTask class. | AddLayersToMapTask | ||
createCommand(layerItems:Array, commandName:String = null):BACommand
Creates a new command encapsulating this task and the given parameters. | AddLayersToMapTask | ||
createParameters(layerItems:Array):IBATaskParameters [static]
Creates parameters of this task in order to execute it with a generic or batch task. | AddLayersToMapTask | ||
execute(layerItems:Array, responder:IResponder = null):AsyncToken
Sends a request for executing an Add Layers to Map task to the Business Analyst Server HTTP (REST) Service. | AddLayersToMapTask | ||
| Constant | Defined By | ||
|---|---|---|---|
| name : String = AddLayersToMap [static] Task name. | AddLayersToMapTask | ||
| lastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertieslastResult:Boolean [read-only] The last result of executing the Add Layers to Map task.
public function get lastResult():Boolean| AddLayersToMapTask | () | Constructor |
public function AddLayersToMapTask(urlOrClient:Object = null)Creates a new instance of the AddLayersToMapTask class.
A new task can be constructed in two ways: as a task sharing a BAServerClient type instance
with other tasks (the urlOrClient parameter has the BAServerClient type) or
as a standalone task encapsulating its own client.
The base URL to the Business Analyst Server HTTP Service looks as follows:
http://{host}:{port}/ArcGIS/baserver/REST/services/DefaultMap/BAServer
The {host} and {port} parameters in this URL should be substituted with
valid Business Analyst Server host name and port, respectively.
urlOrClient:Object (default = null) |
See also
| createCommand | () | method |
public function createCommand(layerItems:Array, commandName:String = null):BACommandCreates a new command encapsulating this task and the given parameters.
Parameters
layerItems:Array — Layer items from the repository that will be added to the default map.
This array should contain items of the LayerItem type.
| |
commandName:String (default = null) |
BACommand — A new command.
|
See also
| createParameters | () | method |
public static function createParameters(layerItems:Array):IBATaskParametersCreates parameters of this task in order to execute it with a generic or batch task.
Parameters
layerItems:Array — Layer items from the repository that will be added to the default map.
This array should contain items of the LayerItem type.
|
IBATaskParameters — Parameters of this task.
|
See also
| execute | () | method |
public function execute(layerItems:Array, responder:IResponder = null):AsyncTokenSends a request for executing an Add Layers to Map task to the Business Analyst Server HTTP (REST) Service.
A response can be received in two ways—in an optional
responder object passed in parameters
of this method and/or in listeners of fault and taskCompleted
events registered for this task.
The responder is notified first when a response is received and parsed.
Its fault method receives a parameter of the FaultEvent type and its
result method receives a parameter of the BATaskCompletedEvent type
whose result property contains the result object.
After that the received event is dispatched to listeners of this task.
If a response is succesfully received and parsed, the result is assigned to the
lastResult property of this task.
Parameters
layerItems:Array — Layer items from the repository that will be added to the default map.
This array should contain items of the LayerItem type.
| |
responder:IResponder (default = null) |
AsyncToken — Asynch token associated with the response.
|
See also
| name | Constant |
public static const name:String = AddLayersToMapTask name.
// The layerItems parameter specifies an array of repository layers to be added to the map.
addLayersToMapTask.execute(layerItems, new Responder(resultHandler, faultHandler));