Skip to content

Types ​

GeoJSONFeatureI ​

表示一个GeoJSON要素的接口

Type: GeoJSONFeatureI

Examples ​

javascript
GeoJSON.Feature<
 GeoJSON.Geometry & (GeoJSON.Point | GeoJSON.LineString | GeoJSON.Polygon),
 GeoJSON.GeoJsonProperties
>

FeatureType ​

基础要素类型

Type: ("circle" | "polygon" | "polyline" | "polygonExtrusion" | "symbol" | "heatmap")

CapitalizeStr ​

将字符串的第一个字母转换为大写字母

Type: CapitalizeStr

Examples ​

javascript
type CapitalizeStr<Str extends string> =
   Str extends `${infer First}-${infer Rest}`
     ? `${First}${Capitalize<CapitalizeStr<Rest>>}`
     : Str

CapitalizeKey ​

将对象的键的第一个字母转换为大写字母

Type: CapitalizeKey

Examples ​

javascript
type CapitalizeKey<obj extends object> = {
 [Key in keyof obj as CapitalizeStr<Key & string>]: obj[Key]
}

PluginStatus ​

插件状态

Type: ("unavailable" | "loading" | "loaded" | "error")

LngLatLike ​

经度和纬度

Type: ([number, number] | LngLat | {lng: number, lat: number} | {lon: number, lat: number})

LngLatBoundsLike ​

经纬度范围

Type: (LngLatBounds | [LngLatLike, LngLatLike] | [number, number, number, number])

PointLike ​

点

Type: (Point | [number, number])

Offset ​

偏移量

Type: (number | PointLike | {: PointLike})

ExpressionName ​

表达式名称

Type: ("array" | "boolean" | "collator" | "format" | "literal" | "number" | "number-format" | "object" | "string" | "image" | "to-boolean" | "to-color" | "to-number" | "to-string" | "typeof" | "feature-state" | "geometry-type" | "id" | "line-progress" | "properties" | "at" | "get" | "has" | "in" | "index-of" | "length" | "slice" | "!" | "!=" | "<" | "<=" | "==" | ">" | ">=" | "all" | "any" | "case" | "match" | "coalesce" | "within" | "interpolate" | "interpolate-hcl" | "interpolate-lab" | "step" | "let" | "var" | "concat" | "downcase" | "is-supported-script" | "resolved-locale" | "upcase" | "rgb" | "rgba" | "to-rgba" | "-" | "*" | "/" | "%" | "^" | "+" | "abs" | "acos" | "asin" | "atan" | "ceil" | "cos" | "e" | "floor" | "ln" | "ln2" | "log10" | "log2" | "max" | "min" | "pi" | "round" | "sin" | "sqrt" | "tan" | "zoom" | "heatmap-density")

Expression ​

表达式

Type: [ExpressionName, ...Array<any>]

Anchor ​

锚点

Type: ("center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right")

DragPanOptions ​

拖拽平移选项

Type: {linearity: number?, easing: function (t: number): number?, deceleration: number?, maxSpeed: number?}

Properties ​

  • linearity number?
  • easing function (t: number): number?
  • deceleration number?
  • maxSpeed number?

InteractiveOptions ​

交互选项

Type: {around: "center" | "auto"?}

Properties ​

  • around ("center" | "auto")?

MapboxOptions ​

Mapbox选项

Properties ​

  • container (string | HTMLElement) 地图容器

  • style (Style | string | undefined) 样式

  • antialias (boolean | undefined)? 是否开启抗锯齿

  • attributionControl (boolean | undefined)? 是否开启属性控制

  • bearing (number | undefined)? 地图旋转角度

  • bearingSnap (number | undefined)? 地图旋转角度的吸附值

  • bounds (LngLatBoundsLike | undefined)? 地图的边界

  • boxZoom (boolean | undefined)? 是否开启框选缩放

  • center (LngLatLike | undefined)? 地图中心点

  • clickTolerance (number | undefined)? 点击容差

  • collectResourceTiming (boolean | undefined)? 是否收集资源时间

  • crossSourceCollisions (boolean | undefined)? 是否允许跨源碰撞

  • cooperativeGestures boolean?? 是否启用协作手势

  • customAttribution (string | Array<string> | undefined)? 自定义属性

  • dragPan (boolean | DragPanOptions | undefined)? 是否启用拖拽平移

  • dragRotate (boolean | undefined)? 是否启用拖拽旋转

  • doubleClickZoom (boolean | undefined)? 是否启用双击缩放

  • hash (boolean | string | undefined)? 是否启用hash

  • fadeDuration (number | undefined)? 淡入淡出时间

  • failIfMajorPerformanceCaveat (boolean | undefined)? 是否在性能严重下降时停止渲染

  • fitBoundsOptions (FitBoundsOptions | undefined)? fitBounds选项

  • interactive (boolean | undefined)? 是否启用交互

  • keyboard (boolean | undefined)? 是否启用键盘

  • localFontFamily (string | undefined)? 本地字体族

  • localIdeographFontFamily (string | undefined)? 本地表意字字体族

  • maxBounds (LngLatBoundsLike | undefined)? 最大边界

  • maxPitch (number | undefined)? 最大俯仰角

  • maxZoom (number | undefined)? 最大缩放级别

  • minPitch (number | undefined)? 最小俯仰角

  • minZoom (number | undefined)? 最小缩放级别

  • optimizeForTerrain (boolean | undefined)? 是否优化地形

  • preserveDrawingBuffer (boolean | undefined)? 是否保留绘图缓冲区

  • pitch (number | undefined)? 俯仰角

  • projection Projection?? 投影方式

  • pitchWithRotate (boolean | undefined)? 是否随旋转而俯仰

  • refreshExpiredTiles (boolean | undefined)? 是否刷新过期瓦片

  • renderWorldCopies (boolean | undefined)? 是否渲染世界复制品

  • scrollZoom (boolean | InteractiveOptions | undefined)? 是否启用滚轮缩放

  • trackResize (boolean | undefined)? 是否跟踪调整大小

  • transformRequest (TransformRequestFunction | undefined)? 转换请求函数

  • touchZoomRotate (boolean | InteractiveOptions | undefined)? 是否启用触摸缩放旋转

  • touchPitch (boolean | InteractiveOptions | undefined)? 是否启用触摸俯仰

  • zoom (number | undefined)? 缩放级别

  • maxTileCacheSize (number | undefined)? 最大瓦片缓存大小

  • accessToken (string | undefined)? 访问令牌

  • testMode (boolean | undefined)? 是否测试模式

  • worldview (string | undefined)? 世界视角

  • showCollisionBoxes (boolean | undefined)? 是否显示碰撞盒

quat ​

四元数

Type: Array<number>

vec3 ​

三维向量

Type: Array<number>

FreeCameraOptions ​

