ServiceAreaParameters

java.lang.Object
- com.google.gwt.core.client.JavaScriptObject
- - edu.ucdavis.cstars.client.tasks.ServiceAreaParameters

```
public class ServiceAreaParameters
extends com.google.gwt.core.client.JavaScriptObject
```
Input parameters for a ServiceAreaTask. Note: ServiceAreaParameters, and other service area related classes, requires ArcGIS Server 10.0 or above and a service area layer. A service area layer is a layer of type esriNAServerServiceAreaLayer.

Author:

Justin Merz

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ServiceAreaParameters.AttributeParameterValue

Nested Classes
Modifier and Type	Class and Description
`static class`	`ServiceAreaParameters.AttributeParameterValue`

Method Summary

Methods
Modifier and Type	Method and Description
`static ServiceAreaParameters`	`create()` Creates a new RouteParameters object.
`com.google.gwt.core.client.JsArrayString`	`getAccumulateAttributes()` The list of network attribute names to be accumulated with the analysis, i.e., which attributes should be returned as part of the response.
`com.google.gwt.core.client.JsArray<ServiceAreaParameters.AttributeParameterValue>`	`getAttributeParameterValues()` A set of attribute parameter values that can be parameterized to determine which network elements can be used by a vehicle.
`com.google.gwt.core.client.JsArrayInteger`	`getDefaultBreaks()` An array of numbers defining the breaks.
`com.google.gwt.core.client.JsArrayString`	`getExcludeSourcesFromPolygons()` An array of network source names to NOT use when generating polygons.
`DataLayer`	`getFacilitiesAsDataLayer()` The set of facilities loaded as network locations during analysis.
`FeatureSet`	`getFacilitiesAsFeatureSet()` The set of facilities loaded as network locations during analysis.
`java.lang.String`	`getImpedanceAttribute()` The network attribute name used as the impedence attribute in analysis.The default is as defined in the specific routing network layer used in your RouteTask.
`int`	`getOutputGeometryPrecision()` The precision of the output geometry after generalization.
`java.lang.String`	`getOutputGeometryPrecisionUnits()` The units of the output geometry precision.
`NAOutputLine`	`getOutputLines()` The type of output lines to be generated in the result.
`SpatialReference`	`getOutSpatialReference()` The well-known ID of the spatial reference for the geometries returned with the analysis results.
`DataLayer`	`getPointBarriersAsDataLayer()` The set of point barriers loaded as network locations during analysis.
`FeatureSet`	`getPointBarriersAsFeatureSet()` The set of point barriers loaded as network locations during analysis.
`DataLayer`	`getPolygonBarriersAsDataLayer()` The set of polygons barriers loaded as network locations during analysis.
`FeatureSet`	`getPolygonBarriersAsFeaturSet()` The set of polygons barriers loaded as network locations during analysis.
`DataLayer`	`getPolylineBarriersAsDataLayer()` The set of polyline barriers loaded as network locations during analysis.
`FeatureSet`	`getPolylineBarriersAsFeatureSet()` The set of polyline barriers loaded as network locations during analysis.
`com.google.gwt.core.client.JsArrayString`	`getRestrictionAttributes()` The list of network attribute names to be used as restrictions with the analysis.
`NAUTurn`	`getRestrictUTurns()` Specifies how U-Turns should be handled.
`boolean`	`getReturnFacilities()` If true, facilities will be returned with the analysis results.
`boolean`	`getReturnPointBarriers()` If true, barriers will be returned in the barriers property of ClosestFacilitySolveResult.
`boolean`	`getReturnPolylineBarriers()` If true, polyline barriers will be returned in the polylineBarriers property of ClosestFacilitySolveResult.
`com.google.gwt.core.client.JsDate`	`getTimeOfDay()` Local date and time at the facility.
`NATravelDirection`	`getTravelDirection()` Options for traveling to or from the facility.
`Units`	`getTrimPolygonDistanceUnits()` If polygons are being trimmed, specifies the units of the trimPolygonDistance.
`boolean`	`getUseHierarchy()` When true, the hierarchy attributes for the network will be used in analysis.
`boolean`	`mergeSimilarPolygonRanges()` If true, similar ranges will be merged in the result polygons.
`boolean`	`overlapLines()` Indicates if the lines should overlap from multiple facilities.
`boolean`	`overlapPolygons()` Indicates if the polygons should overlap from multiple facilities.
`boolean`	`returnPolygonBarriers()` If true, polygon barriers will be returned in the polygonBarriers property of ClosestFacilitySolveResult.
`void`	`setAccumulateAttributes(java.lang.String[] accumulateAttributes)` Set the accumulateAttributes parameter.
`void`	`setAttributeParameterValues(ServiceAreaParameters.AttributeParameterValue[] attributeParameterValues)` Set the attributeParameterValues parameter.
`void`	`setDefaultBreaks(int[] defaultBreaks)` Set the defaultBreaks parameter.
`void`	`setExcludeSourcesFromPolygons(java.lang.String[] excludeSourcesFromPolygons)` Set the excludeSourcesFromPolygons parameter.
`void`	`setFacilities(DataLayer facilities)` Set the facilities parameter.
`void`	`setFacilities(FeatureSet facilities)` Set the facilities parameter.
`void`	`setImpedanceAttribute(java.lang.String impedanceAttribute)` Set the impedanceAttribute parameter.
`void`	`setMergeSimilarPolygonRanges(boolean mergeSimilarPolygonRanges)` Set the mergeSimilarPolygonRanges parameter.
`void`	`setOutputGeometryPrecision(int outputGeometryPrecision)` Set the outputGeometryPrecision parameter.
`void`	`setOutputGeometryPrecisionUnits(java.lang.String outputGeometryPrecisionUnits)` Set the outputGeometryPrecisionUnits parameter
`void`	`setOutputLines(NAOutputLine outputLines)` Set the outputLines parameter
`void`	`setOutSpatialReference(SpatialReference outSpatialReference)` Set the outSpatialReference parameter.
`void`	`setOverlapLines(boolean overlapLines)` Set the overlapLines parameter.
`void`	`setOverlapPolygons(boolean overlapPolygons)` Set the overlapPolygons parameter.
`void`	`setPointBarriers(DataLayer pointBarriers)` Set the pointBarriers parameter.
`void`	`setPointBarriers(FeatureSet pointBarriers)` Set the pointBarriers parameter.
`void`	`setPolygonBarriers(DataLayer polygonBarriers)` Set the polygonBarriers parameter.
`void`	`setPolygonBarriers(FeatureSet polygonBarriers)` Set the polygonBarriers parameter.
`void`	`setPolylineBarriers(DataLayer polylineBarriers)` Set the polylineBarriers parameter.
`void`	`setPolylineBarriers(FeatureSet polylineBarriers)` Set the polylineBarriers parameter.
`void`	`setRestrictionAttributes(java.lang.String[] restrictionAttributes)` Set the restrictionAttributes parameters.
`void`	`setRestrictUTurns(NAUTurn restrictUTurns)` Set the restrictUTurns parameter.
`void`	`setReturnFacilities(boolean returnFacilities)` Set the returnFacilities parameter.
`void`	`setReturnPointBarriers(boolean returnPointBarriers)` Set the returnPointBarriers parameter.
`void`	`setReturnPolygonBarriers(boolean returnPolygonBarriers)` Set the returnPolygonBarriers parameter.
`void`	`setReturnPolylineBarriers(boolean returnPolylineBarriers)` Set the returnPolylineBarriers parameter.
`void`	`setSplitLinesAtBreaks(boolean splitLinesAtBreaks)` Set the splitLinesAtBreaks parameter.
`void`	`setSplitPolygonsAtBreaks(boolean splitPolygonsAtBreaks)` Set the splitPolygonsAtBreaks parameter.
`void`	`setTimeOfDay(com.google.gwt.core.client.JsDate timeOfDay)` Set the timeOfDay parameter.
`void`	`setTravelDirection(NATravelDirection travelDirection)` Set the travelDirection parameter.
`void`	`setTrimOuterPolygon(boolean trimOuterPolygon)` Set the trimOuterPolygon parameter.
`void`	`setTrimPolygonDistance(boolean trimPolygonDistance)`
`void`	`setTrimPolygonDistanceUnits(Units trimPolygonDistanceUnits)` Set the trimPolygonDistanceUnits parameter.
`void`	`setUseHierarchy(boolean userHierarchy)` Set the userHierarchy parameter.
`boolean`	`splitLinesAtBreaks()` If true, lines will be split at breaks.
`boolean`	`splitPolygonsAtBreaks()` If true, polygons will be split at breaks.
`boolean`	`trimOuterPolygon()` If true, the outermost polygon (at the maximum break value) will be trimmed.
`boolean`	`trimPolygonDistance()` If polygons are being trimmed, provides the distance to trim.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject
cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - create
```
public static ServiceAreaParameters create()
```
    Creates a new RouteParameters object.
    
    Returns:
    RouteParameters
  - getAccumulateAttributes
