Interface AttributedTileSet

A tile set that contains data that is possibly copyrighted. The methods of this interface allow users to retrieve copyright related information that should be displayed when using the data contained in this tile set.

interface AttributedTileSet {
    getAttribution(regions): string[];
    getLogo(): null | string;
    on(event, callback): Handle;
}

Hierarchy (view full)

Implemented by

Methods

getAttribution getLogo on

Methods

getAttribution

  • getAttribution(regions): string[]

  • Returns a list of attribution strings that should be displayed when using the specified subset of this tile set.

    Parameters

    Returns string[]

    a (possibly empty) list of attribution strings

getLogo

  • getLogo(): null | string

  • Returns a URL referring to a graphical logo of the copyright owner of this data. If a logo is not available this method will return null.

    Returns null | string

    a URL referring to a graphical logo or null.

on

  • on(event, callback): Handle

  • An event that is emitted whenever the attributions returned by getAttribution has changed from within the model. For example, after a download of attributions has finished, getAttribution needs to be re-evaluated.

    Parameters

    • event: "AttributionChanged"

      The 'AttributionChanged' event.

    • callback: (() => void)

      the callback to be invoked when the attributions of the model changed.

        • (): void

        • Returns void

    Returns Handle

    Since

    2024.0

Settings

Member Visibility

Theme

On This Page

getAttributiongetLogoon