自由相机选项

constructor ​

创建FreeCameraOptions的实例

Parameters ​

position ​

相机位置

Type: (MercatorCoordinate | undefined)

lookAtPoint ​

将相机视角转向某个点

Parameters ​

Returns void

setPitchBearing ​

设置相机的俯仰角和方位角

Parameters ​

  • pitch number
  • bearing number

Returns void

ResourceType ​

资源类型

Type: ("Unknown" | "Style" | "Source" | "Tile" | "Glyphs" | "SpriteImage" | "SpriteJSON" | "Image")

RequestParameters ​

请求参数

Properties ​

  • url string
  • credentials ("same-origin" | "include" | undefined)?
  • method ("GET" | "POST" | "PUT" | undefined)?
  • collectResourceTiming (boolean | undefined)?

TransformRequestFunction ​

将请求参数转换为资源类型

Type: function (url: string, resourceType: ResourceType): RequestParameters

PaddingOptions ​

边距选项

Properties ​

  • top number
  • bottom number
  • left number
  • right number

FeatureIdentifier ​

要素标识符

Properties ​

  • id (string | number | undefined)?
  • source string
  • sourceLayer (string | undefined)?

BoxZoomHandler ​

框选缩放处理器

constructor ​

创建BoxZoomHandler的实例

Parameters ​

isEnabled ​

是否启用

Returns boolean

isActive ​

是否激活

Returns boolean

enable ​

启用框选缩放

Returns void

disable ​

禁用框选缩放

Returns void

ScrollZoomHandler ​

滚轮缩放处理器

constructor ​

创建ScrollZoomHandler的实例

Parameters ​

isEnabled ​

判断是否启用

Returns boolean

enable ​

启用滚轮缩放

Parameters ​

Returns void

disable ​

禁用滚轮缩放

Returns void

setZoomRate ​

设置缩放速率

Parameters ​

  • zoomRate number

Returns void

setWheelZoomRate ​

设置滚轮缩放速率

Parameters ​

  • wheelZoomRate number

Returns void

DragPanHandler ​

拖拽平移处理器

constructor ​

创建DragPanHandler的实例

Parameters ​

isEnabled ​

判断是否启用

Returns boolean

isActive ​

判断是否激活

Returns boolean

enable ​

启用拖拽平移

Parameters ​

Returns void

disable ​

禁用拖拽平移

Returns void

DragRotateHandler ​

拖拽旋转处理器

constructor ​

创建DragRotateHandler的实例

Parameters ​

  • map Map
  • options {bearingSnap: (number | undefined)?, pitchWithRotate: (boolean | undefined)?}?

isEnabled ​

判断是否启用

Returns boolean

isActive ​

判断是否激活

Returns boolean

enable ​

启用拖拽旋转

Returns void

disable ​

禁用拖拽旋转

Returns void

KeyboardHandler ​

处理键盘事件的处理器

constructor ​

创建KeyboardHandler的实例

Parameters ​

isEnabled ​

判断是否启用

Returns boolean

enable ​

启用键盘事件处理

Returns void

disable ​

禁用键盘事件处理

Returns void

isActive ​

判断是否激活

Returns boolean

disableRotation ​

禁用旋转

Returns void

enableRotation ​

启用旋转

Returns void

DoubleClickZoomHandler ​

处理双击缩放的处理器

constructor ​

创建DoubleClickZoomHandler的实例

Parameters ​

isEnabled ​

判断是否启用

Returns boolean

enable ​

启用双击缩放

Returns void

disable ​

禁用双击缩放

Returns void

TouchZoomRotateHandler ​

处理触摸缩放和旋转的处理器

constructor ​

创建TouchZoomRotateHandler的实例

Parameters ​

isEnabled ​

判断是否启用

Returns boolean

enable ​

启用触摸缩放和旋转

Parameters ​

Returns void

disable ​

禁用触摸缩放和旋转

Returns void

disableRotation ​

禁用旋转

Returns void

enableRotation ​

启用旋转

Returns void

TouchPitchHandler ​

触摸倾斜处理器

constructor ​

创建TouchPitchHandler的实例

Parameters ​

enable ​

启用触摸倾斜

Parameters ​

Returns void

isActive ​

判断是否激活

Returns boolean

isEnabled ​

判断是否启用

Returns boolean

disable ​

禁用触摸倾斜

Returns void

IControl ​

控件接口

Properties ​

  • onAdd function
  • onRemove function
  • getDefaultPosition function?

Control ​

控件
继承Evented
实现IControl

onAdd ​

添加控件

Parameters ​

Returns HTMLElement

onRemove ​

移除控件

Parameters ​

Returns void

getDefaultPosition ​

获取默认位置

Type: (function (): string | undefined)

PositionOptions ​

位置选项

enableHighAccuracy ​

是否启用高精度

Type: (boolean | undefined)?

timeout ​

超时时间

Type: (number | undefined)?

maximumAge ​

最大缓存时间

Type: (number | undefined)?

FullscreenControlOptions ​

全屏控制选项

Properties ​

  • container (HTMLElement | null | undefined)?

PopupOptions ​

弹出框选项

Properties ​

  • closeButton (boolean | undefined)? 是否显示关闭按钮
  • closeOnClick (boolean | undefined)? 是否在点击地图时关闭弹出框
  • closeOnMove (boolean | undefined)? 是否在移动地图时关闭弹出框
  • focusAfterOpen (boolean | null | undefined)? 是否在打开弹出框后聚焦
  • anchor (Anchor | undefined)? 锚点
  • offset (Offset | null | undefined)? 偏移量
  • className (string | undefined)? 类名
  • maxWidth (string | undefined)? 最大宽度

Style ​

样式

Properties ​

  • layers Array<AnyLayer> 图层
  • sources Sources 数据源
  • bearing (number | undefined)? 旋转角度
  • center (Array<number> | undefined)? 中心点坐标
  • fog (Fog | undefined)? 雾效
  • glyphs (string | undefined)? 字体图标
  • metadata any? 元数据
  • name (string | undefined)? 名称
  • pitch (number | undefined)? 俯仰角度
  • light (Light | undefined)? 光照
  • sprite (string | undefined)? 精灵图
  • terrain (TerrainSpecification | undefined)? 地形
  • transition (Transition | undefined)? 过渡
  • version number 版本
  • zoom (number | undefined)? 缩放等级

Transition ​

过渡

Properties ​

  • delay (number | undefined)? 延迟时间
  • duration (number | undefined)? 持续时间

Light ​

光照

Properties ​

  • anchor (("map" | "viewport" | undefined))? 锚点
  • position (Array<number> | undefined)? 位置
  • position-transition (Transition | undefined)? 位置过渡
  • color (string | undefined)? 颜色
  • color-transition (Transition | undefined)? 颜色过渡
  • intensity (number | undefined)? 强度
  • intensity-transition (Transition | undefined)? 强度过渡

