# Type aliases

# AnimateMarkerType

Ƭ AnimateMarkerType: "breathingAperture" | "rotatingAperture" | "haloRing" | "diffusedAperture" | "rotatingTextBorder" | "fluorescence"

breathingAperture 呼吸的光圈. rotatingAperture 旋转的光环 haloRing 发光的光环 diffusedAperture 扩散的点 rotatingTextBorder 旋转的文本框 fluorescence 荧光点


# AnimationOps

Ƭ AnimationOps<V>: PlaybackOptions<V> & DecayOptions | KeyframeOptions<V> | SpringOptions

# Type parameters

Name
V

# BackgroundLayerSpecification

Ƭ BackgroundLayerSpecification: object

# Type declaration

Name Type
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.background-color? PropertyValueSpecificationEx<ColorSpecification>
paint.background-opacity? PropertyValueSpecificationEx<number>
paint.background-pattern? PropertyValueSpecificationEx<ResolvedImageSpecification>
type "background"

# CameraFunctionSpecificationEx

Ƭ CameraFunctionSpecificationEx<T>: { stops: [number, T][] ; type: "exponential" } | { stops: [number, T][] ; type: "interval" }

# Type parameters

Name
T

# CircleLayerSpecification

Ƭ CircleLayerSpecification: object

# Type declaration

Name Type
filter? FilterSpecification
id string
layout? object
layout.circle-sort-key? DataDrivenPropertyValueSpecification<number>
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.circle-blur? DataDrivenPropertyValueSpecification<number>
paint.circle-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.circle-opacity? DataDrivenPropertyValueSpecification<number>
paint.circle-pitch-alignment? PropertyValueSpecificationEx<"map" | "viewport">
paint.circle-pitch-scale? PropertyValueSpecificationEx<"map" | "viewport">
paint.circle-radius? DataDrivenPropertyValueSpecification<number>
paint.circle-stroke-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.circle-stroke-opacity? DataDrivenPropertyValueSpecification<number>
paint.circle-stroke-width? DataDrivenPropertyValueSpecification<number>
paint.circle-translate? PropertyValueSpecificationEx<[number, number]>
paint.circle-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
source string
source-layer? string
type "circle"

# CircleLayerStyleProp

Ƭ CircleLayerStyleProp: object

# Type declaration

Name Type
circleBlur? DataDrivenPropertyValueSpecification<number>
circleColor? DataDrivenPropertyValueSpecification<ColorSpecification>
circleOpacity? DataDrivenPropertyValueSpecification<number>
circlePitchAlignment? PropertyValueSpecificationEx<"map" | "viewport">
circlePitchScale? PropertyValueSpecificationEx<"map" | "viewport">
circleRadius? DataDrivenPropertyValueSpecification<number>
circleSortKey? DataDrivenPropertyValueSpecification<number>
circleStrokeColor? DataDrivenPropertyValueSpecification<ColorSpecification>
circleStrokeOpacity? DataDrivenPropertyValueSpecification<number>
circleStrokeWidth? DataDrivenPropertyValueSpecification<number>
circleTranslate? PropertyValueSpecificationEx<[number, number]>
circleTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
filter? FilterSpecification
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# ColorSpecification

Ƭ ColorSpecification: string


# CompositeFunctionSpecification

Ƭ CompositeFunctionSpecification<T>: { default?: T ; property: string ; stops: [{ value: number ; zoom: number }, T][] ; type: "exponential" } | { default?: T ; property: string ; stops: [{ value: number ; zoom: number }, T][] ; type: "interval" } | { default?: T ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, T][] ; type: "categorical" }

# Type parameters

Name
T

# DataDrivenPropertyValueSpecification

Ƭ DataDrivenPropertyValueSpecification<T>: T | CameraFunctionSpecificationEx<T> | SourceFunctionSpecification<T> | CompositeFunctionSpecification<T> | ExpressionSpecificationEx

# Type parameters

Name
T

# Driver

Ƭ Driver: (update: Update) => DriverControls

# Type declaration

