Options
All
  • Public
  • Public/Protected
  • All
Menu

geobase-client

Index

Modules

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

GeocodeResponse

A geocode response containing either a list of results on success, or an error.

Server

Server: string | IServerWithSubdomains

XDomainRequest

XDomainRequest: any

Variables

CUSTOM_DATA_ASSEMBLY_NAME

CUSTOM_DATA_ASSEMBLY_NAME: string = "CustomData"

DEGREES_FACTOR

DEGREES_FACTOR: number = 180 / Math.PI

GEOBASE_ASSEMBLY_NAME

GEOBASE_ASSEMBLY_NAME: string = "geobase.net"

IMAGE_WIDTH

IMAGE_WIDTH: 300 = 300

LATLON_REGEXP

LATLON_REGEXP: RegExp = /^\s*([+-]?\d+(?:\.\d+)?)\s*,\s*([+-]?\d+(?:\.\d+)?)?\s*((?:Z)\d+)*$/

LabelsLayerName

LabelsLayerName: string = "Labels"

MAX_SEARCHES_PER_REQUEST

MAX_SEARCHES_PER_REQUEST: 100 = 100

The maximum number of searches which can be included in a single IGeocodeRequest.

MIN_STRING_TOKEN_LENGTH

MIN_STRING_TOKEN_LENGTH: number = 12

MIN_TOKEN_OCCURANCE

MIN_TOKEN_OCCURANCE: number = 2

RADIANS_FACTOR

RADIANS_FACTOR: number = Math.PI / 180

StreetsLayerName

StreetsLayerName: string = "Streets"

TILES_PER_SUPERTILE

TILES_PER_SUPERTILE: 4 = 4

TOKEN_PROPERTY

TOKEN_PROPERTY: string = "__gbson_token"

VECTOR_TILES_PER_SUPERTILE

VECTOR_TILES_PER_SUPERTILE: 1 = 1

_dtoSerializers

_dtoSerializers: Object

addUserToCdoltLayer

addUserToCdoltLayer: function = getInstance().addUserToCdoltLayer.bind(getInstance())

The instance method GeoStream.addUserToCdoltLayer on the singleton GeoStream instance

Type declaration

    • (layer: any, usernameToAdd: string, cancelEmitter?: CancelEmitter): when.Promise<any>
    • Parameters

      • layer: any
      • usernameToAdd: string
      • Optional cancelEmitter: CancelEmitter

      Returns when.Promise<any>

autocompleteGeocode

autocompleteGeocode: function = getInstance().autocompleteGeocode.bind(getInstance())

The instance method GeoStream.autocompleteGeocode on the singleton GeoStream instance

Type declaration

bulkAutocompleteGeocode

bulkAutocompleteGeocode: function = getInstance().bulkAutocompleteGeocode.bind(getInstance())

The instance method GeoStream.bulkAutocompleteGeocode on the singleton GeoStream instance

Type declaration

bulkGeocode

bulkGeocode: function = getInstance().bulkGeocode.bind(getInstance())

The instance method GeoStream.bulkGeocode on the singleton GeoStream instance

bulkLocationSearch

bulkLocationSearch: function = getInstance().bulkLocationSearch.bind(getInstance())

The instance method GeoStream.bulkLocationSearch on the singleton GeoStream instance

Type declaration

bulkReverseGeocode

bulkReverseGeocode: function = getInstance().bulkReverseGeocode.bind(getInstance())

The instance method GeoStream.bulkReverseGeocode on the singleton GeoStream instance

Type declaration

bulkReverseGeocodeFull

bulkReverseGeocodeFull: function = getInstance().bulkReverseGeocodeFull.bind(getInstance())

The instance method GeoStream.bulkReverseGeocodeFull on the singleton GeoStream instance

Type declaration

classKeyFormatters

classKeyFormatters: any[] = new Array()

countryToStringCache

countryToStringCache: object

Type declaration

  • [key: number]: string

deleteCdoltLayer

deleteCdoltLayer: function = getInstance().deleteCdoltLayer.bind(getInstance())

The instance method GeoStream.deleteCdoltLayer on the singleton GeoStream instance

Type declaration

    • Parameters

      Returns when.Promise<any>

emit

