A task to compute areas that can be serviced (reached) from a given location. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.1 |
| Inherits: |
- List of all members, including inherited members
- ServiceAreaTask is part of QML Type List.
Properties
- apiKey : string
- createDefaultParametersResult : ServiceAreaParameters
- createDefaultParametersStatus : Enums.TaskStatus
- credential : Credential
- error : Error
- loadError : Error
- loadStatus : Enums.LoadStatus
- networkName : string
- requestConfiguration : RequestConfiguration
- serviceAreaTaskInfo : ServiceAreaTaskInfo
- solveServiceAreaResult : ServiceAreaResult
- solveServiceAreaStatus : Enums.TaskStatus
- transportationNetworkDataset : TransportationNetworkDataset
- url : url
Signals
- apiKeyChanged()
- createDefaultParametersStatusChanged()
- credentialChanged()
- loadErrorChanged()
- loadStatusChanged()
- networkNameChanged()
- requestConfigurationChanged()
- serviceAreaTaskInfoChanged()
- solveServiceAreaStatusChanged()
- transportationNetworkDatasetChanged()
- urlChanged()
Methods
- void cancelLoad()
- bool cancelTask(string taskId)
- void createDefaultParameters()
- void load()
- void retryLoad()
- string solveServiceArea(ServiceAreaParameters serviceAreaParameters)
Detailed Description
A ServiceAreaTask calculates areas that can be serviced (reached) from a given location. A network service area is a region that encompasses all street locations that can be accessed within a given distance or travel time from one or more facilities. For instance, the 10-minute service area for a facility includes all the street locations that can be reached within 10 minutes from that facility.
The service area task works in an online connected scenario by using a transportation network that is published to ArcGIS Server as an online Network Analyst service area service. Esri also provides ready-to-use services, such as the Directions and Routing Services, which requires authentication with an ArcGIS organizational account. In connected scenarios, provide a URL to the REST endpoint of the service, along with any necessary credentials.
An example of an online ServiceAreaTask:
ServiceAreaTask { id: onlineServiceAreaTask url: "https://www.myServer.com/arcgis/rest/services/routing/NAServer/Service%20Area" }
This QML type supports the following default properties. A default property is the property to which a value is assigned if an object of a specific QML type is declared within another object's declaration without declaring it as a value for a particular property.
| Type | Default Property |
|---|---|
| Credential | credential |
| RequestConfiguration | requestConfiguration |
See also ApiKeyResource, Cancelable, Loadable, RemoteResource, and Service Area REST API documentation.
Property Documentation
[since Esri.ArcGISRuntime 100.10] apiKey : string |
Returns the API key.
This property was introduced in Esri.ArcGISRuntime 100.10.
See also ApiKeyResource.
[read-only] createDefaultParametersResult : ServiceAreaParameters |
Results from createDefaultParameters(), giving access to the default ServiceAreaParameters (read-only).
Obtain this property after the createDefaultParametersStatusChanged signal emits, and the createDefaultParametersStatus is complete.
[read-only] createDefaultParametersStatus : Enums.TaskStatus |
Returns the current status of the createDefaultParameters method (read-only).
Wait until the createDefaultParametersStatus is Enums.TaskStatusComplete before obtaining the createDefaultParametersResult.
See also Enums.TaskStatus.
[default] credential : Credential |
The Credential for authenticating against a secured service.
Only applicable if using an online service that is secured.
[read-only] loadError : Error |
Returns the load error (read-only).
Note: Load errors are also reported on the error property and emit the errorChanged signal.
See also Loadable.
[read-only] loadStatus : Enums.LoadStatus |
Returns the load status (read-only).
See also Loadable and Enums.LoadStatus.
[since Esri.ArcGISRuntime 100.2] networkName : string |
The network dataset's name in the mobile geodatabase.
Note: This property is only used for offline routing.
This property was introduced in Esri.ArcGISRuntime 100.2.
[default] requestConfiguration : RequestConfiguration |
The configuration parameters used for network requests sent by this task.
[read-only] serviceAreaTaskInfo : ServiceAreaTaskInfo |
Returns ServiceAreaTaskInfo about this ServiceAreaTask (read-only).
Wait until the ServiceAreaTask is loaded before attempting to obtain the ServiceAreaTaskInfo.
[read-only] solveServiceAreaResult : ServiceAreaResult |
Results from solveServiceArea, giving access to the output ServiceAreaResult (read-only).
Obtain this property after the solveServiceAreaStatusChanged signal emits, and the solveServiceAreaStatus is complete.
[read-only] solveServiceAreaStatus : Enums.TaskStatus |
Returns the current status of the solveServiceArea method (read-only).
Wait until the solveServiceAreaStatus is Enums.TaskStatusComplete before obtaining the solveServiceAreaResult.
See also Enums.TaskStatus.
[since Esri.ArcGISRuntime 100.2] transportationNetworkDataset : TransportationNetworkDataset |
The transportation network dataser in the mobile geodatabase.
Note: This property is only used for offline routing.
This property was introduced in Esri.ArcGISRuntime 100.2.
url : url |
The URL to the REST endpoint of the service or a local path to a mobile geodatabase.
Signal Documentation
|
Emitted when the apiKey property changes.
Note: The corresponding handler is onApiKeyChanged.
This signal was introduced in Esri.ArcGISRuntime 100.10.
See also ApiKeyResource.
createDefaultParametersStatusChanged() |
Emitted when the createDefaultParametersStatus property changes.
Note: The corresponding handler is onCreateDefaultParametersStatusChanged.
credentialChanged() |
Emitted when the credential property changes.
Note: The corresponding handler is onCredentialChanged.
loadErrorChanged() |
loadStatusChanged() |
Emitted when the loadStatus property changes.
Note: The corresponding handler is onLoadStatusChanged.
See also Loadable.
|
Emitted when the networkName property of this ServiceAreaTask changes.
Note: The corresponding handler is onNetworkNameChanged.
This signal was introduced in Esri.ArcGISRuntime 100.2.
requestConfigurationChanged() |
Emitted when the requestConfiguration property changes.
Note: The corresponding handler is onRequestConfigurationChanged.
serviceAreaTaskInfoChanged() |
Emitted when the serviceAreaTaskInfo property changes.
Note: The corresponding handler is onServiceAreaTaskInfoChanged.
solveServiceAreaStatusChanged() |
Emitted when the solveServiceAreaStatus property changes.
Note: The corresponding handler is onSolveServiceAreaStatusChanged.
|
Emitted when the transportationNetworkDataset property changes.
Note: The corresponding handler is onTransportationNetworkDatasetChanged.
This signal was introduced in Esri.ArcGISRuntime 100.2.
urlChanged() |
Emitted when the url property changes.
Note: The corresponding handler is onUrlChanged.
Method Documentation
void cancelLoad() |
See also Loadable.
bool cancelTask(string taskId) |
Cancel the task with the ID taskId.
Returns false if the task cannot be canceled or there is no task with the specified id taskId.
See also Cancelable.
void createDefaultParameters() |
Creates default service area parameters from the service.
The createDefaultParametersStatusChanged signal will emit once the operation is complete, giving access to the createDefaultParametersResult.
void load() |
See also Loadable.
void retryLoad() |
See also Loadable.
string solveServiceArea(ServiceAreaParameters serviceAreaParameters) |
Solves a service area with the given serviceAreaParameters.
The solveServiceAreaStatusChanged signal will emit when the operation is complete, giving access to the solveServiceAreaResult.