▸ (update: Update): DriverControls

# Parameters

Name Type
update Update

Returns: DriverControls


# Easing

Ƭ Easing: (v: number) => number

# Type declaration

▸ (v: number): number

# Parameters

Name Type
v number

Returns: number


# EasingModifier

Ƭ EasingModifier: (easing: Easing) => Easing

# Type declaration

▸ (easing: Easing): Easing

# Parameters

Name Type
easing Easing

Returns: Easing


# ExpressionSpecificationEx

Ƭ ExpressionSpecificationEx: unknown[]


# FillExtrusionLayerSpecification

Ƭ FillExtrusionLayerSpecification: object

# Type declaration

Name Type
filter? FilterSpecification
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.fill-extrusion-base? DataDrivenPropertyValueSpecification<number>
paint.fill-extrusion-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.fill-extrusion-height? DataDrivenPropertyValueSpecification<number>
paint.fill-extrusion-opacity? PropertyValueSpecificationEx<number>
paint.fill-extrusion-pattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
paint.fill-extrusion-translate? PropertyValueSpecificationEx<[number, number]>
paint.fill-extrusion-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
paint.fill-extrusion-vertical-gradient? PropertyValueSpecificationEx<boolean>
source string
source-layer? string
type "fill-extrusion"

# FillExtrusionLayerStyleProp

Ƭ FillExtrusionLayerStyleProp: object

# Type declaration

Name Type
fillExtrusionBase? DataDrivenPropertyValueSpecification<number>
fillExtrusionColor? DataDrivenPropertyValueSpecification<ColorSpecification>
fillExtrusionHeight? DataDrivenPropertyValueSpecification<number>
fillExtrusionOpacity? PropertyValueSpecificationEx<number>
fillExtrusionPattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
fillExtrusionTranslate? PropertyValueSpecificationEx<[number, number]>
fillExtrusionTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
fillExtrusionVerticalGradient? PropertyValueSpecificationEx<boolean>
filter? FilterSpecification
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# FillLayerSpecification

Ƭ FillLayerSpecification: object

# Type declaration

Name Type
filter? FilterSpecification
id string
layout? object
layout.fill-sort-key? DataDrivenPropertyValueSpecification<number>
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.fill-antialias? PropertyValueSpecificationEx<boolean>
paint.fill-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.fill-opacity? DataDrivenPropertyValueSpecification<number>
paint.fill-outline-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.fill-pattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
paint.fill-translate? PropertyValueSpecificationEx<[number, number]>
paint.fill-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
source string
source-layer? string
type "fill"

# FillLayerStyleProp

Ƭ FillLayerStyleProp: object

# Type declaration

Name Type
fillAntialias? PropertyValueSpecificationEx<boolean>
fillColor? DataDrivenPropertyValueSpecification<ColorSpecification>
fillOpacity? DataDrivenPropertyValueSpecification<number>
fillOutlineColor? DataDrivenPropertyValueSpecification<ColorSpecification>
fillPattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
fillSortKey? DataDrivenPropertyValueSpecification<number>
fillTranslate? PropertyValueSpecificationEx<[number, number]>
fillTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
filter? FilterSpecification
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# FilterSpecification

Ƭ FilterSpecification: ["has", string] | ["!has", string] | ["==", string, string | number | boolean] | ["!=", string, string | number | boolean] | [">", string, string | number | boolean] | [">=", string, string | number | boolean] | ["<", string, string | number | boolean] | ["<=", string, string | number | boolean] | (string | FilterSpecification)[]


# FogSpecification

Ƭ FogSpecification: object

# Type declaration

Name Type
color? PropertyValueSpecificationEx<ColorSpecification>
horizon-blend? PropertyValueSpecificationEx<number>
range? PropertyValueSpecificationEx<[number, number]>

# FormattedSpecification

Ƭ FormattedSpecification: string


# GeoJSONSourceSpecification

Ƭ GeoJSONSourceSpecification: object

# Type declaration