```
public final com.google.gwt.core.client.JsArrayString getAccumulateAttributes()
```
    The list of network attribute names to be accumulated with the analysis, i.e., which attributes should be returned as part of the response. The default is as defined in the specific routing network layer used in your RouteTask. You can specify any attributes names listed in the Service Directory under Network Dataset > Network Attributes as Usage Type: esriNAUTCost.
    
    Returns:
    JsArrayString
  - setAccumulateAttributes
```
public final void setAccumulateAttributes(java.lang.String[] accumulateAttributes)
```
    Set the accumulateAttributes parameter.
    
    Parameters:
    accumulateAttributes - - The list of network attribute names to be accumulated with the analysis, i.e., which attributes should be returned as part of the response. The default is as defined in the specific routing network layer used in your RouteTask. You can specify any attributes names listed in the Service Directory under Network Dataset > Network Attributes as Usage Type: esriNAUTCost.
  - getAttributeParameterValues
```
public final com.google.gwt.core.client.JsArray<ServiceAreaParameters.AttributeParameterValue> getAttributeParameterValues()
```
    A set of attribute parameter values that can be parameterized to determine which network elements can be used by a vehicle. The parameter holding a vehicle charactersitic is compared to a value coming from a descriptor attribute to determine whether or not a network element is traversible. For example, a parameterized restriction attribute can compare the height of your vehicle with a descriptor attribute that holds the clearance under overpasses through tunnels. If the vehicles height is greater than the clearance, the edge is restricted. Parameterized cost attributes that can reference other cost attributes and scale them, can also be used. This is useful when inclement weather like ice, fog or heavy rain, descends on the study area and hinders normal flow of traffic. By having a parameter already outfitted on a cost attribute, travel-time expectations and traversible network paths can be adjusted with respect to changes in traffic speeds.
    
    Returns:
    JsArray
  - setAttributeParameterValues
