Common

const Common: object

Common enumerations used across TrimbleMaps.

Type declaration

ClassOverride

ClassOverride: object

Enumeration for the Class override.

ClassOverride.ALL

ALL: number = 3

ClassOverride.FIFTY_THREE

FIFTY_THREE: number = 1

ClassOverride.NATIONAL_NETWORK

NATIONAL_NETWORK: number = 2

ClassOverride.NONE

NONE: number = 0

DataRegion

DataRegion: object

Data region option for derived route and report

DataRegion.AF

AF: number = 1

DataRegion.AS

AS: number = 2

DataRegion.EU

EU: number = 3

DataRegion.ME

ME: number = 7

DataRegion.MX

MX: number = 8

DataRegion.NA

NA: number = 4

DataRegion.OC

OC: number = 5

DataRegion.SA

SA: number = 6

DataRegion.UNKNOWN

UNKNOWN: number = 0

DataVersion

DataVersion: object

Enumeration for the data version.

DataVersion.AF

AF: string = 'PCM_AF'

DataVersion.AS

AS: string = 'PCM_AS'

DataVersion.CURRENT

CURRENT: string = 'Current'

DataVersion.EU

EU: string = 'PCM_EU'

DataVersion.IN

IN: string = 'PCM_IN'

DataVersion.JP

JP: string = 'PCM_JP'

DataVersion.ME

ME: string = 'PCM_ME'

DataVersion.NA

NA: string = 'PCM_NA'

DataVersion.OC

OC: string = 'PCM_OC'

DataVersion.SA

SA: string = 'PCM_SA'

DataVersion.SE

SE: string = 'PCM_SE'

DateOption

DateOption: object

Date option

DateOption.CURRENT

CURRENT: number = 0

DateOption.DAY_OF_WEEK

DAY_OF_WEEK: number = 2

DateOption.SPECIFIC

SPECIFIC: number = 1

DayOfWeek

DayOfWeek: object

Day of week option

DayOfWeek.FRIDAY

FRIDAY: number = 5

DayOfWeek.MONDAY

MONDAY: number = 1

DayOfWeek.SATURDAY

SATURDAY: number = 6

DayOfWeek.SUNDAY

SUNDAY: number = 0

DayOfWeek.THURSDAY

THURSDAY: number = 4

DayOfWeek.TUESDAY

TUESDAY: number = 2

DayOfWeek.WEDNESDAY

WEDNESDAY: number = 3

DisplayRestrictionsType

DisplayRestrictionsType: object

Display truck restrictions

DisplayRestrictionsType.ALWAYS_OFF

ALWAYS_OFF: number = 0

DisplayRestrictionsType.ALWAYS_ON

ALWAYS_ON: number = 1

DisplayRestrictionsType.BASED_ON_TRUCK_RESTRICTIONS

BASED_ON_TRUCK_RESTRICTIONS: number = 2

DistanceUnit

DistanceUnit: object

Enumeration for the routing distance units.

DistanceUnit.KILOMETERS

KILOMETERS: number = 1

DistanceUnit.MILES

MILES: number = 0

ETAETDType

ETAETDType: object

Estimated arrival and depart type

ETAETDType.ARRIVAL

ARRIVAL: number = 0

ETAETDType.DEPART

DEPART: number = 1

EmissionType

EmissionType: object

Enumeration for emission type of the engine.

EmissionType.EURO0

EURO0: number = 2

EmissionType.EUROEEV

EUROEEV: number = 9

EmissionType.EUROI

EUROI: number = 3

EmissionType.EUROII

EUROII: number = 4

EmissionType.EUROIII

EUROIII: number = 5

EmissionType.EUROIV

EUROIV: number = 6

EmissionType.EUROV

EUROV: number = 7

EmissionType.EUROVI

EUROVI: number = 8

FuelType

FuelType: object

Fuel type

FuelType.BIODIESEL

BIODIESEL: number = 5

FuelType.COUNT

COUNT: number = 8

FuelType.DIESEL

DIESEL: number = 4

FuelType.DIESEL_D5

DIESEL_D5: number = 6

FuelType.DIESEL_D7

DIESEL_D7: number = 7

FuelType.ETHANOL

ETHANOL: number = 3

FuelType.PETROL

PETROL: number = 0

FuelType.PETROL_E10

PETROL_E10: number = 2

FuelType.PETROL_E5

PETROL_E5: number = 1

FuelUnit

FuelUnit: object

Enumeration for the routing fuel units.

