TomTom Maps SDK for JavaScript
Introduction
Guides
API Reference
This is the documentation of version 1.0.0-rc.3.
Go to the latest version, 1.0.0-rc.5
.
TomTom Maps for JavaScript
Preparing search index...
core
Module core
This module contains basic classes and types used throughout the SDK.
Configuration
TomTomConfig
DisplayUnits
DistanceDisplayUnits
GlobalConfig
RetryConfig
TimeDisplayUnits
DEFAULT_COMMON_BASE_URL
defaultConfig
isProxyCredentialsMode
Errors
SDKErrorCode
sdkErrorCodes
Place
AddressProperties
AddressRanges
ChargingPark
ChargingPoint
ChargingPointCapability
ChargingPointRestriction
ChargingSpeed
ChargingStation
CommonPlaceProps
Connector
ConnectorCount
ConnectorType
CurrentType
EntryPoint
EntryPointType
Fuel
GeographyType
GeometryDataSource
HasConnector
HasCount
Mapcode
MapcodeType
Moment
OpeningHours
OpeningHoursMode
Place
PlaceDataSources
Places
PlaceType
POI
POICategory
PoiDetailsDataSource
RelatedPOI
RevGeoAddressProps
SearchPlaceProps
TimeRange
chargingPointCapabilities
chargingPointRestrictions
connectorTypes
currentTypes
geographyTypes
placeTypes
poiCategories
Reachable Range
BudgetType
ReachableRangeBudget
budgetTypes
budgetUnits
Route
Avoidable
CauseTEC
CountrySectionProps
DistinctSectionProps
DrivingSide
Guidance
ImportantRoadStretchProps
Instruction
InstructionText
Landmark
LaneDirection
LaneSectionProps
LegSectionProps
LegSummary
Maneuver
ManeuverAngle
ManeuverView
PathLike
PossibleLaneDirection
PossibleLaneSeparator
RoadInformation
RoadInformationProperty
RoadShield
RoadShieldReference
RoadShieldSectionProps
RoundaboutType
Route
RoutePathPoint
RoutePlanningLocation
RoutePlanningLocationType
RouteProgress
RouteProgressAtPoint
RouteProgressPoint
RouteProps
Routes
RouteSegmentProgress
RouteSpan
RouteSummary
SectionProps
SectionsProps
SectionType
SideRoad
SideRoadSide
Signpost
SpeedLimitSectionProps
SummaryBase
TollPaymentType
TrafficIncidentTEC
TrafficSectionProps
TravelMode
Waypoint
WaypointLike
WaypointProps
Waypoints
avoidableTypes
inputSectionTypes
inputSectionTypesWithGuidance
sectionTypes
Shared
FeatureCollectionWithProperties
Anything
BBox
GeopoliticalView
GetPositionEntryPointOption
GetPositionOptions
HasBBox
HasLngLat
Language
OptionalBBox
PolygonFeature
PolygonFeatures
TimeZone
geopoliticalViews
languages
Traffic
AreaAnalyticsAnomaly
AreaAnalyticsAverageEntry
AreaAnalyticsCollectionProperties
AreaAnalyticsDailyEntry
AreaAnalyticsFeature
AreaAnalyticsFeatureProperties
AreaAnalyticsHourlyEntry
AreaAnalyticsMetricKey
AreaAnalyticsMetricRange
AreaAnalyticsMetrics
AreaAnalyticsMonthlyEntry
AreaAnalyticsTileEntry
AreaAnalyticsTimedData
AreaAnalyticsTimedEntry
AreaAnalyticsWeeklyEntry
AreaAnalyticsYearlyEntry
DelayMagnitude
TrafficAreaAnalytics
TrafficIncident
TrafficIncidentBaseProperties
TrafficIncidentCategory
TrafficIncidentDetails
TrafficIncidentEvent
TrafficIncidentProbability
TrafficIncidentProperties
TrafficIncidentRequestCategory
TrafficIncidentTimeValidity
areaAnalyticsMetricKeys
fullTrafficIncidentCategories
indexedMagnitudes
trafficIncidentRequestCategories
trafficIncidentTimeValidities
Utils
CompareRoutesOptions
DistanceUnitsType
DistinctSectionsOptions
ImportantRoad
ImportantRoadsOptions
RouteComparison
RouteCoordinateAtProgress
RouteProgressQuery
SectionsWithin
SectionsWithinOfType
SectionsWithinOptions
bboxCenter
bboxFromBBoxes
bboxFromCoordsArray
bboxFromGeoJSON
calculateProgressAtRoutePoint
compareRoutes
findBestWaypointInsertionIndex
findBestWaypointInsertionIndices
formatDistance
formatDuration
getCoordinateAtRouteProgress
getDistinctSections
getImportantRoads
getInstructionLanes
getPosition
getProgressAtNearestRoutePoint
getRouteProgressBetween
getRouteProgressForSection
getSectionBBox
getSectionOverlap
getSectionsWithin
isBBoxWithArea
polygonFromBBox
withInsertedWaypoint
withInsertedWaypoints
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Configuration
Tom
Tom
Config
Display
Units
Distance
Display
Units
Global
Config
Retry
Config
Time
Display
Units
DEFAULT_
COMMON_
BASE_
URL
default
Config
is
Proxy
Credentials
Mode
Errors
SDK
Error
Code
sdk
Error
Codes
Place
Address
Properties
Address
Ranges
Charging
Park
Charging
Point
Charging
Point
Capability
Charging
Point
Restriction
Charging
Speed
Charging
Station
Common
Place
Props
Connector
Connector
Count
Connector
Type
Current
Type
Entry
Point
Entry
Point
Type
Fuel
Geography
Type
Geometry
Data
Source
Has
Connector
Has
Count
Mapcode
Mapcode
Type
Moment
Opening
Hours
Opening
Hours
Mode
Place
Place
Data
Sources
Places
Place
Type
POI
POI
Category
Poi
Details
Data
Source
Related
POI
Rev
Geo
Address
Props
Search
Place
Props
Time
Range
charging
Point
Capabilities
charging
Point
Restrictions
connector
Types
current
Types
geography
Types
place
Types
poi
Categories
Reachable Range
Budget
Type
Reachable
Range
Budget
budget
Types
budget
Units
Route
Avoidable
Cause
TEC
Country
Section
Props
Distinct
Section
Props
Driving
Side
Guidance
Important
Road
Stretch
Props
Instruction
Instruction
Text
Landmark
Lane
Direction
Lane
Section
Props
Leg
Section
Props
Leg
Summary
Maneuver
Maneuver
Angle
Maneuver
View
Path
Like
Possible
Lane
Direction
Possible
Lane
Separator
Road
Information
Road
Information
Property
Road
Shield
Road
Shield
Reference
Road
Shield
Section
Props
Roundabout
Type
Route
Route
Path
Point
Route
Planning
Location
Route
Planning
Location
Type
Route
Progress
Route
Progress
At
Point
Route
Progress
Point
Route
Props
Routes
Route
Segment
Progress
Route
Span
Route
Summary
Section
Props
Sections
Props
Section
Type
Side
Road
Side
Road
Side
Signpost
Speed
Limit
Section
Props
Summary
Base
Toll
Payment
Type
Traffic
Incident
TEC
Traffic
Section
Props
Travel
Mode
Waypoint
Waypoint
Like
Waypoint
Props
Waypoints
avoidable
Types
input
Section
Types
input
Section
Types
With
Guidance
section
Types
Shared
Feature
Collection
With
Properties
Anything
B
Box
Geopolitical
View
Get
Position
Entry
Point
Option
Get
Position
Options
Has
B
Box
Has
Lng
Lat
Language
Optional
B
Box
Polygon
Feature
Polygon
Features
Time
Zone
geopolitical
Views
languages
Traffic
Area
Analytics
Anomaly
Area
Analytics
Average
Entry
Area
Analytics
Collection
Properties
Area
Analytics
Daily
Entry
Area
Analytics
Feature
Area
Analytics
Feature
Properties
Area
Analytics
Hourly
Entry
Area
Analytics
Metric
Key
Area
Analytics
Metric
Range
Area
Analytics
Metrics
Area
Analytics
Monthly
Entry
Area
Analytics
Tile
Entry
Area
Analytics
Timed
Data
Area
Analytics
Timed
Entry
Area
Analytics
Weekly
Entry
Area
Analytics
Yearly
Entry
Delay
Magnitude
Traffic
Area
Analytics
Traffic
Incident
Traffic
Incident
Base
Properties
Traffic
Incident
Category
Traffic
Incident
Details
Traffic
Incident
Event
Traffic
Incident
Probability
Traffic
Incident
Properties
Traffic
Incident
Request
Category
Traffic
Incident
Time
Validity
area
Analytics
Metric
Keys
full
Traffic
Incident
Categories
indexed
Magnitudes
traffic
Incident
Request
Categories
traffic
Incident
Time
Validities
Utils
Compare
Routes
Options
Distance
Units
Type
Distinct
Sections
Options
Important
Road
Important
Roads
Options
Route
Comparison
Route
Coordinate
At
Progress
Route
Progress
Query
Sections
Within
Sections
Within
Of
Type
Sections
Within
Options
bbox
Center
bbox
From
B
Boxes
bbox
From
Coords
Array
bbox
From
Geo
JSON
calculate
Progress
At
Route
Point
compare
Routes
find
Best
Waypoint
Insertion
Index
find
Best
Waypoint
Insertion
Indices
format
Distance
format
Duration
get
Coordinate
At
Route
Progress
get
Distinct
Sections
get
Important
Roads
get
Instruction
Lanes
get
Position
get
Progress
At
Nearest
Route
Point
get
Route
Progress
Between
get
Route
Progress
For
Section
get
Section
B
Box
get
Section
Overlap
get
Sections
Within
is
B
Box
With
Area
polygon
From
B
Box
with
Inserted
Waypoint
with
Inserted
Waypoints
TomTom Maps for JavaScript
Loading...
This module contains basic classes and types used throughout the SDK.