emit: function = getInstance().emit.bind(getInstance())

The instance method GeoStream.emit on the singleton GeoStream instance

Type declaration

    • (event: string | symbol, ...args: any[]): boolean
    • Parameters

      • event: string | symbol
      • Rest ...args: any[]

      Returns boolean

findCdoltNearestLines

findCdoltNearestLines: function = getInstance().findCdoltNearestLines.bind(getInstance())

The instance method GeoStream.findCdoltNearestLines on the singleton GeoStream instance

Type declaration

    • (layer: any, location: LatLon, tableName: string, simplificationLevel?: number, cancelEmitter?: CancelEmitter): when.Promise<any>
    • Parameters

      • layer: any
      • location: LatLon
      • tableName: string
      • Optional simplificationLevel: number
      • Optional cancelEmitter: CancelEmitter

      Returns when.Promise<any>

findCdoltNearestPoints

findCdoltNearestPoints: function = getInstance().findCdoltNearestPoints.bind(getInstance())

The instance method GeoStream.findCdoltNearestPoints on the singleton GeoStream instance

Type declaration

    • (layer: any, location: LatLon, tableName: string, cancelEmitter?: CancelEmitter): when.Promise<any>
    • Parameters

      Returns when.Promise<any>

findCdoltNearestPolygons

findCdoltNearestPolygons: function = getInstance().findCdoltNearestPolygons.bind(getInstance())

The instance method GeoStream.findCdoltNearestPolygons on the singleton GeoStream instance

Type declaration

    • (layer: any, location: LatLon, tableName: string, simplificationLevel?: number, cancelEmitter?: CancelEmitter): when.Promise<any>
    • Parameters

      • layer: any
      • location: LatLon
      • tableName: string
      • Optional simplificationLevel: number
      • Optional cancelEmitter: CancelEmitter

      Returns when.Promise<any>

format

format: function = getInstance().format.bind(getInstance())

The instance method GeoStream.format on the singleton GeoStream instance

Type declaration

getAddressFormatter

getAddressFormatter: function = getInstance().getAddressFormatter.bind(getInstance())

The instance method GeoStream.getAddressFormatter on the singleton GeoStream instance

Type declaration

getAllLayers

getAllLayers: function = getInstance().getAllLayers.bind(getInstance())

The instance method GeoStream.getAllLayers on the singleton GeoStream instance

Type declaration

getAuthToken

getAuthToken: function = getInstance().getAuthToken.bind(getInstance())

The instance method GeoStream.getAuthToken on the singleton GeoStream instance

Type declaration

    • (username: string, password: string, expiry?: TimeSpan, cancelEmitter?: CancelEmitter): when.Promise<string>
    • Parameters

      Returns when.Promise<string>

getCdoltLayers

getCdoltLayers: function = getInstance().getCdoltLayers.bind(getInstance())

The instance method GeoStream.getCdoltLayers on the singleton GeoStream instance

Type declaration

getCopyrightString

getCopyrightString: function = getInstance().getCopyrightString.bind(getInstance())

The instance method GeoStream.getCopyrightString on the singleton GeoStream instance

Type declaration

    • Parameters

      Returns when.Promise<string>

getCorrectedLocation

getCorrectedLocation: function = getInstance().getCorrectedLocation.bind(getInstance())

The instance method GeoStream.getCorrectedLocation on the singleton GeoStream instance

Type declaration

getCustomLocationSearchArgs

getCustomLocationSearchArgs: function = getInstance().getCustomLocationSearchArgs.bind(getInstance())

The instance method GeoStream.getCustomLocationSearchArgs on the singleton GeoStream instance

Type declaration

getDirections

getDirections: function = getInstance().getDirections.bind(getInstance())

The instance method GeoStream.getDirections on the singleton GeoStream instance

Type declaration

getGeostreamLayers

getGeostreamLayers: function = getInstance().getGeostreamLayers.bind(getInstance())

The instance method GeoStream.getGeostreamLayers on the singleton GeoStream instance

Type declaration

getPath

getPath: function = getInstance().getPath.bind(getInstance())

The instance method GeoStream.getPath on the singleton GeoStream instance

Type declaration

getResolvedServerInfoForLayer

