Home
Updates
Guides
Get started
Use a ready-made map
Design your map
Bring your data
Use location services
Manage your account
Developer resources
Overview
Authentication
- API key
- Service token
AI-assisted development
APIs
SDK JS
GeoSplats SDK
- Code examples
- Reference
Mobile SDKs
JavaScript frameworks
- Angular
  - Examples
- React
  - Examples
- Svelte
  - Examples
- Vite
- Vue.js
  - Examples
3rd party libraries
- Leaflet
  - Examples
- MapLibre GL JS
  - Examples
- OpenLayers
  - Examples
- Deck.gl
  - Examples
- Cesium
- Game engines
  - Unreal
  - Unity
Map resources
How maps work
MapTiler schemas & data
Map reference
- GL style specification
  - Root
  - Light
  - Sources
  - Sprite
  - Glyphs
  - Transition
  - Layers
  - Projection
  - Sky
  - Types
  - Expressions
- Map transformations
- Tilestats
  - How to generate tilestats
On-prem
MapTiler Server
MapTiler Engine

On this page

MapTiler SDK JS

Externals
helpers
IntersectionResult
validateStyleMin
CubemapFaceNames
CubemapImagesPresets
MessageType
ResourceType
TextFit
Actor
AlphaImage
AnimatedRouteLayer
AttributionControl
BoxZoomHandler
CanvasSource
CollisionBoxArray
Color
ColorArray
ColorRamp
CompoundExpression
CooperativeGesturesHandler
CubemapLayer
Dispatcher
ErrorEvent
EvaluationContext
Event
FeatureIndex
FormatExpression
Formatted
FormattedSection
FullscreenControl
GeoJSONFeature
GeoJSONSource
GeolocateControl
GlobeControl
ImageAtlas
ImageSource
ImageViewer
ImageViewerEvent
ImageViewerMarker
ImageViewerMarkerEvent
Interpolate
KeyboardHandler
Literal
LogoControl
Map
MapLibreMap
MapMouseEvent
MapStyleVariant
MaptilerAnimation
MaptilerCustomControl
MaptilerExternalControl
MaptilerGeolocateControl
MaptilerLogoControl
MaptilerNavigationControl
MaptilerProjectionControl
MaptilerTerrainControl
MapTouchEvent
MapWheelEvent
Marker
NavigationControl
NumberArray
OverscaledTileID
Padding
Painter
ParsingError
Popup
ProjectionDefinition
RadialGradientLayer
RasterDEMTileSource
RasterTileSource
ReferenceMapStyle
ResolvedImage
ScaleControl
ScrollZoomHandler
SdkConfig
ServiceError
Step
Style
StyleExpression
StyleLayer
StylePropertyFunction
TerrainControl
Tile
TwoFingersTouchPitchHandler
ValidationError
VariableAnchorOffsetCollection
VectorTileSource
VideoSource
ZoomConstantExpression
ZoomDependentExpression
AttributionControlOptions
Bucket
CustomLayerInterface
DragMoveHandler
DragMovementResult
DragPanResult
DragPitchResult
DragRollResult
DragRotateResult
Expression
Handler
IActor
ICanonicalTileID
IControl
ILngLat
IMercatorCoordinate
IValue
Link
MaptilerAnimationOptions
MinimapOptions
MinimapOptionsInput
MousePanHandler
MousePitchHandler
MouseRollHandler
MouseRotateHandler
ParentRect
ParseGeoJSONToKeyframesOptions
PlacemarkProperties
Point2D
Property
Source
StyleImageInterface
Subscription
VisibilityExpression
XMLProperties
$ObjMap
ActorMessage
ActorTarget
AddLayerObject
AddProtocolAction
AJAXError
Alignment
AllLayoutProperties
AllPaintProperties
AnimatedCameraOptions
AnimatedRouteLayerOptions
AnimatedStrokeOptions
AnimationEvent
AnimationEventCallback
AnimationEventListenersRecord
AnimationEventTypes
AnimationOptions
AroundCenterOptions
ArrayColor
ArrayColorRamp
ArrayColorRampStop
AttributeBinder
AutomaticStaticMapOptions
BackgroundLayerSpecification
BaseGeocodingOptions
BinderUniform
BlendEquationType
BlendFuncConstant
BlendFuncType
BoundedStaticMapOptions
BoxZoomEndHandler
BoxZoomHandlerOptions
BucketFeature
BucketParameters
BucketPart
BufferToPixelDataFunction
ByIdGeocodingOptions
CalculateTileZoomFunction
CameraForBoundsOptions
CameraForBoxAndBearingHandlerResult
CameraFunctionSpecification
CameraOptions
CameraPosition
CameraUpdateTransformFunction
CanonicalTileRange
CanvasSourceSpecification
CenteredStaticMapOptions
CenterZoomBearing
CircleGranularity
CircleLayerSpecification
CircleLayoutProps
CircleLayoutPropsPossiblyEvaluated
CirclePaintProps
CirclePaintPropsPossiblyEvaluated
ClearArgs
ClusterIDAndSource
CollatorExpressionSpecification
CollisionArrays
CollisionGroup
ColorArraySpecification
ColorMaskType
ColorPalette
ColorRampOptions
ColorRampTextures
ColorReliefLayerSpecification
ColorReliefPaintProps
ColorReliefPaintPropsPossiblyEvaluated
ColorSpecification
ColorStop
CommonForwardAndReverseGeocodingOptions
CommonShapeLayerOptions
CompareFuncType
Complete
CompleteMapOptions
CompositeExpression
CompositeFunctionSpecification
Config
ControlPosition
CoordinateExport
CoordinateGrid
CoordinateId
Coordinates
CoordinateSearch
CoordinateSearchResult
CoordinatesSearchOptions
CoordinatesTransformOptions
CoordinateTransformation
CoordinateTransformResult
CoveringTilesDetailsProvider
CoveringTilesOptions
CreateTileMeshOptions
CrossFaded
CrossfadeParameters
CrossTileID
CubemapDefinition
CubemapFaces
CubemapLayerConstructorOptions
CullFaceModeType
CustomRenderMethod
CustomRenderMethodInput
DashEntry
DataDrivenPropertyValueSpecification
DataDrivenStyle
DataTextureImage
DefaultTransformation
DEMEncoding
DepthFuncType
DepthMaskType
DepthRangeType
DiffCommand
DiffOperations
DistributiveKeys
DistributiveOmit
DoubleClickZoomHandler
DragPanHandler
DragPanOptions
DragRotateHandler
DragRotateHandlerOptions
DrawMode
EaseToHandlerOptions
EaseToHandlerResult
EaseToOptions
EasingFunctionName
EdgeInsets
ElevationAtOptions
ElevationBatchOptions
EmptyImage
Entry
ErrorLike
Evented
EventInProgress
EventsInProgress
ExpiryData
ExpressionFilterSpecification
ExpressionInputType
ExpressionSpecification
Feature
FeatureFilter
FeatureHierarchy
FeatureIdentifier
FeatureKey
FeaturePosition
FeatureState
FeatureStates
FetchFunction
FillExtrusionLayerSpecification
FillExtrusionPaintProps
FillExtrusionPaintPropsPossiblyEvaluated
FillLayerSpecification
FillLayoutProps
FillLayoutPropsPossiblyEvaluated
FillPaintProps
FillPaintPropsPossiblyEvaluated
FilterSpecification
FitBoundsOptions
FlyToHandlerOptions
FlyToHandlerResult
FlyToOptions
FontFacesSpecification
FormattedSpecification
FrameCallback
FrontFaceType
FullscreenControlOptions
GeocodingFeature
GeocodingOptions
GeocodingSearchResult
GeoJSONFeatureDiff
GeoJSONFeatureId
GeoJSONSourceDiff
GeoJSONSourceOptions
GeoJSONSourceSpecification
GeoJSONWorkerOptions
GeoJSONWorkerSourceLoadDataResult
GeolocateControlOptions
GeolocationInfoOptions
GeolocationResult
GestureOptions
GetClusterLeavesParams
GetDataOptions
GetGlyphsParameters
GetGlyphsResponse
GetImagesParameters
GetImagesResponse
GetResourceResponse
GlobalProperties
GlyphMetrics
GlyphPosition
GlyphPositions
GradientAttributeKey
GradientDefinition
GradientPlaneObject3D
GradientStop
GradientStopColor
GradientTexture
GradientUniformKey
GridKey
HandlerResult
Hash
HeatmapLayerOptions
HeatmapLayerSpecification
HeatmapPaintProps
HeatmapPaintPropsPossiblyEvaluated
HillshadeLayerSpecification
HillshadePaintProps
HillshadePaintPropsPossiblyEvaluated
IBoundingVolume
ICameraHelper
ILngLatLike
ImageMetadata
ImageSourceSpecification
ImageViewerConstructorOptions
ImageViewerEventTypes
ImageViewerFlyToOptions
ImageViewerJumpToOptions
ImageViewerMarkerOptions
IndexedFeature
IndexToPointCache
IndicesType
InterpolatedKeyFrame
InterpolationSpecification
InterpolationType
IntersectionResult
IReadonlyTransform
ITransform
ITransformGetters
ITransformMutators
JumpToOptions
Keyframe
KeyframeableGeoJSONFeature
KeyframeableGeometry
LanguageGeocodingOptions
LanguageInfo
LayerFeatureStates
LayerSpecification
LegacyFilterSpecification
LightPosition
LightProps
LightPropsPossiblyEvaluated
LightSpecification
LineClips
LineLayerSpecification
LineLayoutProps
LineLayoutPropsPossiblyEvaluated
LinePaintProps
LinePaintPropsPossiblyEvaluated
Listener
LngLat
LngLatBounds
LngLatBoundsLike
LngLatLike
LoadGeoJSONParameters
LoadTileResult
LoadWithTerrainEvent
LogoControlOptions
MapContextEvent
MapControlsDeltas
MapDataEvent
MapEventType
MapGeoJSONFeature
MapLayerEventType
MapLayerMouseEvent
MapLayerTouchEvent
MapLibreEvent
MapLibreZoomEvent
MapOptions
MapProjectionEvent
MapSourceDataEvent
MapSourceDataType
MapStyleDataEvent
MapStyleImageMissingEvent
MapStylePreset
MapStyleType
MapTerrainEvent
MaptilerCustomControlCallback
MaptilerExternalControlType
MarkerOptions
MercatorCoordinate
MessageData
MessageHandler
MLFontFace
NavigationControlOptions
NumberArraySpecification
NumericArrayWithNull
Offset
OverlapMode
PaddingOptions
PaddingSpecification
PainterOptions
Pattern
PixelData
PlacedBox
PlacedCircles
PluginState
Point
PointLayerOptions
PointLike
PointProjection
PolygonLayerOptions
PolylineLayerOptions
PoolObject
PopulateParameters
PopupOptions
PositionAnchor
PossiblyEvaluatedValue
PreloadTilesForBoundsOptions
PreloadTilesForCameraPositionsOptions
PreloadTilesOptions
PreparedShader
Projection
ProjectionCache
ProjectionData
ProjectionDataParams
ProjectionDefinitionSpecification
ProjectionDefinitionT
ProjectionGPUContext
ProjectionPreludeUniformsType
ProjectionSpecification
PromoteIdSpecification
PropertyValues
PropertyValueSpecification
QueryIntersectsFeatureParams
QueryParameters
QueryRenderedFeaturesOptions
QueryRenderedFeaturesOptionsStrict
QueryResult
QueryResults
QueryResultsItem
QuerySourceFeatureOptions
RadialGradientLayerConstructorOptions
RasterDEMSourceSpecification
RasterLayerSpecification
RasterSourceSpecification
Rect
RemoveSourceParams
RenderOptions
RenderPass
RequestParameters
RequestResponseMessageMap
RequestTransformFunction
RequireAtLeastOne
ResolvedImageSpecification
ResolveReject
ReverseGeocodingOptions
RgbaColor
RTLPluginStatus
ScaleControlOptions
SchemaSpecification
Segment
Serialized
SerializedFeaturePositionMap
SerializedGrid
SerializedObject
SerializedStructArray
SetClusterOptions
SingleCollisionBox
Size
SizeData
SkyProps
SkyPropsPossiblyEvaluated
SkySpecification
SortKeyRange
SourceClass
SourceData
SourceExpression
SourceFunctionSpecification
SourceSpecification
SpriteOnDemandStyleImage
SpriteSpecification
StateSpecification
StaticMapBaseOptions
StaticMapMarker
StencilFuncType
StencilOpConstant
StencilOpType
StencilTestGL
StructArrayMember
StyleGlyph
StyleImage
StyleImageData
StyleImageMetadata
StyleOptions
StylePropertyExpression
StylePropertySpecification
StyleSetterOptions
StyleSpecification
StyleSpecificationWithMetaData
StyleSwapOptions
SymbolFeature
SymbolInstance
SymbolLayerSpecification
SymbolLayoutProps
SymbolLayoutPropsPossiblyEvaluated
SymbolPaintProps
SymbolPaintPropsPossiblyEvaluated
SymbolProjectionContext
SymbolQuad
TerrainData
TerrainPreludeUniformsType
TerrainSpecification
TextAnchor
TextAnchorOffset
TextureFilter
TextureFormat
TextureImage
TextureUnitType
TextureWrap
TileJSON
TileLayerParameters
TileMesh
TileMeshUsage
TileParameters
TilePreloadErrorCallback
TilePreloadOptions
TilePreloadProgressCallback
TileResult
TileState
TimePoint
TransformConstrainFunction
TransformStyleFunction
TransitionParameters
TransitionSpecification
TwoFingersTouchRotateHandler
TwoFingersTouchZoomHandler
TwoFingersTouchZoomRotateHandler
Type
TypedStyleLayer
UniformBinder
UniformBindings
UniformLocations
UniformValues
Unit
UpdateImageOptions
UpdateLayersParameters
VariableAnchorOffsetCollectionSpecification
VariableExpressionSpecification
VariableOffset
VectorSourceSpecification
VectorTileSourceOptions
VerticalAlign
VideoSourceSpecification
ViewportType
ViewType
VisibilitySpecification
WebGLContextAttributesWithType
WebGLSupportedVersions
WithTilePreload
WorkerDEMTileParameters
WorkerTileParameters
WorkerTileResult
XYZ
ZoomNumberValues
ZoomStringValues
addProtocol
addSourceType
AJAXError
ANIM_LAYER_PREFIX
AnimationEventTypesArray
AttributionControlMLGL
BoxZoomHandlerMLGL
CanvasSourceMLGL
clearPrewarmedResources
colorPalettes
ColorRampCollection
ColorType
config
configMLGL
CooperativeGesturesHandlerMLGL
coordinates
cubemapPresets
data
DoubleClickZoomHandler
DragPanHandler
DragRotateHandler
EdgeInsets
elevation
Evented
expression
expressions
EXTENT
FormattedType
FullscreenControlMLGL
function
geocoding
GeoJSONSourceMLGL
GeolocateControlMLGL
geolocation
GeolocationType
getMapLibreVersion
getMaxParallelImageRequests
getRTLTextPluginStatus
getWorkerCount
getWorkerUrl
Hash
ImageSourceMLGL
importScriptInWorkers
interpolates
KeyboardHandlerMLGL
Language
latest
LngLat
LngLatBounds
LogoControlMLGL
MapMLGL
MapMouseEventMLGL
MapStyle
mapStylePresetList
MapTouchEventMLGL
MapWheelEventMLGL
MarkerMLGL
math
MercatorCoordinate
misc
NavigationControMLGL
NullType
Point
PopupMLGL
prewarm
ProjectionDefinitionType
RasterDEMTileSourceMLGL
RasterTileSourceMLGL
removeProtocol
ScaleControlMLGL
ScrollZoomHandlerMLGL
setMaxParallelImageRequests
setRTLTextPlugin
setWorkerCount
setWorkerUrl
staticMaps
StyleMLGL
TerrainControMLGL
TwoFingersTouchPitchHandlerMLGL
TwoFingersTouchRotateHandler
TwoFingersTouchZoomHandler
TwoFingersTouchZoomRotateHandler
v8
VectorTileSourceMLGL
VideoSourceMLGL
visit
addHeatmap
addPoint
addPolygon
addPolyline
areSameLanguages
bufferToPixelDataBrowser
canParsePixelData
circumferenceAtLatitude
classifyRings
colorDrivenByProperty
computeRampedOutlineWidth
convertFilter
convertFunction
createBezierPathFromCoordinates
createExpression
createFunction
createPropertyExpression
createTileMesh
createVisibilityExpression
dashArrayMaker
derefLayers
diff
displayWebGLContextLostWarning
DOMcreate
DOMremove
emptyStyle
expandMapStyle
featureFilter
findNextEntryAndIndexWithValue
findPreviousEntryAndIndexWithValue
format
generateRandomLayerName
generateRandomSourceName
getAutoLanguage
getAverageDistance
getBrowserLanguage
getBufferToPixelDataParser
getGlobalDispatcher
getKeyframes
getLanguageInfoFromCode
getLanguageInfoFromFlag
getLanguageInfoFromKey
getRandomColor
getTileCache
getVersion
getWebGLSupportError
gpx
gpxOrKml
groupByLayout
hasChildNodeWithName
heatmapIntensityFromColorRamp
isExpression
isFunction
isLanguageInfo
isTimeFrozen
isZoomExpression
kml
lerp
lerpArrayValues
lerpZoomNumberValues
migrate
normalizePropertyExpression
now
opacityDrivenByProperty
paintColorOptionsToPaintSpec
parseGeoJSONFeatureToKeyframes
radiusDrivenByProperty
radiusDrivenByPropertyHeatmap
rampedOptionsToLayerPaintSpec
rampedPropertyValueWeight
resamplePath
restoreNow
setNow
simplifyPath
str2xml
stretchNumericalArray
styleToStyle
supportsPropertyExpression
takeScreenshot
toggleProjection
toggleTerrain
toLanguageInfo
toString
typeOf
validate
validateStyleMin
xml2str

Type Alias AlphaOption

AlphaOption: "discard" | "keep"

Was this helpful?

Thank you! Please tell us what's unclear or missing on this page, so we can improve it for you.

Thank you for your feedback!

You've already voted on this page.

reCAPTCHA failed! Please try again.

Follow us on

Company

About us Careers Press Become a partner Contact us

Usage

Industries Mapbox alternative Google Maps alternative Geolayers Maps for games

Resources

Documentation Showcases & tools Attribution free map Open source Support Connect25 Conference

Security Privacy Policy Terms of Use Cookie settings

SDK JS

Reference

AlphaOption