Fog ​

雾

Properties ​

  • color (string | Expression | undefined)? 雾的颜色
  • horizon-blend (number | Expression | undefined)? 地平线混合
  • range (Array<number> | Expression | undefined)? 范围

Sources ​

数据源

PromoteIdSpecification ​

ID提升规范

Type: ({: string} | string)

AnySourceData ​

数据源

Type: (GeoJSONSourceRaw | VideoSourceRaw | ImageSourceRaw | CanvasSourceRaw | VectorSource | RasterSource | RasterDemSource | CustomSourceInterface<(HTMLImageElement | ImageData | ImageBitmap)>)

VectorSourceImpl ​

Extends VectorSource

矢量数据源
继承VectorSource

Properties ​

  • setTiles function 设置瓦片
  • setUrl function 设置URL

AnySourceImpl ​

任意数据源

Type: (GeoJSONSource | VideoSource | ImageSource | CanvasSource | VectorSourceImpl | RasterSource | RasterDemSource | CustomSource<(HTMLImageElement | ImageData | ImageBitmap)>)

Source ​

数据源

Properties ​

  • type ("vector" | "raster" | "raster-dem" | "geojson" | "image" | "video" | "canvas" | "custom") 数据源类型

GeoJSONSourceRaw ​

Extends Source, GeoJSONSourceOptions

GeoJSON数据源
继承GeoJSONSourceOptions
实现Source

Properties ​

  • type ("geojson") 数据源类型

GeoJSONSource ​

GeoJSON数据源
实现GeoJSONSourceRaw

type ​

数据源类型

Type: "geojson"

constructor ​

构造函数

Parameters ​

setData ​

设置数据

Parameters ​

  • data (GeoJSON.Feature<GeoJSON.Geometry> | GeoJSON.FeatureCollection<GeoJSON.Geometry> | string)

Returns this

getClusterExpansionZoom ​

获取聚合扩展缩放级别

Parameters ​

  • clusterId number
  • callback function (error: any, zoom: number): void

Returns this

getClusterChildren ​

获取聚合子元素

Parameters ​

  • clusterId number
  • callback function (error: any, features: Array<GeoJSON.Feature<GeoJSON.Geometry>>): void

Returns this

getClusterLeaves ​

获取聚合叶子元素

Parameters ​

  • cluserId number
  • limit number
  • offset number
  • callback function (error: any, features: Array<GeoJSON.Feature<GeoJSON.Geometry>>): void

Returns this

GeoJSONSourceOptionsData ​

GeoJSON数据源选项

Type: (GeoJSON.Feature<GeoJSON.Geometry> | GeoJSON.FeatureCollection<GeoJSON.Geometry> | GeoJSON.Geometry | string | undefined)

Examples ​

javascript
type GeoJSONSourceOptionsData =
 | GeoJSON.Feature<GeoJSON.Geometry>
 | GeoJSON.FeatureCollection<GeoJSON.Geometry>
 | GeoJSON.Geometry
 | string
 | undefined

GeoJSONSourceOptions ​

GeoJSON数据源选项

Properties ​

  • data (GeoJSONSourceOptionsData)? 数据
  • maxzoom (number | undefined)? 最大缩放级别
  • attribution (string | undefined)? 版权信息
  • buffer (number | undefined)? 缓冲区大小
  • tolerance (number | undefined)? 容差
  • cluster (number | boolean | undefined)? 是否聚合
  • clusterRadius (number | undefined)? 聚合半径
  • clusterMaxZoom (number | undefined)? 聚合最大缩放级别
  • clusterMinPoints (number | undefined)? 聚合最小点数
  • clusterProperties (object | undefined)? 聚合属性
  • lineMetrics (boolean | undefined)? 是否计算线路度量
  • generateId (boolean | undefined)? 是否生成ID
  • promoteId (PromoteIdSpecification | undefined)? ID提升规范
  • filter any?? 过滤器

VideoSourceRaw ​

Extends Source, VideoSourceOptions

视频数据源
继承VideoSourceOptions
继承Source

Properties ​

  • type ("video") 数据源类型

VideoSource ​

视频数据源
实现VideoSourceRaw

type ​

数据源类型

Type: "video"

constructor ​

创建VideoSource实例

Parameters ​

getVideo ​

获取HTMLVideoElement

Returns HTMLVideoElement

setCoordinates ​

设置坐标

Parameters ​

  • coordinates Array<Array<number>>

Returns this

VideoSourceOptions ​

视频数据源选项

Properties ​

  • urls (Array<string> | undefined)? 视频地址

ImageSourceRaw ​

Extends Source, ImageSourceOptions

图片数据源
继承ImageSourceOptions
继承Source

Properties ​

  • type ("image") 数据源类型

ImageSource ​

图片数据源
实现ImageSourceRaw

type ​

数据源类型

Type: "image"

constructor ​

创建ImageSource实例

Parameters ​

updateImage ​

更新图片

Parameters ​

Returns this

setCoordinates ​

设置坐标

Parameters ​

  • coordinates Array<Array<number>>

Returns this

ImageSourceOptions ​

图片数据源选项

Properties ​

  • url (string | undefined)? 图片地址

CanvasSourceRaw ​

Extends Source, CanvasSourceOptions

画布数据源
继承Source 继承CanvasSourceOptions

Properties ​

  • type ("canvas") 数据源类型

CanvasSource ​

画布数据源
实现CanvasSourceRaw

type ​

数据源类型

Type: "canvas"

coordinates ​

坐标

Type: Array<Array<number>>

canvas ​

画布元素

Type: (string | HTMLCanvasElement)

play ​

播放画布

Returns void

pause ​

暂停画布

Returns void

getCanvas ​

获取HTMLCanvasElement

Returns HTMLCanvasElement

setCoordinates ​

设置坐标

Parameters ​

  • coordinates Array<Array<number>>

Returns this

CanvasSourceOptions ​

画布数据源选项

Properties ​

  • animate (boolean | undefined)? 是否动画
  • canvas (string | HTMLCanvasElement) 画布元素

CameraFunctionSpecification ​

相机函数规范

Type: ({type: "exponential", stops: Array<[number, T]>} | {type: "interval", stops: Array<[number, T]>})

ExpressionSpecification ​

表达式规范

Type: Array<any>

PropertyValueSpecification ​

属性值规范

Type: (T | CameraFunctionSpecification<T> | ExpressionSpecification)

TerrainSpecification ​

地形规范

Properties ​

SourceVectorLayer ​

用于矢量图层的源

Type: {id: string, fields: Record<string, string>?, description: string?, minzoom: number?, maxzoom: number?, source: string?, source_name: string?}

Properties ​

  • id string
  • fields Record<string, string>?
  • description string?
  • minzoom number?
  • maxzoom number?
  • source string?
  • source_name string?