getResolvedServerInfoForLayer: function = getInstance().getResolvedServerInfoForLayer.bind(getInstance())

The instance method GeoStream.getServerForLayer on the singleton GeoStream instance

Type declaration

getRouteHighlight

getRouteHighlight: function = getInstance().getRouteHighlight.bind(getInstance())

The instance method GeoStream.getRouteHighlight on the singleton GeoStream instance

Type declaration

getServerForLayer

getServerForLayer: function = getInstance().getServerForLayer.bind(getInstance())

The instance method [[GeoStream.getServerUrlForLayer]] on the singleton GeoStream instance

Type declaration

getServerInfo

getServerInfo: function = getInstance().getServerInfo.bind(getInstance())

The instance method GeoStream.getServerInfo on the singleton GeoStream instance

Type declaration

getSubdomains

getSubdomains: function = getInstance().getSubdomains.bind(getInstance())

The instance method GeoStream.getSubdomains on the singleton GeoStream instance

Type declaration

    • (layer: Layer): when.Promise<string[]>
    • Parameters

      Returns when.Promise<string[]>

getTileTemplateUrl

getTileTemplateUrl: function = getInstance().getTileTemplateUrl.bind(getInstance())

The instance method GeoStream.getTileTemplateUrl on the singleton GeoStream instance

Type declaration

instance

instance: GeoStream

locationSearch

locationSearch: function = getInstance().locationSearch.bind(getInstance())

The instance method GeoStream.locationSearch on the singleton GeoStream instance

Type declaration

md5

md5: any = require('md5')

on

on: function = getInstance().on.bind(getInstance())

The instance method GeoStream.on on the singleton GeoStream instance

Type declaration

    • (event: string | symbol, listener: Function): GeoStream
    • Parameters

      • event: string | symbol
      • listener: Function

      Returns GeoStream

optimizeRoute

optimizeRoute: function = getInstance().optimizeRoute.bind(getInstance())

The instance method GeoStream.optimizeRoute on the singleton GeoStream instance

Type declaration

queryCdoltLayerIndex

queryCdoltLayerIndex: function = getInstance().queryCdoltLayerIndex.bind(getInstance())

The instance method GeoStream.queryCdoltLayerIndex on the singleton GeoStream instance

Type declaration

    • (layer: any, operator: Operator, value: any, firstResult?: number, simplificationLevel?: number, cancelEmitter?: CancelEmitter): when.Promise<any>
    • Parameters

      • layer: any
      • operator: Operator
      • value: any
      • Optional firstResult: number
      • Optional simplificationLevel: number
      • Optional cancelEmitter: CancelEmitter

      Returns when.Promise<any>

queryCdoltLines

queryCdoltLines: function = getInstance().queryCdoltLines.bind(getInstance())

The instance method GeoStream.queryCdoltLines on the singleton GeoStream instance

Type declaration

    • (layer: any, boundingBox: BoundingBox, tableName: string, simplificationLevel?: number, cancelEmitter?: CancelEmitter): when.Promise<any>
    • Parameters

      • layer: any
      • boundingBox: BoundingBox
      • tableName: string
      • Optional simplificationLevel: number
      • Optional cancelEmitter: CancelEmitter

      Returns when.Promise<any>

queryCdoltPOI

queryCdoltPOI: function = getInstance().queryCdoltPOI.bind(getInstance())

The instance method GeoStream.queryCdoltPOI on the singleton GeoStream instance

Type declaration

queryCdoltPoints

queryCdoltPoints: function = getInstance().queryCdoltPoints.bind(getInstance())

The instance method GeoStream.queryCdoltPoints on the singleton GeoStream instance

Type declaration

queryCdoltPolygons

queryCdoltPolygons: function = getInstance().queryCdoltPolygons.bind(getInstance())

The instance method GeoStream.queryCdoltPolygons on the singleton GeoStream instance

Type declaration

    • (layer: any, boundingBox: BoundingBox, tableName: string, simplificationLevel?: number, cancelEmitter?: CancelEmitter): when.Promise<any>
    • Parameters

      • layer: any
      • boundingBox: BoundingBox
      • tableName: string
      • Optional simplificationLevel: number
      • Optional cancelEmitter: CancelEmitter

      Returns when.Promise<any>

