---
title: "AllLayoutProperties | JavaScript maps SDK"
description: "Documentation for MapTiler SDK"
---

> For AI agents: a documentation index is available at [/llms.txt](https://docs.maptiler.com/llms.txt). Markdown versions of all pages are available by appending .md to any URL.

# Type Alias AllLayoutProperties

Union of all layout properties across all layer types.

type AllLayoutProperties \= {  
    ["circle-sort-key"](#circle-sort-key)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>;  
    ["fill-sort-key"](#fill-sort-key)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>;  
    ["icon-allow-overlap"](#icon-allow-overlap)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>;  
    ["icon-anchor"](#icon-anchor)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<  
        | "center"  
        | "left"  
        | "right"  
        | "top"  
        | "bottom"  
        | "top-left"  
        | "top-right"  
        | "bottom-left"  
        | "bottom-right",  
    \>;  
    ["icon-ignore-placement"](#icon-ignore-placement)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>;  
    ["icon-image"](#icon-image)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<  
        [ResolvedImageSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/ResolvedImageSpecification/),  
    \>;  
    ["icon-keep-upright"](#icon-keep-upright)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>;  
    ["icon-offset"](#icon-offset)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<\[number, number\]\>;  
    ["icon-optional"](#icon-optional)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>;  
    ["icon-overlap"](#icon-overlap)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
        "never"  
        | "always"  
        | "cooperative",  
    \>;  
    ["icon-padding"](#icon-padding)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<[PaddingSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PaddingSpecification/)\>;  
    ["icon-pitch-alignment"](#icon-pitch-alignment)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
        "map"  
        | "viewport"  
        | "auto",  
    \>;  
    ["icon-rotate"](#icon-rotate)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>;  
    ["icon-rotation-alignment"](#icon-rotation-alignment)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
        "map"  
        | "viewport"  
        | "auto",  
    \>;  
    ["icon-size"](#icon-size)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>;  
    ["icon-text-fit"](#icon-text-fit)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
        "none"  
        | "width"  
        | "height"  
        | "both",  
    \>;  
    ["icon-text-fit-padding"](#icon-text-fit-padding)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
        \[number, number, number, number\],  
    \>;  
    ["line-cap"](#line-cap)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<  
        "butt"  
        | "round"  
        | "square",  
    \>;  
    ["line-join"](#line-join)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<  
        "bevel"  
        | "round"  
        | "miter",  
    \>;  
    ["line-miter-limit"](#line-miter-limit)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>;  
    ["line-round-limit"](#line-round-limit)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>;  
    ["line-sort-key"](#line-sort-key)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>;  
    ["symbol-avoid-edges"](#symbol-avoid-edges)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>;  
    ["symbol-placement"](#symbol-placement)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
        "point"  
        | "line"  
        | "line-center",  
    \>;  
    ["symbol-sort-key"](#symbol-sort-key)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>;  
    ["symbol-spacing"](#symbol-spacing)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<number\>;  
    ["symbol-z-order"](#symbol-z-order)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
        "auto"  
        | "viewport-y"  
        | "source",  
    \>;  
    ["text-allow-overlap"](#text-allow-overlap)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>;  
    ["text-anchor"](#text-anchor)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<  
        | "center"  
        | "left"  
        | "right"  
        | "top"  
        | "bottom"  
        | "top-left"  
        | "top-right"  
        | "bottom-left"  
        | "bottom-right",  
    \>;  
    ["text-field"](#text-field)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<[FormattedSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/FormattedSpecification/)\>;  
    ["text-font"](#text-font)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<string\[\]\>;  
    ["text-ignore-placement"](#text-ignore-placement)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>;  
    ["text-justify"](#text-justify)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<  
        "auto"  
        | "left"  
        | "center"  
        | "right",  
    \>;  
    ["text-keep-upright"](#text-keep-upright)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>;  
    ["text-letter-spacing"](#text-letter-spacing)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>;  
    ["text-line-height"](#text-line-height)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<number\>;  
    ["text-max-angle"](#text-max-angle)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<number\>;  
    ["text-max-width"](#text-max-width)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>;  
    ["text-offset"](#text-offset)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<\[number, number\]\>;  
    ["text-optional"](#text-optional)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>;  
    ["text-overlap"](#text-overlap)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
        "never"  
        | "always"  
        | "cooperative",  
    \>;  
    ["text-padding"](#text-padding)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<number\>;  
    ["text-pitch-alignment"](#text-pitch-alignment)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
        "map"  
        | "viewport"  
        | "auto",  
    \>;  
    ["text-radial-offset"](#text-radial-offset)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>;  
    ["text-rotate"](#text-rotate)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>;  
    ["text-rotation-alignment"](#text-rotation-alignment)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
        "map"  
        | "viewport"  
        | "viewport-glyph"  
        | "auto",  
    \>;  
    ["text-size"](#text-size)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>;  
    ["text-transform"](#text-transform)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<  
        "none"  
        | "uppercase"  
        | "lowercase",  
    \>;  
    ["text-variable-anchor"](#text-variable-anchor)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
        (  
            | "center"  
            | "left"  
            | "right"  
            | "top"  
            | "bottom"  
            | "top-left"  
            | "top-right"  
            | "bottom-left"  
            | "bottom-right"  
        )\[\],  
    \>;  
    ["text-variable-anchor-offset"](#text-variable-anchor-offset)?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<  
        [VariableAnchorOffsetCollectionSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/VariableAnchorOffsetCollectionSpecification/),  
    \>;  
    ["text-writing-mode"](#text-writing-mode)?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
        ("horizontal" | "vertical")\[\],  
    \>;  
    [visibility](#visibility)?: [VisibilitySpecification](https://docs.maptiler.com/sdk-js/api-reference/types/VisibilitySpecification/);  
}

##### Index

### Properties[](#properties)

[circle-sort-key?](#circle-sort-key) [fill-sort-key?](#fill-sort-key) [icon-allow-overlap?](#icon-allow-overlap) [icon-anchor?](#icon-anchor) [icon-ignore-placement?](#icon-ignore-placement) [icon-image?](#icon-image) [icon-keep-upright?](#icon-keep-upright) [icon-offset?](#icon-offset) [icon-optional?](#icon-optional) [icon-overlap?](#icon-overlap) [icon-padding?](#icon-padding) [icon-pitch-alignment?](#icon-pitch-alignment) [icon-rotate?](#icon-rotate) [icon-rotation-alignment?](#icon-rotation-alignment) [icon-size?](#icon-size) [icon-text-fit?](#icon-text-fit) [icon-text-fit-padding?](#icon-text-fit-padding) [line-cap?](#line-cap) [line-join?](#line-join) [line-miter-limit?](#line-miter-limit) [line-round-limit?](#line-round-limit) [line-sort-key?](#line-sort-key) [symbol-avoid-edges?](#symbol-avoid-edges) [symbol-placement?](#symbol-placement) [symbol-sort-key?](#symbol-sort-key) [symbol-spacing?](#symbol-spacing) [symbol-z-order?](#symbol-z-order) [text-allow-overlap?](#text-allow-overlap) [text-anchor?](#text-anchor) [text-field?](#text-field) [text-font?](#text-font) [text-ignore-placement?](#text-ignore-placement) [text-justify?](#text-justify) [text-keep-upright?](#text-keep-upright) [text-letter-spacing?](#text-letter-spacing) [text-line-height?](#text-line-height) [text-max-angle?](#text-max-angle) [text-max-width?](#text-max-width) [text-offset?](#text-offset) [text-optional?](#text-optional) [text-overlap?](#text-overlap) [text-padding?](#text-padding) [text-pitch-alignment?](#text-pitch-alignment) [text-radial-offset?](#text-radial-offset) [text-rotate?](#text-rotate) [text-rotation-alignment?](#text-rotation-alignment) [text-size?](#text-size) [text-transform?](#text-transform) [text-variable-anchor?](#text-variable-anchor) [text-variable-anchor-offset?](#text-variable-anchor-offset) [text-writing-mode?](#text-writing-mode) [visibility?](#visibility)

## Properties[](#properties-1)

### `Optional`circle-sort-key[](#circle-sort-key)

"circle-sort-key"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>

Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.

### `Optional`fill-sort-key[](#fill-sort-key)

"fill-sort-key"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>

Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.

### `Optional`icon-allow-overlap[](#icon-allow-overlap)

"icon-allow-overlap"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>

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

### `Optional`icon-anchor[](#icon-anchor)

"icon-anchor"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<  
    | "center"  
    | "left"  
    | "right"  
    | "top"  
    | "bottom"  
    | "top-left"  
    | "top-right"  
    | "bottom-left"  
    | "bottom-right",  
\>

Part of the icon placed closest to the anchor.

#### Default[](#default)

```typescript
"center"
```

### `Optional`icon-ignore-placement[](#icon-ignore-placement)

"icon-ignore-placement"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>

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

### `Optional`icon-image[](#icon-image)

"icon-image"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<[ResolvedImageSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/ResolvedImageSpecification/)\>

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

### `Optional`icon-keep-upright[](#icon-keep-upright)

"icon-keep-upright"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>

If true, the icon may be flipped to prevent it from being rendered upside-down.

### `Optional`icon-offset[](#icon-offset)

"icon-offset"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<\[number, number\]\>

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.

#### Default[](#default-1)

```json
[0, 0]
```

### `Optional`icon-optional[](#icon-optional)

"icon-optional"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>

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

### `Optional`icon-overlap[](#icon-overlap)

"icon-overlap"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<"never" | "always" | "cooperative"\>

Allows for control over whether to show an icon when it overlaps other symbols on the map. If `icon-overlap` is not set, `icon-allow-overlap` is used instead.

### `Optional`icon-padding[](#icon-padding)

"icon-padding"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<[PaddingSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PaddingSpecification/)\>

Size of additional area round the icon bounding box used for detecting symbol collisions.

#### Default[](#default-2)

```json
[2]
```

### `Optional`icon-pitch-alignment[](#icon-pitch-alignment)

"icon-pitch-alignment"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<"map" | "viewport" | "auto"\>

Orientation of icon when map is pitched.

#### Default[](#default-3)

```typescript
"auto"
```

### `Optional`icon-rotate[](#icon-rotate)

"icon-rotate"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>

Rotates the icon clockwise.

### `Optional`icon-rotation-alignment[](#icon-rotation-alignment)

"icon-rotation-alignment"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
    "map"  
    | "viewport"  
    | "auto",  
\>

In combination with `symbol-placement`, determines the rotation behavior of icons.

#### Default[](#default-4)

```typescript
"auto"
```

### `Optional`icon-size[](#icon-size)

"icon-size"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>

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.

#### Default[](#default-5)

```typescript
1
```

### `Optional`icon-text-fit[](#icon-text-fit)

"icon-text-fit"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
    "none"  
    | "width"  
    | "height"  
    | "both",  
\>

Scales the icon to fit around the associated text.

#### Default[](#default-6)

```typescript
"none"
```

### `Optional`icon-text-fit-padding[](#icon-text-fit-padding)

"icon-text-fit-padding"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
    \[number, number, number, number\],  
\>

Size of the additional area added to dimensions determined by `icon-text-fit`, in clockwise order: top, right, bottom, left.

#### Default[](#default-7)

```json
[0, 0, 0, 0]
```

### `Optional`line-cap[](#line-cap)

"line-cap"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<"butt" | "round" | "square"\>

The display of line endings.

#### Default[](#default-8)

```typescript
"butt"
```

### `Optional`line-join[](#line-join)

"line-join"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<"bevel" | "round" | "miter"\>

The display of lines when joining.

#### Default[](#default-9)

```typescript
"miter"
```

### `Optional`line-miter-limit[](#line-miter-limit)

"line-miter-limit"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>

Used to automatically convert miter joins to bevel joins for sharp angles.

#### Default[](#default-10)

```typescript
2
```

### `Optional`line-round-limit[](#line-round-limit)

"line-round-limit"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>

Used to automatically convert round joins to miter joins for shallow angles.

#### Default[](#default-11)

```typescript
1.05
```

### `Optional`line-sort-key[](#line-sort-key)

"line-sort-key"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>

Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.

### `Optional`symbol-avoid-edges[](#symbol-avoid-edges)

"symbol-avoid-edges"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>

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 MapLibre GL JS version 0.42.0 or greater, enabling this property is not needed to prevent clipped labels at tile boundaries.

### `Optional`symbol-placement[](#symbol-placement)

"symbol-placement"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
    "point"  
    | "line"  
    | "line-center",  
\>

Label placement relative to its geometry.

#### Default[](#default-12)

```typescript
"point"
```

### `Optional`symbol-sort-key[](#symbol-sort-key)

"symbol-sort-key"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>

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.

### `Optional`symbol-spacing[](#symbol-spacing)

"symbol-spacing"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<number\>

Distance between two symbol anchors.

#### Default[](#default-13)

```typescript
250
```

### `Optional`symbol-z-order[](#symbol-z-order)

"symbol-z-order"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<"auto" | "viewport-y" | "source"\>

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`.

#### Default[](#default-14)

```typescript
"auto"
```

### `Optional`text-allow-overlap[](#text-allow-overlap)

"text-allow-overlap"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>

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

### `Optional`text-anchor[](#text-anchor)

"text-anchor"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<  
    | "center"  
    | "left"  
    | "right"  
    | "top"  
    | "bottom"  
    | "top-left"  
    | "top-right"  
    | "bottom-left"  
    | "bottom-right",  
\>

Part of the text placed closest to the anchor.

#### Default[](#default-15)

```typescript
"center"
```

### `Optional`text-field[](#text-field)

"text-field"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<[FormattedSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/FormattedSpecification/)\>

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.

### `Optional`text-font[](#text-font)

"text-font"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<string\[\]\>

Fonts to use for displaying text. If the `glyphs` root property is specified, this array is joined together and interpreted as a font stack name. Otherwise, it is interpreted as a cascading fallback list of local font names.

#### Default[](#default-16)

```json
["Open Sans Regular", "Arial Unicode MS Regular"]
```

### `Optional`text-ignore-placement[](#text-ignore-placement)

"text-ignore-placement"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>

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

### `Optional`text-justify[](#text-justify)

"text-justify"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<  
    "auto"  
    | "left"  
    | "center"  
    | "right",  
\>

Text justification options.

#### Default[](#default-17)

```typescript
"center"
```

### `Optional`text-keep-upright[](#text-keep-upright)

"text-keep-upright"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>

If true, the text may be flipped vertically to prevent it from being rendered upside-down.

#### Default[](#default-18)

```typescript
true
```

### `Optional`text-letter-spacing[](#text-letter-spacing)

"text-letter-spacing"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>

Text tracking amount.

### `Optional`text-line-height[](#text-line-height)

"text-line-height"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<number\>

Text leading value for multi-line text.

#### Default[](#default-19)

```typescript
1.2
```

### `Optional`text-max-angle[](#text-max-angle)

"text-max-angle"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<number\>

Maximum angle change between adjacent characters.

#### Default[](#default-20)

```typescript
45
```

### `Optional`text-max-width[](#text-max-width)

"text-max-width"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>

The maximum line width for text wrapping.

#### Default[](#default-21)

```typescript
10
```

### `Optional`text-offset[](#text-offset)

"text-offset"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<\[number, number\]\>

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.

#### Default[](#default-22)

```json
[0, 0]
```

### `Optional`text-optional[](#text-optional)

"text-optional"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<boolean\>

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

### `Optional`text-overlap[](#text-overlap)

"text-overlap"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<"never" | "always" | "cooperative"\>

Allows for control over whether to show symbol text when it overlaps other symbols on the map. If `text-overlap` is not set, `text-allow-overlap` is used instead

### `Optional`text-padding[](#text-padding)

"text-padding"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<number\>

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

#### Default[](#default-23)

```typescript
2
```

### `Optional`text-pitch-alignment[](#text-pitch-alignment)

"text-pitch-alignment"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<"map" | "viewport" | "auto"\>

Orientation of text when map is pitched.

#### Default[](#default-24)

```typescript
"auto"
```

### `Optional`text-radial-offset[](#text-radial-offset)

"text-radial-offset"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>

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.

### `Optional`text-rotate[](#text-rotate)

"text-rotate"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>

Rotates the text clockwise.

### `Optional`text-rotation-alignment[](#text-rotation-alignment)

"text-rotation-alignment"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
    "map"  
    | "viewport"  
    | "viewport-glyph"  
    | "auto",  
\>

In combination with `symbol-placement`, determines the rotation behavior of the individual glyphs forming the text.

#### Default[](#default-25)

```typescript
"auto"
```

### `Optional`text-size[](#text-size)

"text-size"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<number\>

Font size.

#### Default[](#default-26)

```typescript
16
```

### `Optional`text-transform[](#text-transform)

"text-transform"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<  
    "none"  
    | "uppercase"  
    | "lowercase",  
\>

Specifies how to capitalize text, similar to the CSS `text-transform` property.

#### Default[](#default-27)

```typescript
"none"
```

### `Optional`text-variable-anchor[](#text-variable-anchor)

"text-variable-anchor"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<  
    (  
        | "center"  
        | "left"  
        | "right"  
        | "top"  
        | "bottom"  
        | "top-left"  
        | "top-right"  
        | "bottom-left"  
        | "bottom-right"  
    )\[\],  
\>

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`.

#### Example[](#example)

```json
["center", "left", "right"]
```

### `Optional`text-variable-anchor-offset[](#text-variable-anchor-offset)

"text-variable-anchor-offset"?: [DataDrivenPropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/DataDrivenPropertyValueSpecification/)<  
    [VariableAnchorOffsetCollectionSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/VariableAnchorOffsetCollectionSpecification/),  
\>

To increase the chance of placing high-priority labels on the map, you can provide an array of `text-anchor` locations, each paired with an offset value. The renderer will attempt to place the label at each location, in order, before moving on to the next location+offset. Use `text-justify: auto` to choose justification based on anchor position.

The length of the array must be even, and must alternate between enum and point entries. i.e., each anchor location must be accompanied by a point, and that point defines the offset when the corresponding anchor location is used. Positive offset values indicate right and down, while negative values indicate left and up. Anchor locations may repeat, allowing the renderer to try multiple offsets to try and place a label using the same anchor.

When present, this property takes precedence over `text-anchor`, `text-variable-anchor`, `text-offset`, and `text-radial-offset`.

```json
{ "text-variable-anchor-offset": ["top", [0, 4], "left", [3,0], "bottom", [1, 1]] }
```

When the renderer chooses the `top` anchor, `[0, 4]` will be used for `text-offset`; the text will be shifted down by 4 ems.

When the renderer chooses the `left` anchor, `[3, 0]` will be used for `text-offset`; the text will be shifted right by 3 ems.

#### Example[](#example-1)

```json
["top", [0, 4], "left", [3, 0], "bottom", [1, 1]]
```

### `Optional`text-writing-mode[](#text-writing-mode)

"text-writing-mode"?: [PropertyValueSpecification](https://docs.maptiler.com/sdk-js/api-reference/types/PropertyValueSpecification/)<("horizontal" | "vertical")\[\]\>

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. The order of elements in an array define priority order for the placement of an orientation variant.

### `Optional`visibility[](#visibility)

visibility?: [VisibilitySpecification](https://docs.maptiler.com/sdk-js/api-reference/types/VisibilitySpecification/)

Whether this layer is displayed.

#### Default[](#default-28)

```typescript
"visible"
```