On this page
Constructors
Properties
Methods

Class StyleMaptiler

The Style base class

Hierarchy (View Summary)

Index

Constructors

constructor

Properties

crossTileSymbolIndex dispatcher glyphManager imageManager light lineAtlas map pauseablePlacement placement projection sky stylesheet tileManagers z zoomHistory

Methods

addImage addLayer addSource addSprite destroy fire getDashes getFeatureState getFilter getGlobalState getGlyphs getGlyphsUrl getImage getImages getLayer getLayersOrder getLayoutProperty getLight getPaintProperty getProjection getSky getSource getSprite getTransition hasLayer hasTransitions listens listImages loaded loadEmpty loadJSON loadURL moveLayer off on once queryRenderedFeatures querySourceFeatures removeFeatureState removeImage removeLayer removeSource removeSprite serialize setEventedParent setFeatureState setFilter setGeoJSONSourceData setGlobalState setGlobalStateProperty setGlyphs setLayerZoomRange setLayoutProperty setLight setPaintProperty setProjection setSky setSprite setState update updateImage

Constructors

Properties

crossTileSymbolIndex: CrossTileSymbolIndex
dispatcher: Dispatcher
glyphManager: GlyphManager
imageManager: ImageManager
light: Light
lineAtlas: LineAtlas
map: MapLibreMap
pauseablePlacement: PauseablePlacement
placement: Placement
projection: Projection | undefined
sky: Sky
stylesheet: StyleSpecification
tileManagers: { [_: string]: TileManager }
z: number
zoomHistory: ZoomHistory

Methods

  • Add a layer to the map style. The layer will be inserted before the layer with ID before, or appended if before is omitted.

    Parameters

    • layerObject: AddLayerObject

      The style layer to add.

    • Optionalbefore: string

      ID of an existing layer to insert before

    • Optionaloptions: StyleSetterOptions

      Style setter options.

    Returns this

  • Add a sprite.

    Parameters

    • id: string

      The id of the desired sprite

    • url: string

      The url to load the desired sprite from

    • Optionaloptions: StyleSetterOptions

      The style setter options

    • Optionalcompletion: (err: Error) => void

      The completion handler

    Returns void

  • Destroys all internal resources of the style (sources, images, layers, etc.)

    Returns void

  • Parameters

    • event: string | Event
    • Optionalproperties: any

    Returns this

  • Return the style layer object with the given id.

    Parameters

    • id: string

      id of the desired layer

    Returns StyleLayer | undefined

    a layer, if one with the given id exists

  • Return the ids of all layers currently in the style, including custom layers, in order.

    Returns string[]

    ids of layers, in order

  • Get a layout property's value from a given layer

    Parameters

    • layerId: string

      the layer to inspect

    • name: string

      the name of the layout property

    Returns any

    the property value

  • Parameters

    • layer: string
    • name: string

    Returns unknown

  • Get a source by ID.

    Parameters

    • id: string

      ID of the desired source

    Returns Source | undefined

    source

  • Get the current sprite value.

    Returns { id: string; url: string }[]

    empty array when no sprite is set; id-url pairs otherwise

  • Checks if a specific layer is present within the style.

    Parameters

    • id: string

      the id of the desired layer

    Returns boolean

    a boolean specifying if the given layer is present

  • Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.

    Parameters

    • type: string

      The event type

    Returns boolean

    true if there is at least one registered listener for specified event type, false otherwise

  • Returns boolean

  • Moves a layer to a different z-position. The layer will be inserted before the layer with ID before, or appended if before is omitted.

    Parameters

    • id: string

      ID of the layer to move

    • Optionalbefore: string

      ID of an existing layer to insert before

    Returns void

  • Removes a previously registered event listener.

    Parameters

    • type: string

      The event type to remove listeners for.

    • listener: Listener

      The listener function to remove.

    Returns this

  • Adds a listener to a specified event type.

    Parameters

    • type: string

      The event type to add a listen for.

    • listener: Listener

      The function to be called when the event is fired. The listener function is called with the data object passed to fire, extended with target and type properties.

    Returns Subscription

  • Adds a listener that will be called only once to a specified event type.

    The listener will be called first time the event fires after the listener is registered.

    Parameters

    • type: string

      The event type to listen for.

    • Optionallistener: Listener

      The function to be called when the event is fired the first time.

    Returns Promise<any> | Style

    this or a promise if a listener is not provided

  • Parameters

    • id: string

    Returns this

  • Remove the layer with the given id from the style. A ErrorEvent event will be fired if no such layer exists.

    Parameters

    • id: string

      id of the layer to remove

    Returns void

  • Remove a source from this stylesheet, given its id.

    Parameters

    • id: string

      id of the source to remove

    Returns this

    if no source is found with the given ID

  • Remove a sprite by its id. When the last sprite is removed, the whole this.stylesheet.sprite object becomes undefined. This falsy undefined value later prevents attempts to load the sprite when it's absent.

    Parameters

    • id: string

      the id of the sprite to remove

    Returns void

  • Bubble all events fired by this instance of Evented to this parent instance of Evented.

    Parameters

    • Optionalparent: Evented | null
    • Optionaldata: any

    Returns this

  • Parameters

    • name: string
    • value: any

    Returns this

  • Parameters

    • layerId: string
    • Optionalminzoom: number | null
    • Optionalmaxzoom: number | null

    Returns void

Was this helpful?
SDK JS
Reference
Style