queryCdoltPolygonsAtPoint

queryCdoltPolygonsAtPoint: function = getInstance().queryCdoltPolygonsAtPoint.bind(getInstance())

The instance method GeoStream.queryCdoltPolygonsAtPoint on the singleton GeoStream instance

Type declaration

    • (layer: any, location: LatLon, tableName: string, simplificationLevel?: number, cancelEmitter?: CancelEmitter): when.Promise<any>
    • Parameters

      • layer: any
      • location: LatLon
      • tableName: string
      • Optional simplificationLevel: number
      • Optional cancelEmitter: CancelEmitter

      Returns when.Promise<any>

queryLinks

queryLinks: function = getInstance().queryLinks.bind(getInstance())

The instance method [[GeoStream.querylinks]] on the singleton GeoStream instance

Type declaration

refreshServerInfo

refreshServerInfo: function = getInstance().refreshServerInfo.bind(getInstance())

The instance method GeoStream.refreshServerInfo on the singleton GeoStream instance

Type declaration

removeUserFromCdoltLayer

removeUserFromCdoltLayer: function = getInstance().removeUserFromCdoltLayer.bind(getInstance())

The instance method GeoStream.removeUserFromCdoltLayer on the singleton GeoStream instance

Type declaration

    • (layer: any, usernameToRemove: string, cancelEmitter?: CancelEmitter): when.Promise<any>
    • Parameters

      • layer: any
      • usernameToRemove: string
      • Optional cancelEmitter: CancelEmitter

      Returns when.Promise<any>

renameCdoltLayer

renameCdoltLayer: function = getInstance().renameCdoltLayer.bind(getInstance())

The instance method GeoStream.renameCdoltLayer on the singleton GeoStream instance

Type declaration

    • (layer: any, newLayerName: string, cancelEmitter?: CancelEmitter): when.Promise<any>
    • Parameters

      • layer: any
      • newLayerName: string
      • Optional cancelEmitter: CancelEmitter

      Returns when.Promise<any>

reverseGeocode

reverseGeocode: function = getInstance().reverseGeocode.bind(getInstance())

The instance method GeoStream.reverseGeocode on the singleton GeoStream instance

Type declaration

validateAndAggregateLayers

validateAndAggregateLayers: function = getInstance().validateAndAggregateLayers.bind(getInstance())

The instance method GeoStream.validateAndAggregateLayers on the singleton GeoStream instance

Type declaration

    • (allLayers: any[]): when.Promise<any[]>
    • Parameters

      • allLayers: any[]

      Returns when.Promise<any[]>

Functions

_buildDefines

  • Parameters

    Returns object

_buildTokenContainer

  • Parameters

    • rootObject: any

    Returns ITokenContainer

_getTokensFromContainer

_linkTokens

  • Parameters

    Returns any

_resolveGbson

  • _resolveGbson(outputObj: any, gbson: any, refs: Object): void
  • Parameters

    • outputObj: any
    • gbson: any
    • refs: Object

    Returns void

_resolveReference

  • _resolveReference(referenceKey: number, refs: Object): any
  • Parameters

    • referenceKey: number
    • refs: Object

    Returns any

_resolveValue

  • _resolveValue(gbson: any, refs: Object): any
  • Parameters

    • gbson: any
    • refs: Object

    Returns any

_unpack

  • Parameters

    • gbson: any

    Returns IGbsonToken

addDtoSerializer

  • addDtoSerializer(assembly: string, className: string, serializer: IDtoSerializer): void
  • Parameters

    Returns void

addFormatter

  • addFormatter(formatter: function): void
  • Parameters

    • formatter: function
        • (className: string, assemblyName: string): string
        • Parameters

          • className: string
          • assemblyName: string

          Returns string

    Returns void

baseGeocodeArgstoDto

  • Parameters

    Returns Object

boundingBox

  • Creates a BoundingBox from an existing bounding box.

    Parameters

    Returns BoundingBox

  • Creates a BoundingBox with the specified south-west and north-east corners.

    Parameters

    • southWest: ILatLon | string

      The south-west corner of the bounding box.

    • northEast: ILatLon | string

      The north-east corner of the bounding box.

    Returns BoundingBox