```
public final void setAttributeParameterValues(ServiceAreaParameters.AttributeParameterValue[] attributeParameterValues)
```
    Set the attributeParameterValues parameter.
    
    Parameters:
    attributeParameterValues - - A set of attribute parameter values that can be parameterized to determine which network elements can be used by a vehicle. The parameter holding a vehicle charactersitic is compared to a value coming from a descriptor attribute to determine whether or not a network element is traversible. For example, a parameterized restriction attribute can compare the height of your vehicle with a descriptor attribute that holds the clearance under overpasses through tunnels. If the vehicles height is greater than the clearance, the edge is restricted. Parameterized cost attributes that can reference other cost attributes and scale them, can also be used. This is useful when inclement weather like ice, fog or heavy rain, descends on the study area and hinders normal flow of traffic. By having a parameter already outfitted on a cost attribute, travel-time expectations and traversible network paths can be adjusted with respect to changes in traffic speeds.
  - getDefaultBreaks
```
public final com.google.gwt.core.client.JsArrayInteger getDefaultBreaks()
```
    An array of numbers defining the breaks. The default value is defined in the network analysis layer .
    
    Returns:
    JsArrayInteger
  - setDefaultBreaks
```
public final void setDefaultBreaks(int[] defaultBreaks)
```
    Set the defaultBreaks parameter.
    
    Parameters:
    defaultBreaks - - An array of numbers defining the breaks. The default value is defined in the network analysis layer .
  - getExcludeSourcesFromPolygons
```
public final com.google.gwt.core.client.JsArrayString getExcludeSourcesFromPolygons()
```
    An array of network source names to NOT use when generating polygons. ExcludeSourcesFromPolygons specifies if certain network sources should be excluded from the service area polygon generation. A service area on a multi-modal network where only one mode is being used to compute the service area would get a more appropriate shape if other modes are excluded from the polygons.
    
    Returns:
    JsArrayString
  - setExcludeSourcesFromPolygons
