ICopyrightsProvider

Extends IEventEmitter.

Copyright information provider.

Constructor | Fields | Events | Methods

Constructor

ICopyrightsProvider()

Fields

Name Type Description
events IEventManager

Event manager.

Inherited from IEventEmitter.

Events

Name Description
copyrightschange

Event for changes to copyright information.

Methods

Name Returns Description
getCopyrights(coords, zoom)

vow.Promise

Requests information about copyrights at the specified point with the specified zoom.

remove()

Removes copyright information that was added via this object.

setCopyrights(copyrights)

Sets a new value for the copyright information that was added via this object.

Events details

copyrightschange

Event for changes to copyright information.

Methods details

getCopyrights

{vow.Promise} getCopyrights(coords, zoom)

Requests information about copyrights at the specified point with the specified zoom.

Returns Promise that will be resolved and will pass as a result an array of strings or DOM elements with information about copyrights.

Parameters:

Parameter Default value Description
coords *

Type: Number[]

The point on the map that copyright information is being requested for.

zoom *

Type: Number

The zoom level that copyright information is being requested for.

* Mandatory parameter/option.

remove

{} remove()

Removes copyright information that was added via this object.

setCopyrights

{} setCopyrights(copyrights)

Sets a new value for the copyright information that was added via this object.

Parameters:

Parameter Default value Description
copyrights *

Type: String|HTMLElement|String[]|HTMLElement[]

Copyright information.

* Mandatory parameter/option.