Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • TileSetAttributionProvider

Implements

Overview

Constructors

constructor

Methods

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

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

    Returns string[]

    the current list of attribution logos

getAttributionStrings

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

    Returns string[]

    the current list of attribution strings

on

  • (event: "AttributionLogosChanged", callback: (logos: string[]) => void, context?: any): Handle
  • (event: "AttributionStringsChanged", callback: (strings: 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

        • (logos: string[]): void
        • Parameters

          • logos: string[]

          Returns void

    • Optional context: any

      value to use as this when executing callback

    Returns 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

        • (strings: string[]): void
        • Parameters

          • strings: string[]

          Returns void

    • Optional context: any

      value to use as this when executing callback

    Returns Handle

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method