```
public final void setExcludeSourcesFromPolygons(java.lang.String[] excludeSourcesFromPolygons)
```
    Set the excludeSourcesFromPolygons parameter.
    
    Parameters:
    excludeSourcesFromPolygons - - An array of network source names to NOT use when generating polygons. ExcludeSourcesFromPolygons specifies if certain network sources should be excluded from the service area polygon generation. A service area on a multi-modal network where only one mode is being used to compute the service area would get a more appropriate shape if other modes are excluded from the polygons.
  - getFacilitiesAsDataLayer
```
public final DataLayer getFacilitiesAsDataLayer()
```
    The set of facilities loaded as network locations during analysis. Can be either an instance of esri.tasks.DataLayer or esri.tasks.FeatureSet.
    
    Returns:
    DataLayer
  - getFacilitiesAsFeatureSet
```
public final FeatureSet getFacilitiesAsFeatureSet()
```
    The set of facilities loaded as network locations during analysis. Can be either an instance of esri.tasks.DataLayer or esri.tasks.FeatureSet.
    
    Returns:
    FeatureSet
  - setFacilities
```
public final void setFacilities(DataLayer facilities)
```
    Set the facilities parameter.
    
    Parameters:
    facilities - - The set of facilities loaded as network locations during analysis.
  - setFacilities
```
public final void setFacilities(FeatureSet facilities)
```
    Set the facilities parameter.
    
    Parameters:
    facilities - - The set of facilities loaded as network locations during analysis.
  - getImpedanceAttribute
```
public final java.lang.String getImpedanceAttribute()
```
    The network attribute name used as the impedence attribute in analysis.The default is as defined in the specific routing network layer used in your RouteTask. You can specify any attributes names listed in the Service Directory under Network Dataset > Network Attributes as Usage Type: esriNAUTCost. You can also specify a value of none to indicate that no network attributes should be used for impedance. If you specify an empty string, it will use the default of the service. For example, set impedanceAttribute=Time for quickest route and impedanceAttribute=Length for shortest drive. Assuming the service has those two esriNAUTCost attributes.
    
    Returns:
    String
  - setImpedanceAttribute
```
public final void setImpedanceAttribute(java.lang.String impedanceAttribute)
```
    Set the impedanceAttribute parameter.
    
    Parameters:
    impedanceAttribute - - The network attribute name used as the impedence attribute in analysis. The default is as defined in the specific routing network layer used in your RouteTask. You can specify any attributes names listed in the Service Directory under Network Dataset > Network Attributes as Usage Type: esriNAUTCost. You can also specify a value of none to indicate that no network attributes should be used for impedance. If you specify an empty string, it will use the default of the service. For example, set impedanceAttribute=Time for quickest route and impedanceAttribute=Length for shortest drive. Assuming the service has those two esriNAUTCost attributes.
  - mergeSimilarPolygonRanges
```
public final boolean mergeSimilarPolygonRanges()
```
    If true, similar ranges will be merged in the result polygons.
    
    Returns:
    boolean
  - setMergeSimilarPolygonRanges
```
public final void setMergeSimilarPolygonRanges(boolean mergeSimilarPolygonRanges)
```
    Set the mergeSimilarPolygonRanges parameter.
    
    Parameters:
    mergeSimilarPolygonRanges - - If true, similar ranges will be merged in the result polygons.
  - getOutputGeometryPrecision
```
public final int getOutputGeometryPrecision()
```
    The precision of the output geometry after generalization. If 0, no generalization of output geometry is performed. If present and positive, it represents the MaximumAllowableOffset parameter - generalization is performed according to IPolycurve.Generalize.
    
    Returns:
    int
  - setOutputGeometryPrecision
```
public final void setOutputGeometryPrecision(int outputGeometryPrecision)
```
    Set the outputGeometryPrecision parameter.
    
    Parameters:
    outputGeometryPrecision - - The precision of the output geometry after generalization. If 0, no generalization of output geometry is performed. If present and positive, it represents the MaximumAllowableOffset parameter - generalization is performed according to IPolycurve.Generalize.
  - getOutputGeometryPrecisionUnits
