On this page
Constructors
Properties
Methods

Class BackgroundStyleLayer

A base class for style layers

Hierarchy (View Summary)

Index

Constructors

constructor

Properties

filter id layout maxzoom metadata minzoom onAdd onRemove paint source sourceLayer type visibility

Methods

createBucket? fire getCrossfadeParameters getLayoutAffectingGlobalStateRefs getLayoutProperty getPaintAffectingGlobalStateRefs getPaintProperty getVisibilityAffectingGlobalStateRefs hasOffscreenPass hasTransition is3D isHidden isStateDependent isTileClipped listens off on once queryIntersectsFeature? queryRadius? recalculate recalculateVisibility resize serialize setEventedParent setFilter setLayoutProperty setPaintProperty updateTransitions

Constructors

Properties

filter: void | FilterSpecification
id: string
layout: unknown
maxzoom: number
metadata: unknown
minzoom: number
onAdd: (map: MapLibreMap) => void
onRemove: (map: MapLibreMap) => void
paint: PossiblyEvaluated<
    BackgroundPaintProps,
    BackgroundPaintPropsPossiblyEvaluated,
>
source: string
sourceLayer: string
type:
    | "symbol"
    | "custom"
    | "fill"
    | "line"
    | "circle"
    | "heatmap"
    | "fill-extrusion"
    | "raster"
    | "hillshade"
    | "color-relief"
    | "background"
visibility: VisibilitySpecification

Methods

  • Parameters

    • event: string | Event
    • Optionalproperties: any

    Returns this

  • Get list of global state references that are used within layout or filter properties. This is used to determine if layer source need to be reloaded when global state property changes.

    Returns Set<string>

  • Get list of global state references that are used within paint properties. This is used to determine if layer needs to be repainted when global state property changes.

    Returns Map<string, { name: string; value: any }[]>

  • Get list of global state references that are used within visibility expression. This is used to determine if layer visibility needs to be updated when global state property changes.

    Returns Set<string>

  • Parameters

    • Optionalzoom: number
    • OptionalroundMinZoom: boolean

    Returns boolean

  • 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

  • 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> | BackgroundStyleLayer

    this or a promise if a listener is not provided

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

    Parameters

    • Optionalparent: Evented | null
    • Optionaldata: any

    Returns this

Was this helpful?
SDK JS
Reference
BackgroundStyleLayer