Class ValhallaOnlineRoutingService

public shape of the accessors this class declares itself

Hierarchy (View Summary)

ValhallaRoutingService<any, ValhallaOnlineRoutingServiceOptions>
Omit<Accessors, "customServiceURL" | "httpHeaders" | "profile" | "timeout">
Methods
Omit<Accessors, "profile">
Omit<Methods, "calculateRoute" | "getProfile" | "matchRoute" | "setProfile">
- ValhallaOnlineRoutingService

Constructors

constructor

new ValhallaOnlineRoutingService(
options?: ValhallaOnlineRoutingServiceOptions,
native?: any,
): ValhallaOnlineRoutingService
Parameters
- Optionaloptions: ValhallaOnlineRoutingServiceOptions
- Optionalnative: any
Returns ValhallaOnlineRoutingService
Inherited from ValhallaRoutingService.constructor
- Defined in packages/ui-massifmaps/index.d.ts:18

Properties

customServiceURL

customServiceURL: string

duringInit

duringInit: boolean

`Optional`httpHeaders

httpHeaders?: { [k: string]: string }

native

native: any

options

options: ValhallaOnlineRoutingServiceOptions

profile

profile: ValhallaProfile

`Optional`timeout

timeout?: number

Methods

addLocale

addLocale(key: string, json: string): any
Parameters
- key: string
- json: string
Returns any
Inherited from ValhallaRoutingService.addLocale
- Defined in packages/ui-massifmaps/routing/index.d.ts:90

calculateRoute

calculateRoute<T = DefaultLatLonKeys, U extends boolean = false>(
    options: RoutingRequest<T>,
    profile?: string,
    jsonStr?: U,
): Promise<U extends true ? string : RoutingResult<T>>
Type Parameters
- T = DefaultLatLonKeys
- U extends boolean = false
Parameters
- options: RoutingRequest<T>
- Optionalprofile: string
- OptionaljsonStr: U
Returns Promise<U extends true ? string : RoutingResult<T>>
Inherited from ValhallaRoutingService.calculateRoute
- Defined in packages/ui-massifmaps/routing/index.d.ts:82

dispose

dispose(): any
Returns any
Inherited from ValhallaRoutingService.dispose
- Defined in packages/ui-massifmaps/index.d.ts:21

getConfigurationParameter

getConfigurationParameter(param: string): any
Parameters
- param: string
Returns any
Inherited from ValhallaRoutingService.getConfigurationParameter
- Defined in packages/ui-massifmaps/routing/index.d.ts:89

getCustomServiceURL

getCustomServiceURL(): string
Returns string
Inherited from Methods.getCustomServiceURL
- Defined in packages/ui-massifmaps/bindings/routing/ValhallaOnlineRoutingService.d.ts:6

getHTTPHeaders

getHTTPHeaders(): any
Returns any
Inherited from Methods.getHTTPHeaders
- Defined in packages/ui-massifmaps/bindings/routing/ValhallaOnlineRoutingService.d.ts:7

getNative

getNative(): any
Returns any
Inherited from ValhallaRoutingService.getNative
- Defined in packages/ui-massifmaps/index.d.ts:20

getProfile

getProfile(): string
Returns string
Inherited from Methods.getProfile
- Defined in packages/ui-massifmaps/bindings/routing/RoutingService.d.ts:6

getTimeout

getTimeout(): number
Returns number
Inherited from Methods.getTimeout
- Defined in packages/ui-massifmaps/bindings/routing/ValhallaOnlineRoutingService.d.ts:9

initNativeView

initNativeView(native: any, options: ValhallaOnlineRoutingServiceOptions): void
Parameters
- native: any
- options: ValhallaOnlineRoutingServiceOptions
Returns void
Inherited from ValhallaRoutingService.initNativeView
- Defined in packages/ui-massifmaps/index.d.ts:19

matchRoute

matchRoute<T = DefaultLatLonKeys>(
options: RouteMatchingRequest,
profile?: string,
): Promise<RouteMatchingResult<T>>
Type Parameters
- T = DefaultLatLonKeys
Parameters
- options: RouteMatchingRequest
- Optionalprofile: string
Returns Promise<RouteMatchingResult<T>>
Inherited from ValhallaRoutingService.matchRoute
- Defined in packages/ui-massifmaps/routing/index.d.ts:87

routingResultToJSON

routingResultToJSON<T = DefaultLatLonKeys>(
options: RoutingResult<T>,
): Promise<string>
Type Parameters
- T = DefaultLatLonKeys
Parameters
- options: RoutingResult<T>
Returns Promise<string>
Inherited from ValhallaRoutingService.routingResultToJSON
- Defined in packages/ui-massifmaps/routing/index.d.ts:83

setConfigurationParameter

setConfigurationParameter(param: string, value: any): any
Parameters
- param: string
- value: any
Returns any
Inherited from ValhallaRoutingService.setConfigurationParameter
- Defined in packages/ui-massifmaps/routing/index.d.ts:88

setCustomServiceURL

setCustomServiceURL(arg0: string): void
Parameters
- arg0: string
Returns void
Inherited from Methods.setCustomServiceURL
- Defined in packages/ui-massifmaps/bindings/routing/ValhallaOnlineRoutingService.d.ts:11

setHTTPHeaders

setHTTPHeaders(arg0: any): void
Parameters
- arg0: any
Returns void
Inherited from Methods.setHTTPHeaders
- Defined in packages/ui-massifmaps/bindings/routing/ValhallaOnlineRoutingService.d.ts:12

setProfile

setProfile(arg0: string): void
Parameters
- arg0: string
Returns void
Inherited from Methods.setProfile
- Defined in packages/ui-massifmaps/bindings/routing/RoutingService.d.ts:8

setTimeout

setTimeout(arg0: number): void
Parameters
- arg0: number
Returns void
Inherited from Methods.setTimeout
- Defined in packages/ui-massifmaps/bindings/routing/ValhallaOnlineRoutingService.d.ts:14

Class ValhallaOnlineRoutingService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ValhallaOnlineRoutingService

Properties

customServiceURL

duringInit

OptionalhttpHeaders

native

options

profile

Optionaltimeout

Methods

addLocale

Parameters

Returns any

calculateRoute

Type Parameters

Parameters

Returns Promise<U extends true ? string : RoutingResult<T>>

dispose

Returns any

getConfigurationParameter

Parameters

Returns any

getCustomServiceURL

Returns string

getHTTPHeaders

Returns any

getNative

Returns any

getProfile

Returns string

getTimeout

Returns number

initNativeView

Parameters

Returns void

matchRoute

Type Parameters

Parameters

Returns Promise<RouteMatchingResult<T>>

routingResultToJSON

Type Parameters

Parameters

Returns Promise<string>

setConfigurationParameter

Parameters

Returns any

setCustomServiceURL

Parameters

Returns void

setHTTPHeaders

Parameters

Returns void

setProfile

Parameters

Returns void

setTimeout

Parameters

Returns void

Settings

On This Page

`Optional`httpHeaders

`Optional`timeout