distance

  • Returns a distance with an associated value and distance unit.

    Parameters

    Returns Distance

enumToString

  • enumToString(values: number, type: Object): string
  • Parameters

    • values: number
    • type: Object

    Returns string

escapeInvalidNumbers

  • escapeInvalidNumbers(gbson: string): string
  • Escapes the values Infinity, -Infinity, and NaN, which can be present inside GBSON but are invalid JSON. In valid JSON, they are represented as null, but in escaped GBSON they are represented as _r references to their value.

    These values are only escaped when they are present as bare values -- they are all valid when inside strings.

    Parameters

    • gbson: string

    Returns string

formatClassName

  • formatClassName(className: string, assemblyName: string): string
  • Parameters

    • className: string
    • assemblyName: string

    Returns string

formatDictionary

  • formatDictionary(className: string, assemblyName: string): string
  • Parameters

    • className: string
    • assemblyName: string

    Returns string

formatJSONResponse

  • formatJSONResponse(response: any): any
  • Parameters

    • response: any

    Returns any

fromGbson

  • fromGbson(gbson: IGbson): any
  • Parameters

    Returns any

geocode

  • Performs a bulk geocode using the default GeoStream.

    Parameters

    Returns when.Promise<GeocodeResponse>

    the response to the request.

  • Performs a bulk geocode using the given GeoStream.

    Parameters

    Returns when.Promise<GeocodeResponse>

    the response to the request.

getDefaultDistanceUnits

  • Returns the default distance units for the given unit system.

    Parameters

    Returns DistanceUnit

getDtoSerializer

  • Parameters

    • type: Object

    Returns IDtoSerializer

getDtoSerializerByName

  • getDtoSerializerByName(className: string, assemblyName: string): IDtoSerializer
  • Parameters

    • className: string
    • assemblyName: string

    Returns IDtoSerializer

getIDrivingEvent

  • Returns a DrivingEvent for a given DTO.

    Parameters

    • dto: any

    Returns DrivingEvent

getIMovement

  • Returns a Movement for a given DTO.

    Parameters

    • dto: any

    Returns IMovement

getINote

  • getINote(dto: any, callback: function): INote
  • Returns a Note for a given DTO.

    Parameters

    • dto: any
    • callback: function
        • (arg: any): any
        • Parameters

          • arg: any

          Returns any

    Returns INote

getInstance

  • Returns GeoStream

implementsIOneLineGeocodeArgs

  • implementsIOneLineGeocodeArgs(obj: any): boolean
  • Parameters

    • obj: any

    Returns boolean

implementsIStreetStructuredGeocodeArgs

  • implementsIStreetStructuredGeocodeArgs(obj: any): boolean
  • Parameters

    • obj: any

    Returns boolean

implementsIStructuredGeocodeArgs

  • implementsIStructuredGeocodeArgs(obj: any): boolean
  • Parameters

    • obj: any

    Returns boolean

isArrayEqual

  • isArrayEqual(arr1: any[], arr2: any[]): boolean
  • Parameters

    • arr1: any[]
    • arr2: any[]

    Returns boolean

isEqualHelper

  • isEqualHelper(val1: any, val2: any): boolean
  • Parameters

    • val1: any
    • val2: any

    Returns boolean

isIBoundingBox

  • isIBoundingBox(bbox: any): boolean
  • Parameters

    • bbox: any

    Returns boolean

isILatLon

  • isILatLon(arg: any): boolean
  • Parameters

    • arg: any

    Returns boolean

latLon

  • Creates a LatLon object from a string representation.

    Parameters

    • latlonString: string

      The value of a LatLon as a string.

    Returns LatLon

    The decoded LatLon.

  • Creates a LatLon using the properties of the given object, taking the value of the lng field as the longitude value if it is present, otherwise using the value of the lon property.

    Parameters

    • latlon: ILatLon

      The LatLon data, with either a lon property or a lng property.

    Returns LatLon

    A full LatLon object with the given property values.

  • Creates a LatLon using the given values.

    Parameters

    • lat: number

      The latitude in degrees, between -90 and 90.

    • lon: number

      The longitude in degrees, between -180 and 180.

    • Optional z: number

      The z-level of the LatLon, between 0 and 15 (inclusive).

    Returns LatLon

    A LatLon using the given values.

