Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DirectionsViewModel

Hierarchy

Index

Properties

apiKey

apiKey: string

An authorization string used to access a resource or service.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

goToOverride

goToOverride: GoToOverride

This function provides the ability to override either the IMapView goTo() or SceneView goTo() methods.

Read more...

impedanceAttribute

impedanceAttribute: string

The network attribute name to be used as the impedance attribute in the analysis.

Read more...

initialized

initialized: boolean

Readonly lastRoute

The most recent route result.

Read more...

maxStops

maxStops: number

The maximum number of stops allowed for routing.

Read more...

routeParameters

routeParameters: supportRouteParameters

Route Parameters object used to call the service.

Read more...

routeServiceUrl

routeServiceUrl: string

The URL of the REST endpoint of the Route service.

Read more...

routeSymbol

routeSymbol: SimpleLineSymbol

Defines the symbol used to draw the route on the map.

Read more...

selectedTravelMode

selectedTravelMode: TravelMode

The selected travel mode.

Read more...

Readonly serviceDescription

The Service Description object returned by the Route REST Endpoint.

Read more...

Readonly state

state: "disabled" | "ready"

The current state of the view model.

Read more...

stopSymbols

The default stop symbols used to display locations between the origin and final destination.

Read more...

stops

An array of graphics that define the stop locations along the route.

Read more...

Readonly timeAttribute

The name of the network attribute to use for the drive time when computing directions.

Read more...

Readonly travelModes

travelModes: TravelMode[]

Array of objects containing properties specific to either an ArcGIS service or organization's travel modes.

Read more...

view

The view from which the widget will operate.

Read more...

Methods

Protected _get

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

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns DirectionsViewModel

centerAt

  • centerAt(stopOrManeuver: Graphic): void
  • Centers the map at the specified maneuver or stop.

    Read more...

    Parameters

    Returns void

clearHighlights

  • clearHighlights(): void
  • Clears any highlighted route segments.

    Read more...

    Returns void

clearResults

  • clearResults(): void
  • Removes the route directions from the directions list, leaving the inputs untouched.

    Read more...

    Returns void

destroy

  • destroy(): void
  • Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

getCostAttribute

  • getCostAttribute(attributeName: string): string
  • Returns cost attribute name specific to a particular route service.

    Read more...

    Parameters

    • attributeName: string

    Returns string

getDirections

  • Calculate the route to the input locations and display the list of directions.

    Read more...

    Returns Promise<supportRouteResult>

highlightSegment

  • highlightSegment(maneuver: Graphic): void
  • Highlights the specified route segment on the map.

    Read more...

    Parameters

    Returns void

load

  • load(): Promise<any>
  • This method should be called to load the view model's routing resources.

    Read more...

    Returns Promise<any>

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

reset

  • reset(): void
  • Resets the state of the ViewModel, clearing all the input stops and results in the widget and in the map.

    Read more...

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns DirectionsViewModel

  • Parameters

    Returns DirectionsViewModel

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

zoomToRoute

  • zoomToRoute(): void
  • Zoom so that the full route is displayed within the current map extent.

    Read more...

    Returns void

Generated using TypeDoc