Name Type
attribution? string
buffer? number
cluster? boolean
clusterMaxZoom? number
clusterMinPoints? number
clusterProperties? unknown
clusterRadius? number
data? unknown
filter? unknown
generateId? boolean
lineMetrics? boolean
maxzoom? number
promoteId? PromoteIdSpecificationEx
tolerance? number
type "geojson"

# GeoPointLike

Ƭ GeoPointLike: [number, number] | [number, number, number] | GeoPoint | { x: number ; y: number ; z?: number } | { lat: number ; lng: number } | { lat: number ; lon: number }


# HeatmapLayerSpecification

Ƭ HeatmapLayerSpecification: object

# Type declaration

Name Type
filter? FilterSpecification
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.heatmap-color? ExpressionSpecificationEx
paint.heatmap-intensity? PropertyValueSpecificationEx<number>
paint.heatmap-opacity? PropertyValueSpecificationEx<number>
paint.heatmap-radius? DataDrivenPropertyValueSpecification<number>
paint.heatmap-weight? DataDrivenPropertyValueSpecification<number>
source string
source-layer? string
type "heatmap"

# HeatmapLayerStyleProp

Ƭ HeatmapLayerStyleProp: object

# Type declaration

Name Type
filter? FilterSpecification
heatmapColor? ExpressionSpecificationEx
heatmapIntensity? PropertyValueSpecificationEx<number>
heatmapOpacity? PropertyValueSpecificationEx<number>
heatmapRadius? DataDrivenPropertyValueSpecification<number>
heatmapWeight? DataDrivenPropertyValueSpecification<number>
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# HillshadeLayerSpecification

Ƭ HillshadeLayerSpecification: object

# Type declaration

Name Type
filter? FilterSpecification
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.hillshade-accent-color? PropertyValueSpecificationEx<ColorSpecification>
paint.hillshade-exaggeration? PropertyValueSpecificationEx<number>
paint.hillshade-highlight-color? PropertyValueSpecificationEx<ColorSpecification>
paint.hillshade-illumination-anchor? PropertyValueSpecificationEx<"map" | "viewport">
paint.hillshade-illumination-direction? PropertyValueSpecificationEx<number>
paint.hillshade-shadow-color? PropertyValueSpecificationEx<ColorSpecification>
source string
source-layer? string
type "hillshade"

# HillshadeLayerStyleProp

Ƭ HillshadeLayerStyleProp: object

# Type declaration

Name Type
filter? FilterSpecification
hillshadeAccentColor? PropertyValueSpecificationEx<ColorSpecification>
hillshadeExaggeration? PropertyValueSpecificationEx<number>
hillshadeHighlightColor? PropertyValueSpecificationEx<ColorSpecification>
hillshadeIlluminationAnchor? PropertyValueSpecificationEx<"map" | "viewport">
hillshadeIlluminationDirection? PropertyValueSpecificationEx<number>
hillshadeShadowColor? PropertyValueSpecificationEx<ColorSpecification>
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# IDbPoint

Ƭ IDbPoint: [number, number, number?]

坐标类型接口


# ImageSourceSpecification

Ƭ ImageSourceSpecification: object

# Type declaration

Name Type
coordinates [[number, number], [number, number], [number, number], [number, number]]
type "image"
url string

# LayerCallback

Ƭ LayerCallback: (arg0: {}) => void

# Type declaration

▸ (arg0: {}): void

# Parameters

Name Type
arg0 object

Returns: void


# LayerRef

Ƭ LayerRef: string | string[] | RegExp | (arg0: LayerSpecification) => boolean


# LayerRefFunc

Ƭ LayerRefFunc: (arg0: LayerRef, ...args: any[]) => void

# Type declaration

▸ (arg0: LayerRef, ...args: any[]): void

# Parameters

Name Type
arg0 LayerRef
...args any[]

Returns: void


# LayerRefFunc0

Ƭ LayerRefFunc0: (arg0: LayerRef) => void

# Type declaration

▸ (arg0: LayerRef): void

# Parameters

Name Type
arg0 LayerRef

Returns: void


# LayerRefFunc1