```
public final java.lang.String getOutputGeometryPrecisionUnits()
```
    The units of the output geometry precision. The default value is esriUnknownUnits. Known values: esriUnknownUnits | esriCentimeters | esriDecimalDegrees | esriDecimeters | esriFeet | esriInches | esriKilometers | esriMeters | esriMiles | esriMillimeters | esriNauticalMiles | esriPoints | esriYards
    
    Returns:
    String
  - setOutputGeometryPrecisionUnits
```
public final void setOutputGeometryPrecisionUnits(java.lang.String outputGeometryPrecisionUnits)
```
    Set the outputGeometryPrecisionUnits parameter
    
    Parameters:
    outputGeometryPrecisionUnits - - The units of the output geometry precision. The default value is esriUnknownUnits. Known values: esriUnknownUnits | esriCentimeters | esriDecimalDegrees | esriDecimeters | esriFeet | esriInches | esriKilometers | esriMeters | esriMiles | esriMillimeters | esriNauticalMiles | esriPoints | esriYards
  - getOutputLines
```
public final NAOutputLine getOutputLines()
```
    The type of output lines to be generated in the result. The default is as defined in the specific routing network layer used in your RouteTask.
    
    Returns:
    NAOutputLine
  - setOutputLines
```
public final void setOutputLines(NAOutputLine outputLines)
```
    Set the outputLines parameter
    
    Parameters:
    outputLines - - The type of output lines to be generated in the result. The default is as defined in the specific routing network layer used in your RouteTask.
  - getOutSpatialReference
```
public final SpatialReference getOutSpatialReference()
```
    The well-known ID of the spatial reference for the geometries returned with the analysis results. If outSpatialReference is not specified, the geometries are returned in the spatial reference of the map.
    
    Returns:
    SpatialReference
  - setOutSpatialReference
```
public final void setOutSpatialReference(SpatialReference outSpatialReference)
```
    Set the outSpatialReference parameter.
    
    Parameters:
    outSpatialReference - - The well-known ID of the spatial reference for the geometries returned with the analysis results. If outSpatialReference is not specified, the geometries are returned in the spatial reference of the map.
  - overlapLines
```
public final boolean overlapLines()
```
    Indicates if the lines should overlap from multiple facilities. The default is defined by the network analysis layer in your ServiceAreaTask.
    
    Returns:
    boolean
  - setOverlapLines
```
public final void setOverlapLines(boolean overlapLines)
```
    Set the overlapLines parameter.
    
    Parameters:
    overlapLines - - Indicates if the lines should overlap from multiple facilities. The default is defined by the network analysis layer in your ServiceAreaTask.
  - overlapPolygons
```
public final boolean overlapPolygons()
```
    Indicates if the polygons should overlap from multiple facilities. The default is defined by the network analysis layer in your ServiceAreaTask.
    
    Returns:
    boolean
  - setOverlapPolygons
```
public final void setOverlapPolygons(boolean overlapPolygons)
```
    Set the overlapPolygons parameter.
    
    Parameters:
    overlapPolygons - - Indicates if the polygons should overlap from multiple facilities. The default is defined by the network analysis layer in your ServiceAreaTask.
  - getPointBarriersAsDataLayer
```
public final DataLayer getPointBarriersAsDataLayer()
```
    The set of point barriers loaded as network locations during analysis. Can be either an instance of esri.tasks.DataLayer or esri.tasks.FeatureSet.
    
    Returns:
    DataLayer
  - getPointBarriersAsFeatureSet
```
public final FeatureSet getPointBarriersAsFeatureSet()
```
    The set of point barriers loaded as network locations during analysis. Can be either an instance of esri.tasks.DataLayer or esri.tasks.FeatureSet.
    
    Returns:
    FeatureSet
  - setPointBarriers
```
public final void setPointBarriers(DataLayer pointBarriers)
```
    Set the pointBarriers parameter.
    
    Parameters:
    pointBarriers - - The set of point barriers loaded as network locations during analysis. or esri.tasks.FeatureSet.
  - setPointBarriers
