Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: ChooseBestFacilities
[ AMD Module Require | Legacy Module Require ]
require(["esri/dijit/analysis/ChooseBestFacilities"], function(ChooseBestFacilities) { /* code goes here */ });
Description
(Added at v3.16)
Choose Best Facilities allows you to choose the best locations for facilities. The tool allocates locations with demand for the facilities, in a way that satisfies the specified goal. The widget provides various options to solve specific problems. These options include:
- Allocating to existing facilities
- Minimizing travel time
- Maximizing coverage
- Maximizing coverage with capacity
- Covering a percentage of demand
Samples
Search for samples that use this class.Class hierarchy
esri/dijit/analysis/AnalysisBase |_esri/dijit/analysis/ChooseBestFacilities
Constructors
| Name | Summary |
|---|---|
| new ChooseBestFacilities(params, srcNodeRef) | Creates a new ChooseBestFacilities dijit using the given DOM node. |
Properties
| Name | Type | Summary |
|---|---|---|
| analysisGpServer | String | The URL to the analysis service, for example "http://analysis.arcgis.com/arcgis/rest/services/tasks/GPServer". |
| candidateCount | Number | The number of facilities to choose when allocating demand locations. |
| candidateFacilitiesCapacity | String | This specifies how much demand every facility in the candidateFacilitiesLayer is capable of supplying. |
| candidateFacilitiesCapacityField | String | String value indicating the field name on the candidateFacilitiesLayer representing how much demand each facility in the candidatesFacilitiesLayer is capable of supplying. |
| candidateFacilitiesLayer | FeatureLayer | A point layer specifying one or more locations that act as facilities by providing some kind of service. |
| demand | Number | The amount of demand available at every demand locations. |
| demandField | String | String value indicating the field name on the demandLocationLayer representing the amount of demand available at each demand location. |
| demandLocationLayer | FeatureLayer | A point layer specifying the locations that have demand for facilities. |
| demandLocationLayers | FeatureLayer[] | Array of point layers to be used for choosing the demandLocationLayer. |
| enableTravelModes | Boolean | When true, Travel Modes (Driving Time) is enabled for the inputLayer with the point geometries (esriGeometryPoint). |
| featureLayers | FeatureLayer[] | Array of point layers used for setting the required facilities layer and candidate facilities layer. |
| folderId | String | Sets the selected folder of the select folder dropdown. |
| folderName | String | Sets the selected folder of the select folder dropdown. |
| map | Map | Reference to the map. |
| maxTravelRange | Number | The maximum travel time or distance allowed between a demand location and its allocated facility. |
| maxTravelRangeField | String | String value indicating the field name on the demandLocationLayer specifying the maximum travel time or distance allowed between a demand location and its allocated facility. |
| outputLayerName | String | The name of the output layer to be displayed in the result layer nameinputbox. |
| percentDemandCoverage | Number | The percentage of the total demand that you want the chosen and required facilities to capture. |
| portalSelf | Object | The self response of the Portal. |
| portalUrl | String | The URL to the ArcGIS organization or Portal site where the GP server is hosted. |
| requiredFacilitiesCapacity | Number | Specify how much demand every facility in the requiredFacilitiesLayer is capable of supplying. |
| requiredFacilitiesCapacityField | String | A field on the requiredFacilitiesLayer representing how much demand each facility in this layer is capable of supplying. |
| requiredFacilitiesLayer | FeatureLayer | A point layer specifying one or more locations that act as facilities by providing some kind of service. |
| returnFeatureCollection | Boolean | Indicates whether to return the result of analysis as a client-side feature collection. |
| showChooseExtent | Boolean | Indicates whether the "choose extent checkbox" is displayed. |
| showCredits | Boolean | Indicates whether to show the credit options. |
| showHelp | Boolean | Indicates whether the help links are displayed. |
| showReadyToUseLayers | Boolean | Indicates whether to add an option to the UI that allows users to choose ready-to-use analysis layers from the Living Atlas Analysis Layers. |
| showSelectAnalysisLayer | Boolean | Indicates whether to display a dropdown menu listing valid input analysis layers. |
| showSelectFolder | Boolean | Indicates whether the select folder dropdown will be displayed. |
| title | String | The default widget title with a custom title. |
Methods
| Name | Return type | Summary |
|---|---|---|
| cancel(jobInfo) | None | Cancels an analysis job that is being processed. |
| checkJobStatus(jobId) | None | Starts checking the analysis job status for the given jobId. |
| execute(params) | None | Starts an analysis tool. |
| getCreditsEstimate(toolName, jobParams) | Deferred | Gets credits estimate for a specific analysis job. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| close | Fires when close icon is clicked or when run analysis button is clicked. | |
| drawtool-activate | Fires when the drawn boundaries option is activated. | |
| drawtool-deactivate | Fires when the drawn boundaries option is deactivated. | |
| job-cancel | {
response: < | Fires when the job in cancelled. |
| job-fail | {
error: < | Fires when the job fails. |
| job-result | {
result: < | Fires after the job fetches result data. |
| job-status | {
jobInfo: < | Fires when the job execution status is received. |
| job-submit | {
params: < | Fires when the job is submitted to the server for asynchronous processing. |
| job-success | {
jobInfo: < | Fires when the job succeeds. |
| start | {
params: < | Fires when the execute method is called. |
Constructor Details
Creates a new ChooseBestFacilities dijit using the given DOM node.
Parameters:
< |
Required | Various options to configure this dijit. All the properties can be passed into the params object. |
< |
Required | Reference or id of a HTML element that this dijit is rendered into. |
params properties: < |
Optional | The URL to the analysis service, for example "http://analysis.arcgis.com/arcgis/rest/services/tasks/GPServer". |
< |
Optional | The number of facilities to choose when allocating demand locations. If requiredFacilitiesLayer is specified, the number of facilities to choose should be equal to or greater than the count of locations in the requiredFacilitiesLayer.
Default value is 1. |
< |
Optional | Specify how much demand every facility in the candidateFacilitiesLayer is capable of supplying. Default value is "unlimited". |
< |
Optional | String value indicating the field name on the candidateFacilitiesLayer representing how much demand each facility in the candidatesFacilitiesLayer is capable of supplying. This parameter takes precedence when the candidateFacilitiesCapacity parameter is also specified. |
< |
Optional | A point layer specifying one or more locations that act as facilities by providing some kind of service. Facilities specified by this parameter are not required to be part of the output solution and will be used only after all the facilities from the candidatesFacilitiesLayer have been used when allocating demand locations. |
< |
Optional | The amount of demand available at every demand locations. Default value is 1. |
< |
Optional | String value indicating the field name on the demandLocationLayer representing the amount of demand available at each demand location. Only numeric field types are allowed. |
< |
Optional | A point layer specifying the locations that have demand for facilities. If this is not passed in, it's set to the first layer in the demandLocationLayers list. |
< |
Required | Array of point layers to be used for choosing the demandLocationLayer. |
< |
Optional | When true, Travel Modes (Driving Time) is enabled for the inputLayer with the point geometries (esriGeometryPoint). Default value is true. |
< |
Required | Array of point layers used for setting the required facilities layer and candidate facilities layer. |
< |
Optional | Sets the selected folder of the select folder dropdown. This is based on the provided folderId, when showSelectFolder is true. |
< |
Optional | Sets the selected folder of the select folder dropdown. This is based on the provided folderName when showSelectFolder is true. |
< |
Optional | Reference to the map. |
< |
Optional | The maximum travel time or distance allowed between a demand location and its allocated facility. Default value is 1 . |
< |
Optional | String value indicating the field name on the demandLocationLayer specifying the maximum travel time or distance allowed between a demand location and its allocated facility. This parameter takes precedence when the maxTravelRange property is also specified. |
< |
Optional | The name of the output layer to be displayed in the result layer nameinputbox. |
< |
Optional | The percentage of the total demand that you want the chosen and required facilities to capture. Default value is 100. |
< |
Optional | The URL to the ArcGIS organization or Portal site where the GP server is hosted. For example, "http://www.arcgis.com". |
< |
Optional | Specify how much demand every facility in the requiredFacilitiesLayer is capable of supplying. |
< |
Optional | A field on the requiredFacilitiesLayer representing how much demand each facility in this layer is capable of supplying. This parameter takes precedence when requiredFacilitiesCapacityparameter is also specified. Default is "unlimited". |
< |
Optional | A point layer specifying one or more locations that act as facilities by providing some kind of service. Facilities specified by this parameter are required to be part of the output solution and will be used before any facilities from the candidatesFacilitiesLayer when allocating demand locations. |
< |
Optional | Indicates whether to return the result of analysis as a client-side feature collection. |
< |
Optional | Indicates whether the "choose extent checkbox" is displayed. |
< |
Optional | Indicates whether to show the credit options. |
< |
Optional | Indicates whether the help links are displayed. |
< |
Optional | Indicates whether to add an option to the UI that allows users to choose ready-to-use analysis layers from the Living Atlas Analysis Layers. |
< |
Optional | Indicates whether to display a dropdown menu listing valid input analysis layers. |
< |
Optional | Indicates whether the select folder dropdown will be displayed. |
< |
Optional | The default widget title with a custom title. |
Sample:
var toolParams = {
demandLocationLayers: [lots, potentialparks, developerlots],
featureLayers: [lots, potentialparks, developerlots],
portalUrl: "http://www.arcgis.com",
map: map,
returnFeatureCollection: false
};
var chooseBestTool = new ChooseBestFacilities(toolParams, "toolDiv");
chooseBestTool.startup();
Property Details
<String
StringThe URL to the analysis service, for example
"http://analysis.arcgis.com/arcgis/rest/services/tasks/GPServer". Required when portalUrl is not specified.<Number
NumberThe number of facilities to choose when allocating demand locations. If
requiredFacilitiesLayer is specified, the number of facilities to choose should be equal to or greater than the count of locations in the requiredFacilitiesLayer.
Default value:
1<String
StringThis specifies how much demand every facility in the
candidateFacilitiesLayer is capable of supplying.Default value:
"unlimited"<String
StringString value indicating the field name on the
candidateFacilitiesLayer representing how much demand each facility in the candidatesFacilitiesLayer is capable of supplying. This parameter takes precedence when the candidateFacilitiesCapacity parameter is also specified. <FeatureLayer
FeatureLayerA point layer specifying one or more locations that act as facilities by providing some kind of service. Facilities specified by this parameter are not required to be part of the output solution and will be used only after all the facilities from the candidatesFacilitiesLayer have been used when allocating demand locations.
Default value:
1<String
StringString value indicating the field name on the
demandLocationLayer representing the amount of demand available at each demand location. Only numeric field types are allowed.<FeatureLayer
FeatureLayerA point layer specifying the locations that have demand for facilities. If this is not passed in, it's set to the first layer in the
demandLocationLayers list.<FeatureLayer[]
FeatureLayer[]Array of point layers to be used for choosing the
demandLocationLayer.<Boolean
BooleanWhen true, Travel Modes (Driving Time) is enabled for the inputLayer with the point geometries (esriGeometryPoint).
Default value:
true<FeatureLayer[]
FeatureLayer[]Array of point layers used for setting the required facilities layer and candidate facilities layer.
<String
StringSets the selected folder of the select folder dropdown. This is based on the provided folderId, when
showSelectFolder is true.<String
StringSets the selected folder of the select folder dropdown. This is based on the provided
folderName when showSelectFolder is true.<Number
NumberThe maximum travel time or distance allowed between a demand location and its allocated facility.
Default value:
1<String
StringString value indicating the field name on the
demandLocationLayer specifying the maximum travel time or distance allowed between a demand location and its allocated facility. This parameter takes precedence when the maxTravelRange property is also specified.<String
StringThe name of the output layer to be displayed in the result layer nameinputbox.
<Number
NumberThe percentage of the total demand that you want the chosen and required facilities to capture.
Default value:
100<Object
ObjectThe self response of the Portal. When set, optimizes performance to reuse self calls made by the widget. For more documentation on the properties of this object, see the Portal Self ArcGIS REST API documentation. (Added at v3.14)
<String
StringThe URL to the ArcGIS organization or Portal site where the GP server is hosted. For example,
"http://www.arcgis.com". <Number
NumberSpecify how much demand every facility in the
requiredFacilitiesLayer is capable of supplying.<String
StringA field on the
requiredFacilitiesLayer representing how much demand each facility in this layer is capable of supplying. This parameter takes precedence when requiredFacilitiesCapacityparameter is also specified. Default is "unlimited".Default value:
"unlimited"<FeatureLayer
FeatureLayerA point layer specifying one or more locations that act as facilities by providing some kind of service. Facilities specified by this parameter are required to be part of the output solution and will be used before any facilities from the
candidatesFacilitiesLayer when allocating demand locations. <Boolean
BooleanIndicates whether to return the result of analysis as a client-side feature collection.
Default value:
false<Boolean
BooleanIndicates whether the "choose extent checkbox" is displayed.
Default value:
true<Boolean
BooleanIndicates whether to add an option to the UI that allows users to choose ready-to-use analysis layers from the Living Atlas Analysis Layers.
Default value:
true<Boolean
BooleanIndicates whether to display a dropdown menu listing valid input analysis layers.
Default value:
true<Boolean
BooleanIndicates whether the select folder dropdown will be displayed.
Default value:
false<String
StringThe default widget title with a custom title.
Method Details
Cancels an analysis job that is being processed.
Parameters:
< |
Required | An object containing job information including job ID, status, message, etc returned by the job-status event. |
Starts checking the analysis job status for the given jobId. (Added at v3.12)
Parameters:
< |
Required | Job id of the analysis job to check. |
Starts an analysis tool.
Parameters:
< |
Required | See the object specifications table below for the structure of the params object. |
Object Specifications:
<
params>< |
Optional | Parameters for creating the output service item. Refer to the ArcGIS REST API - Add Item help topic for a list of available parameters. Only used when the analysis task creates a hosted service. |
< |
Required | The input job parameters. Required parameters vary from class to class. Refer to the Analysis REST API Documentation for details (Under the Request Parameters section of each task). When creating a hosted service, a layer name is required. |
Sample:
var params = {
itemParams: {
description: "Item description.",
snippet: "A short summary about this item.",
tags: "<tag1>, <tag2>, <tag3>, ... ",
typeKeywords: "<typeKeyword1>, <typeKeyword2>, <typeKeyword3>, ... "
},
jobParams: {
outputLayerName: "{\"serviceProperties\":{\"name\":\"Name of the output feature service\"},\"itemProperties\":{\"itemId\":\"<itemId>\"}}",
...
}
}
analysisBase.execute(params);
Gets credits estimate for a specific analysis job. This method returns a deferred object. The callback function has an object containing the number of records to be processed and the estimated credit cost for this job.
Return type:
DeferredParameters:
< |
Required | The name of the analysis tool from which a credits estimate will be returned. |
< |
Required | The input job parameters. This value should be the same as the jobParams property of an analysis tool dijit. Refer to the jobParams property of this class for detailed syntax. |
Sample:
analysisBase.getCreditsEstimate("FindHotSpots",{
AnalysisLayer: layer._json,
context: '{"outSR":{"wkid":102100}}',
isProcessInfo: true,
returnFeatureCollection: true
}).then(function(result){
console.log(result);
});
//the "result" argument above:
//{
// "cost": 1.472,
// "totalRecords": 1472,
//}Event Details
[ On Style Events | Connect Style Event ]
Fires when the drawn boundaries option is activated. Only valid when using the FindHotSpots or ExtractData widget. A typical usage is to disable the zoom/pan/popup handlers when drawing is activated. (Added at v3.7)
Fires when the drawn boundaries option is deactivated. Only valid when using the FindHotSpots or ExtractData widget. A typical usage is to enable the zoom/pan/popup handlers when drawing is deactivated. (Added at v3.7)
Fires when the job in cancelled. (Added at v3.7)
Event Object Properties:
< |
An GP job object returned by the GP server. Refer to the GP Job and the Checking job status topics in the ArcGIS REST API Documentation for more information and syntax.
{
"inputs": {},
"jobId": <job id>,
"jobStatus": <job status>,
"messages": <an array of message text>,
"results": {}
} |
Fires when the job fails. (Added at v3.7)
Event Object Properties:
< |
The error message returned by a failed job.{
"analysisReport": <analysis report message>,
"dataType": <analysis report message>,
"paramName": < parameter name >,
"value": <output item info | feature collection>
} |
Fires after the job fetches result data. The returned argument contains the output value (either a feature collection or a url to the hosted service), which you may add to the map as a feature layer. (Added at v3.7)
Event Object Properties:
< |
An object containing the resulted message and value. Based on the GP result object returned by the GP server with the analysisReport property added.
If output is a feature collection, value is a feature collection object; if output is a hosted arcgis.com feature service, value is an object with item information including ID and URL. Refer to the ArcGIS REST API documentation - Feature Output for more information.{
"analysisReport": <analysis report message>,
"dataType": <analysis report message>,
"paramName": < parameter name >,
"value": <output item info | feature collection>
} |
Sample:
analysisTool.on("job-result", function(result){
var featureLayer = new FeatureLayer(result.value['url'] || result.value);
map.addLayer(featureLayer);
})
Fires when the job execution status is received. (Added at v3.7)
Event Object Properties:
< |
An object containing job information including job ID, status, message, etc. Based on the GP job object returned by the GP server with the jobParam property attached. Refer to the GP Job and the Checking job status topics in the ArcGIS REST API Documentation for more information and syntax.{
"inputs": {},
"jobParams": <job parameters>,
"jobId": <job id>,
"jobStatus": <job status>,
"messages": <an array of message text>,
"results": {}
} |
Fires when the job is submitted to the server for asynchronous processing. (Added at v3.7)
Event Object Properties:
< |
The input job parameters. |
Fires when the job succeeds. (Added at v3.7)
Event Object Properties:
< |
An object containing job information including job ID, status, message, etc. Based on the GP job object returned by the GP server with the jobParam property attached. Refer to the GP Job and the Checking job status topics in the ArcGIS REST API Documentation for more information and syntax.
This returned object can be passed into the cancel(jobInfo) method to terminate a job. {
"inputs": {},
"jobParams": <job parameters>,
"jobId": <job id>,
"jobStatus": <job status>,
"messages": <an array of message text>,
"results": {}
} |
Fires when the execute method is called. (Added at v3.7)
Event Object Properties:
< |
The input job parameters. |