VectorSource ​

矢量源选项 继承Source

Properties ​

  • type ("vector") 数据源类型
  • format ("pbf" | undefined)? 源格式
  • url (string | undefined)? 源URL
  • id (string | undefined)? 源ID
  • name (string | undefined)? 源名称
  • tiles (Array<string> | undefined)? 瓦片URL
  • bounds (Array<number> | undefined)? 边界
  • scheme ("xyz" | "tms" | undefined)? 瓦片方案
  • minzoom (number | undefined)? 最小缩放级别
  • maxzoom (number | undefined)? 最大缩放级别
  • attribution (string | undefined)? 版权信息
  • promoteId (PromoteIdSpecification | undefined)? 提升ID规范
  • vector_layers (Array<SourceVectorLayer> | undefined)? 矢量图层

RasterSource ​

栅格源 继承Source

Properties ​

  • name string? 名称
  • type ("raster") 数据源类型
  • id string? ID
  • format ("webp" | string)? 格式
  • url (string | undefined)? URL
  • tiles (Array<string> | undefined)? 瓦片
  • bounds (Array<number> | undefined)? 边界
  • minzoom (number | undefined)? 最小缩放级别
  • maxzoom (number | undefined)? 最大缩放级别
  • tileSize (number | undefined)? 瓦片大小
  • scheme ("xyz" | "tms" | undefined)? 瓦片方案
  • attribution (string | undefined)? 版权信息

RasterDemSource ​

栅格DEM源 继承Source

Properties ​

  • name string? 名称
  • type ("raster-dem") 数据源类型
  • id string? ID
  • url (string | undefined)? URL
  • tiles (Array<string> | undefined)? 瓦片
  • bounds (Array<number> | undefined)? 边界
  • minzoom (number | undefined)? 最小缩放级别
  • maxzoom (number | undefined)? 最大缩放级别
  • tileSize (number | undefined)? 瓦片大小
  • attribution (string | undefined)? 版权信息
  • encoding ("terrarium" | "mapbox" | undefined)? 编码

CustomSourceInterface ​

自定义源

Properties ​

  • id string ID
  • type ("custom") 类型
  • dataType ("raster") 数据类型
  • minzoom (number | undefined)? 最小缩放级别
  • maxzoom (number | undefined)? 最大缩放级别
  • scheme (string | undefined)? 瓦片方案
  • tileSize (number | undefined)? 瓦片大小
  • attribution (string | undefined)? 版权信息
  • bounds ([number, number, number, number] | undefined)? 边界
  • hasTile function? 是否有瓦片
  • loadTile function 加载瓦片
  • prepareTile function? 准备瓦片
  • unloadTile function? 卸载瓦片
  • onAdd function? 添加事件
  • onRemove function? 移除事件

CustomSource ​

自定义数据源 继承Source

Properties ​

  • id string ID
  • type ("custom") 类型
  • scheme string 瓦片方案
  • minzoom number 最小缩放级别
  • maxzoom number 最大缩放级别
  • tileSize number 瓦片大小
  • attribution string 版权信息
  • _implementation CustomSourceInterface<T> 自定义数据源接口

Alignment ​

对齐方式

Type: ("map" | "viewport" | "auto")

MarkerOptions ​

标记选项

Properties ​

  • element (HTMLElement | undefined)? 标记元素
  • offset (PointLike | undefined)? 偏移量
  • anchor (Anchor | undefined)? 锚点
  • color (string | undefined)? 颜色
  • draggable (boolean | undefined)? 是否可拖拽
  • clickTolerance (number | null | undefined)? 点击容差
  • rotation (number | undefined)? 旋转角度
  • rotationAlignment (Alignment | undefined)? 旋转对齐方式
  • pitchAlignment (Alignment | undefined)? 倾斜对齐方式
  • scale (number | undefined)? 缩放比例

EventedListener ​

事件监听器

Type: function (object: object): any

StyleOptions ​

样式选项

Properties ​

  • transition (boolean | undefined)? 是否启用过渡效果

MapboxGeoJSONFeature ​

Mapbox GeoJSON要素

Type: MapboxGeoJSONFeature

Examples ​

javascript
type MapboxGeoJSONFeature = GeoJSON.Feature<GeoJSON.Geometry> & {
 layer: Layer
 source: string
 sourceLayer: string
 state: { [key: string]: any }
}

EventData ​

事件data

Type: {: any}

Properties ​

  • `` any

Examples ​

javascript
type EventData = { [key: string]: any }

MapboxEvent ​

Mapbox事件

type ​

事件类型

Type: string

target ​

事件目标

Type: Map

originalEvent ​

原始事件

Type: TOrig

MapMouseEvent ​

地图鼠标事件 继承MapboxEvent

type ​

鼠标事件类型

Type: ("mousedown" | "mouseup" | "click" | "dblclick" | "mousemove" | "mouseover" | "mouseenter" | "mouseleave" | "mouseout" | "contextmenu")

point ​

鼠标事件发生的点

Type: Point

lngLat ​

鼠标事件发生的经纬度

Type: LngLat

preventDefault ​

阻止默认行为

Returns void

defaultPrevented ​

是否阻止了默认行为

Type: boolean

MapLayerMouseEvent ​

地图图层鼠标事件

Type: MapLayerMouseEvent

Examples ​

javascript
type MapLayerMouseEvent = MapMouseEvent & {
 features?: MapboxGeoJSONFeature[]
}

MapTouchEvent ​

地图触摸事件 继承MapboxEvent

type ​

触摸事件类型

Type: ("touchstart" | "touchend" | "touchcancel")

point ​

触摸事件发生的点

Type: Point

lngLat ​

触摸事件发生的经纬度

Type: LngLat

points ​

触摸事件发生的所有点

Type: Array<Point>

lngLats ​

触摸事件发生的所有经纬度

Type: Array<LngLat>

preventDefault ​

阻止默认行为

Returns void

defaultPrevented ​

是否阻止了默认行为

Type: boolean

MapLayerTouchEvent ​

地图图层触摸事件

Type: MapLayerTouchEvent

Examples ​

javascript
type MapLayerTouchEvent = MapTouchEvent & {
 features?: MapboxGeoJSONFeature[]
}

MapWheelEvent ​

地图滚轮事件 继承MapboxEvent

type ​

滚轮事件类型

Type: "wheel"

preventDefault ​

阻止默认行为

Returns void

defaultPrevented ​

是否阻止了默认行为

Type: boolean

MapBoxZoomEvent ​

地图框选事件 继承MapboxEvent

Properties ​

  • type ("boxzoomstart" | "boxzoomend" | "boxzoomcancel") 框选事件类型
  • boxZoomBounds LngLatBounds 框选的经纬度范围

MapDataEvent ​

地图数据事件