FuelUnit.GALLONS

GALLONS: number = 0

FuelUnit.LITERS

LITERS: number = 1

HazMatType

HazMatType: object

Enumeration for the routing HazMat type.

HazMatType.CAUSTIC

CAUSTIC: number = 2

HazMatType.EXPLOSIVES

EXPLOSIVES: number = 3

HazMatType.FLAMMABLE

FLAMMABLE: number = 4

HazMatType.GENERAL

GENERAL: number = 1

HazMatType.HARMFUL_TO_WATER

HARMFUL_TO_WATER: number = 7

HazMatType.INHALANTS

INHALANTS: number = 5

HazMatType.NONE

NONE: number = 0

HazMatType.RADIOACTIVE

RADIOACTIVE: number = 6

HazMatType.TUNNEL

TUNNEL: number = 8

HoSScheduleType

HoSScheduleType: object

Represents which Hours Of Service rule to use

HoSScheduleType.CALIFORNIA_808

CALIFORNIA_808: number = 4

HoSScheduleType.CANADA_CYCLE_1

CANADA_CYCLE_1: number = 2

HoSScheduleType.CANADA_CYCLE_2

CANADA_CYCLE_2: number = 3

HoSScheduleType.EUROPE

EUROPE: number = 7

HoSScheduleType.TEXAS_707

TEXAS_707: number = 5

HoSScheduleType.UNKNOWN

UNKNOWN: number = 8

HoSScheduleType.US_FED_607_LH

US_FED_607_LH: number = 0

HoSScheduleType.US_FED_708_LH

US_FED_708_LH: number = 1

HoSScheduleType.US_SHORT_HAUL

US_SHORT_HAUL: number = 6

Language

Language: object

Language.AR

AR: string = 'ar'

Language.BE

BE: string = 'be'

Language.BG

BG: string = 'bg'

Language.BN

BN: string = 'bn'

Language.BS

BS: string = 'bs'

Language.CA

CA: string = 'ca'

Language.CS

CS: string = 'cs'

Language.CY

CY: string = 'cy'

Language.DA

DA: string = 'da'

Language.DE

DE: string = 'de'

Language.EL

EL: string = 'el'

Language.EN

EN: string = 'en'

Language.EN_AU

EN_AU: string = 'en-AU'

Language.EN_GB

EN_GB: string = 'en-GB'

Language.ES

ES: string = 'es'

Language.ES_LA

ES_LA: string = 'es-LA'

Language.ET

ET: string = 'et'

Language.EU

EU: string = 'eu'

Language.FI

FI: string = 'fi'

Language.FR

FR: string = 'fr'

Language.GL

GL: string = 'gl'

Language.HE

HE: string = 'he'

Language.HI

HI: string = 'hi'

Language.HR

HR: string = 'hr'

Language.HU

HU: string = 'hu'

Language.ID

ID: string = 'id'

Language.IS

IS: string = 'is'

Language.IT

IT: string = 'it'

Language.JA

JA: string = 'ja'

Language.KO

KO: string = 'ko'

Language.LT

LT: string = 'lt'

Language.LV

LV: string = 'lv'

Language.MK

MK: string = 'mk'

Language.MS

MS: string = 'ms'

Language.MT

MT: string = 'mt'

Language.NL

NL: string = 'nl'

Language.NL_BE

NL_BE: string = 'nl-BE'

Language.NO

NO: string = 'no'

Language.PL

PL: string = 'pl'

Language.PT

PT: string = 'pt'

Language.PT_BR

PT_BR: string = 'pt-BR'

Language.RO

RO: string = 'ro'

Language.RU

RU: string = 'ru'

Language.SK

SK: string = 'sk'

Language.SL

SL: string = 'sl'

Language.SQ

SQ: string = 'sq'

Language.SR

SR: string = 'sr'

Language.SV

SV: string = 'sv'

Language.TH

TH: string = 'th'

Language.TR

TR: string = 'tr'

Language.UK

UK: string = 'uk'

Language.VI

VI: string = 'vi'

Language.ZH

ZH: string = 'zh'

Language.ZH_HANS

ZH_HANS: string = 'zh-Hans'

Language.ZH_HK

ZH_HK: string = 'zh-HK'

RailDistanceUnit

RailDistanceUnit: object

Specifies the unit system when displaying distance results.

RailDistanceUnit.KILOMETERS

KILOMETERS: string = 'Kilometers'

RailDistanceUnit.MILES

MILES: string = 'Miles'