Ƭ LayerRefFunc1<T1>: (arg0: LayerRef, arg1: T1) => void

# Type parameters

Name
T1

# Type declaration

▸ (arg0: LayerRef, arg1: T1): void

# Parameters

Name Type
arg0 LayerRef
arg1 T1

Returns: void


# LayerRefFunc2

Ƭ LayerRefFunc2<T1, T2>: (arg0: LayerRef, arg1: T1, arg2: T2) => void

# Type parameters

Name
T1
T2

# Type declaration

▸ (arg0: LayerRef, arg1: T1, arg2: T2): void

# Parameters

Name Type
arg0 LayerRef
arg1 T1
arg2 T2

Returns: void


# LayerRefFunc3

Ƭ LayerRefFunc3<T1, T2, T3>: (arg0: LayerRef, arg1: T1, arg2: T2, arg3: T3) => void

# Type parameters

Name
T1
T2
T3

# Type declaration

▸ (arg0: LayerRef, arg1: T1, arg2: T2, arg3: T3): void

# Parameters

Name Type
arg0 LayerRef
arg1 T1
arg2 T2
arg3 T3

Returns: void


# LayerSpecification

Ƭ LayerSpecification: FillLayerSpecification | LineLayerSpecification | SymbolLayerSpecification | CircleLayerSpecification | HeatmapLayerSpecification | FillExtrusionLayerSpecification | RasterLayerSpecification | HillshadeLayerSpecification | BackgroundLayerSpecification | SkyLayerSpecification


# LightSpecification

Ƭ LightSpecification: object

# Type declaration

Name Type
anchor? PropertyValueSpecificationEx<"map" | "viewport">
color? PropertyValueSpecificationEx<ColorSpecification>
intensity? PropertyValueSpecificationEx<number>
position? PropertyValueSpecificationEx<[number, number, number]>

# LineLayerSpecification

Ƭ LineLayerSpecification: object

# Type declaration

Name Type
filter? FilterSpecification
id string
layout? object
layout.line-cap? DataDrivenPropertyValueSpecification<"butt" | "round" | "square">
layout.line-join? DataDrivenPropertyValueSpecification<"bevel" | "round" | "miter">
layout.line-miter-limit? PropertyValueSpecificationEx<number>
layout.line-round-limit? PropertyValueSpecificationEx<number>
layout.line-sort-key? DataDrivenPropertyValueSpecification<number>
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.line-blur? DataDrivenPropertyValueSpecification<number>
paint.line-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.line-dasharray? DataDrivenPropertyValueSpecification<number[]>
paint.line-gap-width? DataDrivenPropertyValueSpecification<number>
paint.line-gradient? ExpressionSpecificationEx
paint.line-offset? DataDrivenPropertyValueSpecification<number>
paint.line-opacity? DataDrivenPropertyValueSpecification<number>
paint.line-pattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
paint.line-translate? PropertyValueSpecificationEx<[number, number]>
paint.line-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
paint.line-width? DataDrivenPropertyValueSpecification<number>
source string
source-layer? string
type "line"

# LineLayerStyleProp

Ƭ LineLayerStyleProp: object

# Type declaration

Name Type
filter? FilterSpecification
lineBlur? DataDrivenPropertyValueSpecification<number>
lineCap? DataDrivenPropertyValueSpecification<"butt" | "round" | "square">
lineColor? DataDrivenPropertyValueSpecification<ColorSpecification>
lineDasharray? DataDrivenPropertyValueSpecification<number[]>
lineGapWidth? DataDrivenPropertyValueSpecification<number>
lineGradient? ExpressionSpecificationEx
lineJoin? DataDrivenPropertyValueSpecification<"bevel" | "round" | "miter">
lineMiterMimit? PropertyValueSpecificationEx<number>
lineOffset? DataDrivenPropertyValueSpecification<number>
lineOpacity? DataDrivenPropertyValueSpecification<number>
linePattern? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
lineRoundLimit? PropertyValueSpecificationEx<number>
lineSortKey? DataDrivenPropertyValueSpecification<number>
lineTranslate? PropertyValueSpecificationEx<[number, number]>
lineTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
lineWidth? DataDrivenPropertyValueSpecification<number>
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
visibility? "visible" | "none"

