# 样式规格
# 填充样式(Fill)
填充配置适用于面状的图层。
# fill-antialias
类型:Boolean
,默认值:true
。
填充面是否以抗锯齿的形式绘制。
# fill-color
类型:color
,默认值:#000000
。设置fill-pattern
后无效。支持 joinData表达式
以及 interpolate表达式
。
填充面的颜色。颜色支持以 rgba
形式来指定透明度。但如果此图层同时指定了填充面的边界线样式,透明度不会对边界线的样式产生影响。
# fill-opacity
类型:0~1之间的数字
,默认值:1
。支持 joinData表达式
以及 interpolate表达式
。
填充面的不透明度,同 fill-color
一样,如果此图层同时指定了填充面的边界线样式,透明度不会对边界线的样式产生影响。
# fill-pattern
类型:Image
。
在填充面中绘制的图像名称,图像的宽度和高度必须是 2 的整数次方(2,4,8,……,512)。如果使用 zoom
表达式,只有整数类型的 zoom
级别参与计算。
# fill-sort-key
类型:number
。
根据这个值对几何要素进行升序排序。要素的这个值越高,显示的层级越高。
# fill-translate
类型: Array<number>
。单位:像素
。默认值:[0, 0]
。
要素的几何位置偏移量,以 [x, y]
的形式表示,负值表示向左和上偏移。
# fill-translate-anchor
类型:枚举
,可选map
,viewport
。默认map
。需要指定fill-translate。
控制偏移的参考点。
map
:相对于地图偏移。viewport
:相对于视窗偏移。
# visibility
类型:枚举
,可选visible
,none
。默认visible
。
图层是否显示。visible
为显示,none
为隐藏。
# 线样式(Line)
线配置适用于线状的图层。
# line-blur
类型:大于等于 0 的数字
,单位:像素
。支持 joinData表达式
以及 interpolate表达式
。
线虚化的像素值。
# line-cap
类型:枚举
,可选butt
,round
,square
。默认butt
。
线段两端的显示方式。
butt
:方型末端,仅绘制到直线端点。round
:圆型末端,以线宽的 1/2 为半径,以线端点为圆心,超出线端点绘制。square
:方型末端,以线宽的 1/2 长度超出线端点绘制。
# line-color
类型:color
,默认值:#000000
。如果指定line-pattern
则此参数无效,支持 joinData表达式
以及 interpolate表达式
。
绘制线的颜色。
# line-dasharray
类型:array
,单位: 线宽。设置line-pattern
后无效。
指定生成虚线的实部和虚部长度。设置的长度会随着线宽进行缩放。将长度乘以当前线宽即为虚线的实际像素数。
# line-gap-width
类型: number
。单位:像素
。默认值:0
。
在线的实际路径外部绘制线套。设置的值表示内间距。
# line-gradient
类型:color
。设置line-pattern
后无效。只适用于geojson
数据源。支持 interpolate表达式
。
为线类型的要素定义渐变色。
# line-join
类型:枚举
,可选bevel
,round
,miter
。默认miter
。
线段两端的显示方式。
bevel
:方型交点,以线宽的 1/2 长度超出交点绘制。round
:圆型交点,以线宽的 1/2 为半径,以交点为圆心绘制,超出交点绘制。miter
:尖型交角,以两线段外沿相交,超出交点绘制。
# line-miter-limit
类型: number
。默认值:0
。需要将line-join
指定为miter
。
用来将锐利的尖型交角自动地转换为方型交角。
# line-offset
类型: number
。单位:像素
。默认值:0
。
线的偏移。对于线状要素,正值表示相对于线走向的右边偏移。对于多边形要素,正值表示内缩(inset),负值表示外突(outset)。
# line-opacity
类型:0~1之间的数字
,默认值:1
。支持 joinData表达式
以及 interpolate表达式
。
绘制线的不透明度。
# line-pattern
类型:Image
。
在线中绘制的图像名称,图像的宽度和高度必须是 2 的整数次方(2,4,8,……,512)。如果使用 zoom
表达式,只有整数类型的 zoom
级别参与计算。
# line-round-limit
类型: number
。默认值:1.05
。需要将line-join
指定为round
。
用来将平浅的圆型交角自动地转换为尖型交角。
# line-sort-key
类型:number
。
根据这个值对几何要素进行升序排序。要素的这个值越高,显示的层级越高。
# line-translate
类型: Array<number>
。单位:像素
。默认值:[0, 0]
。
要素的几何位置偏移量,以 [x, y]
的形式表示,负值表示向左和上偏移。
# line-translate-anchor
类型:枚举
,可选map
,viewport
。默认map
。需要指定line-translate。
控制偏移的参考点。
map
:相对于地图偏移。viewport
:相对于视窗偏移。
# line-width
类型: number
。单位:像素
。默认值:0
。
绘制线的宽度。
# visibility
类型:枚举
,可选visible
,none
。默认visible
。
图层是否显示。visible
为显示,none
为隐藏。
# 文字样式(Text)
文字配置适用于点状数据的文字显示效果。
# text-allow-overlap
类型: boolean
。默认值:false
。需要指定text-field。
设置为 true 时,文本标注即使碰撞到其他绘制的注记也会显示。
# text-anchor
类型:枚举
,可选center
,left
,right
,top
,bottom
,top-left
,top-right
,bottom-left
,bottom-right
。默认center
。
三维模式下仅支持center
,left
,right
,top
,bottom
。
文本停靠到锚点的部分。
center
:文本中心停靠到锚点。left
:文本左边停靠到锚点。right
:文本右边停靠到锚点。top
:文本顶部停靠到锚点。bottom
:文本底部停靠到锚点。top-left
:文本的左上角停靠到锚点。top-right
:文本的右上角停靠到锚点。bottom-left
:文本的左下角停靠到锚点。bottom-right
:文本的右下角停靠到锚点。
# text-color
类型:color
,默认值:#000000
。需要指定text-field。
绘制文本的颜色。
# text-field
类型:string
。
用来作为文本标注的字段。用 {field_name}
指示使用要素的哪个字段。
# text-font
类型:array
,默认值:['Microsoft YaHei Regular']
。需要指定text-field。
# text-halo-blur
类型: number
。单位:像素
。默认值:0
。需要指定text-field。
光晕向外渐变的宽度。
# text-halo-color
类型:color
,默认值:#000000
。需要指定text-field。
文本光晕的颜色,用于区别于背景。
# text-halo-width
类型: number
。单位:像素
。默认值:0
。需要指定text-field。支持 joinData表达式
以及 interpolate表达式
。
光晕离字体轮廓线的距离。二维场景下最大值为字体大小的 1/4。三维场景下最大值为15。
# text-ignore-placement
类型: boolean
。默认值:false
。需要指定text-field。
设置为 true 时,其他注记即使碰撞到此文本标注也会显示。
# text-justify
类型:枚举
,可选left
,center
,right
。默认center
。需要指定text-field。
center
:文本居中。left
:文本左对齐。right
:文本右对齐。
# text-keep-upright
类型: boolean
。默认值:true
。需要指定text-field,需要指定text-rotation-alignment为 map
,需要指定symbol-placement为 line
。
如果设置为 true,文本可以被翻转以避免图标上下颠倒。
# text-letter-spacing
类型: number
。单位:ems
。默认值:0
。需要指定text-field。
字符间距。
# text-line-height
类型: number
。单位:ems
。默认值:1.2
。需要指定text-field。
多行文本的行高。
# text-max-angle
类型: number
,单位:度
,默认值:45
。需要指定text-field,需要指定symbol-placement 为 line
。
相邻字符的最大夹角。
# text-max-width
类型: number
。单位:ems
。默认值:10
。需要指定text-field。
文本折行的最大行度。
# text-offset
类型: Array<number>
。单位:ems
。默认值:[0, 0]
。需要指定text-field。
文本与其锚点的偏移量。正值表示向右和下偏移,负值表示向左和上偏移。
# text-opacity
类型:0~1之间的数字
,默认值:1
。支持 joinData表达式
以及 interpolate表达式
。
绘制文本的不透明度。
# text-optional
类型: boolean
。默认值:false
。需要指定text-field,icon-image。
设置为 true 时,当此文本注记与其他注记碰撞而图标未碰撞时,仅显示此注记的图标而不显示文本。
# text-padding
类型: number
。单位:像素
。默认值:0
。需要指定text-field。
文本框四周的额外空间,用以检测注记碰撞。
# text-pitch-alignment
类型:枚举
,可选map
,viewport
,auto
。默认auto
。需要指定text-field。
当地图倾斜时文本的方向。
map
:文本与地图平面对齐。viewport
:文本与视窗平面对齐。auto
:自动地与text-rotation-alignment
设置相匹配。
# text-rotate
类型: number
,单位:度
,默认值:0
。需要指定text-field。
顺时针旋转文本的角度。
# text-rotation-alignment
类型:枚举
,可选map
,viewport
,auto
。默认auto
。需要指定text-field。
与 symbol-placement
结合使用,确定构成文本的单个字型的旋转行为。
map
:当symbol-placement
设置为point
时,将文本与东西方向对齐。当symbol-placement
设置为line
时,将文本的 x 轴与线对齐。viewport
:将字型的 x 轴与视窗的 x 轴对齐,无论symbol-placement
设置为哪个值。auto
:当symbol-placement
设置为point
时,与viewport
行为一致。当symbol-placement
设置为line
时,与map
行为一致。
# text-size
类型: number
。单位:像素
。默认值:16
。需要指定text-field。
字体大小。
# text-transform
类型:枚举
,可选none
,uppercase
,lowercase
。默认none
。需要指定text-field。
设置文本的大小写,类似于 CSS 的 text-transform
属性。
none
:文本保持不变。uppercase
:强制使所有的字符大写。lowercase
:强制使所有的字符小写。
# text-translate
类型: Array<number>
。单位:像素
。默认值:[0, 0]
。需要指定text-field。
要素的几何位置偏移量,以 [x, y]
的形式表示,负值表示向左和上偏移。
# text-translate-anchor
类型:枚举
,可选map
,viewport
。默认map
。需要指定text-field,text-translate。
控制偏移的参考点。
map
:相对于地图偏移。viewport
:相对于视窗偏移。
# text-variable-anchor
类型:枚举类型的数组
,可选center
,left
,right
,top
,bottom
,top-left
,top-right
,bottom-left
,bottom-right
。需要指定text-field,需要指定symbol-placement 为 point
。
为了尽可能的显示出地图中某些优先级高的图标文字,开发者可以通过这个属性提供一个text-anchor
数组,地图 SDK 将会按照这个数组的顺序,依次尝试在地图中绘制这个图标文字。
center
:文本中心停靠到锚点。left
:文本左边停靠到锚点。right
:文本右边停靠到锚点。top
:文本顶部停靠到锚点。bottom
:文本底部停靠到锚点。top-left
:文本的左上角停靠到锚点。top-right
:文本的右上角停靠到锚点。bottom-left
:文本的左下角停靠到锚点。bottom-right
:文本的右下角停靠到锚点。
# text-writing-mode
类型:枚举
,可选horizontal
,vertical
。需要指定text-field。
文本的书写方向。如果文本不支持以指定的方向绘制,将会按照文本语言的默认书写方向进行显示。
horizontal
:水平方向显示。vertical
:垂直方向显示。
# visibility
类型:枚举
,可选visible
,none
。默认visible
。
图层是否显示。visible
为显示,none
为隐藏。
# 图标样式(Icon)
图标配置适用于点状数据的图标显示效果。
# icon-allow-overlap
类型: boolean
。默认值:false
。需要指定icon-image。
设置为 true 时,图标符号即使碰撞到其他绘制的注记也会显示。
# icon-anchor
类型:枚举类型的数组
,可选center
,left
,right
,top
,bottom
,top-left
,top-right
,bottom-left
,bottom-right
。默认 center
。需要指定icon-image。
三维模式下仅支持center
,left
,right
,top
,bottom
。
将图标的指定位置固定在锚点处。
center
:图标中心停靠到锚点。left
:图标左边停靠到锚点。right
:图标右边停靠到锚点。top
:图标顶部停靠到锚点。bottom
:图标底部停靠到锚点。top-left
:图标的左上角停靠到锚点。top-right
:图标的右上角停靠到锚点。bottom-left
:图标的左下角停靠到锚点。bottom-right
:图标的右下角停靠到锚点。
# icon-color
类型:color
,默认值:#000000
。需要指定icon-image。
图标的颜色。仅对 sdf 格式的图标有效。
# icon-halo-blur
类型: number
。单位:像素
。默认值:0
。需要指定icon-image。
光晕向外渐变的宽度。
# icon-halo-color
类型:color
,默认值:#000000
。需要指定icon-image。
图标的光晕颜色。仅对 sdf 格式的图标有效。
# icon-halo-width
类型: number
。单位:像素
。默认值:0
。需要指定icon-image。
光晕到图标轮廓的距离。
# icon-ignore-placement
类型: boolean
。默认值:false
。需要指定icon-image。
设置为 true 时,其他注记即使碰撞到此图标符号也会显示。
# icon-image
类型:Image
。
图标资源对应的 id。
# icon-keep-upright
类型: boolean
。默认值:true
。需要指定icon-image,需要指定icon-rotation-alignment为 map
,需要指定symbol-placement为 line
。
如果设置为 true,图标可以被翻转以避免图标上下颠倒。
# icon-offset
类型: Array<number>
。默认值:[0, 0]
。需要指定icon-image。
图标与其锚点的偏移量。正值表示向右和下偏移,负值表示向左和上偏移。
# icon-opacity
类型:0~1之间的数字
,默认值:1
。支持 joinData表达式
以及 interpolate表达式
。
绘制图标的不透明度。
# icon-optional
类型: boolean
。默认值:false
。需要指定text-field,icon-image。
设置为 true 时,当此注记的图标与其他注记碰撞而文本未碰撞时,仅显示此注记的文本而不显示图标。
# icon-padding
类型: number
。单位:像素
。默认值:2
。需要指定icon-image。
包围在图标 bbox 外的额外空间,用以检测注记碰撞。
# icon-pitch-alignment
类型:枚举
,可选map
,viewport
,auto
。默认auto
。需要指定icon-image。
当地图倾斜时图标的方向。
map
:图标与地图平面对齐。viewport
:图标与视窗平面对齐。auto
:与icon-rotation-alignment
值相同。
# icon-rotate
类型: number
,单位:度
,默认值:0
。需要指定icon-image。
按顺时针方向旋转图标。
# icon-rotation-alignment
类型:枚举
,可选map
,viewport
,auto
。默认auto
。需要指定icon-image。
与 symbol-placement
结合使用,确定构成文本的单个字型的旋转行为。
map
:当symbol-placement
设置为point
时,将文本与东西方向对齐。当symbol-placement
设置为line
时,将文本的 x 轴与线对齐。viewport
:将字型的 x 轴与视窗的 x 轴对齐,无论symbol-placement
设置为哪个值。auto
:当symbol-placement
设置为point
时,与viewport
行为一致。当symbol-placement
设置为line
时,与map
行为一致。
# icon-size
类型: number
。默认值:1
。需要指定icon-image。
图标的缩放因子。1 表示原始大小,3 表示三倍大小。
# icon-text-fit
类型:枚举
,可选none
,width
,height
,both
。默认none
。需要指定icon-image。
缩放图标以与文本相匹配。
none
:图标按其本身的比例进行显示。width
:图标在 x 轴进行缩放以匹配文本的宽度。height
:图标在 y 轴进行缩放以匹配文本的高度。lowercase
:图标在 x 轴与 y 轴都进行缩放。
# icon-text-fit-padding
类型: Array<number>
。单位:像素
。默认值:[0, 0, 0, 0]
。需要指定icon-image,text-field,需要指定icon-text-fit 为 width
或 height
或 both
。
根据 icon-text-fit
确定的图标尺寸添加额外的间隔,以上-右-下-左的顺时针顺序设置。
# icon-translate
类型: Array<number>
。单位:像素
。默认值:[0, 0]
。需要指定icon-image。
要素的几何位置偏移量,以 [x, y]
的形式表示,负值表示向左和上偏移。
# icon-translate-anchor
类型:枚举
,可选map
,viewport
。默认map
。需要指定icon-image,icon-translate。
控制偏移的参考点。
map
:相对于地图偏移。viewport
:相对于视窗偏移。
# visibility
类型:枚举
,可选visible
,none
。默认visible
。
图层是否显示。
visible
:显示。none
:隐藏。
# 文本和图标通用样式(Symbol)
在地图 SDK 中,Text 和 Icon 均属于 Symbol 的概念,因此,本小节中的样式属性,均可与文本样式或是图标样式配合使用。
# symbol-avoid-edges
类型:Boolean
,默认值:false
。
设置为 true 时,注记不会跨瓦片边缘,以避免相互冲突。当图层的矢量瓦片没有足够的缓冲区以避免冲突,或者一个点注记图层在一个线注记图层之上时,推荐开启此设置。
# symbol-placement
类型:枚举
,可选point
,line
,line-center
。默认point
。
注记相对于几何要素的位置。
point
:标注在几何要素的点位上。line
:标注在几何要素的边线上。只能用在 LineString 和 Polygon 要素上。line-center
:标注在几何要素的边线中点上。只能用在 LineString 和 Polygon 要素上。
# symbol-sort-key
类型:number
。
根据这个值对几何要素进行升序排序。要素的这个值越高,显示的层级越高。
# symbol-spacing
类型: number
。单位:pixels
,默认值:250
。需要指定symbol-placement 为 line
。
两个注记锚点之间的距离。
# 圆点样式(Circle)
圆点配置适用于点状数据的小圆点显示效果。
# circle-blur
类型: number
。默认值:0
。
圆点虚化的程度。1 表示把圆点虚化到只有圆心是不透明的。
# circle-color
类型:color
,默认值:#000000
。
圆点的填充颜色。
# circle-blend
类型:枚举
,可选normal
,light
。默认normal
。
当圆点重叠时,重叠区域的颜色效果。指定为light
时,circle-opacity
参数将失效。
normal
:重叠区域只显示最上面的圆点的颜色。light
:重叠区域叠加重叠的圆点的RGB值,呈现效果类似于变亮。
# circle-opacity
类型:0~1之间的数字
,默认值:1
。
绘制圆点的不透明度。
# circle-pitch-alignment
类型:枚举
,可选map
,viewport
。默认viewport
。
当地图倾斜时图标的方向。
map
:图标与地图平面对齐。viewport
:图标与视窗平面对齐。
# circle-pitch-scale
类型:枚举
,可选map
,viewport
。默认map
。
当地图倾斜时,控制圆的缩放行为。
map
:圆根据与相机的视距离进行缩放。viewport
:圆不进行缩放。
# circle-radius
类型: number
,单位:像素
。默认值:5
。
圆点的半径。
# circle-sort-key
类型:number
。
根据这个值对几何要素进行升序排序。要素的这个值越高,显示的层级越高。
# circle-stroke-color
类型:color
,默认值:#000000
。
圆点的轮廓线的颜色。
# circle-stroke-opacity
类型:0~1之间的数字
,默认值:1
。
绘制圆点的轮廓线的不透明度。
# circle-stroke-width
类型: number
。单位:像素
。默认值:0
。
绘制圆点的轮廓线的宽度。
# circle-translate
类型: Array<number>
。单位:像素
。默认值:[0, 0]
。
几何要素的偏移量。以 [x, y] 形式设置,负值表示向左和上偏移。
# circle-translate-anchor
类型:枚举
,可选map
,viewport
。默认map
。需要指定circle-translate。
控制偏移的参考点。
map
:相对于地图偏移。viewport
:相对于视窗偏移。
# visibility
类型:枚举
,可选visible
,none
。默认visible
。
图层是否显示。
visible
:显示。none
:隐藏。
# 热力样式(Heatmap)
热力样式适用于将点状数据以热力图的样式进行呈现。热力样式相比较于其他样式较为复杂,建议参考下述样式的默认值进行自定义的调整。
# heatmap-color
类型:color
,默认值:["interpolate",["linear"],["heatmap-density"],0,"rgba(0, 0, 255, 0)",0.1,"royalblue",0.3,"cyan",0.5,"lime",0.7,"yellow",1,"red"]
。
根据热图中像素的密度值定义每个像素的颜色。
# heatmap-intensity
类型:大于 0 的数字
,默认值:1
。
类似于 heatmap-weight
,但控制整个热力图层的强度。主要用于根据地图缩放级别调整热力图层的显示效果。
# heatmap-opacity
类型:0~1之间的数字
,默认值:1
。
热力图层的不透明度。
# heatmap-radius
类型:大于 1 的数字
,单位:像素
。默认值:30
。
单个点的热力效果的影响半径(以像素为单位)。增加该值会使热图更加平滑,但会丢失更多的细节。
# heatmap-weight
类型:大于 0 的数字
,默认值:1
。
用于衡量单个点对热力图的贡献程度。如果传入 10, 则相当于在同一位置有 10 个权重为 1 的点。特别适用于当缩小地图时,点聚合后的热力图效果的呈现。
# visibility
类型:枚举
,可选visible
,none
。默认visible
。
图层是否显示。
visible
:显示。none
:隐藏。
# 拉伸样式(Extrusion)
拉伸样式是根据平面的多边形,通过指定高度后生成的立方体。拉伸样式的自由度不如其他图层,请参考下述内容。
# extrusion-base
类型: number
。单位:米
。默认值:0
。需要指定extrusion-height。
拉伸体的下表面相对于地面的高度。
# extrusion-color
类型:color
,默认值:#000000
。
圆点的填充颜色。
# extrusion-height
类型: number
。单位:米
。默认值:0
。
拉伸体的上表面相对于地面的高度。
# extrusion-opacity
类型:0~1之间的数字
,默认值:1
。
拉伸的不透明度。不支持通过表达式为不同的拉伸指定不同的颜色。
# extrusion-pattern
类型:Image
。
在拉伸体的表面绘制的图像名称,图像的宽度和高度必须是 2 的整数次方(2,4,8,……,512)。如果使用 zoom
表达式,只有整数类型的 zoom
级别参与计算。
# extrusion-translate
类型: Array<number>
。单位:像素
。默认值:[0, 0]
。
几何要素的偏移量。以 [x, y] 形式设置,负值表示向左和上偏移。
# extrusion-translate-anchor
类型:枚举
,可选map
,viewport
。默认map
。需要指定extrusion-translate。
控制偏移的参考点。
map
:相对于地图偏移。viewport
:相对于视窗偏移。
# extrusion-vertical-gradient
类型:Boolean
,默认值:true
。
是否对拉伸体应用垂直方向上的渐变效果。为 true
时,侧面视觉上会更暗。
# visibility
类型:枚举
,可选visible
,none
。默认visible
。
图层是否显示。
visible
:显示。none
:隐藏。
# 栅格样式(Raster)
栅格样式适用于栅格数据,例如图像图层,WMS图层等的数据源的显示效果。
# raster-brightness-max
类型: number
,默认值:1
。
增大或减少图片的亮度。此值是最大亮度。
# raster-brightness-min
类型: number
,默认值:0
。
增大或减少图片的亮度。此值是最小亮度。
# raster-contrast
类型: number
,默认值:0
。
增加或者减少图片的对比度。
# raster-fade-duration
类型: number
,单位:milliseconds
,默认值:0
。
当添加新瓦片时的渐隐时间。
# raster-hue-rotate
类型: number
,单位:度
,默认值:0
。
在色轮上旋转色相的角度。
# raster-opacity
类型:0~1之间的数字
,默认值:1
。
绘制图片的不透明度。
# raster-resampling
类型:枚举
,可选linear
,nearest
。默认linear
。
对图像数据的重采样的方式。
linear
:线性重采样,过度缩放时,图像过度平滑但是模糊。nearest
:邻近重采样,过度缩放时,图像显示锐利但是像素感强烈。
# raster-saturation
类型: number
,默认值:0
。
增加或者减少图片的饱和度。
# visibility
类型:枚举
,可选visible
,none
。默认visible
。
图层是否显示。
visible
:显示。none
:隐藏。