| Package | com.esri.baserver.tasks.tradeareas |
| Class | public final class ThresholdRingsTask |
| Inheritance | ThresholdRingsTask  BAServerTask BATask AbstractTask flash.events.EventDispatcher |
The radii of the rings are determined by expanding out from the store location until they meet the given criteria. You define the criteria, or size of each ring, manually.
The following is an example of how this task can be used to examine the optimal location for a new community center in a given market. Assume you have several proposed community center locations in San Diego, California. To create threshold rings for each location, you would set the community center point layer as the store layer. You would then set the threshold data to a standard geographic layer. You can set the field to aggregate to total households and create the ring-based trade areas based on the values you set in the radii parameter.
Each ring created will have the same number of households but will be of different sizes. This task provides an excellent visual indicator of how far each community center will have to draw the same number of households. A city may want to optimize the location of a new community center by finding the location that will minimize how far people will have to travel to a facility. This same logic can be applied to a retail business scenario.
Because the radii is the same for each store, this task is good for comparing the trade areas of similar stores.
This task is typically used to create radius trade areas for competitors so a store owner can see if a store is being cannibalized by the competition. It can also be used to look for gaps in the market area.
The result of this task is a TaskResultOutput object,
which is compatible with ArcGIS Server's mapping APIs. FeatureSet, MapImage, and an array of
ReportInfo objects can be returned in it depending on task output options requested.
Additionally, the output analysis layer and/or report can be stored to the Business Analyst Server repository.
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 : TaskResultOutput [read-only]
The last result of executing the Threshold Rings task. | ThresholdRingsTask | ||
| 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 | ||
|---|---|---|---|
ThresholdRingsTask(urlOrClient:Object = null)
Creates a new instance of the ThresholdRingsTask class. | ThresholdRingsTask | ||
Creates a new command encapsulating this task and the given parameters. | ThresholdRingsTask | ||
execute(parameters:ThresholdRingsParameters, responder:IResponder = null):AsyncToken
Sends a request for executing a Threshold Rings task to the Business Analyst Server HTTP (REST) Service. | ThresholdRingsTask | ||
| Constant | Defined By | ||
|---|---|---|---|
| name : String = ThresholdRings [static] Task name. | ThresholdRingsTask | ||
| lastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertieslastResult:TaskResultOutput [read-only] The last result of executing the Threshold Rings task.
public function get lastResult():TaskResultOutput| ThresholdRingsTask | () | Constructor |
public function ThresholdRingsTask(urlOrClient:Object = null)Creates a new instance of the ThresholdRingsTask 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(parameters:ThresholdRingsParameters, commandName:String = null):BACommandCreates a new command encapsulating this task and the given parameters.
Parameters
parameters:ThresholdRingsParameters — Parameters of a task to be executed.
| |
commandName:String (default = null) |
BACommand — A new command.
|
| execute | () | method |
public function execute(parameters:ThresholdRingsParameters, responder:IResponder = null):AsyncTokenSends a request for executing a Threshold Rings 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
parameters:ThresholdRingsParameters — Parameters of the task.
| |
responder:IResponder (default = null) |
AsyncToken — Asynch token associated with the response.
|
| name | Constant |
public static const name:String = ThresholdRingsTask name.