Skip to main content
Documentation
WEB SDK & APIs
INTERACTIVE MAPS
JavaScript Maps SDK
SOAP APIs
(Web Services)
Appian Integration
RESTful APIs
(Web Services)
Location
Places
Routing
Multi-Vehicle Routing
Mapping
Trip Management
Account Manager
Fleet Configuration
Freight Rail
MOBILE SDK & APIs
COPILOT NAVIGATION
Integration Options
Standalone App
CPIK Libraries
SDK App
CoPilot Native Nav SDK
NEW
INTERACTIVE MAPS
Mobile Maps SDK
Features Guide
Support
Get an API Key
JavaScript Maps SDK
Developer Guide
API
Examples
Style Specification
Release Notes
Legal
Developer Guide
Overview
Getting Started
Maps Toolbox
Overview
Custom Tilesets
Map Styles
Map Settings
Map Layers
Traffic
Weather Radar
Weather Alerts
Road Surface
Places
Points of Interest (POI)
3D Buildings
Custom Layers
Satellite
Traffic Incident
Traffic Camera
Truck Restrictions
Geocoding
Routing
Add-ons
Custom Places
Draw Tool
Energy Layers
Export Map
Map Menus
Route Modifiers
Single Search
Map Icons
v2 upgrade guide
v4 upgrade guide
Maps SDK v4
Maps SDK v3
Maps SDK v2
Examples
3D Terrain
Add 3D Model BabylonJS
Add 3D Model With Terrain
3D Model
Animate Point on Route
Basic Map
Basic Map (Europe)
Cluster Points
Content Layers
Context Menu
Custom HTML Marker
Custom Layers
Custom Places
Customize Popup
Dark Mode UI
Data Driven Styles
Data Visualization Icons
Draggable Marker Popup
Draggable Marker
Draw Tool Add-on
Energy Layers
Export Map Addon
Feature Intersections
Features Under Mouse Pointer
Filter Symbols by Text
Game Controls
GeoJSON Point
GeoJSON Polygon
Heat Map
Hide and Show Markers
Highlight Selected Features
Interactive Routes
Layer Stacking
Live Feature Update
Map Controls
MapMenu Add-on
Map Styles Marker
Map Styles Symbol
Map Styles
Marker and Popup
Marker Styles
Markers and Routes
Mouse Position
Rich Text
Road Surface
Route Stops Customization
Route Event Handling
Route Event Stop Inserting
Route Line Only
Route Modifiers
Route Options
Route Styling
Routing
Scroll Fly To
Single Search Add-on
Style Modifications
Toll Detail Report
Truck Restrictions
Truck Stops Layer Filter
Using Maps SDK with Azure
Weather Alerts
Weather
Style Specification
Introduction
Root
Light
Projection
Sources
Sprite
Glyphs
Transition
Layers
Types
Expressions
Legal
Maps SDK v3 License
API
Classes
`abstract` StyleLayer
`abstract` TwoFingersTouchHandler
Actor
AJAXError
AlphaImage
AttributionControl
BoxZoomHandler
CanonicalTileID
CanvasSource
CircleStyleLayer
ClickZoomHandler
ContentBase
CooperativeGesturesHandler
CustomRoad
DEMData
Dispatcher
DoubleClickZoomHandler
DragPanHandler
DragRotateHandler
EdgeInsets
Event
Evented
FeatureIndex
FullscreenControl
GeoJSONFeature
GeoJSONSource
GeolocateControl
Hash
HeatmapStyleLayer
ImageAtlas
ImageManager
ImageSource
KeyboardHandler
Layout (Props)
LngLat
LngLatBounds
LogoControl
Map
MapMouseEvent
MapTouchEvent
MapWheelEvent
Marker
MercatorCoordinate
NavigationControl
OverscaledTileID
PlaceClickControl
PointsOfInterest
Popup
RasterDEMTileSource
RasterTileSource
RGBAImage
RoadSurface
RoadSurfaceLegendControl
Route
ScaleControl
ScrollZoomHandler
Style
TapDragZoomHandler
TapZoomHandler
TerrainControl
ThrottledInvoker
Tile
TouchPanHandler
Traffic
TrafficCamera
TrafficCameraClickControl
TrafficIncident
TrafficIncidentClickControl
TrafficIncidentFilterControl
TruckRestriction
TruckRestrictionClickControl
TruckRestrictionFilterControl
TwoFingersTouchPitchHandler
TwoFingersTouchRotateHandler
TwoFingersTouchZoomHandler
TwoFingersTouchZoomRotateHandler
UndoRedoStack
VectorTileSource
VideoSource
WeatherAlert
WeatherAlertClickControl
WeatherAlertFilterControl
WeatherCloud
WeatherRadar
WorkerPool
Enumerations
MessageType
ResourceType
TextFit
Functions
~~interpolateFactory()~~
addProtocol()
addSourceType()
clearPrewarmedResources()
getAPIKey()
getAPIToken()
getMaxParallelImageRequests()
getRTLTextPluginStatus()
getTIDToken()
getUnit()
getVersion()
getWorkerCount()
getWorkerUrl()
importScriptInWorkers()
prewarm()
removeProtocol()
setAPIKey()
setAPIToken()
setMaxParallelImageRequests()
setRTLTextPlugin()
setServiceUrls()
setTIDToken()
setUnit()
setWorkerCount()
setWorkerUrl()
Interfaces
ActorTarget
AttributeBinder
Bucket
CustomLayerInterface
Expression
Handler
IActor
IControl
MousePanHandler
MousePitchHandler
MouseRotateHandler
Source
StyleImageInterface
Type Aliases
ActorMessage<T>
AddLayerObject
AddProtocolAction()
Alignment
AnimationOptions
AroundCenterOptions
ArrowOptions
AttributionControlOptions
Callback()<T>
CameraForBoundsOptions
CameraOptions
CameraUpdateTransformFunction()
Cancelable
CanvasSourceSpecification
CenterZoomBearing
ClusterIDAndSource
Complete <T>
Config
ContentFilter
ContentRemove
ContentVisibility
ControlPosition
Coordinates
CrossFaded<T>
customplaces
CustomRenderMethod()
customRoad
customRoadLoading
DashEntry
DEMEncoding
DiffOperationsMap
DistributiveKeys<T>
DistributiveOmit<T, K>
DragPanOptions
DragRotateHandlerOptions
DragRouteOptions
EventData
ExpiryData
FeatureIdentifier
FitBoundsOptions
FlyToOptions
FullscreenControlOptions
GeoJSONFeatureDiff
GeoJSONFeatureId
GeoJSONSourceDiff
GeoJSONSourceOptions
GeoJSONWorkerOptions
GeoJSONWorkerSourceLoadDataResult
GeolocateControlOptions
GestureOptions
GetClusterLeavesParams
GetGlyphsParamerters
GetGlyphsResponse
GetImagesParamerters
GetImagesResponse
GetResourceResponse<T>
GlyphMetrics
GlyphPosition
GlyphPositions
GridKey
HandlerResult
HCLColor
JumpToOptions
LABColor
Listener()
LngLatBoundsLike
LngLatLike
LoadGeoJSONParameters
LogoControlOptions
MapContextEvent
MapDataEvent
MapEventType
MapGeoJSONFeature
MapLayerEventType
MapLayerMouseEvent
MapLayerTouchEvent
MapLibreZoomEvent
MapOptions
MapSourceDataEvent
MapSourceDataType
MapStyleDataEvent
MapStyleImageMissingEvent
MapTerrainEvent
MarkerOptions
MessageData
NavigationControlOptions
Offset
OverlapMode
PaddingOptions
PluginState
PointLike
PointProjection
PointsofInterestEvent
PointsofInterestLoading
PopupOptions
PositionAnchor
PossiblyEvaluatedValue<T>
Projection
QueryRenderedFeaturesOptions
QuerySourceFeatureOptions
Rect
RemoveSourceParams
RequestParameters
RequestResponseMessageMap
RequestTransformFunction()
RequireAtLeastOne<T>
ResponseCallback()<T>
RGBColor
RoadSpeedBase
RoadSurfaceEvent
RoadSurfaceLoading
RTLPluginStatus
ScaleControlOptions
Serialized
SerializedObject<S>
SerializedStructArray
SetClusterOptions
SourceClass()
SpriteOnDemandStyleImage
StopOptions
StyleGlyph
StyleImage
StyleImageData
StyleImageMetadata
StyleOptions
StyleSetterOptions
StyleSwapOptions
SymbolQuad
TileParameters
TileState
TrafficCameraEvent
TrafficCameraLoading
TrafficEvent
TrafficIncidentEvent
TrafficIncidentLoading
TrafficLoading
TransformStyleFunction()
TrimbleMapsEvent<TOrig>
TrimbleMapsZoomEvent
TruckRestrictionEvent
TruckRestrictionLoading
Unit
UpdateImageOptions
UpdateLayersParameters
WeatherAlertEvent
WeatherAlertEventname
WeatherAlertLoading
WeatherCloudEvent
WeatherCloudLoading
WeatherRadarEvent
WeatherRadarLoading
WorkerDEMTileParameters
WorkerTileParameters
WorkerTileResult
Variables
Common
DwellTimes
Geocoder
Places
Rail
Routing
Search
customRoad
customRoad
:
object
The customroad event
Type declaration
type
type
:
"customroad"
Was this page helpful?
Yes
No