mass

  • Returns a mass with an associated value and mass unit.

    Parameters

    Returns Mass

onlyDefined

  • onlyDefined(obj: Object): Object
  • Returns a shallow copy of the given object with any properties containing the value undefined removed.

    Parameters

    • obj: Object

    Returns Object

padLoad

parseEnum

  • parseEnum(values: string, type: Object): number
  • Parameters

    • values: string
    • type: Object

    Returns number

removeTokenRef

  • removeTokenRef(object: any): void
  • Parameters

    • object: any

    Returns void

speed

  • Returns the speed with an associated value and speed unit.

    Parameters

    Returns Speed

timeSpan

  • Returns the time span with an associated value and unit.

    Parameters

    Returns TimeSpan

toGbson

  • toGbson(source: any): IGbson
  • Parameters

    • source: any

    Returns IGbson

tryFormatDate

  • tryFormatDate(date: Date): string
  • Parameters

    • date: Date

    Returns string

use

  • use(server: string, username: string, password: string): when.Promise<string[]>
  • use(config: IGeoStreamConfig): when.Promise<string[]>
  • Parameters

    • server: string
    • username: string
    • password: string

    Returns when.Promise<string[]>

  • Parameters

    Returns when.Promise<string[]>

Object literals

IntersectionType

IntersectionType: object

The types of intersection, or events occurring at an intersection, supported.

ChangeFerry

ChangeFerry: string = "ChangeFerry"

The event of changing from one ferry to another.

Complex

Complex: string = "Complex"

A complex intersection that cannot be categorized by any of the other intersection types.

Continue

Continue: string = "Continue"

The event of continuing from one street to another, without turning, but possibly with a change of the street name.

Departure

Departure: string = "Departure"

The event of starting a route.

DisembarkFerry

DisembarkFerry: string = "DisembarkFerry"

The event of disembarking from a ferry.

EmbarkFerry

EmbarkFerry: string = "EmbarkFerry"

The event of embarking onto a ferry.

EndPoint

EndPoint: string = "EndPoint"

The event of arriving at a destination.

FourWay

FourWay: string = "FourWay"

An intersection where two roads cross.

InsideIntersection

InsideIntersection: string = "InsideIntersection"

The event of being inside an intersection.

IntersectionEntry

IntersectionEntry: string = "IntersectionEntry"

The event of entering an intersection.

IntersectionExit

IntersectionExit: string = "IntersectionExit"

The event of exiting an intersection.

None

None: string = "None"

No intersection, normal street without turn-offs.

RampEntry

RampEntry: string = "RampEntry"

The event of entering a freeway ramp.

RampExit

RampExit: string = "RampExit"

The event of exiting a freeway ramp.

RoundAboutEntry

RoundAboutEntry: string = "RoundAboutEntry"

The event of entering a traffic circle.

RoundAboutExit

RoundAboutExit: string = "RoundAboutExit"

The event of exiting a traffic circle.

RoundAboutInside

RoundAboutInside: string = "RoundAboutInside"

The event of being inside a traffic circle.

SkipBypass

SkipBypass: string = "SkipBypass"

The event of skipping a bypass road and instead driving along the main, more congested, route.

Split

Split: string = "Split"

A split where one road splits into two.

T

T: string = "T"

A T-junction, where three street links meet.

UTurn

UTurn: string = "UTurn"

A u-turn.

YJoin

YJoin: string = "YJoin"

A join, where two roads merge into one, in the shape of a Y.

YSplit

YSplit: string = "YSplit"

A split where one road splits into two, in the shape of a Y.

LoadType

LoadType: object

The types of loads supported.

Agricultural

Agricultural: string = "Agricultural"

Agricultural items (such as livestock, feed or produce).

AllHazmat

AllHazmat: string = "AllHazmat"

This load contains items from each HAZMAT category.

BuildingMaterials

BuildingMaterials: string = "BuildingMaterials"

Building materials (for example, timber framing).

Coal

Coal: string = "Coal"

Coal

Forestry

Forestry: string = "Forestry"

Forestry (such as unsawn timber)

GoodsHarmfulToWater