# OffHandler

Ƭ OffHandler: () => void

# Type declaration

▸ (): void

Returns: void


# PromoteIdSpecificationEx

Ƭ PromoteIdSpecificationEx: Record<string, string> | string


# PropName

Ƭ PropName: string


# PropValue

Ƭ PropValue: string | any[] | null | number | {}


# PropertyValueSpecificationEx

Ƭ PropertyValueSpecificationEx<T>: T | CameraFunctionSpecificationEx<T> | ExpressionSpecificationEx

# Type parameters

Name
T

# RasterDEMSourceSpecification

Ƭ RasterDEMSourceSpecification: object

# Type declaration

Name Type
attribution? string
bounds? [number, number, number, number]
encoding? "terrarium" | "mapbox"
maxzoom? number
minzoom? number
tileSize? number
tiles? string[]
type "raster-dem"
url? string
volatile? boolean

# RasterLayerSpecification

Ƭ RasterLayerSpecification: object

# Type declaration

Name Type
filter? FilterSpecification
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.raster-brightness-max? PropertyValueSpecificationEx<number>
paint.raster-brightness-min? PropertyValueSpecificationEx<number>
paint.raster-contrast? PropertyValueSpecificationEx<number>
paint.raster-fade-duration? PropertyValueSpecificationEx<number>
paint.raster-hue-rotate? PropertyValueSpecificationEx<number>
paint.raster-opacity? PropertyValueSpecificationEx<number>
paint.raster-resampling? PropertyValueSpecificationEx<"linear" | "nearest">
paint.raster-saturation? PropertyValueSpecificationEx<number>
source string
source-layer? string
type "raster"

# RasterLayerStyleProp

Ƭ RasterLayerStyleProp: object

# Type declaration

Name Type
filter? FilterSpecification
maxzoom? number
metadata? unknown
minzoom? number
rasterBrightnessMax? PropertyValueSpecificationEx<number>
rasterBrightnessMin? PropertyValueSpecificationEx<number>
rasterContrast? PropertyValueSpecificationEx<number>
rasterFadeDuration? PropertyValueSpecificationEx<number>
rasterHueRotate? PropertyValueSpecificationEx<number>
rasterOpacity? PropertyValueSpecificationEx<number>
rasterResampling? PropertyValueSpecificationEx<"linear" | "nearest">
rasterSaturation? PropertyValueSpecificationEx<number>
source? string
sourceLayer? string
visibility? "visible" | "none"

# RasterSourceSpecification

Ƭ RasterSourceSpecification: object

# Type declaration

Name Type
attribution? string
bounds? [number, number, number, number]
maxzoom? number
minzoom? number
scheme? "xyz" | "tms"
tileSize? number
tiles? string[]
type "raster"
url? string
volatile? boolean

# ResolvedImageSpecification

Ƭ ResolvedImageSpecification: string


# SkyLayerSpecification

Ƭ SkyLayerSpecification: object

# Type declaration

Name Type
id string
layout? object
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.sky-atmosphere-color? ColorSpecification
paint.sky-atmosphere-halo-color? ColorSpecification
paint.sky-atmosphere-sun? PropertyValueSpecificationEx<[number, number]>
paint.sky-atmosphere-sun-intensity? number
paint.sky-gradient? ExpressionSpecificationEx
paint.sky-gradient-center? PropertyValueSpecificationEx<[number, number]>
paint.sky-gradient-radius? PropertyValueSpecificationEx<number>
paint.sky-opacity? PropertyValueSpecificationEx<number>
paint.sky-type? PropertyValueSpecificationEx<"gradient" | "atmosphere">
type "sky"

# SourceBoundUtils

Ƭ SourceBoundUtils: MapGlUtils


# SourceFunctionSpecification