```
public final void setPointBarriers(FeatureSet pointBarriers)
```
    Set the pointBarriers parameter.
    
    Parameters:
    pointBarriers - - The set of point barriers loaded as network locations during analysis. or esri.tasks.FeatureSet.
  - getPolygonBarriersAsDataLayer
```
public final DataLayer getPolygonBarriersAsDataLayer()
```
    The set of polygons barriers loaded as network locations during analysis. Can be either an instance of esri.tasks.DataLayer or esri.tasks.FeatureSet.
    
    Returns:
    DataLayer
  - getPolygonBarriersAsFeaturSet
```
public final FeatureSet getPolygonBarriersAsFeaturSet()
```
    The set of polygons barriers loaded as network locations during analysis. Can be either an instance of esri.tasks.DataLayer or esri.tasks.FeatureSet.
    
    Returns:
    FeatureSet
  - setPolygonBarriers
```
public final void setPolygonBarriers(DataLayer polygonBarriers)
```
    Set the polygonBarriers parameter.
    
    Parameters:
    polygonBarriers - - The set of polygons barriers loaded as network locations during analysis. or esri.tasks.FeatureSet.
  - setPolygonBarriers
```
public final void setPolygonBarriers(FeatureSet polygonBarriers)
```
    Set the polygonBarriers parameter.
    
    Parameters:
    polygonBarriers - - The set of polygons barriers loaded as network locations during analysis. or esri.tasks.FeatureSet.
  - getPolylineBarriersAsDataLayer
```
public final DataLayer getPolylineBarriersAsDataLayer()
```
    The set of polyline barriers loaded as network locations during analysis. Can be either an instance of esri.tasks.DataLayer or esri.tasks.FeatureSet.
    
    Returns:
    DataLayer
  - getPolylineBarriersAsFeatureSet
```
public final FeatureSet getPolylineBarriersAsFeatureSet()
```
    The set of polyline barriers loaded as network locations during analysis. Can be either an instance of esri.tasks.DataLayer or esri.tasks.FeatureSet.
    
    Returns:
    FeatureSet
  - setPolylineBarriers
```
public final void setPolylineBarriers(DataLayer polylineBarriers)
```
    Set the polylineBarriers parameter.
    
    Parameters:
    polylineBarriers - - The set of polyline barriers loaded as network locations during analysis.
  - setPolylineBarriers
```
public final void setPolylineBarriers(FeatureSet polylineBarriers)
```
    Set the polylineBarriers parameter.
    
    Parameters:
    polylineBarriers - - The set of polyline barriers loaded as network locations during analysis.
  - getRestrictionAttributes
```
public final com.google.gwt.core.client.JsArrayString getRestrictionAttributes()
```
    The list of network attribute names to be used as restrictions with the analysis. The default is as defined in the specific routing network layer used in your RouteTask. Possible values are listed in the Service Directory under Network Dataset > Network Attributes. You can also specify a value of none to indicate that no network attributes should be used as restrictions. If you specify an empty array, it will default to the default of the service.
    
    Returns:
    JsArrayString
  - setRestrictionAttributes
```
public final void setRestrictionAttributes(java.lang.String[] restrictionAttributes)
```
    Set the restrictionAttributes parameters.
    
    Parameters:
    restrictionAttributes - - The list of network attribute names to be used as restrictions with the analysis. The default is as defined in the specific routing network layer used in your RouteTask. Possible values are listed in the Service Directory under Network Dataset > Network Attributes. You can also specify a value of none to indicate that no network attributes should be used as restrictions. If you specify an empty array, it will default to the default of the service.
  - getRestrictUTurns
```
public final NAUTurn getRestrictUTurns()
```
    Specifies how U-Turns should be handled. The default is as defined in the specific routing network layer used in your RouteTask.
    
    Returns:
    NAUTurn
  - setRestrictUTurns
```
public final void setRestrictUTurns(NAUTurn restrictUTurns)
```
    Set the restrictUTurns parameter.
    
    Parameters:
    restrictUTurns - - Specifies how U-Turns should be handled. The default is as defined in the specific routing network layer used in your RouteTask.
  - getReturnFacilities
```
public final boolean getReturnFacilities()
```
    If true, facilities will be returned with the analysis results. Default value is false.
    
    Returns:
    boolean
  - setReturnFacilities
