Interface CopyrightInfo

Copyright info attached to data displayed on map. Provided by DataSource and attached to Tiles.

In most cases, an application should display this information on MapView to conform with licencing terms of its map data providers.

Hierarchy

  • CopyrightInfo

Properties

Properties

id: string

Unique id of the copyright holder.

Remarks

ids should be unique. It is recommended to build them from unique identifiers like registered domain names.

Examples:

  • openstreetmap.org - for data originating from OpenStreetMap project
  • naturalearthdata.com - for data originating from Natural Earth dataset

Note: DataSource may return CopyrightInfo with only id, thus defining only holder of copyright, however, valid attribution may require proper label and link.

Entries with same id are deduplicated by mergeArrays.

label?: string

Copyright text to display after the copyright symbol on the map.

If undefined, id is used as text label. Set it to empty string to not render a copyright info.

link?: string

Optional URL pointing to further copyright information.

year?: number

Optional, copyright notice year.

Generated using TypeDoc