Ƭ SourceFunctionSpecification<T>: { default?: T ; property: string ; stops: [number, T][] ; type: "exponential" } | { default?: T ; property: string ; stops: [number, T][] ; type: "interval" } | { default?: T ; property: string ; stops: [string | number | boolean, T][] ; type: "categorical" } | { default?: T ; property: string ; type: "identity" }

# Type parameters

Name
T

# SourceOrData

Ƭ SourceOrData: SourceSpecification | string | GeoJsonGeomertry


# SourceRef

Ƭ SourceRef: LayerRef


# SourceRefFunc0

Ƭ SourceRefFunc0: (arg0: SourceRef) => void

# Type declaration

▸ (arg0: SourceRef): void

# Parameters

Name Type
arg0 SourceRef

Returns: void


# SourceRefFunc1

Ƭ SourceRefFunc1<T1>: (arg0: SourceRef, arg1: T1) => void

# Type parameters

Name
T1

# Type declaration

▸ (arg0: SourceRef, arg1: T1): void

# Parameters

Name Type
arg0 SourceRef
arg1 T1

Returns: void


# SourceRefFunc2

Ƭ SourceRefFunc2<T1, T2>: (arg0: SourceRef, arg1: T1, arg2: T2) => void

# Type parameters

Name
T1
T2

# Type declaration

▸ (arg0: SourceRef, arg1: T1, arg2: T2): void

# Parameters

Name Type
arg0 SourceRef
arg1 T1
arg2 T2

Returns: void


# SourceRefFunc3

Ƭ SourceRefFunc3<T1, T2, T3>: (arg0: SourceRef, arg1: T1, arg2: T2, arg3: T3) => void

# Type parameters

Name
T1
T2
T3

# Type declaration

▸ (arg0: SourceRef, arg1: T1, arg2: T2, arg3: T3): void

# Parameters

Name Type
arg0 SourceRef
arg1 T1
arg2 T2
arg3 T3

Returns: void


# SourceSpecification

Ƭ SourceSpecification: VectorSourceSpecification | RasterSourceSpecification | RasterDEMSourceSpecification | GeoJSONSourceSpecification | VideoSourceSpecification | ImageSourceSpecification


# StyleSpecification

Ƭ StyleSpecification: object

# Type declaration

Name Type
bearing? number
center? number[]
fog? FogSpecification
glyphs? string
layers LayerSpecification[]
light? LightSpecification
metadata? unknown
name? string
pitch? number
sources Record<string, SourceSpecification>
sprite? string
terrain? TerrainSpecificationEx
transition? TransitionSpecification
version 8
zoom? number

# SymbolLayerSpecification

Ƭ SymbolLayerSpecification: object

# Type declaration