Type: (MapSourceDataEvent | MapStyleDataEvent)

MapStyleDataEvent ​

地图样式数据事件 继承MapboxEvent

Properties ​

  • dataType ("style") 数据类型

MapSourceDataEvent ​

地图源数据事件 继承MapboxEvent

Properties ​

  • dataType ("source") 数据类型
  • isSourceLoaded boolean 地图源是否已加载
  • source Source 地图源
  • sourceId string 地图源ID
  • sourceDataType ("metadata" | "content") 数据类型
  • tile any 瓦片
  • coord Coordinate 坐标

Coordinate ​

坐标

Properties ​

CanonicalCoordinate ​

规范化坐标

Properties ​

  • x number x坐标
  • y number y坐标
  • z number z坐标
  • key number 坐标键
  • equals function 判断两个规范化坐标是否相等

MapContextEvent ​

地图WebGL上下文事件 继承MapboxEvent

Properties ​

  • type ("webglcontextlost" | "webglcontextrestored") 事件类型

ErrorEvent ​

地图错误事件 继承MapboxEvent

type ​

事件类型

Type: "error"

error ​

错误对象

Type: Error

FilterOptions ​

用于过滤的选项

Properties ​

  • validate (boolean | null | undefined)? 是否验证

AnimationOptions ​

动画选项

Properties ​

  • duration (number | undefined)? 持续时间
  • easing function? 缓动函数
  • offset (PointLike | undefined)? 偏移量
  • animate (boolean | undefined)? 是否动画
  • essential (boolean | undefined)? 是否必要

CameraOptions ​

相机选项

Properties ​

  • center (LngLatLike | undefined)? 中心点
  • zoom (number | undefined)? 缩放级别
  • bearing (number | undefined)? 旋转角度
  • pitch (number | undefined)? 倾斜角度
  • around (LngLatLike | undefined)? 围绕点
  • padding (number | PaddingOptions | undefined)? 填充

CameraForBoundsOptions ​

用于边界的相机选项 继承CameraOptions

Properties ​

  • offset (PointLike | undefined)? 偏移量
  • maxZoom (number | undefined)? 最大缩放级别

CameraForBoundsOptions ​

用于边界的相机选项
继承CameraOptions

Properties ​

  • offset (PointLike | undefined)? 偏移量
  • maxZoom (number | undefined)? 最大缩放级别

CameraForBoundsResult ​

用于边界的相机结果

Type: CameraForBoundsResult

Examples ​

javascript
type CameraForBoundsResult = Required<
   Pick<CameraOptions, "zoom" | "bearing">
 > & {
   center: { lng: number; lat: number }
 }

FlyToOptions ​

用于飞行动画的相机选项
继承AnimationOptions
继承CameraOptions

Properties ​

  • curve (number | undefined)? 动画曲线的张力
  • minZoom (number | undefined)? 最小缩放级别
  • speed (number | undefined)? 动画速度
  • screenSpeed (number | undefined)? 屏幕速度
  • maxDuration (number | undefined)? 最大动画持续时间
  • maxDuration (number | undefined)? 最大动画持续时间

EaseToOptions ​

用于缓动动画的相机选项
继承AnimationOptions
继承CameraOptions

Properties ​

  • delayEndEvents (number | undefined)? 结束事件的延迟时间

FitBoundsOptions ​

用于适应边界的相机选项
继承FlyToOptions

Properties ​

  • linear (boolean | undefined)? 是否使用线性过渡
  • offset (PointLike | undefined)? 相机偏移量
  • maxZoom (number | undefined)? 最大缩放级别
  • maxDuration (number | undefined)? 最大动画持续时间

MapEventType ​

地图事件类型

Type: {error: ErrorEvent, load: MapboxEvent, idle: MapboxEvent, remove: MapboxEvent, render: MapboxEvent, resize: MapboxEvent, webglcontextlost: MapContextEvent, webglcontextrestored: MapContextEvent, dataloading: MapDataEvent, data: MapDataEvent, tiledataloading: MapDataEvent, sourcedataloading: MapSourceDataEvent, styledataloading: MapStyleDataEvent, sourcedata: MapSourceDataEvent, styledata: MapStyleDataEvent, boxzoomcancel: MapBoxZoomEvent, boxzoomstart: MapBoxZoomEvent, boxzoomend: MapBoxZoomEvent, touchcancel: MapTouchEvent, touchmove: MapTouchEvent, touchend: MapTouchEvent, touchstart: MapTouchEvent, click: MapMouseEvent, contextmenu: MapMouseEvent, dblclick: MapMouseEvent, mousemove: MapMouseEvent, mouseup: MapMouseEvent, mousedown: MapMouseEvent, mouseout: MapMouseEvent, mouseover: MapMouseEvent, movestart: MapboxEvent<(MouseEvent | TouchEvent | WheelEvent | undefined)>, move: MapboxEvent<(MouseEvent | TouchEvent | WheelEvent | undefined)>, moveend: MapboxEvent<(MouseEvent | TouchEvent | WheelEvent | undefined)>, zoomstart: MapboxEvent<(MouseEvent | TouchEvent | WheelEvent | undefined)>, zoom: MapboxEvent<(MouseEvent | TouchEvent | WheelEvent | undefined)>, zoomend: MapboxEvent<(MouseEvent | TouchEvent | WheelEvent | undefined)>, rotatestart: MapboxEvent<(MouseEvent | TouchEvent | undefined)>, rotate: MapboxEvent<(MouseEvent | TouchEvent | undefined)>, rotateend: MapboxEvent<(MouseEvent | TouchEvent | undefined)>, dragstart: MapboxEvent<(MouseEvent | TouchEvent | undefined)>, drag: MapboxEvent<(MouseEvent | TouchEvent | undefined)>, dragend: MapboxEvent<(MouseEvent | TouchEvent | undefined)>, pitchstart: MapboxEvent<(MouseEvent | TouchEvent | undefined)>, pitch: MapboxEvent<(MouseEvent | TouchEvent | undefined)>, pitchend: MapboxEvent<(MouseEvent | TouchEvent | undefined)>, wheel: MapWheelEvent}

Properties ​

MapLayerEventType ​

地图图层事件类型

Type: {click: MapLayerMouseEvent, dblclick: MapLayerMouseEvent, mousedown: MapLayerMouseEvent, mouseup: MapLayerMouseEvent, mousemove: MapLayerMouseEvent, mouseenter: MapLayerMouseEvent, mouseleave: MapLayerMouseEvent, mouseover: MapLayerMouseEvent, mouseout: MapLayerMouseEvent, contextmenu: MapLayerMouseEvent, touchstart: MapLayerTouchEvent, touchend: MapLayerTouchEvent, touchcancel: MapLayerTouchEvent}

Properties ​

AnyLayout ​

任意图层布局