RailRoutePreference

RailRoutePreference: object

Route calculation heuristic.

RailRoutePreference.AUTO_RACKS

AUTO_RACKS: string = 'AutoRacks'

RailRoutePreference.COAL_BULK

COAL_BULK: string = 'CoalBulk'

RailRoutePreference.FUEL_SURCHARGE

FUEL_SURCHARGE: string = 'FuelSurcharge'

RailRoutePreference.INTERMODAL

INTERMODAL: string = 'Intermodal'

RailRoutePreference.PRACTICAL

PRACTICAL: string = 'Practical'

RailRoutePreference.SHORTEST

SHORTEST: string = 'Shortest'

RailStationFormat

RailStationFormat: object

Format for rail freight stations.

RailStationFormat.ERPC

ERPC: string = 'ERPC'

RailStationFormat.FSAC

FSAC: string = 'FSAC'

RailStationFormat.R260

R260: string = 'R260'

RailStationFormat.SPLC

SPLC: string = 'SPLC'

RailStationFormat.STATION_STATE

STATION_STATE: string = 'StationState'

Region

Region: object

Enumeration for map regions values.

Example

map.setRegion(TrimbleMaps.Common.Region.NA);

Region.AF

AF: string = 'af'

Region.AS

AS: string = 'as'

Region.EU

EU: string = 'eu'

Region.ME

ME: string = 'me'

Region.NA

NA: string = 'na'

Region.OC

OC: string = 'oc'

Region.SA

SA: string = 'sa'

Region.WW

WW: string = 'ww'

ReportType

ReportType: object

Enumeration for the report type.

ReportType.DETAIL

DETAIL: string = 'Detail'

ReportType.DIRECTIONS

DIRECTIONS: string = 'Directions'

ReportType.MILEAGE

MILEAGE: string = 'Mileage'

ReportType.ROAD

ROAD: string = 'Road'

ReportType.STATE

STATE: string = 'State'

ReportType.TOLL

TOLL: string = 'TollDetail'

RequestMethod

RequestMethod: object

HTTP request method.

RequestMethod.GET

GET: string = 'GET'

RequestMethod.POST

POST: string = 'POST'

RoadType

RoadType: object

Represents the type of roads for road speeds.

RoadType.DIVIDED_RURAL

DIVIDED_RURAL: number = 3

RoadType.DIVIDED_URBAN

DIVIDED_URBAN: number = 12

RoadType.FERRIES_RURAL

FERRIES_RURAL: number = 5

RoadType.FERRIES_URBAN

FERRIES_URBAN: number = 14

RoadType.INTER_STATE_RURAL

INTER_STATE_RURAL: number = 1

RoadType.INTER_STATE_URBAN

INTER_STATE_URBAN: number = 10

RoadType.LOCAL_RURAL

LOCAL_RURAL: number = 8

RoadType.LOCAL_URBAN

LOCAL_URBAN: number = 17

RoadType.PRIMARY_RURAL

PRIMARY_RURAL: number = 4

RoadType.PRIMARY_URBAN

PRIMARY_URBAN: number = 13

RoadType.RAMP_RURAL

RAMP_RURAL: number = 7

RoadType.RAMP_URBAN

RAMP_URBAN: number = 16

RoadType.SECONDARY_RURAL

SECONDARY_RURAL: number = 6

RoadType.SECONDARY_URBAN

SECONDARY_URBAN: number = 15

RouteOptimization

RouteOptimization: object

Enumeration for the routing optimization.

RouteOptimization.NONE

NONE: number = 0

RouteOptimization.OPTIMIZE_ALL_STOPS

OPTIMIZE_ALL_STOPS: number = 1

RouteOptimization.OPTIMIZE_INTERMEDIATE_STOPS

OPTIMIZE_INTERMEDIATE_STOPS: number = 2

RouteType

RouteType: object

Enumeration for the route type.

RouteType.FASTEST

FASTEST: number = 2

RouteType.PRACTICAL

PRACTICAL: number = 0

RouteType.SHORTEST

SHORTEST: number = 1

SatelliteProvider

SatelliteProvider: object

Enumeration for the Satellite Provider.

SatelliteProvider.ALKCURATED

ALKCURATED: string = 'alkcurated'

SatelliteProvider.DEFAULT

DEFAULT: string = 'default'

SatelliteProvider.SAT1

SAT1: string = 'sat1'

SatelliteProvider.SAT2

SAT2: string = 'sat2'

