Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Directions

Hierarchy

Index

Properties

apiKey

apiKey: string

An authorization string used to access a resource or service.

Read more...

container

container: string | HTMLElement

The ID or node representing the DOM element containing the widget.

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...

headingLevel

headingLevel: number

Indicates the heading level to use for the origin and destination addresses (i.e.

Read more...

iconClass

iconClass: string

The widget's default CSS icon class.

Read more...

id

id: string

The unique ID assigned to the widget when the widget is created.

Read more...

initialized

initialized: boolean

label

label: string

The widget's label.

Read more...

Readonly lastRoute

The most recent route result.

Read more...

maxStops

maxStops: number

The maximum number of stops allowed for routing.

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...

searchProperties

searchProperties: DirectionsSearchProperties

Controls the default properties used when searching.

Read more...

stopSymbols

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

Read more...

view

The view from which the widget will operate.

Read more...

viewModel

The view model for this widget.

Read more...

visible

visible: boolean

Indicates whether the widget is visible.

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

  • _set<T>(propertyName: string, value: T): Directions
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Directions

classes

  • classes(...classNames: any[]): string
  • A utility method used for building the value for a widget's class property.

    Read more...

    Parameters

    • Rest ...classNames: any[]

    Returns string

destroy

  • destroy(): void
  • Destroys the widget instance.

    Read more...

    Returns void

emit

  • emit(type: string, event?: any): boolean
  • Emits an event on the instance.

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

get

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

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

getDirections

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

    Read more...

    Returns Promise<supportRouteResult>

hasEventListener

  • hasEventListener(type: string): boolean
  • Indicates whether there is an event listener on the instance that matches the provided event name.

    Read more...

    Parameters

    • type: string

    Returns boolean

isFulfilled

  • isFulfilled(): boolean
  • isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

    Read more...

    Returns boolean

isRejected

  • isRejected(): boolean
  • isRejected() may be used to verify if creating an instance of the class is rejected.

    Read more...

    Returns boolean

isResolved

  • isResolved(): boolean
  • isResolved() may be used to verify if creating an instance of the class is resolved.

    Read more...

    Returns boolean

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

on

  • Registers an event handler on the instance.

    Read more...

    Parameters

    Returns IHandle

own

  • Widget teardown helper.

    Read more...

    Parameters

    Returns void

postInitialize

  • postInitialize(): void
  • This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

    Read more...

    Returns void

render

  • render(): any
  • This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

    Read more...

    Returns any

renderNow

  • renderNow(): void
  • Renders widget to the DOM immediately.

    Read more...

    Returns void

scheduleRender

  • scheduleRender(): void
  • This method is primarily used by developers when implementing custom widgets. Schedules widget rendering.

    Read more...

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Directions

  • Parameters

    Returns Directions

watch

  • Parameters

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

    Returns WatchHandle

when

  • when(callback?: Function, errback?: Function): Promise<any>
  • when() may be leveraged once an instance of the class is created.

    Read more...

    Parameters

    • Optional callback: Function
    • Optional errback: Function

    Returns Promise<any>

zoomToRoute

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

    Read more...

    Returns void

Generated using TypeDoc