Type: (BackgroundLayout | FillLayout | FillExtrusionLayout | LineLayout | SymbolLayout | RasterLayout | CircleLayout | HeatmapLayout | HillshadeLayout | SkyLayout)

AnyPaint ​

任意图层绘制

Type: (BackgroundPaint | FillPaint | FillExtrusionPaint | LinePaint | SymbolPaint | RasterPaint | CirclePaint | HeatmapPaint | HillshadePaint | SkyPaint)

Layer ​

地图图层

Properties ​

  • id string 图层ID
  • type string 图层类型
  • layout (AnyLayout | undefined)? 图层布局
  • paint (AnyPaint | undefined)? 图层绘制
  • ref string? 引用
  • source (string | AnySourceData | undefined)? 数据源
  • minzoom (number | undefined)? 最小缩放级别
  • maxzoom (number | undefined)? 最大缩放级别
  • interactive (boolean | undefined)? 是否可交互
  • filter (Array<any> | undefined)? 过滤器
  • layout (AnyLayout | undefined)? 图层布局
  • paint (AnyPaint | undefined)? 图层绘制

BackgroundLayer ​

背景图层 继承Layer

Properties ​

TCircleLayer ​

圆形图层 继承Layer

Properties ​

  • type ("circle") 图层类型
  • layout (CircleLayout | undefined)? 图层布局
  • paint (CirclePaint | undefined)? 图层绘制

FillExtrusionLayer ​

填充拉伸图层 继承Layer

Properties ​

FillLayer ​

填充图层 继承Layer

Properties ​

  • type ("fill") 图层类型
  • layout (FillLayout | undefined)? 图层布局
  • paint (FillPaint | undefined)? 图层绘制

THeatmapLayer ​

热力图层 继承Layer

Properties ​

HillshadeLayer ​

遮蔽山地图层 继承Layer

Properties ​

LineLayer ​

线图层 继承Layer

Properties ​

  • type ("line") 图层类型
  • layout (LineLayout | undefined)? 图层布局
  • paint (LinePaint | undefined)? 图层绘制

TRasterLayer ​

栅格图层 继承Layer

Properties ​

  • type ("raster") 图层类型
  • layout (RasterLayout | undefined)? 图层布局
  • paint (RasterPaint | undefined)? 图层绘制

TSymbolLayer ​

符号图层 继承Layer

Properties ​

  • type ("symbol") 图层类型
  • layout (SymbolLayout | undefined)? 图层布局
  • paint (SymbolPaint | undefined)? 图层绘制

SkyLayer ​

天空图层 继承Layer

Properties ​

  • type ("sky") 图层类型
  • layout (SkyLayout | undefined)? 图层布局
  • paint (SkyPaint | undefined)? 图层绘制

AnyLayer ​

任意图层

Type: (BackgroundLayer | TCircleLayer | FillExtrusionLayer | FillLayer | THeatmapLayer | HillshadeLayer | LineLayer | TRasterLayer | TSymbolLayer | CustomLayerInterface | SkyLayer)

CustomLayerInterface ​

自定义图层接口

Properties ​

  • id string 图层id
  • type ("custom") 图层类型
  • renderingMode ("2d" | "3d" | undefined)? 渲染模式
  • onRemove function? 移除图层
  • onAdd function? 添加图层
  • prerender function? 预渲染
  • render function 渲染

StyleFunction ​

样式函数

Properties ​

  • property (string | undefined)? 属性
  • base (number | undefined)? 基础
  • type ("identity" | "exponential" | "interval" | "categorical" | undefined)? 类型
  • default any? 默认值
  • colorSpace ("rgb" | "lab" | "hcl" | undefined)? 颜色空间

Visibility ​

可见性

Type: ("visible" | "none")

Layout ​

布局

Properties ​

BackgroundLayout ​

背景布局 继承Layout

BackgroundPaint ​

背景画笔

Properties ​

  • background-color (string | Expression | undefined)? 背景颜色
  • background-color-transition (Transition | undefined)? 背景颜色过渡
  • background-pattern (string | undefined)? 背景图案
  • background-pattern-transition (Transition | undefined)? 背景图案过渡
  • background-opacity (number | Expression | undefined)? 背景透明度
  • background-opacity-transition (Transition | undefined)? 背景透明度过渡

FillLayout ​

填充布局 继承Layout

Properties ​

  • fill-sort-key (number | Expression | undefined)? 填充排序键

FillPaint ​

填充画笔

Properties ​

  • fill-antialias (boolean | Expression | undefined)? 是否开启抗锯齿
  • fill-opacity (number | StyleFunction | Expression | undefined)? 填充不透明度
  • fill-opacity-transition (Transition | undefined)? 填充不透明度过渡
  • fill-color (string | StyleFunction | Expression | undefined)? 填充颜色
  • fill-color-transition (Transition | undefined)? 填充颜色过渡
  • fill-outline-color (string | StyleFunction | Expression | undefined)? 填充轮廓颜色
  • fill-outline-color-transition (Transition | undefined)? 填充轮廓颜色过渡
  • fill-translate (Array<number> | undefined)? 填充平移
  • fill-translate-transition (Transition | undefined)? 填充平移过渡
  • fill-translate-anchor ("map" | "viewport" | undefined)? 填充平移锚点
  • fill-pattern (string | Expression | undefined)? 填充图案
  • fill-pattern-transition (Transition | undefined)? 填充图案过渡

FillExtrusionLayout ​

用于填充立体建筑物的样式 继承Layout

FillExtrusionPaint ​

用于填充立体建筑物的样式

Properties ​

  • fill-extrusion-opacity (number | Expression | undefined)? 填充立体建筑物的不透明度
  • fill-extrusion-opacity-transition (Transition | undefined)? 填充立体建筑物的不透明度过渡
  • fill-extrusion-color (string | StyleFunction | Expression | undefined)? 填充立体建筑物的颜色
  • fill-extrusion-color-transition (Transition | undefined)? 填充立体建筑物的颜色过渡
  • fill-extrusion-translate (Array<number> | Expression | undefined)? 填充立体建筑物的平移
  • fill-extrusion-translate-transition (Transition | undefined)? 填充立体建筑物的平移过渡
  • fill-extrusion-translate-anchor ("map" | "viewport" | undefined)? 填充立体建筑物的平移锚点
  • fill-extrusion-pattern (string | Expression | undefined)? 填充立体建筑物的图案
  • fill-extrusion-pattern-transition (Transition | undefined)? 填充立体建筑物的图案过渡
  • fill-extrusion-height (number | StyleFunction | Expression | undefined)? 填充立体建筑物的高度
  • fill-extrusion-height-transition (Transition | undefined)? 填充立体建筑物的高度过渡
  • fill-extrusion-base (number | StyleFunction | Expression | undefined)? 填充立体建筑物的底部高度
  • fill-extrusion-base-transition (Transition | undefined)? 填充立体建筑物的底部高度过渡
  • fill-extrusion-vertical-gradient (boolean | undefined)? 是否使用垂直渐变填充立体建筑物

