レイヤー
スタイルのlayers
プロパティは、そのスタイルで使用可能なすべてのレイヤーをリストします。レイヤーのタイプは"type"
プロパティで指定され、background, fill, line, symbol, raster, raster-particle, circle, fill-extrusion, heatmap, hillshade, sky, model のいずれかである必要があります。
backgroundまたはskyタイプのレイヤー除いて、各レイヤーはソースを参照する必要があります。レイヤーはソースから得られたデータを受け取り、必要に応じてフィルター処理を行い、その機能がどのようにスタイルされるかを定義します。
以下はスタイルに含まれる可能性のあるlayers
オブジェクトの例です:
"layers": [
{
"id": "water",
"source": "mapbox-streets",
"source-layer": "water",
"type": "fill",
"paint": {
"fill-color": "#00ffff"
}
}
]
レイヤープロパティ
id
Unique layer name.
type
"fill"
, "line"
, "symbol"
, "circle"
, "heatmap"
, "fill-extrusion"
, "raster"
, "raster-particle"
, "hillshade"
, "model"
, "background"
, "sky"
, "slot"
, "clip"
. Rendering type of this layer.
"fill"
:A filled polygon with an optional stroked border.
"line"
:A stroked line.
"symbol"
:An icon or a text label.
"circle"
:A filled circle.
"heatmap"
:A heatmap.
"fill-extrusion"
:An extruded (3D) polygon.
"raster"
:Raster map textures such as satellite imagery.
"raster-particle"
:Particle animation driven by textures such as wind maps.
"hillshade"
:Client-side hillshading visualization based on DEM data. Currently, the implementation only supports Mapbox Terrain RGB and Mapzen Terrarium tiles.
"model"
:A 3D model
"background"
:The background color or pattern of the map.
"sky"
:A spherical dome around the map that is always rendered behind all other layers.
"slot"
:Marks the position of a slot.
"clip"
:Layer that removes 3D content from map.
filter
An expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The ["feature-state", ...]
expression is not supported in filter expressions. The ["pitch"]
and ["distance-from-center"]
expressions are supported only for filter expressions on the symbol layer.
layout
Layout properties for the layer.
maxzoom
0
and 24
inclusive. The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.
metadata
Arbitrary properties useful to track with the layer, but do not influence rendering. Properties should be prefixed to avoid collisions, like 'mapbox:'.
minzoom
0
and 24
inclusive. The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.
paint
Default paint properties for this layer.
slot
The slot this layer is assigned to. If specified, and a slot with that name exists, it will be placed at that position in the layer order.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
source
Name of a source description to be used for this layer. Required for all layer types except background
and slot
.
source-layer
Layer to use from a vector tile source. Required for vector and raster-array sources; prohibited for all other source types, including GeoJSON sources.
レイヤーのサブプロパティ
レイヤーには、そのレイヤーのデータがどのようにレンダリングされるかを決定する2つのサブプロパティ、layout
およびpaint
プロパティがあります。
-
レイアウトプロパティ は、レイヤーの
"layout"
オブジェクトに表示されます。これらはレンダリングプロセスの早い段階で適用され、そのレイヤーのデータがGPUにどのように渡されるかを定義します。レイアウトプロパティの変更には非同期の「レイアウト」ステップが必要です。 -
ペイントプロパティ は、レンダリングプロセスの後半に適用されます。ペイントプロパティはレイヤーの
"paint"
オブジェクトに表示されます。ペイントプロパティの変更はコストが低く、同期的に行われます。
background
background
スタイルレイヤーは、マップ全体を覆っています。背景スタイルのレイヤーを使用して、他の地図の内容の下に表示される色やパターンを設定できます。背景レイヤーが透明またはスタイルから省略されている場合、他のスタイルレイヤーが表示されない地図ビューの任意の部分は透明になります。
The Vintage map styleはテクスチャのあるビンテージの外観を実現するために、カスタムSVG background-pattern
を使用しています。
background-color
"#000000"
. Disabled by background-pattern. Supports interpolate
expressions. Transitionable. The color with which the background will be drawn.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
background-emissive-strength
0
. Units in intensity. Defaults to 0
. Requires lights. Supports interpolate
expressions. Transitionable. Controls the intensity of light emitted on the source features.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
background-opacity
0
and 1
inclusive. Defaults to 1
. Supports interpolate
expressions. Transitionable. The opacity at which the background will be drawn.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
background-pattern
Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
background-pitch-alignment
Orientation of background layer.
"map"
:The background is aligned to the plane of the map.
"viewport"
:The background is aligned to the plane of the viewport, covering the whole screen. Note: This mode disables the automatic reordering of the layer when terrain or globe projection is used.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.8.0 | >= 11.8.0 | >= 11.8.0 |
visibility
Whether this layer is displayed.
"visible"
:The layer is shown.
"none"
:The layer is not shown.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
expressions support | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill
fill
スタイルレイヤーは、地図上に1つ以上の塗りつぶされた(およびオプションで描画された)ポリゴンを描画します。ポリゴンまたはマルチポリゴンの機能の視覚的な外観を設定するために、塗りつぶしレイヤーを使用できます。
このワシントンD.C.の地図では、fill-opacity
ペイントプロパティを使用して、Isochrone APIにより生成された半透明のポリゴンが描画され、中心から10分間歩ける範囲を示しています。
fill-antialias
Whether or not the fill should be antialiased.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
fill-color
"#000000"
. Disabled by fill-pattern. Supports feature-state
and interpolate
expressions. Transitionable. The color of the filled part of this layer. This color can be specified as rgba
with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.19.0 | >= 5.0.0 | >= 3.5.0 |
fill-emissive-strength
0
. Units in intensity. Defaults to 0
. Requires lights. Supports interpolate
expressions. Transitionable. Controls the intensity of light emitted on the source features.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-opacity
0
and 1
inclusive. Defaults to 1
. Supports feature-state
and interpolate
expressions. Transitionable. The opacity of the entire fill layer. In contrast to the fill-color
, this value will also affect the 1px stroke around the fill, if the stroke is used.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.21.0 | >= 5.0.0 | >= 3.5.0 |
fill-outline-color
true
. Supports feature-state
and interpolate
expressions. Transitionable. The outline color of the fill. Matches the value of fill-color
if unspecified.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.19.0 | >= 5.0.0 | >= 3.5.0 |
fill-pattern
Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.49.0 | >= 6.5.0 | >= 4.4.0 |
fill-sort-key
Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 1.2.0 | >= 9.1.0 | >= 5.8.0 |
data-driven styling | >= 1.2.0 | >= 9.1.0 | >= 5.8.0 |
fill-translate
[0,0]
. Supports interpolate
expressions. Transitionable. The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
fill-translate-anchor
"map"
, "viewport"
. Defaults to "map"
. Requires fill-translate. Controls the frame of reference for fill-translate
.
"map"
:The fill is translated relative to the map.
"viewport"
:The fill is translated relative to the viewport.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
fill-z-offset
0
. Defaults to 0
. Supports interpolate
expressions. Transitionable. Specifies an uniform elevation in meters. Note: If the value is zero, the layer will be rendered on the ground. Non-zero values will elevate the layer from the sea level, which can cause it to be rendered below the terrain.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.7.0 | Not yet supported | Not yet supported |
data-driven styling | >= 3.7.0 | Not yet supported | Not yet supported |
visibility
Whether this layer is displayed.
"visible"
:The layer is shown.
"none"
:The layer is not shown.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
expressions support | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
line
line
スタイルレイヤーはマップ上に1つ以上のストロークされたポリラインをレンダリングします。ラインレイヤーを使用すると、ポリラインまたはマルチポリライン機能の視覚的な外観を設定できます。
このStravaユーザーのグランドティトン国立公園でのハイキングルートのマップでは、line-color
および line-width
ペイントプロパティを使用してユーザーのルートの強い赤い線をスタイリングしています。
line-blur
0
. Units in pixels. Defaults to 0
. Supports feature-state
and interpolate
expressions. Transitionable. Blur applied to the line, in pixels.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
line-cap
The display of line endings.
"butt"
:A cap with a squared-off end which is drawn to the exact endpoint of the line.
"round"
:A cap with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line.
"square"
:A cap with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 2.3.0 | Not yet supported | Not yet supported |
line-color
"#000000"
. Disabled by line-pattern. Supports feature-state
and interpolate
expressions. Transitionable. The color with which the line will be drawn.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.23.0 | >= 5.0.0 | >= 3.5.0 |
line-cross-slope
Defines the slope of an elevated line. A value of 0 creates a horizontal line. A value of 1 creates a vertical line. Other values are currently not supported. If undefined, the line follows the terrain slope. This is an experimental property with some known issues:
- Vertical lines don't support line caps
line-join: round
is not supported with this property
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.8.0 | >= 11.9.0 | >= 11.9.0 |
line-dasharray
0
. Units in line widths. Disabled by line-pattern. Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to pixels, multiply the length by the current line width. Note that GeoJSON sources with lineMetrics: true
specified won't render dashed lines to the expected scale. Also note that zoom-dependent expressions will be evaluated only at integer zoom levels.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 2.3.0 | Not yet supported | Not yet supported |
line-elevation-reference
"none"
, "sea"
, "ground"
, "hd-road-markup"
. Defaults to "none"
. Selects the base of line-elevation. Some modes might require precomputed elevation data in the tileset.
"none"
:Elevated rendering is disabled.
"sea"
:Elevated rendering is enabled. Use this mode to elevate lines relative to the sea level.
"ground"
:Elevated rendering is enabled. Use this mode to elevate lines relative to the ground's height below them.
"hd-road-markup"
:Elevated rendering is enabled. Use this mode to describe additive and stackable features that should exist only on top of road polygons.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.8.0 | >= 11.9.0 | >= 11.9.0 |
line-emissive-strength
0
. Units in intensity. Defaults to 0
. Requires lights. Supports interpolate
expressions. Transitionable. Controls the intensity of light emitted on the source features.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
line-gap-width
0
. Units in pixels. Defaults to 0
. Supports feature-state
and interpolate
expressions. Transitionable. Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
line-gradient
"geojson"
. Supports interpolate
expressions. A gradient used to color a line feature at various distances along its length. Defined using a step
or interpolate
expression which outputs a color for each corresponding line-progress
input value. line-progress
is a percentage of the line feature's total length as measured on the webmercator projected coordinate plane (a number
between 0
and 1
). Can only be used with GeoJSON sources that specify "lineMetrics": true
.
[
"interpolate",
[
"linear"
],
[
"line-progress"
],
0,
"blue",
0.1,
"royalblue",
0.3,
"cyan",
0.5,
"lime",
0.7,
"yellow",
1,
"red"
]
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.45.0 | >= 6.5.0 | >= 4.4.0 |
data-driven styling | Not yet supported | Not yet supported | Not yet supported |
line-join
The display of lines when joining.
"bevel"
:A join with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width.
"round"
:A join with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line.
"miter"
:A join with a sharp, angled corner which is drawn with the outer sides beyond the endpoint of the path until they meet.
"none"
:Line segments are not joined together, each one creates a separate line. Useful in combination with line-pattern. Line-cap property is not respected. Can't be used with data-driven styling.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.40.0 | >= 5.2.0 | >= 3.7.0 |
| >= 3.4.0 | >= 11.5.0 | >= 11.5.0 |
line-miter-limit
2
. Requires line-join to be "miter"
. Supports interpolate
expressions. Used to automatically convert miter joins to bevel joins for sharp angles.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
line-occlusion-opacity
0
and 1
inclusive. Defaults to 0
. Supports interpolate
expressions. Transitionable. Opacity multiplier (multiplies line-opacity value) of the line part that is occluded by 3D objects. Value 0 hides occluded part, value 1 means the same opacity as non-occluded part. The property is not supported when line-opacity
has data-driven styling.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.5.0 | >= 11.5.0 | >= 11.5.0 |
line-offset
0
. Supports feature-state
and interpolate
expressions. Transitionable. The line's offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.12.1 | >= 3.0.0 | >= 3.1.0 |
data-driven styling | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
line-opacity
0
and 1
inclusive. Defaults to 1
. Supports feature-state
and interpolate
expressions. Transitionable. The opacity at which the line will be drawn.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
line-pattern
Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.49.0 | >= 6.5.0 | >= 4.4.0 |
line-round-limit
1.05
. Requires line-join to be "round"
. Supports interpolate
expressions. Used to automatically convert round joins to miter joins for shallow angles.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
line-sort-key
Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 1.2.0 | >= 9.1.0 | >= 5.8.0 |
data-driven styling | >= 1.2.0 | >= 9.1.0 | >= 5.8.0 |
line-translate
[0,0]
. Supports interpolate
expressions. Transitionable. The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
line-translate-anchor
"map"
, "viewport"
. Defaults to "map"
. Requires line-translate. Controls the frame of reference for line-translate
.
"map"
:The line is translated relative to the map.
"viewport"
:The line is translated relative to the viewport.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
line-trim-color
"transparent"
. Requires line-trim-offset. Requires source to be "geojson"
. Supports interpolate
expressions. Transitionable. The color to be used for rendering the trimmed line section that is defined by the line-trim-offset
property.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.6.0 | >= 11.6.0 | >= 11.6.0 |
line-trim-fade-range
0
and 1
inclusive, between 0
and 1
inclusive ]. Defaults to [0,0]
. Requires line-trim-offset. Requires source to be "geojson"
. Supports interpolate
expressions. The fade range for the trim-start and trim-end points is defined by the line-trim-offset
property. The first element of the array represents the fade range from the trim-start point toward the end of the line, while the second element defines the fade range from the trim-end point toward the beginning of the line. The fade result is achieved by interpolating between line-trim-color
and the color specified by the line-color
or the line-gradient
property.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.6.0 | >= 11.6.0 | >= 11.6.0 |
line-trim-offset
0
and 1
inclusive, between 0
and 1
inclusive ]. Defaults to [0,0]
. Requires source to be "geojson"
. The line part between [trim-start, trim-end] will be painted using line-trim-color,
which is transparent by default to produce a route vanishing effect. The line trim-off offset is based on the whole line range [0.0, 1.0].
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 2.9.0 | >= 10.5.0 | >= 10.5.0 |
line-width
0
. Units in pixels. Defaults to 1
. Supports feature-state
and interpolate
expressions. Transitionable. Stroke thickness.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.39.0 | >= 5.2.0 | >= 3.7.0 |
line-z-offset
Vertical offset from ground, in meters. Defaults to 0. This is an experimental property with some known issues:
- Not supported for globe projection at the moment
- Elevated line discontinuity is possible on tile borders with terrain enabled
- Rendering artifacts can happen near line joins and line caps depending on the line styling
- Rendering artifacts relating to
line-opacity
andline-blur
- Elevated line visibility is determined by layer order
- Z-fighting issues can happen with intersecting elevated lines
- Elevated lines don't cast shadows
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.5.0 | >= 11.5.0 | >= 11.5.0 |
data-driven styling | >= 3.5.0 | >= 11.5.0 | >= 11.5.0 |
visibility
Whether this layer is displayed.
"visible"
:The layer is shown.
"none"
:The layer is not shown.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
expressions support | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
symbol
symbol
style layerは、地図上の点や線に沿ってアイコンおよびテキストラベルをレンダリングします。シンボルレイヤーを使用して、ベクタータイル内の特徴に対するラベルの視覚的な外観を設定することができます。
このデンバー地域のビジネスマップでは、icon-image
レイアウトプロパティを使用して、カスタム画像をシンボルレイヤーのアイコンとして使用しています。
icon-allow-overlap
If true, the icon will be visible even if it collides with other previously drawn symbols.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
icon-anchor
"center"
, "left"
, "right"
, "top"
, "bottom"
, "top-left"
, "top-right"
, "bottom-left"
, "bottom-right"
. Defaults to "center"
. Requires icon-image. Part of the icon placed closest to the anchor.
"center"
:The center of the icon is placed closest to the anchor.
"left"
:The left side of the icon is placed closest to the anchor.
"right"
:The right side of the icon is placed closest to the anchor.
"top"
:The top of the icon is placed closest to the anchor.
"bottom"
:The bottom of the icon is placed closest to the anchor.
"top-left"
:The top left corner of the icon is placed closest to the anchor.
"top-right"
:The top right corner of the icon is placed closest to the anchor.
"bottom-left"
:The bottom left corner of the icon is placed closest to the anchor.
"bottom-right"
:The bottom right corner of the icon is placed closest to the anchor.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.40.0 | >= 5.2.0 | >= 3.7.0 |
data-driven styling | >= 0.40.0 | >= 5.2.0 | >= 3.7.0 |
icon-color
"#000000"
. Requires icon-image. Supports feature-state
and interpolate
expressions. Transitionable. The color of the icon. This can only be used with SDF icons.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
icon-color-brightness-max
Increase or reduce the brightness of the symbols. The value is the maximum brightness.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.5.0 | >= 11.5.0 | >= 11.5.0 |
icon-color-brightness-min
Increase or reduce the brightness of the symbols. The value is the minimum brightness.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.5.0 | >= 11.5.0 | >= 11.5.0 |
icon-color-contrast
Increase or reduce the contrast of the symbol icon.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.5.0 | >= 11.5.0 | >= 11.5.0 |
icon-color-saturation
Increase or reduce the saturation of the symbol icon.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.1.0 | >= 11.1.0 | >= 11.1.0 |
icon-emissive-strength
0
. Units in intensity. Defaults to 1
. Requires lights. Supports feature-state
and interpolate
expressions. Transitionable. Controls the intensity of light emitted on the source features.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
icon-halo-blur
0
. Units in pixels. Defaults to 0
. Requires icon-image. Supports feature-state
and interpolate
expressions. Transitionable. Fade out the halo towards the outside.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
icon-halo-color
"rgba(0, 0, 0, 0)"
. Requires icon-image. Supports feature-state
and interpolate
expressions. Transitionable. The color of the icon's halo. Icon halos can only be used with SDF icons.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
icon-halo-width
0
. Units in pixels. Defaults to 0
. Requires icon-image. Supports feature-state
and interpolate
expressions. Transitionable. Distance of halo to the icon outline.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
icon-ignore-placement
If true, other symbols can be visible even if they collide with the icon.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
icon-image
Name of image in sprite to use for drawing an image background.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.35.0 | >= 5.1.0 | >= 3.6.0 |
icon-image-cross-fade
0
and 1
inclusive. Defaults to 0
. Requires icon-image. Supports feature-state
and interpolate
expressions. Transitionable. Controls the transition progress between the image variants of icon-image. Zero means the first variant is used, one is the second, and in between they are blended together.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
icon-keep-upright
false
. Requires icon-image. Requires icon-rotation-alignment to be "map"
. Requires symbol-placement to be "line"
, or "line-center"
. If true, the icon may be flipped to prevent it from being rendered upside-down.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
icon-occlusion-opacity
0
and 1
inclusive. Defaults to 0
. Requires icon-image. Supports feature-state
and interpolate
expressions. Transitionable. The opacity at which the icon will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.5.0 | >= 11.5.0 | >= 11.6.0 |
data-driven styling | >= 3.5.0 | >= 11.5.0 | >= 11.6.0 |
icon-offset
[0,0]
. Requires icon-image. Supports interpolate
expressions. Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. Each component is multiplied by the value of icon-size
to obtain the final offset in pixels. When combined with icon-rotate
the offset will be as if the rotated direction was up.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
icon-opacity
0
and 1
inclusive. Defaults to 1
. Requires icon-image. Supports feature-state
and interpolate
expressions. Transitionable. The opacity at which the icon will be drawn.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
icon-optional
If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
icon-padding
0
. Units in pixels. Defaults to 2
. Requires icon-image. Supports interpolate
expressions. Size of the additional area around the icon bounding box used for detecting symbol collisions.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
icon-pitch-alignment
"map"
, "viewport"
, "auto"
. Defaults to "auto"
. Requires icon-image. Orientation of icon when map is pitched.
"map"
:The icon is aligned to the plane of the map.
"viewport"
:The icon is aligned to the plane of the viewport.
"auto"
:Automatically matches the value of
icon-rotation-alignment
.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.39.0 | >= 5.2.0 | >= 3.7.0 |
icon-rotate
0
. Requires icon-image. Supports interpolate
expressions. Rotates the icon clockwise.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.21.0 | >= 5.0.0 | >= 3.5.0 |
icon-rotation-alignment
"map"
, "viewport"
, "auto"
. Defaults to "auto"
. Requires icon-image. In combination with symbol-placement
, determines the rotation behavior of icons.
"map"
:When
symbol-placement
is set topoint
, aligns icons east-west. Whensymbol-placement
is set toline
orline-center
, aligns icon x-axes with the line."viewport"
:Produces icons whose x-axes are aligned with the x-axis of the viewport, regardless of the value of
symbol-placement
."auto"
:When
symbol-placement
is set topoint
, this is equivalent toviewport
. Whensymbol-placement
is set toline
orline-center
, this is equivalent tomap
.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
| >= 0.25.0 | >= 4.2.0 | >= 3.4.0 |
icon-size
0
. Units in factor of the original icon size. Defaults to 1
. Requires icon-image. Supports interpolate
expressions. Scales the original size of the icon by the provided factor. The new pixel size of the image will be the original pixel size multiplied by icon-size
. 1 is the original size; 3 triples the size of the image.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.35.0 | >= 5.1.0 | >= 3.6.0 |
icon-text-fit
"none"
, "width"
, "height"
, "both"
. Defaults to "none"
. Requires icon-image. Requires text-field. Scales the icon to fit around the associated text.
"none"
:The icon is displayed at its intrinsic aspect ratio.
"width"
:The icon is scaled in the x-dimension to fit the width of the text.
"height"
:The icon is scaled in the y-dimension to fit the height of the text.
"both"
:The icon is scaled in both x- and y-dimensions.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.21.0 | >= 4.2.0 | >= 3.4.0 |
stretchable icons | >= 1.6.0 | >= 9.2.0 | >= 5.8.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
icon-text-fit-padding
[0,0,0,0]
. Requires icon-image. Requires text-field. Requires icon-text-fit to be "both"
, or "width"
, or "height"
. Supports interpolate
expressions. Size of the additional area added to dimensions determined by icon-text-fit
, in clockwise order: top, right, bottom, left.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.21.0 | >= 4.2.0 | >= 3.4.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
icon-translate
[0,0]
. Requires icon-image. Supports interpolate
expressions. Transitionable. Distance that the icon's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
icon-translate-anchor
"map"
, "viewport"
. Defaults to "map"
. Requires icon-image. Requires icon-translate. Controls the frame of reference for icon-translate
.
"map"
:Icons are translated relative to the map.
"viewport"
:Icons are translated relative to the viewport.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
symbol-avoid-edges
If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don't have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer. When using a client that supports global collision detection, like Mapbox GL JS version 0.42.0 or greater, enabling this property is not needed to prevent clipped labels at tile boundaries.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
symbol-elevation-reference
Selects the base of symbol-elevation.
"sea"
:Elevate symbols relative to the sea level.
"ground"
:Elevate symbols relative to the ground's height below them.
"hd-road-markup"
:Use this mode to enable elevated behavior for features that are rendered on top of 3D road polygons. The feature is currently being developed.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | Not yet supported | >= 11.9.0 | >= 11.9.0 |
symbol-placement
Label placement relative to its geometry.
"point"
:The label is placed at the point where the geometry is located.
"line"
:The label is placed along the line of the geometry. Can only be used on
LineString
andPolygon
geometries."line-center"
:The label is placed at the center of the line of the geometry. Can only be used on
LineString
andPolygon
geometries. Note that a single feature in a vector tile may contain multiple line geometries.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
| >= 0.47.0 | >= 6.4.0 | >= 4.3.0 |
symbol-sort-key
Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When icon-allow-overlap
or text-allow-overlap
is false
, features with a lower sort key will have priority during placement. When icon-allow-overlap
or text-allow-overlap
is set to true
, features with a higher sort key will overlap over features with a lower sort key.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.53.0 | >= 7.4.0 | >= 4.11.0 |
data-driven styling | >= 0.53.0 | >= 7.4.0 | >= 4.11.0 |
symbol-spacing
1
. Units in pixels. Defaults to 250
. Requires symbol-placement to be "line"
. Supports interpolate
expressions. Distance between two symbol anchors.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
symbol-z-elevate
false
. Requires symbol-placement to be "point"
. Requires symbol-z-order to be "auto"
. Position symbol on buildings (both fill extrusions and models) rooftops. In order to have minimal impact on performance, this is supported only when fill-extrusion-height
is not zoom-dependent and remains unchanged. For fading in buildings when zooming in, fill-extrusion-vertical-scale should be used and symbols would raise with building rooftops. Symbols are sorted by elevation, except in cases when viewport-y
sorting or symbol-sort-key
are applied.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
symbol-z-offset
0
. Defaults to 0
. Supports interpolate
expressions. Transitionable. Specifies an uniform elevation from the ground, in meters.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.7.0 | >= 11.7.0 | >= 11.7.0 |
data-driven styling | >= 3.7.0 | >= 11.7.0 | >= 11.7.0 |
symbol-z-order
Determines whether overlapping symbols in the same layer are rendered in the order that they appear in the data source or by their y-position relative to the viewport. To control the order and prioritization of symbols otherwise, use symbol-sort-key
.
"auto"
:Sorts symbols by
symbol-sort-key
if set. Otherwise, sorts symbols by their y-position relative to the viewport ificon-allow-overlap
ortext-allow-overlap
is set totrue
oricon-ignore-placement
ortext-ignore-placement
isfalse
."viewport-y"
:Sorts symbols by their y-position relative to the viewport if any of the following is set to
true
:icon-allow-overlap
,text-allow-overlap
,icon-ignore-placement
,text-ignore-placement
."source"
:Sorts symbols by
symbol-sort-key
if set. Otherwise, no sorting is applied; symbols are rendered in the same order as the source data.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.49.0 | >= 6.6.0 | >= 4.5.0 |
text-allow-overlap
If true, the text will be visible even if it collides with other previously drawn symbols.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
text-anchor
"center"
, "left"
, "right"
, "top"
, "bottom"
, "top-left"
, "top-right"
, "bottom-left"
, "bottom-right"
. Defaults to "center"
. Requires text-field. Disabled by text-variable-anchor. Part of the text placed closest to the anchor.
"center"
:The center of the text is placed closest to the anchor.
"left"
:The left side of the text is placed closest to the anchor.
"right"
:The right side of the text is placed closest to the anchor.
"top"
:The top of the text is placed closest to the anchor.
"bottom"
:The bottom of the text is placed closest to the anchor.
"top-left"
:The top left corner of the text is placed closest to the anchor.
"top-right"
:The top right corner of the text is placed closest to the anchor.
"bottom-left"
:The bottom left corner of the text is placed closest to the anchor.
"bottom-right"
:The bottom right corner of the text is placed closest to the anchor.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.39.0 | >= 5.2.0 | >= 3.7.0 |
text-color
"#000000"
. Requires text-field. Supports feature-state
and interpolate
expressions. Transitionable. The color with which the text will be drawn.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
text-emissive-strength
0
. Units in intensity. Defaults to 1
. Requires lights. Supports feature-state
and interpolate
expressions. Transitionable. Controls the intensity of light emitted on the source features.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
text-field
Value to use for a text label. If a plain string
is provided, it will be treated as a formatted
with default/inherited formatting options. SDF images are not supported in formatted text and will be ignored.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
text-font
["Open Sans Regular","Arial Unicode MS Regular"]
. Requires text-field. Font stack to use for displaying text.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.43.0 | >= 6.0.0 | >= 4.0.0 |
text-halo-blur
0
. Units in pixels. Defaults to 0
. Requires text-field. Supports feature-state
and interpolate
expressions. Transitionable. The halo's fadeout distance towards the outside.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
text-halo-color
"rgba(0, 0, 0, 0)"
. Requires text-field. Supports feature-state
and interpolate
expressions. Transitionable. The color of the text's halo, which helps it stand out from backgrounds.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
text-halo-width
0
. Units in pixels. Defaults to 0
. Requires text-field. Supports feature-state
and interpolate
expressions. Transitionable. Distance of halo to the font outline. Max text halo width is 1/4 of the font-size.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
text-ignore-placement
If true, other symbols can be visible even if they collide with the text.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
text-justify
"auto"
, "left"
, "center"
, "right"
. Defaults to "center"
. Requires text-field. Text justification options.
"auto"
:The text is aligned towards the anchor position.
"left"
:The text is aligned to the left.
"center"
:The text is centered.
"right"
:The text is aligned to the right.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.39.0 | >= 5.2.0 | >= 3.7.0 |
auto | >= 0.54.0 | >= 7.4.0 | >= 4.10.0 |
text-keep-upright
true
. Requires text-field. Requires text-rotation-alignment to be "map"
. Requires symbol-placement to be "line"
, or "line-center"
. If true, the text may be flipped vertically to prevent it from being rendered upside-down.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
text-letter-spacing
0
. Requires text-field. Supports interpolate
expressions. Text tracking amount.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.40.0 | >= 5.2.0 | >= 3.7.0 |
text-line-height
1.2
. Requires text-field. Supports interpolate
expressions. Text leading value for multi-line text.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 2.3.0 | >= 10.0.0 | >= 10.0.0 |
text-max-angle
45
. Requires text-field. Requires symbol-placement to be "line"
, or "line-center"
. Supports interpolate
expressions. Maximum angle change between adjacent characters.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
text-max-width
0
. Units in ems. Defaults to 10
. Requires text-field. Requires symbol-placement to be "point"
. Supports interpolate
expressions. The maximum line width for text wrapping.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.40.0 | >= 5.2.0 | >= 3.7.0 |
text-occlusion-opacity
0
and 1
inclusive. Defaults to 0
. Requires text-field. Supports feature-state
and interpolate
expressions. Transitionable. The opacity at which the text will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.5.0 | >= 11.5.0 | >= 11.6.0 |
data-driven styling | >= 3.5.0 | >= 11.5.0 | >= 11.6.0 |
text-offset
[0,0]
. Requires text-field. Disabled by text-radial-offset. Supports interpolate
expressions. Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up. If used with text-variable-anchor, input values will be taken as absolute values. Offsets along the x- and y-axis will be applied automatically based on the anchor position.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.35.0 | >= 5.1.0 | >= 3.6.0 |
text-opacity
0
and 1
inclusive. Defaults to 1
. Requires text-field. Supports feature-state
and interpolate
expressions. Transitionable. The opacity at which the text will be drawn.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
text-optional
If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
text-padding
0
. Units in pixels. Defaults to 2
. Requires text-field. Supports interpolate
expressions. Size of the additional area around the text bounding box used for detecting symbol collisions.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
text-pitch-alignment
"map"
, "viewport"
, "auto"
. Defaults to "auto"
. Requires text-field. Orientation of text when map is pitched.
"map"
:The text is aligned to the plane of the map.
"viewport"
:The text is aligned to the plane of the viewport.
"auto"
:Automatically matches the value of
text-rotation-alignment
.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.21.0 | >= 4.2.0 | >= 3.4.0 |
| >= 0.25.0 | >= 4.2.0 | >= 3.4.0 |
text-radial-offset
0
. Requires text-field. Supports interpolate
expressions. Radial offset of text, in the direction of the symbol's anchor. Useful in combination with text-variable-anchor
, which defaults to using the two-dimensional text-offset
if present.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.54.0 | >= 7.4.0 | >= 4.10.0 |
data-driven styling | >= 0.54.0 | >= 7.4.0 | >= 4.10.0 |
text-rotate
0
. Requires text-field. Supports interpolate
expressions. Rotates the text clockwise.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.35.0 | >= 5.1.0 | >= 3.6.0 |
text-rotation-alignment
"map"
, "viewport"
, "auto"
. Defaults to "auto"
. Requires text-field. In combination with symbol-placement
, determines the rotation behavior of the individual glyphs forming the text.
"map"
:When
symbol-placement
is set topoint
, aligns text east-west. Whensymbol-placement
is set toline
orline-center
, aligns text x-axes with the line."viewport"
:Produces glyphs whose x-axes are aligned with the x-axis of the viewport, regardless of the value of
symbol-placement
."auto"
:When
symbol-placement
is set topoint
, this is equivalent toviewport
. Whensymbol-placement
is set toline
orline-center
, this is equivalent tomap
.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
| >= 0.25.0 | >= 4.2.0 | >= 3.4.0 |
text-size
0
. Units in pixels. Defaults to 16
. Requires text-field. Supports interpolate
expressions. Font size.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.35.0 | >= 5.1.0 | >= 3.6.0 |
text-transform
"none"
, "uppercase"
, "lowercase"
. Defaults to "none"
. Requires text-field. Specifies how to capitalize text, similar to the CSS text-transform
property.
"none"
:The text is not altered.
"uppercase"
:Forces all letters to be displayed in uppercase.
"lowercase"
:Forces all letters to be displayed in lowercase.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
text-translate
[0,0]
. Requires text-field. Supports interpolate
expressions. Transitionable. Distance that the text's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
text-translate-anchor
"map"
, "viewport"
. Defaults to "map"
. Requires text-field. Requires text-translate. Controls the frame of reference for text-translate
.
"map"
:The text is translated relative to the map.
"viewport"
:The text is translated relative to the viewport.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
text-variable-anchor
"center"
, "left"
, "right"
, "top"
, "bottom"
, "top-left"
, "top-right"
, "bottom-left"
, "bottom-right"
. Requires text-field. Requires symbol-placement to be "point"
. To increase the chance of placing high-priority labels on the map, you can provide an array of text-anchor
locations: the renderer will attempt to place the label at each location, in order, before moving onto the next label. Use text-justify: auto
to choose justification based on anchor position. To apply an offset, use the text-radial-offset
or the two-dimensional text-offset
.
"center"
:The center of the text is placed closest to the anchor.
"left"
:The left side of the text is placed closest to the anchor.
"right"
:The right side of the text is placed closest to the anchor.
"top"
:The top of the text is placed closest to the anchor.
"bottom"
:The bottom of the text is placed closest to the anchor.
"top-left"
:The top left corner of the text is placed closest to the anchor.
"top-right"
:The top right corner of the text is placed closest to the anchor.
"bottom-left"
:The bottom left corner of the text is placed closest to the anchor.
"bottom-right"
:The bottom right corner of the text is placed closest to the anchor.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.54.0 | >= 7.4.0 | >= 4.10.0 |
text-writing-mode
The property allows control over a symbol's orientation. Note that the property values act as a hint, so that a symbol whose language doesn’t support the provided orientation will be laid out in its natural orientation. Example: English point symbol will be rendered horizontally even if array value contains single 'vertical' enum value. For symbol with point placement, the order of elements in an array define priority order for the placement of an orientation variant. For symbol with line placement, the default text writing mode is either ['horizontal', 'vertical'] or ['vertical', 'horizontal'], the order doesn't affect the placement.
"horizontal"
:If a text's language supports horizontal writing mode, symbols would be laid out horizontally.
"vertical"
:If a text's language supports vertical writing mode, symbols would be laid out vertically.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 1.3.0 | >= 8.3.0 | >= 5.3.0 |
visibility
Whether this layer is displayed.
"visible"
:The layer is shown.
"none"
:The layer is not shown.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
expressions support | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
raster
raster
スタイルレイヤーは、地図上にラスタタイルをレンダリングします。ラスタレイヤーを使用して、ラスタタイルのカラーパラメータを設定できます。
このMaxarによるインタラクティブなSWIR画像地図は、短波赤外線衛星画像のラスタレイヤーの表示/非表示を切り替えるためにvisibility
レイアウトプロパティを使用しています。
raster-array-band
Displayed band of raster array source layer. Defaults to the first band if not set.
"band-name"
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.1.0 | >= 11.1.0 | >= 11.1.0 |
raster-brightness-max
0
and 1
inclusive. Defaults to 1
. Supports interpolate
expressions. Transitionable. Increase or reduce the brightness of the image. The value is the maximum brightness.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
raster-brightness-min
0
and 1
inclusive. Defaults to 0
. Supports interpolate
expressions. Transitionable. Increase or reduce the brightness of the image. The value is the minimum brightness.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
raster-color
Defines a color map by which to colorize a raster layer, parameterized by the ["raster-value"]
expression and evaluated at 256 uniformly spaced steps over the range specified by raster-color-range
.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | Not yet supported | Not yet supported | Not yet supported |
raster-color-mix
[0.2126,0.7152,0.0722,0]
. Requires raster-color. Supports interpolate
expressions. Transitionable. When raster-color
is active, specifies the combination of source RGB channels used to compute the raster value. Computed using the equation mix.r * src.r + mix.g * src.g + mix.b * src.b + mix.a
. The first three components specify the mix of source red, green, and blue channels, respectively. The fourth component serves as a constant offset and is not multipled by source alpha. Source alpha is instead carried through and applied as opacity to the colorized result. Default value corresponds to RGB luminosity.
[
0.2126,
0.7152,
0.0722,
0
]
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
raster-color-range
interpolate
expressions. Transitionable. When raster-color
is active, specifies the range over which raster-color
is tabulated. Units correspond to the computed raster value via raster-color-mix
. For rasterarray
sources, if raster-color-range
is unspecified, the source's stated data range is used.
[
0.5,
10
]
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
raster-contrast
-1
and 1
inclusive. Defaults to 0
. Supports interpolate
expressions. Transitionable. Increase or reduce the contrast of the image.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
raster-elevation
0
. Defaults to 0
. Supports interpolate
expressions. Transitionable. Specifies an uniform elevation from the ground, in meters.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.1.0 | >= 11.2.0 | >= 11.2.0 |
raster-emissive-strength
0
. Units in intensity. Defaults to 0
. Requires lights. Supports interpolate
expressions. Transitionable. Controls the intensity of light emitted on the source features.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.1.0 | >= 11.1.0 | >= 11.1.0 |
raster-fade-duration
0
. Units in milliseconds. Defaults to 300
. Supports interpolate
expressions. Fade duration when a new tile is added.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
raster-hue-rotate
0
. Supports interpolate
expressions. Transitionable. Rotates hues around the color wheel.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
raster-opacity
0
and 1
inclusive. Defaults to 1
. Supports interpolate
expressions. Transitionable. The opacity at which the image will be drawn.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
raster-resampling
The resampling/interpolation method to use for overscaling, also known as texture magnification filter
"linear"
:(Bi)linear filtering interpolates pixel values using the weighted average of the four closest original source pixels creating a smooth but blurry look when overscaled
"nearest"
:Nearest neighbor filtering interpolates pixel values using the nearest original source pixel creating a sharp but pixelated look when overscaled
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.47.0 | >= 6.3.0 | >= 4.2.0 |
raster-saturation
-1
and 1
inclusive. Defaults to 0
. Supports interpolate
expressions. Transitionable. Increase or reduce the saturation of the image.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
visibility
Whether this layer is displayed.
"visible"
:The layer is shown.
"none"
:The layer is not shown.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
expressions support | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
raster-particle
raster-particle
スタイルレイヤーは、地図上で粒子アニメーションをレンダリングします。速度タイルセットがレイヤーを駆動し、粒子の相対的な速度と方向を提供します。粒子のアニメーションプロパティ、速度、密度、色付けなどを設定するためにこのレイヤーを使用します。
全球予想システム(GFS)から派生した風タイルセットによる粒子アニメーション。
raster-particle-array-band
Displayed band of raster array source layer
"\"1713348000\""
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.3.0 | >= 11.4.0 | >= 11.4.0 |
raster-particle-color
Defines a color map by which to colorize a raster particle layer, parameterized by the ["raster-particle-speed"]
expression and evaluated at 256 uniformly spaced steps over the range specified by raster-particle-max-speed
.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.3.0 | >= 11.4.0 | >= 11.4.0 |
data-driven styling | Not yet supported | Not yet supported | Not yet supported |
raster-particle-count
Defines the amount of particles per tile.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.3.0 | >= 11.4.0 | >= 11.4.0 |
raster-particle-elevation
0
. Defaults to 0
. Supports interpolate
expressions. Transitionable. Specifies an uniform elevation from the ground, in meters.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.7.0 | >= 11.7.0 | >= 11.7.0 |
raster-particle-fade-opacity-factor
0
and 1
inclusive. Defaults to 0.98
. Supports interpolate
expressions. Transitionable. Defines defines the opacity coefficient applied to the faded particles in each frame. In practice, this property controls the length of the particle tail.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.3.0 | >= 11.4.0 | >= 11.4.0 |
raster-particle-max-speed
Defines the maximum speed for particles. Velocities with magnitudes equal to or exceeding this value are clamped to the max value.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.3.0 | >= 11.4.0 | >= 11.4.0 |
raster-particle-reset-rate-factor
Defines a coefficient for a time period at which particles will restart at a random position, to avoid degeneration (empty areas without particles).
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.3.0 | >= 11.4.0 | >= 11.4.0 |
raster-particle-speed-factor
0
and 1
inclusive. Defaults to 0.2
. Supports interpolate
expressions. Transitionable. Defines a coefficient for the speed of particles’ motion.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.3.0 | >= 11.4.0 | >= 11.4.0 |
visibility
Whether this layer is displayed.
"visible"
:The layer is shown.
"none"
:The layer is not shown.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.3.0 | >= 11.4.0 | >= 11.4.0 |
expressions support | >= 3.3.0 | >= 11.4.0 | >= 11.4.0 |
circle
circle
style layerは、地図上に1つ以上の塗りつぶされた円をレンダリングします。ベクタータイル内のポイントやポイントコレクションの特徴の視覚的な外観を設定するために、circle layerを使用できます。circle layerは画面単位で測定される半径の円をレンダリングします。
このclusters mapは、GeoJSONデータソースを使用してcircle layerを使用し、ソースのcluster
プロパティをtrue
に設定してポイントをclustersとして視覚化しています。
circle-blur
0
. Supports feature-state
and interpolate
expressions. Transitionable. Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity. Setting a negative value renders the blur as an inner glow effect.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.20.0 | >= 5.0.0 | >= 3.5.0 |
circle-color
"#000000"
. Supports feature-state
and interpolate
expressions. Transitionable. The fill color of the circle.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.18.0 | >= 5.0.0 | >= 3.5.0 |
circle-emissive-strength
0
. Units in intensity. Defaults to 0
. Requires lights. Supports interpolate
expressions. Transitionable. Controls the intensity of light emitted on the source features.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
circle-opacity
0
and 1
inclusive. Defaults to 1
. Supports feature-state
and interpolate
expressions. Transitionable. The opacity at which the circle will be drawn.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.20.0 | >= 5.0.0 | >= 3.5.0 |
circle-pitch-alignment
Orientation of circle when map is pitched.
"map"
:The circle is aligned to the plane of the map.
"viewport"
:The circle is aligned to the plane of the viewport.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.39.0 | >= 5.2.0 | >= 3.7.0 |
circle-pitch-scale
Controls the scaling behavior of the circle when the map is pitched.
"map"
:Circles are scaled according to their apparent distance to the camera.
"viewport"
:Circles are not scaled.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.21.0 | >= 4.2.0 | >= 3.4.0 |
circle-radius
0
. Units in pixels. Defaults to 5
. Supports feature-state
and interpolate
expressions. Transitionable. Circle radius.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.18.0 | >= 5.0.0 | >= 3.5.0 |
circle-sort-key
Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 1.2.0 | >= 9.2.0 | >= 5.9.0 |
data-driven styling | >= 1.2.0 | >= 9.2.0 | >= 5.9.0 |
circle-stroke-color
"#000000"
. Supports feature-state
and interpolate
expressions. Transitionable. The stroke color of the circle.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
data-driven styling | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
circle-stroke-opacity
0
and 1
inclusive. Defaults to 1
. Supports feature-state
and interpolate
expressions. Transitionable. The opacity of the circle's stroke.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
data-driven styling | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
circle-stroke-width
0
. Units in pixels. Defaults to 0
. Supports feature-state
and interpolate
expressions. Transitionable. The width of the circle's stroke. Strokes are placed outside of the circle-radius
.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
data-driven styling | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
circle-translate
[0,0]
. Supports interpolate
expressions. Transitionable. The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
circle-translate-anchor
"map"
, "viewport"
. Defaults to "map"
. Requires circle-translate. Controls the frame of reference for circle-translate
.
"map"
:The circle is translated relative to the map.
"viewport"
:The circle is translated relative to the viewport.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
visibility
Whether this layer is displayed.
"visible"
:The layer is shown.
"none"
:The layer is not shown.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
expressions support | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion
fill-extrusion
style layerは、地図上に1つ以上の塗りつぶされた(およびオプションでストロークされた)押し出し(3D)ポリゴンをレンダリングします。ポリゴンまたはマルチポリゴンの特徴の押し出しと視覚的な外観を設定するために、fill extrusionを使用できます。
この地図では、外部データセットを使用して、fill extrusionにあるさまざまな国のポリゴンのfill-extrusion-height
ペイントプロパティのデータ駆動値を提供しています。
fill-extrusion-ambient-occlusion-ground-attenuation
0
and 1
inclusive. Defaults to 0.69
. Requires lights. Supports interpolate
expressions. Transitionable. Provides a control to futher fine-tune the look of the ambient occlusion on the ground beneath the extruded buildings. Lower values give the effect a more solid look while higher values make it smoother.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-ambient-occlusion-ground-radius
0
. Defaults to 3
. Requires lights. Supports interpolate
expressions. Transitionable. The extent of the ambient occlusion effect on the ground beneath the extruded buildings in meters.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-ambient-occlusion-intensity
0
and 1
inclusive. Defaults to 0
. Supports interpolate
expressions. Transitionable. Controls the intensity of shading near ground and concave angles between walls. Default value 0.0 disables ambient occlusion and values around 0.3 provide the most plausible results for buildings.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 10.7.0 | >= 10.7.0 |
fill-extrusion-ambient-occlusion-radius
0
. Defaults to 3
. Requires fill-extrusion-edge-radius. Supports interpolate
expressions. Transitionable. Shades area near ground and concave angles between walls where the radius defines only vertical impact. Default value 3.0 corresponds to height of one floor and brings the most plausible results for buildings. This property works only with legacy light. When 3D lights are enabled fill-extrusion-ambient-occlusion-wall-radius
and fill-extrusion-ambient-occlusion-ground-radius
are used instead.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 10.7.0 | >= 10.7.0 |
fill-extrusion-ambient-occlusion-wall-radius
0
. Defaults to 3
. Requires lights. Requires fill-extrusion-edge-radius. Supports interpolate
expressions. Transitionable. Shades area near ground and concave angles between walls where the radius defines only vertical impact. Default value 3.0 corresponds to height of one floor and brings the most plausible results for buildings.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-base
0
. Units in meters. Defaults to 0
. Requires fill-extrusion-height. Supports feature-state
and interpolate
expressions. Transitionable. The height with which to extrude the base of this layer. Must be less than or equal to fill-extrusion-height
.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
data-driven styling | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
fill-extrusion-base-alignment
"terrain"
, "flat"
. Defaults to "terrain"
. Requires fill-extrusion-base. Controls the behavior of fill extrusion base over terrain
"terrain"
:The fill extrusion base follows terrain slope.
"flat"
:The fill extrusion base is flat over terrain.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.8.0 | >= 11.8.0 | >= 11.8.0 |
fill-extrusion-cast-shadows
Enable/Disable shadow casting for this layer
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.7.0 | >= 11.8.0 | >= 11.8.0 |
fill-extrusion-color
"#000000"
. Disabled by fill-extrusion-pattern. Supports feature-state
and interpolate
expressions. Transitionable. The base color of the extruded fill. The extrusion's surfaces will be shaded differently based on this color in combination with the root light
settings. If this color is specified as rgba
with an alpha component, the alpha component will be ignored; use fill-extrusion-opacity
to set layer opacity.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
data-driven styling | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
fill-extrusion-cutoff-fade-range
This parameter defines the range for the fade-out effect before an automatic content cutoff on pitched map views. Fade out is implemented by scaling down and removing buildings in the fade range in a staggered fashion. Opacity is not changed. The fade range is expressed in relation to the height of the map view. A value of 1.0 indicates that the content is faded to the same extent as the map's height in pixels, while a value close to zero represents a sharp cutoff. When the value is set to 0.0, the cutoff is completely disabled. Note: The property has no effect on the map if terrain is enabled.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-edge-radius
Radius of a fill extrusion edge in meters. If not zero, rounds extrusion edges for a smoother appearance.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 10.7.0 | >= 10.7.0 |
expressions support | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-emissive-strength
0
. Units in intensity. Defaults to 0
. Requires lights. Supports feature-state
and interpolate
expressions. Transitionable. Controls the intensity of light emitted on the source features.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.8.0 | >= 11.8.0 | >= 11.8.0 |
fill-extrusion-flood-light-color
"#ffffff"
. Requires lights. Supports interpolate
expressions. Transitionable. The color of the flood light effect on the walls of the extruded buildings.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-flood-light-ground-attenuation
0
and 1
inclusive. Defaults to 0.69
. Requires lights. Supports interpolate
expressions. Transitionable. Provides a control to futher fine-tune the look of the flood light on the ground beneath the extruded buildings. Lower values give the effect a more solid look while higher values make it smoother.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-flood-light-ground-radius
0
. Requires lights. Supports feature-state
and interpolate
expressions. Transitionable. The extent of the flood light effect on the ground beneath the extruded buildings in meters. Note: this experimental property is evaluated once per tile, during tile initialization. Changing the property value could trigger tile reload. The feature-state
styling is deprecated and will get removed soon.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-flood-light-intensity
0
and 1
inclusive. Defaults to 0
. Requires lights. Supports interpolate
expressions. Transitionable. The intensity of the flood light color.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-flood-light-wall-radius
0
. Units in meters. Defaults to 0
. Requires lights. Supports feature-state
and interpolate
expressions. Transitionable. The extent of the flood light effect on the walls of the extruded buildings in meters.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-height
0
. Units in meters. Defaults to 0
. Supports feature-state
and interpolate
expressions. Transitionable. The height with which to extrude this layer.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
data-driven styling | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
fill-extrusion-height-alignment
"terrain"
, "flat"
. Defaults to "flat"
. Requires fill-extrusion-height. Controls the behavior of fill extrusion height over terrain
"terrain"
:The fill extrusion height follows terrain slope.
"flat"
:The fill extrusion height is flat over terrain.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.8.0 | >= 11.8.0 | >= 11.8.0 |
fill-extrusion-line-width
0
. Units in meters. Defaults to 0
. Supports feature-state
and interpolate
expressions. Transitionable. If a non-zero value is provided, it sets the fill-extrusion layer into wall rendering mode. The value is used to render the feature with the given width over the outlines of the geometry. Note: This property is experimental and some other fill-extrusion properties might not be supported with non-zero line width.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.7.0 | >= 11.7.0 | >= 11.7.0 |
data-driven styling | >= 3.7.0 | >= 11.7.0 | >= 11.7.0 |
fill-extrusion-opacity
0
and 1
inclusive. Defaults to 1
. Supports interpolate
expressions. Transitionable. The opacity of the entire fill extrusion layer. This is rendered on a per-layer, not per-feature, basis, and data-driven styling is not available.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
fill-extrusion-pattern
Name of image in sprite to use for drawing images on extruded fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
data-driven styling | >= 0.49.0 | >= 6.5.0 | >= 4.4.0 |
fill-extrusion-rounded-roof
Indicates whether top edges should be rounded when fill-extrusion-edge-radius has a value greater than 0. If false, rounded edges are only applied to the sides. Default is true.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 10.10.0 | >= 10.10.0 |
fill-extrusion-translate
[0,0]
. Supports interpolate
expressions. Transitionable. The geometry's offset. Values are [x, y] where negatives indicate left and up (on the flat plane), respectively.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
fill-extrusion-translate-anchor
"map"
, "viewport"
. Defaults to "map"
. Requires fill-extrusion-translate. Controls the frame of reference for fill-extrusion-translate
.
"map"
:The fill extrusion is translated relative to the map.
"viewport"
:The fill extrusion is translated relative to the viewport.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
fill-extrusion-vertical-gradient
Whether to apply a vertical gradient to the sides of a fill-extrusion layer. If true, sides will be shaded slightly darker farther down.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.50.0 | >= 7.0.0 | >= 4.7.0 |
fill-extrusion-vertical-scale
0
. Defaults to 1
. Supports interpolate
expressions. Transitionable. A global multiplier that can be used to scale base, height, AO, and flood light of the fill extrusions.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
visibility
Whether this layer is displayed.
"visible"
:The layer is shown.
"none"
:The layer is not shown.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
expressions support | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
heatmap
heatmap
style layerは、範囲内のポイントの密度を表す一連の色をレンダリングします。
地震データのこの可視化は、ペイントプロパティが慎重に定義されたHeatmap layerを使用して、地震の頻度が高く多くのポイントが密集しているエリアを強調しています。
heatmap-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"]
. Supports interpolate
expressions. Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses ["heatmap-density"]
as input.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.41.0 | >= 6.0.0 | >= 4.0.0 |
data-driven styling | Not yet supported | Not yet supported | Not yet supported |
heatmap-intensity
0
. Defaults to 1
. Supports interpolate
expressions. Transitionable. Similar to heatmap-weight
but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.41.0 | >= 6.0.0 | >= 4.0.0 |
heatmap-opacity
0
and 1
inclusive. Defaults to 1
. Supports interpolate
expressions. Transitionable. The global opacity at which the heatmap layer will be drawn.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.41.0 | >= 6.0.0 | >= 4.0.0 |
heatmap-radius
1
. Units in pixels. Defaults to 30
. Supports feature-state
and interpolate
expressions. Transitionable. Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed. queryRenderedFeatures
on heatmap layers will return points within this radius.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.41.0 | >= 6.0.0 | >= 4.0.0 |
data-driven styling | >= 0.43.0 | >= 6.0.0 | >= 4.0.0 |
heatmap-weight
0
. Defaults to 1
. Supports feature-state
and interpolate
expressions. A measure of how much an individual point contributes to the heatmap. A value of 10 would be equivalent to having 10 points of weight 1 in the same spot. Especially useful when combined with clustering.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.41.0 | >= 6.0.0 | >= 4.0.0 |
data-driven styling | >= 0.41.0 | >= 6.0.0 | >= 4.0.0 |
visibility
Whether this layer is displayed.
"visible"
:The layer is shown.
"none"
:The layer is not shown.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.41.0 | >= 6.0.0 | >= 4.0.0 |
expressions support | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
hillshade
hillshade
style layerは、クライアント側でデジタル標高モデル(DEM)データをレンダリングします。この実装は、Mapbox Terrain RGB とMapzen Terrariumタイルのみをサポートします。
このシャスタ山の地図は、hillshade-exaggeration
paint propertyを高く設定して強烈な陰影効果を適用しています。
hillshade-accent-color
"#000000"
. Supports interpolate
expressions. Transitionable. The shading color used to accentuate rugged terrain like sharp cliffs and gorges.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.43.0 | >= 6.0.0 | >= 4.0.0 |
hillshade-emissive-strength
0
. Units in intensity. Defaults to 0
. Requires lights. Supports interpolate
expressions. Transitionable. Controls the intensity of light emitted on the source features.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
hillshade-exaggeration
0
and 1
inclusive. Defaults to 0.5
. Supports interpolate
expressions. Transitionable. Intensity of the hillshade
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.43.0 | >= 6.0.0 | >= 4.0.0 |
hillshade-highlight-color
"#FFFFFF"
. Supports interpolate
expressions. Transitionable. The shading color of areas that faces towards the light source.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.43.0 | >= 6.0.0 | >= 4.0.0 |
hillshade-illumination-anchor
Direction of light source when map is rotated.
"map"
:The hillshade illumination is relative to the north direction.
"viewport"
:The hillshade illumination is relative to the top of the viewport.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.43.0 | >= 6.0.0 | >= 4.0.0 |
hillshade-illumination-direction
0
and 359
inclusive. Defaults to 335
. Supports interpolate
expressions. The direction of the light source used to generate the hillshading with 0 as the top of the viewport if hillshade-illumination-anchor
is set to viewport
and due north if hillshade-illumination-anchor
is set to map
and no 3d lights enabled. If hillshade-illumination-anchor
is set to map
and 3d lights enabled, the direction from 3d lights is used instead.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.43.0 | >= 6.0.0 | >= 4.0.0 |
hillshade-shadow-color
"#000000"
. Supports interpolate
expressions. Transitionable. The shading color of areas that face away from the light source.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.43.0 | >= 6.0.0 | >= 4.0.0 |
visibility
Whether this layer is displayed.
"visible"
:The layer is shown.
"none"
:The layer is not shown.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 0.43.0 | >= 6.0.0 | >= 4.0.0 |
expressions support | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
sky
sky
style layerは、地図全体を取り囲むようデザインされた球状ドームを描画し、自動的にすべてのレイヤーの背後にレンダリングされます。これを使用して、特定の時間帯を表す設定された空や、デザインされたカスタムグラデーションで地平線上の領域を埋めることができます。
sky-type: 'atmosphere'
ペイントプロパティを使用したカリフォルニアの砂漠の上にシミュレートされた日の出。
sky-atmosphere-color
A color used to tweak the main atmospheric scattering coefficients. Using white applies the default coefficients giving the natural blue color to the atmosphere. This color affects how heavily the corresponding wavelength is represented during scattering. The alpha channel describes the density of the atmosphere, with 1 maximum density and 0 no density.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 2.0.0 | >= 10.0.0 | >= 10.0.0 |
sky-atmosphere-halo-color
A color applied to the atmosphere sun halo. The alpha channel describes how strongly the sun halo is represented in an atmosphere sky layer.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 2.0.0 | >= 10.0.0 | >= 10.0.0 |
sky-atmosphere-sun
0
and 360
inclusive, between 0
and 180
inclusive ]. Units in degrees. Requires sky-type to be "atmosphere"
. Position of the sun center [a azimuthal angle, p polar angle]. The azimuthal angle indicates the position of the sun relative to 0° north, where degrees proceed clockwise. The polar angle indicates the height of the sun, where 0° is directly above, at zenith, and 90° at the horizon. When this property is ommitted, the sun center is directly inherited from the light position.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 2.0.0 | >= 10.0.0 | >= 10.0.0 |
sky-atmosphere-sun-intensity
0
and 100
inclusive. Defaults to 10
. Requires sky-type to be "atmosphere"
. Intensity of the sun as a light source in the atmosphere (on a scale from 0 to a 100). Setting higher values will brighten up the sky.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 2.0.0 | >= 10.0.0 | >= 10.0.0 |
sky-gradient
["interpolate",["linear"],["sky-radial-progress"],0.8,"#87ceeb",1,"white"]
. Requires sky-type to be "gradient"
. Supports interpolate
expressions. Defines a radial color gradient with which to color the sky. The color values can be interpolated with an expression using sky-radial-progress
. The range [0, 1] for the interpolant covers a radial distance (in degrees) of [0, sky-gradient-radius
] centered at the position specified by sky-gradient-center
.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 2.0.0 | >= 10.0.0 | >= 10.0.0 |
data-driven styling | Not yet supported | Not yet supported | Not yet supported |
sky-gradient-center
0
and 360
inclusive, between 0
and 180
inclusive ]. Units in degrees. Defaults to [0,0]
. Requires sky-type to be "gradient"
. Position of the gradient center [a azimuthal angle, p polar angle]. The azimuthal angle indicates the position of the gradient center relative to 0° north, where degrees proceed clockwise. The polar angle indicates the height of the gradient center, where 0° is directly above, at zenith, and 90° at the horizon.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 2.0.0 | >= 10.0.0 | >= 10.0.0 |
sky-gradient-radius
0
and 180
inclusive. Defaults to 90
. Requires sky-type to be "gradient"
. The angular distance (measured in degrees) from sky-gradient-center
up to which the gradient extends. A value of 180 causes the gradient to wrap around to the opposite direction from sky-gradient-center
.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 2.0.0 | >= 10.0.0 | >= 10.0.0 |
sky-opacity
0
and 1
inclusive. Defaults to 1
. Supports interpolate
expressions. Transitionable. The opacity of the entire sky layer.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 2.0.0 | >= 10.0.0 | >= 10.0.0 |
sky-type
The type of the sky
"gradient"
:Renders the sky with a gradient that can be configured with
sky-gradient-radius
andsky-gradient
."atmosphere"
:Renders the sky with a simulated atmospheric scattering algorithm, the sun direction can be attached to the light position or explicitly set through
sky-atmosphere-sun
.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 2.0.0 | >= 10.0.0 | >= 10.0.0 |
visibility
Whether this layer is displayed.
"visible"
:The layer is shown.
"none"
:The layer is not shown.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 2.0.0 | >= 10.0.0 | >= 10.0.0 |
expressions support | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model
model
style layerは、3Dの建物や簡略化されたモデル(標準スタイルの例として、木)をレンダリングします。model
何文字は以下のソースからコンテンツを描画します:
- ベクターまたはGeoJSON(標準スタイルの木に使用)
batched-model
(標準スタイルのランドマークビルに使用)
サードパーティのモデルを地図上に配置するには、最初のアプローチを使用する必要があります。model
何文字のプロパティを使用して、モデルの回転、スケール、色、色混合、詳細度を調整することができます。
model-id
layout propertyおよびmodel-rotation
paint propertyを使用して地図上にレンダリングされたさまざまな木。
model-ambient-occlusion-intensity
0
and 1
inclusive. Defaults to 1
. Supports interpolate
expressions. Transitionable. Intensity of the ambient occlusion if present in the 3D model.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-cast-shadows
Enable/Disable shadow casting for this layer
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-color
"#ffffff"
. Supports feature-state
and interpolate
expressions. Transitionable. The tint color of the model layer. model-color-mix-intensity (defaults to 0) defines tint(mix) intensity - this means that, this color is not used unless model-color-mix-intensity gets value greater than 0. Expressions that depend on measure-light are not supported when using GeoJSON or vector tile as the model layer source.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-color-mix-intensity
0
and 1
inclusive. Defaults to 0
. Supports feature-state
and interpolate
expressions. Transitionable. Intensity of model-color (on a scale from 0 to 1) in color mix with original 3D model's colors. Higher number will present a higher model-color contribution in mix. Expressions that depend on measure-light are not supported when using GeoJSON or vector tile as the model layer source.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-cutoff-fade-range
This parameter defines the range for the fade-out effect before an automatic content cutoff on pitched map views. The automatic cutoff range is calculated according to the minimum required zoom level of the source and layer. The fade range is expressed in relation to the height of the map view. A value of 1.0 indicates that the content is faded to the same extent as the map's height in pixels, while a value close to zero represents a sharp cutoff. When the value is set to 0.0, the cutoff is completely disabled. Note: The property has no effect on the map if terrain is enabled.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-emissive-strength
0
and 5
inclusive. Units in intensity. Defaults to 0
. Supports feature-state
and interpolate
expressions. Transitionable. Strength of the emission. There is no emission for value 0. For value 1.0, only emissive component (no shading) is displayed and values above 1.0 produce light contribution to surrounding area, for some of the parts (e.g. doors). Expressions that depend on measure-light are only supported as a global layer value (and not for each feature) when using GeoJSON or vector tile as the model layer source.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-height-based-emissive-strength-multiplier
[1,1,1,1,0]
. Supports feature-state
and interpolate
expressions. Transitionable. Emissive strength multiplier along model height (gradient begin, gradient end, value at begin, value at end, gradient curve power (logarithmic scale, curve power = pow(10, val)).
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-id
Model to render. It can be either a string referencing an element to the models root property or an internal or external URL
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-opacity
0
and 1
inclusive. Defaults to 1
. Supports feature-state
and interpolate
expressions. Transitionable. The opacity of the model layer. Except for zoom, expressions that are data-driven are not supported if using GeoJSON or vector tile as the model layer source.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.9.0 | >= 11.9.0 | >= 11.9.0 |
model-receive-shadows
Enable/Disable shadow receiving for this layer
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-rotation
[0,0,0]
. Supports feature-state
and interpolate
expressions. Transitionable. The rotation of the model in euler angles [lon, lat, z].
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-roughness
0
and 1
inclusive. Defaults to 1
. Supports feature-state
and interpolate
expressions. Transitionable. Material roughness. Material is fully smooth for value 0, and fully rough for value 1. Affects only layers using batched-model source.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-scale
[1,1,1]
. Supports feature-state
and interpolate
expressions. Transitionable. The scale of the model. Expressions that are zoom-dependent are not supported if using GeoJSON or vector tile as the model layer source.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-translation
[0,0,0]
. Supports feature-state
and interpolate
expressions. Transitionable. The translation of the model in meters in form of [longitudal, latitudal, altitude] offsets.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-type
Defines rendering behavior of model in respect to other 3D scene objects.
"common-3d"
:Integrated to 3D scene, using depth testing, along with terrain, fill-extrusions and custom layer.
"location-indicator"
:Displayed over other 3D content, occluded by terrain.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
visibility
Whether this layer is displayed.
"visible"
:The layer is shown.
"none"
:The layer is not shown.
SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |