SymbolLayer.md

<!-- This file was autogenerated from SymbolLayer.tsx do not modify -->

  Mapbox spec: [symbol](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#symbol)
  

```tsx
import { SymbolLayer } from '@rnmapbox/maps';

SymbolLayer

```
SymbolLayer is a style layer that renders icon and text labels at points or along lines on the map.

## props

  
### id

```tsx
string
```
_required_
A string that uniquely identifies the source in the style to which it is added.


  
### existing

```tsx
boolean
```
The id refers to an existing layer in the style. Does not create a new layer.


  
### sourceID

```tsx
string
```
The source from which to obtain the data to style.
If the source has not yet been added to the current style, the behavior is undefined.
Inferred from parent source only if the layer is a direct child to it.

  _defaults to:_ `Mapbox.StyleSource.DefaultSourceID`

  
### sourceLayerID

```tsx
string
```
Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style.


  
### aboveLayerID

```tsx
string
```
Inserts a layer above aboveLayerID.


  
### belowLayerID

```tsx
string
```
Inserts a layer below belowLayerID


  
### layerIndex

```tsx
number
```
Inserts a layer at a specified index


  
### filter

```tsx
FilterExpression
```
Filter only the features in the source layer that satisfy a condition that you define


  
### minZoomLevel

```tsx
number
```
The minimum zoom level at which the layer gets parsed and appears.


  
### maxZoomLevel

```tsx
number
```
The maximum zoom level at which the layer gets parsed and appears.


  
### slot

```tsx
'bottom' | 'middle' | 'top'
```
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.

v11 only


  
### style

```tsx
SymbolLayerStyleProps
```
_required_
Customizable style attributes


  
### children

```tsx
JSX.Element | JSX.Element[]
```
@deprecated passed children used to create an image with id of symbol in style and also set the iconImageName property accordingly.
This is now deprecated, use Image component instead.


  






## styles

* <a href="#symbolplacement">symbolPlacement</a><br/>
* <a href="#symbolspacing">symbolSpacing</a><br/>
* <a href="#symbolavoidedges">symbolAvoidEdges</a><br/>
* <a href="#symbolsortkey">symbolSortKey</a><br/>
* <a href="#symbolzorder">symbolZOrder</a><br/>
* <a href="#symbolzelevate">symbolZElevate</a><br/>
* <a href="#symbolelevationreference">symbolElevationReference</a><br/>
* <a href="#iconallowoverlap">iconAllowOverlap</a><br/>
* <a href="#iconignoreplacement">iconIgnorePlacement</a><br/>
* <a href="#iconoptional">iconOptional</a><br/>
* <a href="#iconrotationalignment">iconRotationAlignment</a><br/>
* <a href="#iconsize">iconSize</a><br/>
* <a href="#icontextfit">iconTextFit</a><br/>
* <a href="#icontextfitpadding">iconTextFitPadding</a><br/>
* <a href="#iconimage">iconImage</a><br/>
* <a href="#iconrotate">iconRotate</a><br/>
* <a href="#iconpadding">iconPadding</a><br/>
* <a href="#iconkeepupright">iconKeepUpright</a><br/>
* <a href="#iconoffset">iconOffset</a><br/>
* <a href="#iconanchor">iconAnchor</a><br/>
* <a href="#iconpitchalignment">iconPitchAlignment</a><br/>
* <a href="#textpitchalignment">textPitchAlignment</a><br/>
* <a href="#textrotationalignment">textRotationAlignment</a><br/>
* <a href="#textfield">textField</a><br/>
* <a href="#textfont">textFont</a><br/>
* <a href="#textsize">textSize</a><br/>
* <a href="#textmaxwidth">textMaxWidth</a><br/>
* <a href="#textlineheight">textLineHeight</a><br/>
* <a href="#textletterspacing">textLetterSpacing</a><br/>
* <a href="#textjustify">textJustify</a><br/>
* <a href="#textradialoffset">textRadialOffset</a><br/>
* <a href="#textvariableanchor">textVariableAnchor</a><br/>
* <a href="#textanchor">textAnchor</a><br/>
* <a href="#textmaxangle">textMaxAngle</a><br/>
* <a href="#textwritingmode">textWritingMode</a><br/>
* <a href="#textrotate">textRotate</a><br/>
* <a href="#textpadding">textPadding</a><br/>
* <a href="#textkeepupright">textKeepUpright</a><br/>
* <a href="#texttransform">textTransform</a><br/>
* <a href="#textoffset">textOffset</a><br/>
* <a href="#textallowoverlap">textAllowOverlap</a><br/>
* <a href="#textignoreplacement">textIgnorePlacement</a><br/>
* <a href="#textoptional">textOptional</a><br/>
* <a href="#visibility">visibility</a><br/>
* <a href="#iconopacity">iconOpacity</a><br/>
* <a href="#iconocclusionopacity">iconOcclusionOpacity</a><br/>
* <a href="#iconemissivestrength">iconEmissiveStrength</a><br/>
* <a href="#textemissivestrength">textEmissiveStrength</a><br/>
* <a href="#iconcolor">iconColor</a><br/>
* <a href="#iconhalocolor">iconHaloColor</a><br/>
* <a href="#iconhalowidth">iconHaloWidth</a><br/>
* <a href="#iconhaloblur">iconHaloBlur</a><br/>
* <a href="#icontranslate">iconTranslate</a><br/>
* <a href="#icontranslateanchor">iconTranslateAnchor</a><br/>
* <a href="#iconimagecrossfade">iconImageCrossFade</a><br/>
* <a href="#textopacity">textOpacity</a><br/>
* <a href="#textocclusionopacity">textOcclusionOpacity</a><br/>
* <a href="#textcolor">textColor</a><br/>
* <a href="#texthalocolor">textHaloColor</a><br/>
* <a href="#texthalowidth">textHaloWidth</a><br/>
* <a href="#texthaloblur">textHaloBlur</a><br/>
* <a href="#texttranslate">textTranslate</a><br/>
* <a href="#texttranslateanchor">textTranslateAnchor</a><br/>
* <a href="#iconcolorsaturation">iconColorSaturation</a><br/>
* <a href="#iconcolorcontrast">iconColorContrast</a><br/>
* <a href="#iconcolorbrightnessmin">iconColorBrightnessMin</a><br/>
* <a href="#iconcolorbrightnessmax">iconColorBrightnessMax</a><br/>
* <a href="#symbolzoffset">symbolZOffset</a><br/>

___

### symbolPlacement
Name: `symbolPlacement`

Mapbox spec: [symbol-placement](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-symbol-placement)

#### Description
Label placement relative to its geometry.

#### Type
`enum`
#### Default Value
`point`

#### Supported Values
**point** - The label is placed at the point where the geometry is located.<br />
**line** - The label is placed along the line of the geometry. Can only be used on `LineString` and `Polygon` geometries.<br />
**line-center** - The label is placed at the center of the line of the geometry. Can only be used on `LineString` and `Polygon` geometries. Note that a single feature in a vector tile may contain multiple line geometries.<br />


#### Expression

Parameters: `zoom`

___

### symbolSpacing
Name: `symbolSpacing`

Mapbox spec: [symbol-spacing](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-symbol-spacing)

#### Description
Distance between two symbol anchors.

#### Type
`number`
#### Default Value
`250`

#### Units
`pixels`

#### Minimum
`1`


#### Expression

Parameters: `zoom`

___

### symbolAvoidEdges
Name: `symbolAvoidEdges`

Mapbox spec: [symbol-avoid-edges](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-symbol-avoid-edges)

#### Description
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.

#### Type
`boolean`
#### Default Value
`false`


#### Expression

Parameters: `zoom`

___

### symbolSortKey
Name: `symbolSortKey`

Mapbox spec: [symbol-sort-key](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-symbol-sort-key)

#### Description
Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When `iconAllowOverlap` or `textAllowOverlap` is `false`, features with a lower sort key will have priority during placement. When `iconAllowOverlap` or `textAllowOverlap` is set to `true`, features with a higher sort key will overlap over features with a lower sort key.

#### Type
`number`


#### Expression

Parameters: `zoom, feature`

___

### symbolZOrder
Name: `symbolZOrder`

Mapbox spec: [symbol-z-order](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-symbol-z-order)

#### Description
Determines whether overlapping symbols in the same layer are rendered in the order that they appear in the data source or by their yPosition relative to the viewport. To control the order and prioritization of symbols otherwise, use `symbolSortKey`.

#### Type
`enum`
#### Default Value
`auto`

#### Supported Values
**auto** - Sorts symbols by `symbol-sort-key` if set. Otherwise, sorts symbols by their y-position relative to the viewport if `icon-allow-overlap` or `text-allow-overlap` is set to `true` or `icon-ignore-placement` or `text-ignore-placement` is `false`.<br />
**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`.<br />
**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.<br />


#### Expression

Parameters: `zoom`

___

### symbolZElevate
Name: `symbolZElevate`

Mapbox spec: [symbol-z-elevate](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-symbol-z-elevate)

#### Description
Position symbol on buildings (both fill extrusions and models) rooftops. In order to have minimal impact on performance, this is supported only when `fillExtrusionHeight` is not zoomDependent and remains unchanged. For fading in buildings when zooming in, fillExtrusionVerticalScale should be used and symbols would raise with building rooftops. Symbols are sorted by elevation, except in cases when `viewportY` sorting or `symbolSortKey` are applied.

#### Type
`boolean`
#### Default Value
`false`


#### Expression

Parameters: `zoom`

___

### symbolElevationReference
Name: `symbolElevationReference`

Mapbox spec: [symbol-elevation-reference](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-symbol-elevation-reference)

#### Description
Selects the base of symbolElevation.

#### Type
`enum`
#### Default Value
`ground`

#### Supported Values
**sea** - Elevate symbols relative to the sea level.<br />
**ground** - Elevate symbols relative to the ground's height below them.<br />
**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.<br />


#### Expression

Parameters: `zoom`

___

### iconAllowOverlap
Name: `iconAllowOverlap`

Mapbox spec: [icon-allow-overlap](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-icon-allow-overlap)

#### Description
If true, the icon will be visible even if it collides with other previously drawn symbols.

#### Type
`boolean`
#### Default Value
`false`


#### Requires
`iconImage`

#### Expression

Parameters: `zoom`

___

### iconIgnorePlacement
Name: `iconIgnorePlacement`

Mapbox spec: [icon-ignore-placement](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-icon-ignore-placement)

#### Description
If true, other symbols can be visible even if they collide with the icon.

#### Type
`boolean`
#### Default Value
`false`


#### Requires
`iconImage`

#### Expression

Parameters: `zoom`

___

### iconOptional
Name: `iconOptional`

Mapbox spec: [icon-optional](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-icon-optional)

#### Description
If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.

#### Type
`boolean`
#### Default Value
`false`


#### Requires
`iconImage, textField`

#### Expression

Parameters: `zoom`

___

### iconRotationAlignment
Name: `iconRotationAlignment`

Mapbox spec: [icon-rotation-alignment](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-icon-rotation-alignment)

#### Description
In combination with `symbolPlacement`, determines the rotation behavior of icons.

#### Type
`enum`
#### Default Value
`auto`

#### Supported Values
**map** - When `symbol-placement` is set to `point`, aligns icons east-west. When `symbol-placement` is set to `line` or `line-center`, aligns icon x-axes with the line.<br />
**viewport** - Produces icons whose x-axes are aligned with the x-axis of the viewport, regardless of the value of `symbol-placement`.<br />
**auto** - When `symbol-placement` is set to `point`, this is equivalent to `viewport`. When `symbol-placement` is set to `line` or `line-center`, this is equivalent to `map`.<br />


#### Requires
`iconImage`

#### Expression

Parameters: `zoom`

___

### iconSize
Name: `iconSize`

Mapbox spec: [icon-size](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-icon-size)

#### Description
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 `iconSize`. 1 is the original size; 3 triples the size of the image.

#### Type
`number`
#### Default Value
`1`

#### Units
`factor of the original icon size`

#### Minimum
`0`


#### Requires
`iconImage`

#### Expression

Parameters: `zoom, feature`

___

### iconTextFit
Name: `iconTextFit`

Mapbox spec: [icon-text-fit](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-icon-text-fit)

#### Description
Scales the icon to fit around the associated text.

#### Type
`enum`
#### Default Value
`none`

#### Supported Values
**none** - The icon is displayed at its intrinsic aspect ratio.<br />
**width** - The icon is scaled in the x-dimension to fit the width of the text.<br />
**height** - The icon is scaled in the y-dimension to fit the height of the text.<br />
**both** - The icon is scaled in both x- and y-dimensions.<br />


#### Requires
`iconImage, textField`

#### Expression

Parameters: `zoom, feature`

___

### iconTextFitPadding
Name: `iconTextFitPadding`

Mapbox spec: [icon-text-fit-padding](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-icon-text-fit-padding)

#### Description
Size of the additional area added to dimensions determined by `iconTextFit`, in clockwise order: top, right, bottom, left.

#### Type
`array<number>`
#### Default Value
`[0,0,0,0]`

#### Units
`pixels`


#### Requires
`iconImage, textField`

#### Expression

Parameters: `zoom, feature`

___

### iconImage
Name: `iconImage`

Mapbox spec: [icon-image](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-icon-image)

#### Description
Name of image in sprite to use for drawing an image background.

#### Type
`resolvedImage`


#### Expression

Parameters: `zoom, feature`

___

### iconRotate
Name: `iconRotate`

Mapbox spec: [icon-rotate](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-icon-rotate)

#### Description
Rotates the icon clockwise.

#### Type
`number`
#### Default Value
`0`

#### Units
`degrees`


#### Requires
`iconImage`

#### Expression

Parameters: `zoom, feature`

___

### iconPadding
Name: `iconPadding`

Mapbox spec: [icon-padding](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-icon-padding)

#### Description
Size of the additional area around the icon bounding box used for detecting symbol collisions.

#### Type
`number`
#### Default Value
`2`

#### Units
`pixels`

#### Minimum
`0`


#### Requires
`iconImage`

#### Expression

Parameters: `zoom`

___

### iconKeepUpright
Name: `iconKeepUpright`

Mapbox spec: [icon-keep-upright](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-icon-keep-upright)

#### Description
If true, the icon may be flipped to prevent it from being rendered upsideDown.

#### Type
`boolean`
#### Default Value
`false`


#### Requires
`iconImage`

#### Expression

Parameters: `zoom`

___

### iconOffset
Name: `iconOffset`

Mapbox spec: [icon-offset](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-icon-offset)

#### Description
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 `iconSize` to obtain the final offset in pixels. When combined with `iconRotate` the offset will be as if the rotated direction was up.

#### Type
`array<number>`
#### Default Value
`[0,0]`


#### Requires
`iconImage`

#### Expression

Parameters: `zoom, feature`

___

### iconAnchor
Name: `iconAnchor`

Mapbox spec: [icon-anchor](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-icon-anchor)

#### Description
Part of the icon placed closest to the anchor.

#### Type
`enum`
#### Default Value
`center`

#### Supported Values
**center** - The center of the icon is placed closest to the anchor.<br />
**left** - The left side of the icon is placed closest to the anchor.<br />
**right** - The right side of the icon is placed closest to the anchor.<br />
**top** - The top of the icon is placed closest to the anchor.<br />
**bottom** - The bottom of the icon is placed closest to the anchor.<br />
**top-left** - The top left corner of the icon is placed closest to the anchor.<br />
**top-right** - The top right corner of the icon is placed closest to the anchor.<br />
**bottom-left** - The bottom left corner of the icon is placed closest to the anchor.<br />
**bottom-right** - The bottom right corner of the icon is placed closest to the anchor.<br />


#### Requires
`iconImage`

#### Expression

Parameters: `zoom, feature`

___

### iconPitchAlignment
Name: `iconPitchAlignment`

Mapbox spec: [icon-pitch-alignment](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-icon-pitch-alignment)

#### Description
Orientation of icon when map is pitched.

#### Type
`enum`
#### Default Value
`auto`

#### Supported Values
**map** - The icon is aligned to the plane of the map.<br />
**viewport** - The icon is aligned to the plane of the viewport.<br />
**auto** - Automatically matches the value of `icon-rotation-alignment`.<br />


#### Requires
`iconImage`

#### Expression

Parameters: `zoom`

___

### textPitchAlignment
Name: `textPitchAlignment`

Mapbox spec: [text-pitch-alignment](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-pitch-alignment)

#### Description
Orientation of text when map is pitched.

#### Type
`enum`
#### Default Value
`auto`

#### Supported Values
**map** - The text is aligned to the plane of the map.<br />
**viewport** - The text is aligned to the plane of the viewport.<br />
**auto** - Automatically matches the value of `text-rotation-alignment`.<br />


#### Requires
`textField`

#### Expression

Parameters: `zoom`

___

### textRotationAlignment
Name: `textRotationAlignment`

Mapbox spec: [text-rotation-alignment](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-rotation-alignment)

#### Description
In combination with `symbolPlacement`, determines the rotation behavior of the individual glyphs forming the text.

#### Type
`enum`
#### Default Value
`auto`

#### Supported Values
**map** - When `symbol-placement` is set to `point`, aligns text east-west. When `symbol-placement` is set to `line` or `line-center`, aligns text x-axes with the line.<br />
**viewport** - Produces glyphs whose x-axes are aligned with the x-axis of the viewport, regardless of the value of `symbol-placement`.<br />
**auto** - When `symbol-placement` is set to `point`, this is equivalent to `viewport`. When `symbol-placement` is set to `line` or `line-center`, this is equivalent to `map`.<br />


#### Requires
`textField`

#### Expression

Parameters: `zoom`

___

### textField
Name: `textField`

Mapbox spec: [text-field](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-field)

#### Description
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.

#### Type
`formatted`
#### Default Value
``


#### Expression

Parameters: `zoom, feature`

___

### textFont
Name: `textFont`

Mapbox spec: [text-font](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-font)

#### Description
Font stack to use for displaying text.

#### Type
`array<string>`
#### Default Value
`[Open Sans Regular,Arial Unicode MS Regular]`


#### Requires
`textField`

#### Supported Style Functions
`camera`
#### Expression

Parameters: `zoom, feature`

___

### textSize
Name: `textSize`

Mapbox spec: [text-size](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-size)

#### Description
Font size.

#### Type
`number`
#### Default Value
`16`

#### Units
`pixels`

#### Minimum
`0`


#### Requires
`textField`

#### Expression

Parameters: `zoom, feature`

___

### textMaxWidth
Name: `textMaxWidth`

Mapbox spec: [text-max-width](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-max-width)

#### Description
The maximum line width for text wrapping.

#### Type
`number`
#### Default Value
`10`

#### Units
`ems`

#### Minimum
`0`


#### Requires
`textField`

#### Supported Style Functions
`camera`
#### Expression

Parameters: `zoom, feature`

___

### textLineHeight
Name: `textLineHeight`

Mapbox spec: [text-line-height](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-line-height)

#### Description
Text leading value for multiLine text.

#### Type
`number`
#### Default Value
`1.2`

#### Units
`ems`


#### Requires
`textField`

#### Expression

Parameters: `zoom, feature`

___

### textLetterSpacing
Name: `textLetterSpacing`

Mapbox spec: [text-letter-spacing](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-letter-spacing)

#### Description
Text tracking amount.

#### Type
`number`
#### Default Value
`0`

#### Units
`ems`


#### Requires
`textField`

#### Supported Style Functions
`camera`
#### Expression

Parameters: `zoom, feature`

___

### textJustify
Name: `textJustify`

Mapbox spec: [text-justify](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-justify)

#### Description
Text justification options.

#### Type
`enum`
#### Default Value
`center`

#### Supported Values
**auto** - The text is aligned towards the anchor position.<br />
**left** - The text is aligned to the left.<br />
**center** - The text is centered.<br />
**right** - The text is aligned to the right.<br />


#### Requires
`textField`

#### Supported Style Functions
`camera`
#### Expression

Parameters: `zoom, feature`

___

### textRadialOffset
Name: `textRadialOffset`

Mapbox spec: [text-radial-offset](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-radial-offset)

#### Description
Radial offset of text, in the direction of the symbol's anchor. Useful in combination with `textVariableAnchor`, which defaults to using the twoDimensional `textOffset` if present.

#### Type
`number`
#### Default Value
`0`

#### Units
`ems`


#### Requires
`textField`

#### Expression

Parameters: `zoom, feature`

___

### textVariableAnchor
Name: `textVariableAnchor`

Mapbox spec: [text-variable-anchor](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-variable-anchor)

#### Description
To increase the chance of placing highPriority labels on the map, you can provide an array of `textAnchor` locations: the renderer will attempt to place the label at each location, in order, before moving onto the next label. Use `textJustify: auto` to choose justification based on anchor position. To apply an offset, use the `textRadialOffset` or the twoDimensional `textOffset`. Known issue: at the moment having both `appearances` and `textVariableAnchor` in the same layer doesn't work correctly.

#### Type
`array<enum>`


#### Requires
`textField`

#### Expression

Parameters: `zoom`

___

### textAnchor
Name: `textAnchor`

Mapbox spec: [text-anchor](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-anchor)

#### Description
Part of the text placed closest to the anchor.

#### Type
`enum`
#### Default Value
`center`

#### Supported Values
**center** - The center of the text is placed closest to the anchor.<br />
**left** - The left side of the text is placed closest to the anchor.<br />
**right** - The right side of the text is placed closest to the anchor.<br />
**top** - The top of the text is placed closest to the anchor.<br />
**bottom** - The bottom of the text is placed closest to the anchor.<br />
**top-left** - The top left corner of the text is placed closest to the anchor.<br />
**top-right** - The top right corner of the text is placed closest to the anchor.<br />
**bottom-left** - The bottom left corner of the text is placed closest to the anchor.<br />
**bottom-right** - The bottom right corner of the text is placed closest to the anchor.<br />


#### Requires
`textField`

#### Disabled By
`textVariableAnchor`

#### Supported Style Functions
`camera`
#### Expression

Parameters: `zoom, feature`

___

### textMaxAngle
Name: `textMaxAngle`

Mapbox spec: [text-max-angle](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-max-angle)

#### Description
Maximum angle change between adjacent characters.

#### Type
`number`
#### Default Value
`45`

#### Units
`degrees`


#### Requires
`textField`

#### Expression

Parameters: `zoom`

___

### textWritingMode
Name: `textWritingMode`

Mapbox spec: [text-writing-mode](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-writing-mode)

#### Description
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.

#### Type
`array<enum>`


#### Requires
`textField`

#### Expression

Parameters: `zoom`

___

### textRotate
Name: `textRotate`

Mapbox spec: [text-rotate](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-rotate)

#### Description
Rotates the text clockwise.

#### Type
`number`
#### Default Value
`0`

#### Units
`degrees`


#### Requires
`textField`

#### Expression

Parameters: `zoom, feature`

___

### textPadding
Name: `textPadding`

Mapbox spec: [text-padding](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-padding)

#### Description
Size of the additional area around the text bounding box used for detecting symbol collisions.

#### Type
`number`
#### Default Value
`2`

#### Units
`pixels`

#### Minimum
`0`


#### Requires
`textField`

#### Expression

Parameters: `zoom`

___

### textKeepUpright
Name: `textKeepUpright`

Mapbox spec: [text-keep-upright](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-keep-upright)

#### Description
If true, the text may be flipped vertically to prevent it from being rendered upsideDown.

#### Type
`boolean`
#### Default Value
`true`


#### Requires
`textField`

#### Expression

Parameters: `zoom`

___

### textTransform
Name: `textTransform`

Mapbox spec: [text-transform](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-transform)

#### Description
Specifies how to capitalize text, similar to the CSS `textTransform` property.

#### Type
`enum`
#### Default Value
`none`

#### Supported Values
**none** - The text is not altered.<br />
**uppercase** - Forces all letters to be displayed in uppercase.<br />
**lowercase** - Forces all letters to be displayed in lowercase.<br />


#### Requires
`textField`

#### Expression

Parameters: `zoom, feature`

___

### textOffset
Name: `textOffset`

Mapbox spec: [text-offset](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-offset)

#### Description
Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up. If used with textVariableAnchor, input values will be taken as absolute values. Offsets along the x and yAxis will be applied automatically based on the anchor position.

#### Type
`array<number>`
#### Default Value
`[0,0]`

#### Units
`ems`


#### Requires
`textField`

#### Disabled By
`textRadialOffset`

#### Expression

Parameters: `zoom, feature`

___

### textAllowOverlap
Name: `textAllowOverlap`

Mapbox spec: [text-allow-overlap](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-allow-overlap)

#### Description
If true, the text will be visible even if it collides with other previously drawn symbols.

#### Type
`boolean`
#### Default Value
`false`


#### Requires
`textField`

#### Expression

Parameters: `zoom`

___

### textIgnorePlacement
Name: `textIgnorePlacement`

Mapbox spec: [text-ignore-placement](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-ignore-placement)

#### Description
If true, other symbols can be visible even if they collide with the text.

#### Type
`boolean`
#### Default Value
`false`


#### Requires
`textField`

#### Expression

Parameters: `zoom`

___

### textOptional
Name: `textOptional`

Mapbox spec: [text-optional](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-text-optional)

#### Description
If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.

#### Type
`boolean`
#### Default Value
`false`


#### Requires
`textField, iconImage`

#### Expression

Parameters: `zoom`

___

### visibility
Name: `visibility`

Mapbox spec: [visibility](https://docs.mapbox.com/style-spec/reference/layers/#layout-symbol-visibility)

#### Description
Whether this layer is displayed.

#### Type
`enum`
#### Default Value
`visible`

#### Supported Values
**visible** - The layer is shown.<br />
**none** - The layer is not shown.<br />


#### Expression

Parameters: ``

___

### iconOpacity
Name: `iconOpacity`

Mapbox spec: [icon-opacity](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-icon-opacity)

#### Description
The opacity at which the icon will be drawn.

#### Type
`number`
#### Default Value
`1`

#### Minimum
`0`


#### Maximum
`1`

#### Requires
`iconImage`

#### Expression

Parameters: `zoom, feature, feature-state, measure-light`
___

### iconOpacityTransition
Name: `iconOpacityTransition`

#### Description

The transition affecting any changes to this layer’s iconOpacity property.

#### Type

`{ duration, delay }`

#### Units
`milliseconds`

#### Default Value
`{duration: 300, delay: 0}`


___

### iconOcclusionOpacity
Name: `iconOcclusionOpacity`

Mapbox spec: [icon-occlusion-opacity](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-icon-occlusion-opacity)

#### Description
The opacity at which the icon will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only.

#### Type
`number`
#### Default Value
`0`

#### Minimum
`0`


#### Maximum
`1`

#### Requires
`iconImage`

#### Expression

Parameters: `zoom, feature, feature-state, measure-light`
___

### iconOcclusionOpacityTransition
Name: `iconOcclusionOpacityTransition`

#### Description

The transition affecting any changes to this layer’s iconOcclusionOpacity property.

#### Type

`{ duration, delay }`

#### Units
`milliseconds`

#### Default Value
`{duration: 300, delay: 0}`


___

### iconEmissiveStrength
Name: `iconEmissiveStrength`

Mapbox spec: [icon-emissive-strength](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-icon-emissive-strength)

#### Description
Controls the intensity of light emitted on the source features.

#### Type
`number`
#### Default Value
`1`

#### Units
`intensity`

#### Minimum
`0`


#### Requires
`lights`

#### Expression

Parameters: `zoom, measure-light, feature-state`
___

### iconEmissiveStrengthTransition
Name: `iconEmissiveStrengthTransition`

#### Description

The transition affecting any changes to this layer’s iconEmissiveStrength property.

#### Type

`{ duration, delay }`

#### Units
`milliseconds`

#### Default Value
`{duration: 300, delay: 0}`


___

### textEmissiveStrength
Name: `textEmissiveStrength`

Mapbox spec: [text-emissive-strength](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-text-emissive-strength)

#### Description
Controls the intensity of light emitted on the source features.

#### Type
`number`
#### Default Value
`1`

#### Units
`intensity`

#### Minimum
`0`


#### Requires
`lights`

#### Expression

Parameters: `zoom, measure-light, feature-state`
___

### textEmissiveStrengthTransition
Name: `textEmissiveStrengthTransition`

#### Description

The transition affecting any changes to this layer’s textEmissiveStrength property.

#### Type

`{ duration, delay }`

#### Units
`milliseconds`

#### Default Value
`{duration: 300, delay: 0}`


___

### iconColor
Name: `iconColor`

Mapbox spec: [icon-color](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-icon-color)

#### Description
The color of the icon. This can only be used with [SDF icons](https://docs.mapbox.com/help/troubleshooting/using-recolorable-images-in-mapbox-maps/).

#### Type
`color`
#### Default Value
`#000000`


#### Requires
`iconImage`

#### Expression

Parameters: `zoom, feature, feature-state, measure-light`
___

### iconColorTransition
Name: `iconColorTransition`

#### Description

The transition affecting any changes to this layer’s iconColor property.

#### Type

`{ duration, delay }`

#### Units
`milliseconds`

#### Default Value
`{duration: 300, delay: 0}`


___

### iconHaloColor
Name: `iconHaloColor`

Mapbox spec: [icon-halo-color](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-icon-halo-color)

#### Description
The color of the icon's halo. Icon halos can only be used with [SDF icons](https://docs.mapbox.com/help/troubleshooting/using-recolorable-images-in-mapbox-maps/).

#### Type
`color`
#### Default Value
`rgba(0, 0, 0, 0)`


#### Requires
`iconImage`

#### Expression

Parameters: `zoom, feature, feature-state, measure-light`
___

### iconHaloColorTransition
Name: `iconHaloColorTransition`

#### Description

The transition affecting any changes to this layer’s iconHaloColor property.

#### Type

`{ duration, delay }`

#### Units
`milliseconds`

#### Default Value
`{duration: 300, delay: 0}`


___

### iconHaloWidth
Name: `iconHaloWidth`

Mapbox spec: [icon-halo-width](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-icon-halo-width)

#### Description
Distance of halo to the icon outline.

#### Type
`number`
#### Default Value
`0`

#### Units
`pixels`

#### Minimum
`0`


#### Requires
`iconImage`

#### Expression

Parameters: `zoom, feature, feature-state, measure-light`
___

### iconHaloWidthTransition
Name: `iconHaloWidthTransition`

#### Description

The transition affecting any changes to this layer’s iconHaloWidth property.

#### Type

`{ duration, delay }`

#### Units
`milliseconds`

#### Default Value
`{duration: 300, delay: 0}`


___

### iconHaloBlur
Name: `iconHaloBlur`

Mapbox spec: [icon-halo-blur](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-icon-halo-blur)

#### Description
Fade out the halo towards the outside.

#### Type
`number`
#### Default Value
`0`

#### Units
`pixels`

#### Minimum
`0`


#### Requires
`iconImage`

#### Expression

Parameters: `zoom, feature, feature-state, measure-light`
___

### iconHaloBlurTransition
Name: `iconHaloBlurTransition`

#### Description

The transition affecting any changes to this layer’s iconHaloBlur property.

#### Type

`{ duration, delay }`

#### Units
`milliseconds`

#### Default Value
`{duration: 300, delay: 0}`


___

### iconTranslate
Name: `iconTranslate`

Mapbox spec: [icon-translate](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-icon-translate)

#### Description
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.

#### Type
`array<number>`
#### Default Value
`[0,0]`

#### Units
`pixels`


#### Requires
`iconImage`

#### Expression

Parameters: `zoom`
___

### iconTranslateTransition
Name: `iconTranslateTransition`

#### Description

The transition affecting any changes to this layer’s iconTranslate property.

#### Type

`{ duration, delay }`

#### Units
`milliseconds`

#### Default Value
`{duration: 300, delay: 0}`


___

### iconTranslateAnchor
Name: `iconTranslateAnchor`

Mapbox spec: [icon-translate-anchor](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-icon-translate-anchor)

#### Description
Controls the frame of reference for `iconTranslate`.

#### Type
`enum`
#### Default Value
`map`

#### Supported Values
**map** - Icons are translated relative to the map.<br />
**viewport** - Icons are translated relative to the viewport.<br />


#### Requires
`iconImage, iconTranslate`

#### Expression

Parameters: `zoom`

___

### iconImageCrossFade
Name: `iconImageCrossFade`

Mapbox spec: [icon-image-cross-fade](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-icon-image-cross-fade)

#### Description
Controls the transition progress between the image variants of iconImage. Zero means the first variant is used, one is the second, and in between they are blended together. . Both images should be the same size and have the same type (either raster or vector).

#### Type
`number`
#### Default Value
`0`

#### Minimum
`0`


#### Maximum
`1`

#### Requires
`iconImage`

#### Expression

Parameters: `zoom, measure-light`

___

### textOpacity
Name: `textOpacity`

Mapbox spec: [text-opacity](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-text-opacity)

#### Description
The opacity at which the text will be drawn.

#### Type
`number`
#### Default Value
`1`

#### Minimum
`0`


#### Maximum
`1`

#### Requires
`textField`

#### Expression

Parameters: `zoom, feature, feature-state, measure-light`
___

### textOpacityTransition
Name: `textOpacityTransition`

#### Description

The transition affecting any changes to this layer’s textOpacity property.

#### Type

`{ duration, delay }`

#### Units
`milliseconds`

#### Default Value
`{duration: 300, delay: 0}`


___

### textOcclusionOpacity
Name: `textOcclusionOpacity`

Mapbox spec: [text-occlusion-opacity](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-text-occlusion-opacity)

#### Description
The opacity at which the text will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only.

#### Type
`number`
#### Default Value
`0`

#### Minimum
`0`


#### Maximum
`1`

#### Requires
`textField`

#### Expression

Parameters: `zoom, feature, feature-state, measure-light`
___

### textOcclusionOpacityTransition
Name: `textOcclusionOpacityTransition`

#### Description

The transition affecting any changes to this layer’s textOcclusionOpacity property.

#### Type

`{ duration, delay }`

#### Units
`milliseconds`

#### Default Value
`{duration: 300, delay: 0}`


___

### textColor
Name: `textColor`

Mapbox spec: [text-color](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-text-color)

#### Description
The color with which the text will be drawn.

#### Type
`color`
#### Default Value
`#000000`


#### Requires
`textField`

#### Expression

Parameters: `zoom, feature, feature-state, measure-light`
___

### textColorTransition
Name: `textColorTransition`

#### Description

The transition affecting any changes to this layer’s textColor property.

#### Type

`{ duration, delay }`

#### Units
`milliseconds`

#### Default Value
`{duration: 300, delay: 0}`


___

### textHaloColor
Name: `textHaloColor`

Mapbox spec: [text-halo-color](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-text-halo-color)

#### Description
The color of the text's halo, which helps it stand out from backgrounds.

#### Type
`color`
#### Default Value
`rgba(0, 0, 0, 0)`


#### Requires
`textField`

#### Expression

Parameters: `zoom, feature, feature-state, measure-light`
___

### textHaloColorTransition
Name: `textHaloColorTransition`

#### Description

The transition affecting any changes to this layer’s textHaloColor property.

#### Type

`{ duration, delay }`

#### Units
`milliseconds`

#### Default Value
`{duration: 300, delay: 0}`


___

### textHaloWidth
Name: `textHaloWidth`

Mapbox spec: [text-halo-width](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-text-halo-width)

#### Description
Distance of halo to the font outline. Max text halo width is 1/4 of the fontSize.

#### Type
`number`
#### Default Value
`0`

#### Units
`pixels`

#### Minimum
`0`


#### Requires
`textField`

#### Expression

Parameters: `zoom, feature, feature-state, measure-light`
___

### textHaloWidthTransition
Name: `textHaloWidthTransition`

#### Description

The transition affecting any changes to this layer’s textHaloWidth property.

#### Type

`{ duration, delay }`

#### Units
`milliseconds`

#### Default Value
`{duration: 300, delay: 0}`


___

### textHaloBlur
Name: `textHaloBlur`

Mapbox spec: [text-halo-blur](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-text-halo-blur)

#### Description
The halo's fadeout distance towards the outside.

#### Type
`number`
#### Default Value
`0`

#### Units
`pixels`

#### Minimum
`0`


#### Requires
`textField`

#### Expression

Parameters: `zoom, feature, feature-state, measure-light`
___

### textHaloBlurTransition
Name: `textHaloBlurTransition`

#### Description

The transition affecting any changes to this layer’s textHaloBlur property.

#### Type

`{ duration, delay }`

#### Units
`milliseconds`

#### Default Value
`{duration: 300, delay: 0}`


___

### textTranslate
Name: `textTranslate`

Mapbox spec: [text-translate](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-text-translate)

#### Description
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.

#### Type
`array<number>`
#### Default Value
`[0,0]`

#### Units
`pixels`


#### Requires
`textField`

#### Expression

Parameters: `zoom`
___

### textTranslateTransition
Name: `textTranslateTransition`

#### Description

The transition affecting any changes to this layer’s textTranslate property.

#### Type

`{ duration, delay }`

#### Units
`milliseconds`

#### Default Value
`{duration: 300, delay: 0}`


___

### textTranslateAnchor
Name: `textTranslateAnchor`

Mapbox spec: [text-translate-anchor](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-text-translate-anchor)

#### Description
Controls the frame of reference for `textTranslate`.

#### Type
`enum`
#### Default Value
`map`

#### Supported Values
**map** - The text is translated relative to the map.<br />
**viewport** - The text is translated relative to the viewport.<br />


#### Requires
`textField, textTranslate`

#### Expression

Parameters: `zoom`

___

### iconColorSaturation
Name: `iconColorSaturation`

Mapbox spec: [icon-color-saturation](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-icon-color-saturation)

#### Description
Increase or reduce the saturation of the symbol icon.

#### Type
`number`
#### Default Value
`0`

#### Minimum
`-1`


#### Maximum
`1`

#### Expression

Parameters: ``

___

### iconColorContrast
Name: `iconColorContrast`

Mapbox spec: [icon-color-contrast](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-icon-color-contrast)

#### Description
Increase or reduce the contrast of the symbol icon.

#### Type
`number`
#### Default Value
`0`

#### Minimum
`-1`


#### Maximum
`1`

#### Expression

Parameters: ``

___

### iconColorBrightnessMin
Name: `iconColorBrightnessMin`

Mapbox spec: [icon-color-brightness-min](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-icon-color-brightness-min)

#### Description
Increase or reduce the brightness of the symbols. The value is the minimum brightness.

#### Type
`number`
#### Default Value
`0`

#### Minimum
`0`


#### Maximum
`1`

#### Expression

Parameters: ``

___

### iconColorBrightnessMax
Name: `iconColorBrightnessMax`

Mapbox spec: [icon-color-brightness-max](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-icon-color-brightness-max)

#### Description
Increase or reduce the brightness of the symbols. The value is the maximum brightness.

#### Type
`number`
#### Default Value
`1`

#### Minimum
`0`


#### Maximum
`1`

#### Expression

Parameters: ``

___

### symbolZOffset
Name: `symbolZOffset`

Mapbox spec: [symbol-z-offset](https://docs.mapbox.com/style-spec/reference/layers/#paint-symbol-symbol-z-offset)

#### Description
Specifies an uniform elevation from the ground.

#### Type
`number`
#### Default Value
`0`

#### Units
`meters`

#### Minimum
`0`


#### Expression

Parameters: `zoom, feature`
___

### symbolZOffsetTransition
Name: `symbolZOffsetTransition`

#### Description

The transition affecting any changes to this layer’s symbolZOffset property.

#### Type

`{ duration, delay }`

#### Units
`milliseconds`

#### Default Value
`{duration: 300, delay: 0}`