LineLayout ​

用于线条的样式 继承Layout

Properties ​

  • line-cap ("butt" | "round" | "square" | Expression | undefined)? 线条端点的样式
  • line-join ("bevel" | "round" | "miter" | Expression | undefined)? 线条连接点的样式
  • line-miter-limit (number | Expression | undefined)? 线条连接点的最大斜接长度
  • line-round-limit (number | Expression | undefined)? 线条连接点的最大圆角半径
  • line-sort-key (number | Expression | undefined)? 线条的排序关键字

LinePaint ​

用于线条的绘制样式

Properties ​

  • line-opacity (number | StyleFunction | Expression | undefined)? 线条透明度
  • line-opacity-transition (Transition | undefined)? 线条透明度过渡
  • line-color (string | StyleFunction | Expression | undefined)? 线条颜色
  • line-color-transition (Transition | undefined)? 线条颜色过渡
  • line-translate (Array<number> | Expression | undefined)? 线条平移
  • line-translate-transition (Transition | undefined)? 线条平移过渡
  • line-translate-anchor ("map" | "viewport" | undefined)? 线条平移的锚点
  • line-width (number | StyleFunction | Expression | undefined)? 线条宽度
  • line-width-transition (Transition | undefined)? 线条宽度过渡
  • line-gap-width (number | StyleFunction | Expression | undefined)? 线条间隔宽度
  • line-gap-width-transition (Transition | undefined)? 线条间隔宽度过渡
  • line-offset (number | StyleFunction | Expression | undefined)? 线条偏移量
  • line-offset-transition (Transition | undefined)? 线条偏移量过渡
  • line-blur (number | StyleFunction | Expression | undefined)? 线条模糊度
  • line-blur-transition (Transition | undefined)? 线条模糊度过渡
  • line-dasharray (Array<number> | Expression | undefined)? 线条虚线样式
  • line-dasharray-transition (Transition | undefined)? 线条虚线样式过渡
  • line-pattern (string | Expression | undefined)? 线条纹理
  • line-pattern-transition (Transition | undefined)? 线条纹理过渡
  • line-gradient (Expression | undefined)? 线条渐变

SymbolLayout ​

符号布局 继承Layout

Properties ​

  • symbol-placement ("point" | "line" | "line-center" | undefined)? 符号放置方式
  • symbol-spacing (number | Expression | undefined)? 符号间距
  • symbol-avoid-edges (boolean | undefined)? 是否避开边缘
  • symbol-z-order ("viewport-y" | "source" | undefined)? 符号Z轴顺序
  • icon-allow-overlap (boolean | StyleFunction | Expression | undefined)? 是否允许图标重叠
  • icon-ignore-placement (boolean | Expression | undefined)? 是否忽略图标布局
  • icon-optional (boolean | undefined)? 是否可选
  • icon-rotation-alignment ("map" | "viewport" | "auto" | undefined)? 图标旋转对齐方式
  • icon-size (number | StyleFunction | Expression | undefined)? 图标大小
  • icon-text-fit ("none" | "both" | "width" | "height" | undefined)? 图标文本适配方式
  • icon-text-fit-padding (Array<number> | Expression | undefined)? 图标文本适配内边距
  • icon-image (string | StyleFunction | Expression | undefined)? 图标图片
  • icon-rotate (number | StyleFunction | Expression | undefined)? 图标旋转角度
  • icon-padding (number | Expression | undefined)? 图标内边距
  • icon-keep-upright (boolean | undefined)? 图标是否保持垂直
  • icon-offset (Array<number> | StyleFunction | Expression | undefined)? 图标偏移量
  • icon-anchor (Anchor | StyleFunction | Expression | undefined)? 图标锚点
  • icon-pitch-alignment ("map" | "viewport" | "auto" | undefined)? 图标倾斜对齐方式
  • text-pitch-alignment ("map" | "viewport" | "auto" | undefined)? 文本倾斜对齐方式
  • text-field (string | StyleFunction | Expression | undefined)? 文本内容
  • text-font (Array<string> | Expression | undefined)? 文本字体, 只允许“normal”和“bold”两种
  • text-size (number | StyleFunction | Expression | undefined)? 文本大小,px
  • text-max-width (number | StyleFunction | Expression | undefined)? 文本最大宽度
  • text-line-height (number | Expression | undefined)? 文本行高
  • text-letter-spacing (number | Expression | undefined)? 文本字间距
  • text-justify ("auto" | "left" | "center" | "right" | Expression | undefined)? 文本对齐方式
  • text-anchor (Anchor | StyleFunction | Expression | undefined)? 文本锚点
  • text-max-angle (number | Expression | undefined)? 文本最大角度
  • text-rotate (number | StyleFunction | Expression | undefined)? 文本旋转角度
  • text-padding (number | Expression | undefined)? 文本内边距
  • text-keep-upright (boolean | undefined)? 文本是否保持垂直
  • text-transform ("none" | "uppercase" | "lowercase" | StyleFunction | Expression | undefined)? 文本转换方式
  • text-offset (Array<number> | Expression | undefined)? 文本偏移量
  • text-allow-overlap (boolean | undefined)? 文本是否允许重叠
  • text-ignore-placement (boolean | undefined)? 文本是否忽略布局
  • text-optional (boolean | undefined)? 文本是否可选
  • text-radial-offset (number | Expression | undefined)? 文本径向偏移量
  • text-variable-anchor (Array<Anchor> | undefined)? 文本可变锚点
  • text-writing-mode (Array<("horizontal" | "vertical")> | undefined)? 文本书写方式
  • symbol-sort-key (number | Expression | undefined)? 符号排序键

SymbolPaint ​

符号绘制样式