SatelliteProvider.SAT3

SAT3: string = 'sat3'

SatelliteProvider.SAT4

SAT4: string = 'sat4'

SatelliteProvider.SAT5

SAT5: string = 'sat5'

SatelliteProvider.SAT6

SAT6: string = 'sat6'

SideOfStreetAdherenceLevel

SideOfStreetAdherenceLevel: object

Side of street adherence level

SideOfStreetAdherenceLevel.ADHERE

ADHERE: number = 5

SideOfStreetAdherenceLevel.AVERAGE

AVERAGE: number = 3

SideOfStreetAdherenceLevel.MINIMAL

MINIMAL: number = 1

SideOfStreetAdherenceLevel.MODERATE

MODERATE: number = 2

SideOfStreetAdherenceLevel.OFF

OFF: number = 0

SideOfStreetAdherenceLevel.STRICT

STRICT: number = 4

SideOfStreetAdherenceLevel.STRONGLY_ADHERE

STRONGLY_ADHERE: number = 6

SnapKey

SnapKey: object

The modifier key used by drag routing when snapping to visible roads.

SnapKey.ALT

ALT: string = 'altKey'

SnapKey.CONTROL

CONTROL: string = 'ctrlKey'

SnapKey.SHIFT

SHIFT: string = 'shiftKey'

SnapMode

SnapMode: object

Used to indicate when drag routing will snap to visible roads.

SnapMode.DISABLE_WITH_KEY

DISABLE_WITH_KEY: number = 2

SnapMode.ENABLE_WITH_KEY

ENABLE_WITH_KEY: number = 1

SnapMode.OFF

OFF: number = 0

Style

Style: object

Enumeration for map style values.

Param

Param

Param

Param

Param

Param

Param

Param

Param

Param

Param

Param

Param

Param

Param

Example

var map = new TrimbleMaps.Map({
  container: 'map',
  center: [-122.420679, 37.772537],
  zoom: 13,
  style: TrimbleMaps.Common.Style.TRANSPORTATION
});

Style.ACCESSIBLE_DARK

ACCESSIBLE_DARK: string = 'dark_accessible'

Style.ACCESSIBLE_LIGHT

ACCESSIBLE_LIGHT: string = 'light_accessible'

Style.BASIC

BASIC: string = 'basic'

Style.BASIC_DARK

BASIC_DARK: string = 'basic_dark'

Style.DATADARK

DATADARK: string = 'datadark'

Style.DATALIGHT

DATALIGHT: string = 'datalight'

Style.DEFAULT

DEFAULT: string = 'default'

Style.MOBILE_DAY

MOBILE_DAY: string = 'mobileday'

Style.MOBILE_NIGHT

MOBILE_NIGHT: string = 'mobilenight'

Style.MOBILE_SATELLITE

MOBILE_SATELLITE: string = 'mobilesatellite'

Style.SATELLITE

SATELLITE: string = 'satellite'

Style.SIMPLE_DARK

SIMPLE_DARK: string = 'simple_dark'

Style.SIMPLE_LIGHT

SIMPLE_LIGHT: string = 'simple_light'

Style.TERRAIN

TERRAIN: string = 'terrain'

Style.TRANSPORTATION

TRANSPORTATION: string = 'transportation'

Style.TRANSPORTATION_DARK

TRANSPORTATION_DARK: string = 'transportation_dark'

TimeZone

TimeZone: object

Time zone option

TimeZone.ALASKA

ALASKA: number = 3

TimeZone.ARIZONA

ARIZONA: number = 5

TimeZone.ATLANTIC

ATLANTIC: number = 9

TimeZone.CENTRAL

CENTRAL: number = 7

TimeZone.EASTERN

EASTERN: number = 8

TimeZone.GMT

GMT: number = 11

TimeZone.HAWAII

HAWAII: number = 2

TimeZone.LOCAL

LOCAL: number = 0

TimeZone.MOUNTAIN

MOUNTAIN: number = 6

TimeZone.NEWFOUNDLAND

NEWFOUNDLAND: number = 10

TimeZone.PACIFIC

PACIFIC: number = 4

TimeZone.SYSTEM

SYSTEM: number = 1

TimeZone.UTC

UTC: number = 12

TollCurrency

TollCurrency: object

Enumeration for the routing currency units.

TollCurrency.ALL

ALL: number = 2

TollCurrency.AMD

AMD: number = 3

TollCurrency.AZN

AZN: number = 4

TollCurrency.BAM

