TomTom Maps SDK for JavaScript
Introduction
Guides
API Reference
This is the documentation of version 0.62.1.
Go to the latest version, 1.0.0-rc.5
.
TomTom Maps for JavaScript
Preparing search index...
map
Module map
This module contains functions that enable showing and interacting with the map in web page.
Classes
ModuleEvents
Type Aliases
CustomGeoJSONEvents
TrafficIncidentsModuleFeature
Base Map
BaseMapModule
BaseMapEvents
BaseMapEventScope
BaseMapKnob
BaseMapKnobId
BaseMapKnobValueOf
BaseMapLayerGroupName
BaseMapLayerGroups
BaseMapModuleConfig
BASE_MAP_SOURCE_ID
baseMapKnobCatalogue
baseMapKnobIds
baseMapLayerGroupNames
Custom
CustomGeoJSONModule
CustomGeoJSONImageData
CustomGeoJSONImageSpec
CustomGeoJSONKnob
CustomGeoJSONKnobId
CustomGeoJSONKnobValueOf
CustomGeoJSONLayerSpec
CustomGeoJSONModuleConfig
CustomGeoJSONModuleSerializableConfig
CustomGeoJSONShownFeatures
CustomGeoJSONSourceSpec
customGeoJSONKnobCatalogue
customGeoJSONKnobIds
Events
CombinedEvents
UserEvents
ShownFeaturesType
Geometries
AbstractGeometriesModule
GeometriesModule
ReachableRangesModule
DisplayGeometryProps
ExtraGeometryDisplayProps
FillStyledGeometryConfigOptions
GeometriesEvents
GeometriesKnob
GeometriesKnobId
GeometriesKnobValueOf
GeometriesModuleConfig
GeometriesModuleSerializableConfig
GeometryBeforeLayerConfig
GeometryFillConfig
GeometryFillStyle
GeometryHighlightConfig
GeometryLabelConfig
GeometryLineConfig
GeometryLineLabelConfig
ReachableRangesEvents
ReachableRangesKnob
ReachableRangesKnobId
ReachableRangesKnobValueOf
ReachableRangesModuleConfig
ReachableRangesModuleSerializableConfig
ReachableRangeTitleFn
geometriesKnobCatalogue
geometriesKnobIds
geometryFillStyles
reachableRangesKnobCatalogue
reachableRangesKnobIds
fillStyledGeometryConfig
Map
TomTomMap
MapLibreOptions
TomTomMapParams
Map Style
CustomStyle
CustomStyleSource
LightDark
MapFont
SetStyleOptions
StandardStyle
StandardStyleID
StyleChangeContext
StyleChangeHandler
StyleInput
StylePart
DEFAULT_TEXT_SIZE
MAP_BOLD_FONT
MAP_ITALIC_FONT
MAP_MEDIUM_FONT
MAP_REGULAR_FONT
mapFonts
mapStyleLayerIDs
standardStyleIDs
styleParts
Map Styling
LayerSelection
StylingModule
LayerQuery
MapColorName
MapColors
StylingColorKnobId
StylingEvents
StylingKnob
StylingKnobAppliesTo
StylingKnobId
StylingKnobKind
StylingKnobRange
StylingKnobValue
StylingKnobValueOf
StylingPreset
StylingPresetId
StylingSettings
mapColorNames
stylingColorKnobIds
stylingKnobAppliesTo
stylingKnobCatalogue
stylingKnobIds
stylingKnobKinds
stylingPresetCatalogue
stylingPresetIds
Places
PlacesModule
DefaultPlaceIconConfig
DisplayPlaceProps
EVAvailabilityConfig
ExtraFeatureProp
FeaturePropValue
PlaceClusterBadgeConfig
PlaceConnectionDisplay
PlaceConnectionLayerName
PlaceConnectionsConfig
PlaceConnectionsLayersConfig
PlaceDisplayProps
PlaceEntryPointFeature
PlaceEntryPointProps
PlaceEntryPointsConfig
PlaceEntryPointsLayersConfig
PlaceEntryPointsShowFor
PlaceIconConfig
PlaceLabelConfig
PlaceLayerName
PlaceLayersConfig
PlacesBeforeLayerConfig
PlacesClusterConfig
PlacesEvents
PlacesKnob
PlacesKnobId
PlacesKnobValueOf
PlacesMarkerType
PlacesModuleConfig
PlacesModuleSerializableConfig
PlacesShownFeatures
ShownPlaces
placesKnobCatalogue
placesKnobIds
placesMarkerTypes
buildPlaceTitle
preparePlacesForDisplay
toPlaces
POIs
POIsModule
FilterablePOICategory
MapStylePOICategory
POICategoryGroup
POIsKnob
POIsKnobId
POIsKnobValueOf
POIsModuleConfig
POIsModuleFeature
POI_SOURCE_ID
poiCategoryGroups
poisKnobCatalogue
poisKnobIds
Routing
RoutingModule
BespokeSectionType
ChargingSpeedIconMapping
ChargingStopIconConfig
ChargingStopIconMapping
ChargingStopLabelConfig
ChargingStopsConfig
CountryCrossingAlignment
CountryCrossingConfig
CountryCrossingFeature
DisplayCountryCrossing
DisplayCountryCrossingProps
DisplayCountryCrossings
DisplayRouteProps
DisplayRouteRelatedProps
DisplayRouteSummaries
DisplayRouteSummary
DisplayRouteSummaryProps
DrawnSectionType
GeneratedSectionType
PlanningWaypoint
RouteHighlightConfig
RouteLayersConfig
RouteStateProps
RouteWaypointSize
RouteWidth
RoutingBeforeLayerConfig
RoutingEvents
RoutingKnob
RoutingKnobId
RoutingKnobValueOf
RoutingModuleConfig
RoutingModuleSerializableConfig
RoutingShownFeatures
SectionDisplayConfig
SectionDrawStyle
SectionIconConfig
SectionIconPlacement
SectionKnobName
SectionKnobOf
SectionLineLayerName
SectionLinePattern
SectionsDisplayConfig
SectionSignConfig
SectionSignLayerName
SectionSignPlacement
SectionSignPriority
SectionSignUnit
SectionSourceKey
SectionSymbolLayerName
WaypointDisplayProps
WaypointIndexType
WaypointsConfig
bespokeSectionTypes
defaultRoutingLayers
DESELECTED_ROUTE_FILTER
drawnSectionTypes
FINISH_INDEX
generatedSectionTypes
MIDDLE_INDEX
ROUTE_HIGHLIGHT_OUTLINE_WIDTH_FACTOR_RANGE
ROUTE_WAYPOINT_SIZE_FACTOR_RANGE
ROUTE_WIDTH_FACTOR_RANGE
routingKnobCatalogue
routingKnobIds
SECTION_ICON_SIZE_FACTOR_RANGE
SELECTED_ROUTE_FILTER
START_INDEX
sectionDrawsByDefault
sectionSourceKey
sectionSupportsKnob
Shared
AbstractDataOwnedMapModule
AbstractMapModule
AbstractStyleOwnedMapModule
AvailabilityLevel
BeforeLayerConfig
CustomImage
FilterShowMode
HasAdditionalLayersConfig
KnobEntry
KnobKind
KnobRange
KnobValueOf
LabelConfig
MapModuleCommonConfig
MapStyleLayerID
PartsBeforeLayerConfig
SerializableCustomImage
SourceWithLayerIDs
SVGIconStyleOptions
ToBeAddedLayerSpecTemplate
ValuesFilter
filterShowModes
setKnob
validateKnobValue
Terrain
TerrainModule
TerrainKnob
TerrainKnobId
TerrainKnobValueOf
TerrainModuleConfig
HILLSHADE_SOURCE_ID
TERRAIN_SOURCE_ID
terrainKnobCatalogue
terrainKnobIds
Traffic
TrafficIncidentDetailsModule
IncidentFocusStyle
RoadCategory
RoadSubCategory
ServiceRoadSubCategory
StreetRoadSubCategory
TrafficCommonFilter
TrafficIncidentDetailsKnob
TrafficIncidentDetailsKnobId
TrafficIncidentDetailsKnobValueOf
TrafficIncidentDetailsModuleConfig
INCIDENT_FOCUS_WIDTH_FACTOR_RANGE
roadCategories
serviceRoadSubCategories
streetRoadSubCategories
trafficIncidentDetailsKnobCatalogue
trafficIncidentDetailsKnobIds
Traffic Area Analytics
TrafficAreaAnalyticsModule
AreaAnalyticsBeforeLayerConfig
AreaAnalyticsColorStop
AreaAnalyticsColorStopsConfig
AreaAnalyticsDisplayMode
AreaAnalyticsDisplayProperties
AreaAnalyticsHeightConfig
AreaAnalyticsMetricConfig
AreaAnalyticsMetricFilter
AreaAnalyticsPalette
AreaAnalyticsRegionPolygonConfig
AreaAnalyticsTileFeature
AreaAnalyticsValueType
TrafficAreaAnalyticsKnob
TrafficAreaAnalyticsKnobId
TrafficAreaAnalyticsKnobValueOf
TrafficAreaAnalyticsModuleConfig
AREA_ANALYTICS_DEFAULTS
areaAnalyticsPalettes
trafficAreaAnalyticsKnobCatalogue
trafficAreaAnalyticsKnobIds
Traffic Flow
TrafficFlowModule
TrafficFlowFilter
TrafficFlowFilters
TrafficFlowKnob
TrafficFlowKnobId
TrafficFlowKnobValueOf
TrafficFlowModuleConfig
TrafficFlowModuleFeature
TRAFFIC_FLOW_SOURCE_ID
trafficFlowKnobCatalogue
trafficFlowKnobIds
Traffic Incidents
TrafficIncidentsModule
DelayFilter
IncidentIconsConfig
TrafficIncidentsFilter
TrafficIncidentsFilters
TrafficIncidentsKnob
TrafficIncidentsKnobId
TrafficIncidentsKnobValueOf
TrafficIncidentsModuleConfig
TRAFFIC_INCIDENTS_SOURCE_ID
trafficIncidentsKnobCatalogue
trafficIncidentsKnobIds
User Interaction Events
UserEventsWithStates
ByIdOrIndex
CleanEventStateOptions
CleanEventStatesOptions
ClickEventType
CSSCursor
EventHandlerConfig
EventHandlerCursorConfig
EventHandlerHoverConfig
EventState
EventStateIds
EventType
HoverEventType
MapEventsConfig
PutEventStateOptions
SupportsEvents
UserEventHandler
Utils
CalculateFittingBBoxOptions
CalculateMapBoundsOptions
CalculateMapCenterOptions
calculateFittingBBox
calculatePaddedBBox
calculatePaddedCenter
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Classes
Module
Events
Type Aliases
Custom
Geo
JSON
Events
Traffic
Incidents
Module
Feature
Base Map
Base
Map
Module
Base
Map
Events
Base
Map
Event
Scope
Base
Map
Knob
Base
Map
Knob
Id
Base
Map
Knob
Value
Of
Base
Map
Layer
Group
Name
Base
Map
Layer
Groups
Base
Map
Module
Config
BASE_
MAP_
SOURCE_
ID
base
Map
Knob
Catalogue
base
Map
Knob
Ids
base
Map
Layer
Group
Names
Custom
Custom
Geo
JSON
Module
Custom
Geo
JSON
Image
Data
Custom
Geo
JSON
Image
Spec
Custom
Geo
JSON
Knob
Custom
Geo
JSON
Knob
Id
Custom
Geo
JSON
Knob
Value
Of
Custom
Geo
JSON
Layer
Spec
Custom
Geo
JSON
Module
Config
Custom
Geo
JSON
Module
Serializable
Config
Custom
Geo
JSON
Shown
Features
Custom
Geo
JSON
Source
Spec
custom
Geo
JSON
Knob
Catalogue
custom
Geo
JSON
Knob
Ids
Events
Combined
Events
User
Events
Shown
Features
Type
Geometries
Abstract
Geometries
Module
Geometries
Module
Reachable
Ranges
Module
Display
Geometry
Props
Extra
Geometry
Display
Props
Fill
Styled
Geometry
Config
Options
Geometries
Events
Geometries
Knob
Geometries
Knob
Id
Geometries
Knob
Value
Of
Geometries
Module
Config
Geometries
Module
Serializable
Config
Geometry
Before
Layer
Config
Geometry
Fill
Config
Geometry
Fill
Style
Geometry
Highlight
Config
Geometry
Label
Config
Geometry
Line
Config
Geometry
Line
Label
Config
Reachable
Ranges
Events
Reachable
Ranges
Knob
Reachable
Ranges
Knob
Id
Reachable
Ranges
Knob
Value
Of
Reachable
Ranges
Module
Config
Reachable
Ranges
Module
Serializable
Config
Reachable
Range
Title
Fn
geometries
Knob
Catalogue
geometries
Knob
Ids
geometry
Fill
Styles
reachable
Ranges
Knob
Catalogue
reachable
Ranges
Knob
Ids
fill
Styled
Geometry
Config
Map
Tom
Tom
Map
Map
Libre
Options
Tom
Tom
Map
Params
Map Style
Custom
Style
Custom
Style
Source
Light
Dark
Map
Font
Set
Style
Options
Standard
Style
Standard
Style
ID
Style
Change
Context
Style
Change
Handler
Style
Input
Style
Part
DEFAULT_
TEXT_
SIZE
MAP_
BOLD_
FONT
MAP_
ITALIC_
FONT
MAP_
MEDIUM_
FONT
MAP_
REGULAR_
FONT
map
Fonts
map
Style
Layer
I
Ds
standard
Style
I
Ds
style
Parts
Map Styling
Layer
Selection
Styling
Module
Layer
Query
Map
Color
Name
Map
Colors
Styling
Color
Knob
Id
Styling
Events
Styling
Knob
Styling
Knob
Applies
To
Styling
Knob
Id
Styling
Knob
Kind
Styling
Knob
Range
Styling
Knob
Value
Styling
Knob
Value
Of
Styling
Preset
Styling
Preset
Id
Styling
Settings
map
Color
Names
styling
Color
Knob
Ids
styling
Knob
Applies
To
styling
Knob
Catalogue
styling
Knob
Ids
styling
Knob
Kinds
styling
Preset
Catalogue
styling
Preset
Ids
Places
Places
Module
Default
Place
Icon
Config
Display
Place
Props
EV
Availability
Config
Extra
Feature
Prop
Feature
Prop
Value
Place
Cluster
Badge
Config
Place
Connection
Display
Place
Connection
Layer
Name
Place
Connections
Config
Place
Connections
Layers
Config
Place
Display
Props
Place
Entry
Point
Feature
Place
Entry
Point
Props
Place
Entry
Points
Config
Place
Entry
Points
Layers
Config
Place
Entry
Points
Show
For
Place
Icon
Config
Place
Label
Config
Place
Layer
Name
Place
Layers
Config
Places
Before
Layer
Config
Places
Cluster
Config
Places
Events
Places
Knob
Places
Knob
Id
Places
Knob
Value
Of
Places
Marker
Type
Places
Module
Config
Places
Module
Serializable
Config
Places
Shown
Features
Shown
Places
places
Knob
Catalogue
places
Knob
Ids
places
Marker
Types
build
Place
Title
prepare
Places
For
Display
to
Places
POIs
PO
Is
Module
Filterable
POI
Category
Map
Style
POI
Category
POI
Category
Group
PO
Is
Knob
PO
Is
Knob
Id
PO
Is
Knob
Value
Of
PO
Is
Module
Config
PO
Is
Module
Feature
POI_
SOURCE_
ID
poi
Category
Groups
pois
Knob
Catalogue
pois
Knob
Ids
Routing
Routing
Module
Bespoke
Section
Type
Charging
Speed
Icon
Mapping
Charging
Stop
Icon
Config
Charging
Stop
Icon
Mapping
Charging
Stop
Label
Config
Charging
Stops
Config
Country
Crossing
Alignment
Country
Crossing
Config
Country
Crossing
Feature
Display
Country
Crossing
Display
Country
Crossing
Props
Display
Country
Crossings
Display
Route
Props
Display
Route
Related
Props
Display
Route
Summaries
Display
Route
Summary
Display
Route
Summary
Props
Drawn
Section
Type
Generated
Section
Type
Planning
Waypoint
Route
Highlight
Config
Route
Layers
Config
Route
State
Props
Route
Waypoint
Size
Route
Width
Routing
Before
Layer
Config
Routing
Events
Routing
Knob
Routing
Knob
Id
Routing
Knob
Value
Of
Routing
Module
Config
Routing
Module
Serializable
Config
Routing
Shown
Features
Section
Display
Config
Section
Draw
Style
Section
Icon
Config
Section
Icon
Placement
Section
Knob
Name
Section
Knob
Of
Section
Line
Layer
Name
Section
Line
Pattern
Sections
Display
Config
Section
Sign
Config
Section
Sign
Layer
Name
Section
Sign
Placement
Section
Sign
Priority
Section
Sign
Unit
Section
Source
Key
Section
Symbol
Layer
Name
Waypoint
Display
Props
Waypoint
Index
Type
Waypoints
Config
bespoke
Section
Types
default
Routing
Layers
DESELECTED_
ROUTE_
FILTER
drawn
Section
Types
FINISH_
INDEX
generated
Section
Types
MIDDLE_
INDEX
ROUTE_
HIGHLIGHT_
OUTLINE_
WIDTH_
FACTOR_
RANGE
ROUTE_
WAYPOINT_
SIZE_
FACTOR_
RANGE
ROUTE_
WIDTH_
FACTOR_
RANGE
routing
Knob
Catalogue
routing
Knob
Ids
SECTION_
ICON_
SIZE_
FACTOR_
RANGE
SELECTED_
ROUTE_
FILTER
START_
INDEX
section
Draws
By
Default
section
Source
Key
section
Supports
Knob
Shared
Abstract
Data
Owned
Map
Module
Abstract
Map
Module
Abstract
Style
Owned
Map
Module
Availability
Level
Before
Layer
Config
Custom
Image
Filter
Show
Mode
Has
Additional
Layers
Config
Knob
Entry
Knob
Kind
Knob
Range
Knob
Value
Of
Label
Config
Map
Module
Common
Config
Map
Style
Layer
ID
Parts
Before
Layer
Config
Serializable
Custom
Image
Source
With
Layer
I
Ds
SVG
Icon
Style
Options
To
Be
Added
Layer
Spec
Template
Values
Filter
filter
Show
Modes
set
Knob
validate
Knob
Value
Terrain
Terrain
Module
Terrain
Knob
Terrain
Knob
Id
Terrain
Knob
Value
Of
Terrain
Module
Config
HILLSHADE_
SOURCE_
ID
TERRAIN_
SOURCE_
ID
terrain
Knob
Catalogue
terrain
Knob
Ids
Traffic
Traffic
Incident
Details
Module
Incident
Focus
Style
Road
Category
Road
Sub
Category
Service
Road
Sub
Category
Street
Road
Sub
Category
Traffic
Common
Filter
Traffic
Incident
Details
Knob
Traffic
Incident
Details
Knob
Id
Traffic
Incident
Details
Knob
Value
Of
Traffic
Incident
Details
Module
Config
INCIDENT_
FOCUS_
WIDTH_
FACTOR_
RANGE
road
Categories
service
Road
Sub
Categories
street
Road
Sub
Categories
traffic
Incident
Details
Knob
Catalogue
traffic
Incident
Details
Knob
Ids
Traffic Area Analytics
Traffic
Area
Analytics
Module
Area
Analytics
Before
Layer
Config
Area
Analytics
Color
Stop
Area
Analytics
Color
Stops
Config
Area
Analytics
Display
Mode
Area
Analytics
Display
Properties
Area
Analytics
Height
Config
Area
Analytics
Metric
Config
Area
Analytics
Metric
Filter
Area
Analytics
Palette
Area
Analytics
Region
Polygon
Config
Area
Analytics
Tile
Feature
Area
Analytics
Value
Type
Traffic
Area
Analytics
Knob
Traffic
Area
Analytics
Knob
Id
Traffic
Area
Analytics
Knob
Value
Of
Traffic
Area
Analytics
Module
Config
AREA_
ANALYTICS_
DEFAULTS
area
Analytics
Palettes
traffic
Area
Analytics
Knob
Catalogue
traffic
Area
Analytics
Knob
Ids
Traffic Flow
Traffic
Flow
Module
Traffic
Flow
Filter
Traffic
Flow
Filters
Traffic
Flow
Knob
Traffic
Flow
Knob
Id
Traffic
Flow
Knob
Value
Of
Traffic
Flow
Module
Config
Traffic
Flow
Module
Feature
TRAFFIC_
FLOW_
SOURCE_
ID
traffic
Flow
Knob
Catalogue
traffic
Flow
Knob
Ids
Traffic Incidents
Traffic
Incidents
Module
Delay
Filter
Incident
Icons
Config
Traffic
Incidents
Filter
Traffic
Incidents
Filters
Traffic
Incidents
Knob
Traffic
Incidents
Knob
Id
Traffic
Incidents
Knob
Value
Of
Traffic
Incidents
Module
Config
TRAFFIC_
INCIDENTS_
SOURCE_
ID
traffic
Incidents
Knob
Catalogue
traffic
Incidents
Knob
Ids
User Interaction Events
User
Events
With
States
By
Id
Or
Index
Clean
Event
State
Options
Clean
Event
States
Options
Click
Event
Type
CSS
Cursor
Event
Handler
Config
Event
Handler
Cursor
Config
Event
Handler
Hover
Config
Event
State
Event
State
Ids
Event
Type
Hover
Event
Type
Map
Events
Config
Put
Event
State
Options
Supports
Events
User
Event
Handler
Utils
Calculate
Fitting
B
Box
Options
Calculate
Map
Bounds
Options
Calculate
Map
Center
Options
calculate
Fitting
B
Box
calculate
Padded
B
Box
calculate
Padded
Center
TomTom Maps for JavaScript
Loading...
This module contains functions that enable showing and interacting with the map in web page.