TravelMode | @types/arcgis-js-api

Hierarchy

Accessor
JSONSupport
- TravelMode

Index

Properties

attributeParameterValues

attributeParameterValues: TravelModeAttributeParameterValues[]

Lists the parameterized attributes used by the travel mode.

declaredClass

declaredClass: string

description

description: string

A short text description of the travel mode.

destroyed

destroyed: boolean

distanceAttributeName

distanceAttributeName: string

Indicates the distance-based cost attribute for reporting directions and for solving vehicle routing problems.

id

id: string

The unique identifier.

impedanceAttributeName

impedanceAttributeName: string

The network cost attribute used as impedance.

initialized

initialized: boolean

name

name: string

The unique name of the travel mode.

restrictionAttributeNames

restrictionAttributeNames: string[]

The list of the restriction attributes used when solving network analysis problems with this travel mode.

simplificationTolerance

simplificationTolerance: number

Specifies whether the travel mode generalizes the geometry of analysis results and by how much.

simplificationToleranceUnits

The linear units associated with simplificationTolerance.

timeAttributeName

timeAttributeName: string

Indicates the time-based cost attribute for reporting directions.

type

type: "automobile" | "truck" | "walk" | "other"

Indicates the category of travel or vehicle represented by this travel mode.

useHierarchy

useHierarchy: boolean

Indicates whether the travel mode uses a hierarchy attribute while performing the analysis.

uturnAtJunctions

uturnAtJunctions: "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections"

Indicates how the U-turns at junctions that could occur during network traversal are handled by the solver.

Methods

Protected _get

_get(propertyName: string): any
_get<T>(propertyName: string): T

Inherited from Accessor._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:35
Parameters
- propertyName: string
Returns any
Inherited from Accessor._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:36
Type parameters
- T
Parameters
- propertyName: string
Returns T

Protected _set

_set<T>(propertyName: string, value: T): TravelMode

Inherited from Accessor._set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:37
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns TravelMode

clone

clone(): TravelMode

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:40657
Returns a deep clone of the travel mode object.

Read more...

Returns TravelMode

destroy

destroy(): void

Inherited from Accessor.destroy
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:26
Returns void

get

get<T>(propertyName: string): T
get(propertyName: string): any

Inherited from Accessor.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:28
Type parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Accessor.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:29
Parameters
- propertyName: string
Returns any

Protected notifyChange

notifyChange(propertyName: string): void

Inherited from Accessor.notifyChange
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:34
Parameters
- propertyName: string
Returns void

set

set<T>(propertyName: string, value: T): TravelMode
set(props: HashMap<any>): TravelMode

Inherited from Accessor.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:30
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns TravelMode
Inherited from Accessor.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:31
Parameters
- props: HashMap<any>
Returns TravelMode

toJSON

toJSON(): any

Inherited from JSONSupport.toJSON
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1214
Converts an instance of this class to its ArcGIS portal JSON representation.

Read more...

Returns any

watch

watch(path: string | string[], callback: WatchCallback, sync?: boolean): WatchHandle

Inherited from Accessor.watch
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:32
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle

Hierarchy

Index

Properties

Methods

Properties

attributeParameterValues

declaredClass

description

destroyed

distanceAttributeName

id

impedanceAttributeName

initialized

name

restrictionAttributeNames

simplificationTolerance

simplificationToleranceUnits

timeAttributeName

type

useHierarchy

uturnAtJunctions

Methods

Protected _get

Parameters

propertyName: string

Returns any

Type parameters

T

Parameters

propertyName: string

Returns T

Protected _set

Type parameters

T

Parameters

propertyName: string

value: T

Returns TravelMode

clone

Returns TravelMode

destroy

Returns void

get

Type parameters

T

Parameters

propertyName: string

Returns T

Parameters

propertyName: string

Returns any

Protected notifyChange

Parameters

propertyName: string

Returns void

set

Type parameters

T

Parameters

propertyName: string

value: T

Returns TravelMode

Parameters

props: HashMap<any>

Returns TravelMode

toJSON

Returns any

watch

Parameters

path: string | string[]

callback: WatchCallback

Optional sync: boolean

Returns WatchHandle