Name Type
filter? FilterSpecification
id string
layout? object
layout.icon-allow-overlap? PropertyValueSpecificationEx<boolean>
layout.icon-anchor? DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right">
layout.icon-ignore-placement? PropertyValueSpecificationEx<boolean>
layout.icon-image? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
layout.icon-keep-upright? PropertyValueSpecificationEx<boolean>
layout.icon-offset? DataDrivenPropertyValueSpecification<[number, number]>
layout.icon-optional? PropertyValueSpecificationEx<boolean>
layout.icon-padding? PropertyValueSpecificationEx<number>
layout.icon-pitch-alignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
layout.icon-rotate? DataDrivenPropertyValueSpecification<number>
layout.icon-rotation-alignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
layout.icon-size? DataDrivenPropertyValueSpecification<number>
layout.icon-text-fit? PropertyValueSpecificationEx<"none" | "width" | "height" | "both">
layout.icon-text-fit-padding? PropertyValueSpecificationEx<[number, number, number, number]>
layout.symbol-avoid-edges? PropertyValueSpecificationEx<boolean>
layout.symbol-placement? PropertyValueSpecificationEx<"point" | "line" | "line-center">
layout.symbol-sort-key? DataDrivenPropertyValueSpecification<number>
layout.symbol-spacing? PropertyValueSpecificationEx<number>
layout.symbol-z-order? PropertyValueSpecificationEx<"auto" | "viewport-y" | "source">
layout.text-allow-overlap? PropertyValueSpecificationEx<boolean>
layout.text-anchor? DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right">
layout.text-field? DataDrivenPropertyValueSpecification<FormattedSpecification>
layout.text-font? DataDrivenPropertyValueSpecification<string[]>
layout.text-ignore-placement? PropertyValueSpecificationEx<boolean>
layout.text-justify? DataDrivenPropertyValueSpecification<"auto" | "left" | "center" | "right">
layout.text-keep-upright? PropertyValueSpecificationEx<boolean>
layout.text-letter-spacing? DataDrivenPropertyValueSpecification<number>
layout.text-line-height? DataDrivenPropertyValueSpecification<number>
layout.text-max-angle? PropertyValueSpecificationEx<number>
layout.text-max-width? DataDrivenPropertyValueSpecification<number>
layout.text-offset? DataDrivenPropertyValueSpecification<[number, number]>
layout.text-optional? PropertyValueSpecificationEx<boolean>
layout.text-padding? PropertyValueSpecificationEx<number>
layout.text-pitch-alignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
layout.text-radial-offset? DataDrivenPropertyValueSpecification<number>
layout.text-rotate? DataDrivenPropertyValueSpecification<number>
layout.text-rotation-alignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
layout.text-size? DataDrivenPropertyValueSpecification<number>
layout.text-transform? DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">
layout.text-variable-anchor? PropertyValueSpecificationEx<("center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right")[]>
layout.text-writing-mode? PropertyValueSpecificationEx<("horizontal" | "vertical")[]>
layout.visibility? "visible" | "none"
maxzoom? number
metadata? unknown
minzoom? number
paint? object
paint.icon-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.icon-halo-blur? DataDrivenPropertyValueSpecification<number>
paint.icon-halo-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.icon-halo-width? DataDrivenPropertyValueSpecification<number>
paint.icon-opacity? DataDrivenPropertyValueSpecification<number>
paint.icon-translate? PropertyValueSpecificationEx<[number, number]>
paint.icon-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
paint.text-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.text-halo-blur? DataDrivenPropertyValueSpecification<number>
paint.text-halo-color? DataDrivenPropertyValueSpecification<ColorSpecification>
paint.text-halo-width? DataDrivenPropertyValueSpecification<number>
paint.text-opacity? DataDrivenPropertyValueSpecification<number>
paint.text-translate? PropertyValueSpecificationEx<[number, number]>
paint.text-translate-anchor? PropertyValueSpecificationEx<"map" | "viewport">
source string
source-layer? string
type "symbol"

# SymbolLayerStyleProp

Ƭ SymbolLayerStyleProp: object

# Type declaration