BAM: number = 5

TollCurrency.BGN

BGN: number = 6

TollCurrency.BYR

BYR: number = 7

TollCurrency.CAD

CAD: number = 1

TollCurrency.CHF

CHF: number = 8

TollCurrency.CZK

CZK: number = 9

TollCurrency.DKK

DKK: number = 10

TollCurrency.EUR

EUR: number = 11

TollCurrency.GBP

GBP: number = 12

TollCurrency.GEL

GEL: number = 13

TollCurrency.HRK

HRK: number = 14

TollCurrency.HUF

HUF: number = 15

TollCurrency.ISK

ISK: number = 16

TollCurrency.MDL

MDL: number = 17

TollCurrency.MKD

MKD: number = 18

TollCurrency.NOK

NOK: number = 19

TollCurrency.PLN

PLN: number = 20

TollCurrency.RON

RON: number = 21

TollCurrency.RSD

RSD: number = 22

TollCurrency.RUB

RUB: number = 23

TollCurrency.SEK

SEK: number = 24

TollCurrency.TRY

TRY: number = 25

TollCurrency.UAH

UAH: number = 26

TollCurrency.USD

USD: number = 0

TollRoadsType

TollRoadsType: object

Toll roads type

TollRoadsType.ALWAYS_AVOID

ALWAYS_AVOID: number = 1

TollRoadsType.AVOID_IF_POSSIBLE

AVOID_IF_POSSIBLE: number = 2

TollRoadsType.USE

USE: number = 3

TrailerType

TrailerType: object

Enumeration for trailer type.

TrailerType.CARAVAN

CARAVAN: number = 2

TrailerType.NONE

NONE: number = 1

TrailerType.TRAILER

TRAILER: number = 3

TruckConfig

TruckConfig: object

Represents vehicle dimensions of a truck trailer to use for.

TruckConfig.CONVENTIONAL_SCHOOL_BUS

CONVENTIONAL_SCHOOL_BUS: number = 7

TruckConfig.FIFTY_THREE

FIFTY_THREE: number = 4

TruckConfig.FORTY

FORTY: number = 2

TruckConfig.FORTY_EIGHT

FORTY_EIGHT: number = 3

TruckConfig.FULL_SIZE_VAN

FULL_SIZE_VAN: number = 5

TruckConfig.NONE

NONE: number = 0

TruckConfig.SMALL_SCHOOL_BUS

SMALL_SCHOOL_BUS: number = 8

TruckConfig.TWENTY_EIGHT

TWENTY_EIGHT: number = 1

TruckConfig.TWENTY_SIX_STRAIGHT_TRUCK

TWENTY_SIX_STRAIGHT_TRUCK: number = 6

TruckUnit

TruckUnit: object

Enumeration for the routing truck units.

TruckUnit.ENGLISH

ENGLISH: number = 0

TruckUnit.METRIC

METRIC: number = 1

TunnelCategory

TunnelCategory: object

Represents the EU Tunnel categories. Applicable for EU region only.

TunnelCategory.BCDE

BCDE: number = 1

TunnelCategory.CDE

CDE: number = 2

TunnelCategory.DE

DE: number = 3

TunnelCategory.E

E: number = 4

TunnelCategory.NONE

NONE: number = 0

Unit

Unit: object

Enumeration for the map units.

Unit.ENGLISH

ENGLISH: number = 0

Unit.METRIC

METRIC: number = 1

VehicleType

VehicleType: object

Enumeration for the routing vehicle type.

VehicleType.AUTOMOBILE

AUTOMOBILE: number = 2

VehicleType.BUS

BUS: number = 4

VehicleType.LIGHT_TRUCK

LIGHT_TRUCK: number = 1

VehicleType.MID_SIZE_TRUCK

MID_SIZE_TRUCK: number = 3

VehicleType.RV

RV: number = 5

VehicleType.TRUCK

TRUCK: number = 0

ViaPointModifierKey

ViaPointModifierKey: object

The modifier key used by removing via point flag introduced by drag routing.

ViaPointModifierKey.ALT

ALT: string = 'altKey'

ViaPointModifierKey.CONTROL

CONTROL: string = 'ctrlKey'

ViaPointModifierKey.SHIFT

SHIFT: string = 'shiftKey'

ZoneType

ZoneType: object

Represents the Euro Zone values

ZoneType.ALLOW

ALLOW: number = 0

ZoneType.AVOID

AVOID: number = 2

ZoneType.WARN

WARN: number = 1