Class: FindClosestFacilitiesParameters

SuperMap.FindClosestFacilitiesParameters

The FindClosestFacilitiesParameters class.

new SuperMap.FindClosestFacilitiesParameters(options)

FindClosestFacilitiesParameters.js, line 5
Name Type Description
options Object

The parameters.

Name Type Default Description
event SuperMap.Geometry.Point | L.LatLng | L.Point | ol.geom.Point | number

Event sites need event locations where service facilities provide services.

expectFacilityCount number 1 optional

The number of facility points to find.

facilities Array.<(SuperMap.Geometry.Point|L.LatLng|L.Point|ol.geom.Point|number)>

The facility set, generally is the service facility location providing service.

fromEvent boolean false optional

Whether to find from the event site to the facilities.

isAnalyzeById boolean false optional

Whether to specify event points and facilities by node ID number.

maxWeight number 0 optional

The search radius. And the unit is in consist with the cost field set by the parameter field (the general parameter of the traffic network analysis) in this class.

parameter SuperMap.TransportationAnalystParameter optional

The TransportationAnalystParameter class.

Members

eventSuperMap.Geometry.Point L.LatLng L.Point ol.geom.Point number

Event sites need event locations where service facilities provide services. The event point can be given through these two ways: When the field in this class is isAnalyzeById = true, the event point ID number should be entered; when isAnalyzeById = false, the event point coordinate should be entered.

expectFacilityCountnumber

The number of facility points to find.

Default Value:
1

facilitiesArray.<(SuperMap.Geometry.Point|L.LatLng|L.Point|ol.geom.Point|number)>

The facility set, generally is the service facility location providing service, required. The type could be SuperMap.Geometry.Point、L.LatLng、L.Point and ol.geom.Point. The facility can be given through these two ways: When the field in this class is isAnalyzeById = true, the facility ID number should be entered; when isAnalyzeById = false, the facility coordinate should be entered.

fromEventboolean

Whether to find from the event site to the facilities. Closest Facility analyzes an optional route between facilities and event sites. This route is calculated in the network layer. Possibly, the cost from A to B and B to A is different, so the different selection of the start point and end point may get different optimal route. Therefore, you need to set the direction of the route before closest facilities analysis. If the direction is from the event site to the facilities, the field value is true.

isAnalyzeByIdboolean

Whether the event point and the facility point are specified by the node ID number, that is specifying the event point and the facility point by coordinates.

maxWeightnumber

The search radius. And the unit is in consist with the cost field set by the parameter field (the general parameter of the traffic network analysis) in this class. In the example of finding for an accident the closest hospital within ten minutes' distance from all the selected hospitals,then parameter. weightFieldName in the network analysis parameter need to be set as the field representing time, then sets the radius value to find the range as 10.

The TransportationAnalystParameter class. This class can set the side barrier, the barrier point, the name identification of the weight field information, turn weight field and other information. The TransportationAnalystParameter type, although it is an optional parameter, but if the resultSetting field of them is not set, and then the returned result spatial information and so on are empty.

Methods

destroy()

FindClosestFacilitiesParameters.js, line 76

Disposes the resource. The property that references resource is set to null.