Name Type
filter? FilterSpecification
iconAllowOverlap? PropertyValueSpecificationEx<boolean>
iconAnchor? DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right">
iconColor? DataDrivenPropertyValueSpecification<ColorSpecification>
iconHaloBlur? DataDrivenPropertyValueSpecification<number>
iconHaloColor? DataDrivenPropertyValueSpecification<ColorSpecification>
iconHaloWidth? DataDrivenPropertyValueSpecification<number>
iconIgnorePlacement? PropertyValueSpecificationEx<boolean>
iconImage? DataDrivenPropertyValueSpecification<ResolvedImageSpecification>
iconKeepUpright? PropertyValueSpecificationEx<boolean>
iconOffset? DataDrivenPropertyValueSpecification<[number, number]>
iconOpacity? DataDrivenPropertyValueSpecification<number>
iconOptional? PropertyValueSpecificationEx<boolean>
iconPadding? PropertyValueSpecificationEx<number>
iconPitchAlignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
iconRotate? DataDrivenPropertyValueSpecification<number>
iconRotationAlignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
iconSize? DataDrivenPropertyValueSpecification<number>
iconTextFit? PropertyValueSpecificationEx<"none" | "width" | "height" | "both">
iconTextFitPadding? PropertyValueSpecificationEx<[number, number, number, number]>
iconTranslate? PropertyValueSpecificationEx<[number, number]>
iconTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
maxzoom? number
metadata? unknown
minzoom? number
source? string
sourceLayer? string
symbolAvoidEdges? PropertyValueSpecificationEx<boolean>
symbolPlacement? PropertyValueSpecificationEx<"point" | "line" | "line-center">
symbolSortKey? DataDrivenPropertyValueSpecification<number>
symbolSpacing? PropertyValueSpecificationEx<number>
symbolZOrder? PropertyValueSpecificationEx<"auto" | "viewport-y" | "source">
textAllowOverlap? PropertyValueSpecificationEx<boolean>
textAnchor? DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right">
textColor? DataDrivenPropertyValueSpecification<ColorSpecification>
textField? DataDrivenPropertyValueSpecification<FormattedSpecification>
textFont? DataDrivenPropertyValueSpecification<string[]>
textHaloBlur? DataDrivenPropertyValueSpecification<number>
textHaloColor? DataDrivenPropertyValueSpecification<ColorSpecification>
textHaloWidth? DataDrivenPropertyValueSpecification<number>
textIgnorePlacement? PropertyValueSpecificationEx<boolean>
textJustify? DataDrivenPropertyValueSpecification<"auto" | "left" | "center" | "right">
textKeepUpright? PropertyValueSpecificationEx<boolean>
textLetterSpacing? DataDrivenPropertyValueSpecification<number>
textLineHeight? DataDrivenPropertyValueSpecification<number>
textMaxAngle? PropertyValueSpecificationEx<number>
textMaxWidth? DataDrivenPropertyValueSpecification<number>
textOffset? DataDrivenPropertyValueSpecification<[number, number]>
textOpacity? DataDrivenPropertyValueSpecification<number>
textOptional? PropertyValueSpecificationEx<boolean>
textPadding? PropertyValueSpecificationEx<number>
textPitchAlignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
textRadialOffset? DataDrivenPropertyValueSpecification<number>
textRotate? DataDrivenPropertyValueSpecification<number>
textRotationAlignment? PropertyValueSpecificationEx<"map" | "viewport" | "auto">
textSize? DataDrivenPropertyValueSpecification<number>
textTransform? DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">
textTranslate? PropertyValueSpecificationEx<[number, number]>
textTranslateAnchor? PropertyValueSpecificationEx<"map" | "viewport">
textVariableAnchor? PropertyValueSpecificationEx<("center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right")[]>
textWritingMode? PropertyValueSpecificationEx<("horizontal" | "vertical")[]>
visibility? "visible" | "none"

# TerrainSpecificationEx

Ƭ TerrainSpecificationEx: object

# Type declaration

Name Type
exaggeration? PropertyValueSpecificationEx<number>
source string

# TransitionSpecification

Ƭ TransitionSpecification: object

# Type declaration

Name Type
delay? number
duration? number

# VectorSourceSpecification

Ƭ VectorSourceSpecification: object

# Type declaration

Name Type
attribution? string
bounds? [number, number, number, number]
maxzoom? number
minzoom? number
promoteId? PromoteIdSpecificationEx
scheme? "xyz" | "tms"
tiles? string[]
type "vector"
url? string
volatile? boolean

# VideoSourceSpecification

Ƭ VideoSourceSpecification: object

# Type declaration

Name Type
coordinates [[number, number], [number, number], [number, number], [number, number]]
type "video"
urls string[]

# mat2dtype

Ƭ mat2dtype: [number, number, number, number, number, number] | Float32Array


# mat2type

Ƭ mat2type: [number, number, number, number] | Float32Array


# mat3type

Ƭ mat3type: [number, number, number, number, number, number, number, number, number] | Float32Array


# mat4type

Ƭ mat4type: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number] | Float32Array


# quattype

Ƭ quattype: [number, number, number, number] | Float32Array


# vec2type

Ƭ vec2type: [number, number] | Float32Array


# vec3type

Ƭ vec3type: [number, number, number] | Float32Array


# vec4type

Ƭ vec4type: [number, number, number, number] | Float32Array