Properties ​

  • icon-opacity (number | StyleFunction | Expression | undefined)? 图标透明度
  • icon-opacity-transition (Transition | undefined)? 图标透明度过渡
  • icon-color (string | StyleFunction | Expression | undefined)? 图标颜色
  • icon-color-transition (Transition | undefined)? 图标颜色过渡
  • icon-halo-color (string | StyleFunction | Expression | undefined)? 图标光晕颜色
  • icon-halo-color-transition (Transition | undefined)? 图标光晕颜色过渡
  • icon-halo-width (number | StyleFunction | Expression | undefined)? 图标光晕宽度
  • icon-halo-width-transition (Transition | undefined)? 图标光晕宽度过渡
  • icon-halo-blur (number | StyleFunction | Expression | undefined)? 图标光晕模糊度
  • icon-halo-blur-transition (Transition | undefined)? 图标光晕模糊度过渡
  • icon-translate (Array<number> | Expression | undefined)? 图标平移
  • icon-translate-transition (Transition | undefined)? 图标平移过渡
  • icon-translate-anchor ("map" | "viewport" | undefined)? 图标平移锚点
  • text-opacity (number | StyleFunction | Expression | undefined)? 文本透明度
  • text-opacity-transition (Transition | undefined)? 文本透明度过渡
  • text-color (string | StyleFunction | Expression | undefined)? 文本颜色
  • text-color-transition (Transition | undefined)? 文本颜色过渡
  • text-halo-color (string | StyleFunction | Expression | undefined)? 文本光晕颜色
  • text-halo-color-transition (Transition | undefined)? 文本光晕颜色过渡
  • text-halo-width (number | StyleFunction | Expression | undefined)? 文本光晕宽度
  • text-halo-width-transition (Transition | undefined)? 文本光晕宽度过渡
  • text-halo-blur (number | StyleFunction | Expression | undefined)? 文本光晕模糊度
  • text-halo-blur-transition (Transition | undefined)? 文本光晕模糊度过渡
  • text-translate (Array<number> | Expression | undefined)? 文本平移
  • text-translate-transition (Transition | undefined)? 文本平移过渡
  • text-translate-anchor ("map" | "viewport" | undefined)? 文本平移锚点

RasterLayout ​

矢量栅格图层布局 继承Layout

RasterPaint ​

矢量栅格图层绘制

Properties ​

  • raster-opacity (number | Expression | undefined)? 栅格图层透明度
  • raster-opacity-transition (Transition | undefined)? 栅格图层透明度过渡
  • raster-hue-rotate (number | Expression | undefined)? 栅格图层色相旋转
  • raster-hue-rotate-transition (Transition | undefined)? 栅格图层色相旋转过渡
  • raster-brightness-min (number | Expression | undefined)? 栅格图层最小亮度
  • raster-brightness-min-transition (Transition | undefined)? 栅格图层最小亮度过渡
  • raster-brightness-max (number | Expression | undefined)? 栅格图层最大亮度
  • raster-brightness-max-transition (Transition | undefined)? 栅格图层最大亮度过渡
  • raster-saturation (number | Expression | undefined)? 栅格图层饱和度
  • raster-saturation-transition (Transition | undefined)? 栅格图层饱和度过渡
  • raster-contrast (number | Expression | undefined)? 栅格图层对比度
  • raster-contrast-transition (Transition | undefined)? 栅格图层对比度过渡
  • raster-fade-duration (number | Expression | undefined)? 栅格图层淡出时间
  • raster-resampling ("linear" | "nearest" | undefined)? 栅格图层重采样方式

CircleLayout ​

圆形图层布局 继承Layout

Properties ​

  • circle-sort-key (number | Expression | undefined)? 圆形图层排序关键字

CirclePaint ​

圆形图层绘制

Properties ​

  • circle-radius (number | StyleFunction | Expression | undefined)? 圆形半径
  • circle-radius-transition (Transition | undefined)? 圆形半径过渡
  • circle-color (string | StyleFunction | Expression | undefined)? 圆形颜色
  • circle-color-transition (Transition | undefined)? 圆形颜色过渡
  • circle-blur (number | StyleFunction | Expression | undefined)? 圆形模糊度
  • circle-blur-transition (Transition | undefined)? 圆形模糊度过渡
  • circle-opacity (number | StyleFunction | Expression | undefined)? 圆形透明度
  • circle-opacity-transition (Transition | undefined)? 圆形透明度过渡
  • circle-translate (Array<number> | Expression | undefined)? 圆形平移
  • circle-translate-transition (Transition | undefined)? 圆形平移过渡
  • circle-translate-anchor ("map" | "viewport" | undefined)? 圆形平移锚点
  • circle-pitch-scale ("map" | "viewport" | undefined)? 圆形俯仰缩放
  • circle-pitch-alignment ("map" | "viewport" | undefined)? 圆形俯仰对齐
  • circle-stroke-width (number | StyleFunction | Expression | undefined)? 圆形描边宽度
  • circle-stroke-width-transition (Transition | undefined)? 圆形描边宽度过渡
  • circle-stroke-color (string | StyleFunction | Expression | undefined)? 圆形描边颜色
  • circle-stroke-color-transition (Transition | undefined)? 圆形描边颜色过渡
  • circle-stroke-opacity (string | StyleFunction | Expression | undefined)? 圆形描边透明度
  • circle-stroke-opacity-transition (Transition | undefined)? 圆形描边透明度过渡

HeatmapLayout ​

热力图图层布局 继承Layout

HeatmapPaint ​

热力图绘制样式

Properties ​

HillshadeLayout ​

山体阴影图层布局 继承Layout

HillshadePaint ​

山体阴影绘制样式

Properties ​

  • hillshade-illumination-direction (number | Expression | undefined)? 光照方向,0为正北,90为正东,180为正南,270为正西
  • hillshade-illumination-anchor ("map" | "viewport" | undefined)? 光照方向相对于地图还是视口
  • hillshade-exaggeration (number | Expression | undefined)? 高程放大系数
  • hillshade-exaggeration-transition (Transition | undefined)? 高程放大系数过渡
  • hillshade-shadow-color (string | Expression | undefined)? 阴影颜色
  • hillshade-shadow-color-transition (Transition | undefined)? 阴影颜色过渡
  • hillshade-highlight-color (string | Expression | undefined)? 高亮颜色
  • hillshade-highlight-color-transition (Transition | undefined)? 高亮颜色过渡
  • hillshade-accent-color (string | Expression | undefined)? 强调颜色
  • hillshade-accent-color-transition (Transition | undefined)? 强调颜色过渡

SkyLayout ​

天空图层布局 继承Layout

SkyPaint ​

用于设置天空的绘制样式

Properties ​

  • sky-atmosphere-color (string | Expression | undefined)? 大气层颜色
  • sky-atmosphere-halo-color (string | Expression | undefined)? 大气层光晕颜色
  • sky-atmosphere-sun (Array<number> | Expression | undefined)? 太阳位置
  • sky-atmosphere-sun-intensity (number | Expression | undefined)? 太阳强度
  • sky-gradient (string | Expression | undefined)? 渐变颜色
  • sky-gradient-center (Array<number> | Expression | undefined)? 渐变中心位置
  • sky-gradient-radius (number | Expression | undefined)? 渐变半径
  • sky-opacity (number | Expression | undefined)? 天空透明度
  • sky-type ("gradient" | "atmosphere" | undefined)? 天空类型

ElevationQueryOptions ​

用于设置获取高程的参数

Type: {exaggerated: boolean}

Properties ​

  • exaggerated boolean

Projection ​

用于设置地图投影方式的参数

Properties ​

  • center [number, number]? 投影中心点
  • parallels [number, number]? 投影平行线