Skip to content

Mapbox GL Types Reference

The mapbox_style module provides Pydantic models for Mapbox GL style specification types.

Layer Types

BackgroundLayer

map_style.generator.mapbox_style.BackgroundLayer

Bases: BaseModel

FillLayer

map_style.generator.mapbox_style.FillLayer

Bases: Layer

FillExtrusionLayer

map_style.generator.mapbox_style.FillExtrusionLayer

Bases: Layer

LineLayer

map_style.generator.mapbox_style.LineLayer

Bases: Layer

SymbolLayer

map_style.generator.mapbox_style.SymbolLayer

Bases: Layer

CircleLayer

map_style.generator.mapbox_style.CircleLayer

Bases: Layer

Paint Classes

BackgroundPaint

map_style.generator.mapbox_style.BackgroundPaint

Bases: BaseModel

FillPaint

map_style.generator.mapbox_style.FillPaint

Bases: BaseModel

FillExtrusionPaint

map_style.generator.mapbox_style.FillExtrusionPaint

Bases: BaseModel

LinePaint

map_style.generator.mapbox_style.LinePaint

Bases: BaseModel

SymbolPaint

map_style.generator.mapbox_style.SymbolPaint

Bases: BaseModel

CirclePaint

map_style.generator.mapbox_style.CirclePaint

Bases: BaseModel

Layout Classes

BaseLayout

map_style.generator.mapbox_style.BaseLayout

Bases: BaseModel

LineLayout

map_style.generator.mapbox_style.LineLayout

Bases: BaseLayout

SymbolLayout

map_style.generator.mapbox_style.SymbolLayout

Bases: BaseLayout

Style

Style

map_style.generator.mapbox_style.Style

Bases: BaseModel

StyleMetadata

map_style.generator.mapbox_style.StyleMetadata

Bases: BaseModel

Type Aliases

Interpolation Types

"""MapLibre GL type aliases for interpolatable values."""

from map_style.generator.mapbox_style import (
    NumberInterpolate,
    NumberOrInterpolate,
    StringInterpolate,
    StringOrInterpolate,
)

# String with zoom interpolation
color_static: StringOrInterpolate = "#ff0000"
color_stops: StringOrInterpolate = StringInterpolate(stops=[(10, "#ff0000"), (14, "#00ff00")])

# Number with zoom interpolation
width_static: NumberOrInterpolate = 2.0
width_stops: NumberOrInterpolate = NumberInterpolate(stops=[(10, 1.0), (14, 3.0)])

StringInterpolate

string_interpolate = StringInterpolate(
    base=1.0,
    stops=[(10, "#ff0000"), (14, "#00ff00")],
)

NumberInterpolate

number_interpolate = NumberInterpolate(
    base=1.2,
    stops=[(10, 1.0), (14, 3.0), (18, 6.0)],
)