```
public final void setReturnFacilities(boolean returnFacilities)
```
    Set the returnFacilities parameter.
    
    Parameters:
    returnFacilities - - If true, facilities will be returned with the analysis results. Default value is false.
  - getReturnPointBarriers
```
public final boolean getReturnPointBarriers()
```
    If true, barriers will be returned in the barriers property of ClosestFacilitySolveResult. The default value is false.
    
    Returns:
    boolean
  - setReturnPointBarriers
```
public final void setReturnPointBarriers(boolean returnPointBarriers)
```
    Set the returnPointBarriers parameter.
    
    Parameters:
    returnPointBarriers - - If true, barriers will be returned in the barriers property of ClosestFacilitySolveResult. The default value is false.
  - returnPolygonBarriers
```
public final boolean returnPolygonBarriers()
```
    If true, polygon barriers will be returned in the polygonBarriers property of ClosestFacilitySolveResult. The default value is false.
    
    Returns:
    boolean
  - setReturnPolygonBarriers
```
public final void setReturnPolygonBarriers(boolean returnPolygonBarriers)
```
    Set the returnPolygonBarriers parameter.
    
    Parameters:
    returnPolygonBarriers - - If true, polygon barriers will be returned in the polygonBarriers property of ClosestFacilitySolveResult. The default value is false.
  - getReturnPolylineBarriers
```
public final boolean getReturnPolylineBarriers()
```
    If true, polyline barriers will be returned in the polylineBarriers property of ClosestFacilitySolveResult. The default value is false.
    
    Returns:
    boolean
  - setReturnPolylineBarriers
```
public final void setReturnPolylineBarriers(boolean returnPolylineBarriers)
```
    Set the returnPolylineBarriers parameter.
    
    Parameters:
    returnPolylineBarriers - - If true, polyline barriers will be returned in the polylineBarriers property of ClosestFacilitySolveResult. The default value is false.
  - splitLinesAtBreaks
```
public final boolean splitLinesAtBreaks()
```
    If true, lines will be split at breaks.
    
    Returns:
    boolean
  - setSplitLinesAtBreaks
```
public final void setSplitLinesAtBreaks(boolean splitLinesAtBreaks)
```
    Set the splitLinesAtBreaks parameter.
    
    Parameters:
    splitLinesAtBreaks - - If true, lines will be split at breaks.
  - splitPolygonsAtBreaks
```
public final boolean splitPolygonsAtBreaks()
```
    If true, polygons will be split at breaks.
    
    Returns:
    boolean
  - setSplitPolygonsAtBreaks
```
public final void setSplitPolygonsAtBreaks(boolean splitPolygonsAtBreaks)
```
    Set the splitPolygonsAtBreaks parameter.
    
    Parameters:
    splitPolygonsAtBreaks - - If true, polygons will be split at breaks.
  - getTimeOfDay
```
public final com.google.gwt.core.client.JsDate getTimeOfDay()
```
    Local date and time at the facility. if travelDirection set to TO_FACILITY, timeOfDay value specifies arrival time at the facility. if travelDirection set to FROM_FACILITY, timeOfDay specifies departure time from the facility. Requires ArcGIS Server service version 10.1 or greater. (As of v2.6)
    
    Returns:
    JsDate
  - setTimeOfDay
```
public final void setTimeOfDay(com.google.gwt.core.client.JsDate timeOfDay)
```
    Set the timeOfDay parameter.
    
    Parameters:
    timeOfDay - - Local date and time at the facility. if travelDirection set to TO_FACILITY, timeOfDay value specifies arrival time at the facility. if travelDirection set to FROM_FACILITY, timeOfDay specifies departure time from the facility. Requires ArcGIS Server service version 10.1 or greater. (As of v2.6)
  - getTravelDirection
```
public final NATravelDirection getTravelDirection()
```
    Options for traveling to or from the facility. Default values are defined by the newtork layer.
    
    Returns:
    NATravelDirection
  - setTravelDirection
```
public final void setTravelDirection(NATravelDirection travelDirection)
```
    Set the travelDirection parameter.
    
    Parameters:
    travelDirection - - Options for traveling to or from the facility. Default values are defined by the newtork layer.
  - trimOuterPolygon
