TomTom Maps SDK for JavaScript
Introduction
Guides
API Reference
This is the documentation of version 1.0.0-rc.6.
Go to the latest version, 1.0.0
.
TomTom Maps for JavaScript
Preparing search index...
plugins
Module plugins
Type Aliases
AreaSource
AreaWhere
ResolveAreasOptions
ResolvedArea
ResolvedAreaDisclosure
ResolvedBias
ResolveError
ResolveKind
WhereContext
Variables
CHART_TYPES
isChartConfiguration
isResolveError
resolveGlobal
resolveNearby
resolveWithin
toolStateToWhereContext
Functions
resolveWhere
Agent Toolkit
EntryModeSlice
StateSlice
AnalysisRecord
ByodSourceUrlValidation
ByodSourceUrlValidator
ClarifyIntentQuestion
ClarifyIntentToolOptions
ClassificationResult
Classifier
ClassifierContext
ClassifierOptions
ClusteringOutput
ClusteringParams
ClusterResult
ClusterTrend
CodeExecutionConfig
CodeExecutionMode
DataEntryConfig
DataEntryKind
EntryDataKind
EntryMode
EntryModeSliceName
FeatureFlags
GeometriesId
GeometriesIdKind
GetCurrentLocationToolOptions
IncidentSnapshot
MapAgentInstance
MapAgentOptions
MemberRef
MonitoredArea
OnToolExecute
PollingStatus
QueryAs
SandboxExecutor
StateDigest
SystemPromptSection
SystemPromptSectionOverrides
ToolBuildOptions
ToolDefinition
ToolEntry
ToolEntryBuilder
ToolExecuteOptions
ToolExecutionInfo
ToolMetadata
ToolName
ToolNameHint
ToolState
Tracker
TrackerEvent
TrackerEventStatus
TrackerEventType
TrackerStateEvents
Verdict
BASE_SYSTEM_PROMPT
CLARIFY_FORM_PROMPT
CLARIFY_PROSE_PROMPT
clarifyIntentOutputSchema
clarifyIntentSchema
classifyUserIntent
composeSystemPrompt
createClarifyIntentTool
createDefaultClassifier
createExecuteMaplibreCodeTool
createGetCurrentLocationTool
createMapAgent
DATA_ENTRY_KIND_TO_SLICE
DEFAULT_TOOLS
ENTRY_MODE_SLICE_NAMES
extractLastUserText
formatStateDigestDiff
geometriesIdSchema
getDefaultToolPrompts
getStateDigest
getViewportBias
locatePlace
MIN_VIEWPORT_BIAS_ZOOM
questionSchema
resolveTools
SYSTEM_PROMPT_SECTIONS
TOOL_NAMES
TOOLS_BY_DATA_ENTRY_KIND
Buildings 3D
Buildings3D
BuildingsLayer
BuildingHit
Buildings3DConfig
Buildings3DKnob
Buildings3DKnobId
Buildings3DKnobValueOf
BuildingsPreset
FacadePattern
PaletteMode
buildings3DKnobCatalogue
buildings3DKnobIds
buildingsPresets
facadePatterns
paletteMapColors
paletteModes
Flyover
RouteFlyover
FlyoverAim
FlyoverAnchor
FlyoverCamera
FlyoverMarkerConfig
FlyoverMarkerImage
FlyoverProgress
FlyoverZoom
RouteFlyoverOptions
anchorForPitch
GL Surfaces
GLSurfaces
GLSurfacesConfig
GLSurfacesKnob
GLSurfacesKnobId
GLSurfacesKnobValueOf
SurfaceKind
SurfaceSeason
glSurfacesKnobCatalogue
glSurfacesKnobIds
surfaceKinds
surfaceSeasons
Landmarks 3D
Landmarks3D
ModelsLayer
ModelsSource
ModelsLayerSpecification
ModelsSourceSpecification
Landmarks3DConfig
Landmarks3DKnob
Landmarks3DKnobId
Landmarks3DKnobValueOf
Landmarks3DOptions
LandmarkTextureUse
buildLandmarksTileURL
landmarks3DKnobCatalogue
landmarks3DKnobIds
landmarkTextureUses
Map Effects
MapEffects
BloomScope
BloomScopeEntry
CaptureOptions
EffectKnob
EffectKnobId
EffectKnobRange
EffectKnobValueOf
MapEffectsConfig
MapEffectsLayer
MapEffectsLayerPlacement
MapEffectsPass
MapEffectsPassPlacement
MapEffectsPassUniforms
StyleColorKnobGroup
effectKnobCatalogue
effectKnobIds
Map Theme
ImagePixels
MapThemeExtractionOptions
MapThemeImageSource
MapThemeMode
MapThemeOptions
cssColors
deriveMapColors
deriveMapColorsFromCss
deriveMapColorsFromImage
dominantColors
mapColorsLightDark
mapThemeModes
Route dragging
RouteDragging
RouteDraggingOptions
RouteDraggingPlanner
WaypointDrag
WaypointDragKind
Viewport Places
ViewportPlaces
ViewportPlacesAddCommonOptions
ViewportPlacesAddOptions
ViewportPlacesConstructorOptions
ViewportPlacesOptions
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Type Aliases
Area
Source
Area
Where
Resolve
Areas
Options
Resolved
Area
Resolved
Area
Disclosure
Resolved
Bias
Resolve
Error
Resolve
Kind
Where
Context
Variables
CHART_
TYPES
is
Chart
Configuration
is
Resolve
Error
resolve
Global
resolve
Nearby
resolve
Within
tool
State
To
Where
Context
Functions
resolve
Where
Agent Toolkit
Entry
Mode
Slice
State
Slice
Analysis
Record
Byod
Source
Url
Validation
Byod
Source
Url
Validator
Clarify
Intent
Question
Clarify
Intent
Tool
Options
Classification
Result
Classifier
Classifier
Context
Classifier
Options
Clustering
Output
Clustering
Params
Cluster
Result
Cluster
Trend
Code
Execution
Config
Code
Execution
Mode
Data
Entry
Config
Data
Entry
Kind
Entry
Data
Kind
Entry
Mode
Entry
Mode
Slice
Name
Feature
Flags
Geometries
Id
Geometries
Id
Kind
Get
Current
Location
Tool
Options
Incident
Snapshot
Map
Agent
Instance
Map
Agent
Options
Member
Ref
Monitored
Area
On
Tool
Execute
Polling
Status
Query
As
Sandbox
Executor
State
Digest
System
Prompt
Section
System
Prompt
Section
Overrides
Tool
Build
Options
Tool
Definition
Tool
Entry
Tool
Entry
Builder
Tool
Execute
Options
Tool
Execution
Info
Tool
Metadata
Tool
Name
Tool
Name
Hint
Tool
State
Tracker
Tracker
Event
Tracker
Event
Status
Tracker
Event
Type
Tracker
State
Events
Verdict
BASE_
SYSTEM_
PROMPT
CLARIFY_
FORM_
PROMPT
CLARIFY_
PROSE_
PROMPT
clarify
Intent
Output
Schema
clarify
Intent
Schema
classify
User
Intent
compose
System
Prompt
create
Clarify
Intent
Tool
create
Default
Classifier
create
Execute
Maplibre
Code
Tool
create
Get
Current
Location
Tool
create
Map
Agent
DATA_
ENTRY_
KIND_
TO_
SLICE
DEFAULT_
TOOLS
ENTRY_
MODE_
SLICE_
NAMES
extract
Last
User
Text
format
State
Digest
Diff
geometries
Id
Schema
get
Default
Tool
Prompts
get
State
Digest
get
Viewport
Bias
locate
Place
MIN_
VIEWPORT_
BIAS_
ZOOM
question
Schema
resolve
Tools
SYSTEM_
PROMPT_
SECTIONS
TOOL_
NAMES
TOOLS_
BY_
DATA_
ENTRY_
KIND
Buildings 3D
Buildings3
D
Buildings
Layer
Building
Hit
Buildings3
D
Config
Buildings3
D
Knob
Buildings3
D
Knob
Id
Buildings3
D
Knob
Value
Of
Buildings
Preset
Facade
Pattern
Palette
Mode
buildings3
D
Knob
Catalogue
buildings3
D
Knob
Ids
buildings
Presets
facade
Patterns
palette
Map
Colors
palette
Modes
Flyover
Route
Flyover
Flyover
Aim
Flyover
Anchor
Flyover
Camera
Flyover
Marker
Config
Flyover
Marker
Image
Flyover
Progress
Flyover
Zoom
Route
Flyover
Options
anchor
For
Pitch
GL Surfaces
GL
Surfaces
GL
Surfaces
Config
GL
Surfaces
Knob
GL
Surfaces
Knob
Id
GL
Surfaces
Knob
Value
Of
Surface
Kind
Surface
Season
gl
Surfaces
Knob
Catalogue
gl
Surfaces
Knob
Ids
surface
Kinds
surface
Seasons
Landmarks 3D
Landmarks3
D
Models
Layer
Models
Source
Models
Layer
Specification
Models
Source
Specification
Landmarks3
D
Config
Landmarks3
D
Knob
Landmarks3
D
Knob
Id
Landmarks3
D
Knob
Value
Of
Landmarks3
D
Options
Landmark
Texture
Use
build
Landmarks
Tile
URL
landmarks3
D
Knob
Catalogue
landmarks3
D
Knob
Ids
landmark
Texture
Uses
Map Effects
Map
Effects
Bloom
Scope
Bloom
Scope
Entry
Capture
Options
Effect
Knob
Effect
Knob
Id
Effect
Knob
Range
Effect
Knob
Value
Of
Map
Effects
Config
Map
Effects
Layer
Map
Effects
Layer
Placement
Map
Effects
Pass
Map
Effects
Pass
Placement
Map
Effects
Pass
Uniforms
Style
Color
Knob
Group
effect
Knob
Catalogue
effect
Knob
Ids
Map Theme
Image
Pixels
Map
Theme
Extraction
Options
Map
Theme
Image
Source
Map
Theme
Mode
Map
Theme
Options
css
Colors
derive
Map
Colors
derive
Map
Colors
From
Css
derive
Map
Colors
From
Image
dominant
Colors
map
Colors
Light
Dark
map
Theme
Modes
Route dragging
Route
Dragging
Route
Dragging
Options
Route
Dragging
Planner
Waypoint
Drag
Waypoint
Drag
Kind
Viewport Places
Viewport
Places
Viewport
Places
Add
Common
Options
Viewport
Places
Add
Options
Viewport
Places
Constructor
Options
Viewport
Places
Options
TomTom Maps for JavaScript
Loading...