GoodsHarmfulToWater: string = "GoodsHarmfulToWater"

Goods harmful to water (such as oil)

Gravel

Gravel: string = "Gravel"

Gravel

Hazardous

Hazardous: string = "Hazardous"

Some form of hazardous load. You may wish to identify the particular hazard more precisely using a HAZMAT load type (such as Hazmat_1) or simply GoodsHarmfulToWater.

Hazmat_1

Hazmat_1: string = "Hazmat_1"

Class 1 HAZMAT (explosives)

Hazmat_2

Hazmat_2: string = "Hazmat_2"

Class 2 HAZMAT (compressed gases)

Hazmat_3

Hazmat_3: string = "Hazmat_3"

Class 3 HAZMAT (flammable liquids)

Hazmat_4

Hazmat_4: string = "Hazmat_4"

Class 4 HAZMAT (flammable solids)

Hazmat_5

Hazmat_5: string = "Hazmat_5"

Class 5 HAZMAT (oxidizers)

Hazmat_6

Hazmat_6: string = "Hazmat_6"

Class 6 HAZMAT (poisons)

Hazmat_7

Hazmat_7: string = "Hazmat_7"

Class 7 HAZMAT (radioactive materials)

Hazmat_8

Hazmat_8: string = "Hazmat_8"

Class 8 HAZMAT (corrosive liquids)

Hazmat_9

Hazmat_9: string = "Hazmat_9"

Class 9 HAZMAT (miscellaneous, not covered by HAZMAT classes 1-8)

Hazmat_I

Hazmat_I: string = "Hazmat_I"

Hazardous goods posing an inhalation risk.

NaturalResource

NaturalResource: string = "NaturalResource"

Some form of natural resource (for example, masonry).

None

None: string = "None"

An empty load.

Sand

Sand: string = "Sand"

Sand

SanitaryWaste

SanitaryWaste: string = "SanitaryWaste"

Sanitary waste

NoteType

NoteType: object

The types of notes supported that inform the driver of events, but do not affect navigation.

DrivingBreak

DrivingBreak: string = "DrivingBreak"

Note about a driving break.

FreewayEnds

FreewayEnds: string = "FreewayEnds"

Note about a freeway ending.

NameChange

NameChange: string = "NameChange"

Note about the name of a street changing.

StateChange

StateChange: string = "Statechange"

Note about the name of the state changing, as a state border is crossed.

TollwayBegins

TollwayBegins: string = "TollwayBegins"

Note about a tollway starting.

TollwayEnds

TollwayEnds: string = "TollwayEnds"

Note about a tollway ending.

WayPointApproaching

WayPointApproaching: string = "WayPointApproaching"

Note about the vehicle approaching a way point.

WayPointPassed

WayPointPassed: string = "WayPointPassed"

Note about the vehicle having passed a way point.

RoadCrossingBehavior

RoadCrossingBehavior: object

The supported behavior for crossing over oncoming traffic.

Allowed

Allowed: string = "Allowed"

Crossing over oncoming traffic is fine.

Discouraged

Discouraged: string = "Discouraged"

Crossing over oncoming traffic is avoided where possible and incurs an extra penality cost.

Forbidden

Forbidden: string = "Forbidden"

Crossing over oncoming traffic is strictly forbidden.

RoutingStrategyType

RoutingStrategyType: object

The types of routing strategy supported.

Fastest

Fastest: string = "Fastest"

The fastest route between two route stops.

Pedestrian

Pedestrian: string = "Pedestrian"

The shortest walking route between two route stops.

Shortest

Shortest: string = "Shortest"

The shortest route between two route stops.

TurnDirection

TurnDirection: object

The types of turn directions supported.

-1

-1: string = "Left"

Equivalent to a left turn.

0

0: string = "None"

Equivalent to no turn.

1

1: string = "Right"

Equivalent to a right turn.

Left

Left: string = "Left"

Left turn.

None

None: string = "None"

No turn.

Right

Right: string = "Right"

Right turn.

replacements

replacements: object

-Infinity

-Infinity: string = "{"_r":"-Infinity"}"

Infinity

Infinity: string = "{"_r":"Infinity"}"

NaN

NaN: string = "{"_r":"NaN"}"

Generated using TypeDoc