Class TileSetAttributionProvider

A utility class that can provide tileset attribution information for all tilesets that are visible in a map.

Implements

Evented

Index

Constructors

Methods

dispose getAttributionLogos getAttributionStrings getLayerAttributions on

Constructors

constructor

new TileSetAttributionProvider(map: Map): TileSetAttributionProvider
Creates a new tileset attribution provider for the given map.
Parameters
- map: Map
  the map
Returns TileSetAttributionProvider

Methods

dispose

dispose(): void
Disposes this tileset attribution provider. Once this method has been called this instance will no longer produce attribution change events.

Returns void

getAttributionLogos

getAttributionLogos(): string[]
Returns the current list of attribution logos. The returned list may be empty.

Returns string[]
the current list of attribution logos

getAttributionStrings

getAttributionStrings(): string[]
Returns the current list of attribution strings. The returned list may be empty.

Returns string[]
the current list of attribution strings

getLayerAttributions

getLayerAttributions(): LayerAttribution[]
Returns the current list of layer attributions. The returned list may be empty.

Returns LayerAttribution[]
the current list of layer attributions

Since
2023.1

on

on(
    event: "AttributionLogosChanged",
    callback: (logos: string[]) => void,
    context?: any,
): Handle
Event fired when the attribution logos change.
Parameters
- event: "AttributionLogosChanged"
  the 'AttributionLogosChanged' event
- callback: (logos: string[]) => void
  the callback to be invoked when the attribution logos change. The callback gets the 'logos' parameter, which is an array of strings containing the updated list of logo URLs
- Optionalcontext: any
  value to use as this when executing callback
Returns Handle
Implementation of Evented.on
on(
    event: "AttributionStringsChanged",
    callback: (strings: string[]) => void,
    context?: any,
): Handle
Event fired when the attribution strings change.
Parameters
- event: "AttributionStringsChanged"
  the 'AttributionStringsChanged' event
- callback: (strings: string[]) => void
  the callback to be invoked when the attribution strings change. The callback gets the 'strings' parameter, which is an array of strings containing the updated list of attribution strings
- Optionalcontext: any
  value to use as this when executing callback
Returns Handle
Implementation of Evented.on
on(
    event: "LayerAttributionsChanged",
    callback: (attributions: LayerAttribution[]) => void,
    context?: any,
): Handle
Event fired when the layer attributions change
Parameters
- event: "LayerAttributionsChanged"
  the 'LayerAttributionsChanged' event
- callback: (attributions: LayerAttribution[]) => void
  the callback to be invoked when the layer attributions change. The callback gets the 'attributions' parameter, which is an array of LayerAttribution containing the updated list of layer attributions
- Optionalcontext: any
  value to use as this when executing callback
Returns Handle
Since
2023.1

Implementation of Evented.on