```
public final boolean trimOuterPolygon()
```
    If true, the outermost polygon (at the maximum break value) will be trimmed. The default is defined in the network analysis layer in your ServiceAreaTask.
    
    Returns:
    boolean
  - setTrimOuterPolygon
```
public final void setTrimOuterPolygon(boolean trimOuterPolygon)
```
    Set the trimOuterPolygon parameter.
    
    Parameters:
    trimOuterPolygon - - If true, the outermost polygon (at the maximum break value) will be trimmed. The default is defined in the network analysis layer in your ServiceAreaTask.
  - trimPolygonDistance
```
public final boolean trimPolygonDistance()
```
    If polygons are being trimmed, provides the distance to trim. The default is defined in the network analysis layer.
    
    Returns:
    boolean
  - setTrimPolygonDistance
```
public final void setTrimPolygonDistance(boolean trimPolygonDistance)
```
  - getTrimPolygonDistanceUnits
```
public final Units getTrimPolygonDistanceUnits()
```
    If polygons are being trimmed, specifies the units of the trimPolygonDistance. The default is defined in the network analysis layer.
    
    Returns:
    Units
  - setTrimPolygonDistanceUnits
```
public final void setTrimPolygonDistanceUnits(Units trimPolygonDistanceUnits)
```
    Set the trimPolygonDistanceUnits parameter.
    
    Parameters:
    trimPolygonDistanceUnits - - If polygons are being trimmed, specifies the units of the trimPolygonDistance. The default is defined in the network analysis layer.
  - getUseHierarchy
```
public final boolean getUseHierarchy()
```
    When true, the hierarchy attributes for the network will be used in analysis. The default value is defined in the network layer. useHierarchy cannot be used in conjunction with outputLines. Requires ArcGIS Server service version 10.1 or greater. (As of v2.6)
    
    Returns:
    boolean
  - setUseHierarchy
```
public final void setUseHierarchy(boolean userHierarchy)
```
    Set the userHierarchy parameter.
    
    Parameters:
    userHierarchy - -When true, the hierarchy attributes for the network will be used in analysis. The default value is defined in the network layer. useHierarchy cannot be used in conjunction with outputLines. Requires ArcGIS Server service version 10.1 or greater. (As of v2.6)

Class ServiceAreaParameters

Nested Class Summary

Method Summary

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

Methods inherited from class java.lang.Object

Method Detail

create

getAccumulateAttributes

setAccumulateAttributes

getAttributeParameterValues

setAttributeParameterValues

getDefaultBreaks

setDefaultBreaks

getExcludeSourcesFromPolygons

setExcludeSourcesFromPolygons

getFacilitiesAsDataLayer

getFacilitiesAsFeatureSet

setFacilities

setFacilities

getImpedanceAttribute

setImpedanceAttribute

mergeSimilarPolygonRanges

setMergeSimilarPolygonRanges

getOutputGeometryPrecision

setOutputGeometryPrecision

getOutputGeometryPrecisionUnits

setOutputGeometryPrecisionUnits

getOutputLines

setOutputLines

getOutSpatialReference

setOutSpatialReference

overlapLines

setOverlapLines

overlapPolygons

setOverlapPolygons

getPointBarriersAsDataLayer

getPointBarriersAsFeatureSet

setPointBarriers

setPointBarriers

getPolygonBarriersAsDataLayer

getPolygonBarriersAsFeaturSet

setPolygonBarriers

setPolygonBarriers

getPolylineBarriersAsDataLayer

getPolylineBarriersAsFeatureSet

setPolylineBarriers

setPolylineBarriers

getRestrictionAttributes

setRestrictionAttributes

getRestrictUTurns

setRestrictUTurns

getReturnFacilities

setReturnFacilities

getReturnPointBarriers

setReturnPointBarriers

returnPolygonBarriers

setReturnPolygonBarriers

getReturnPolylineBarriers

setReturnPolylineBarriers

splitLinesAtBreaks

setSplitLinesAtBreaks

splitPolygonsAtBreaks

setSplitPolygonsAtBreaks

getTimeOfDay

setTimeOfDay

getTravelDirection

setTravelDirection

trimOuterPolygon

setTrimOuterPolygon

trimPolygonDistance

setTrimPolygonDistance

getTrimPolygonDistanceUnits

setTrimPolygonDistanceUnits

getUseHierarchy

setUseHierarchy