---
metadata:
  - name: generator
    content: Diplodoc Platform v5.39.1
alternate:
  - https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/map.Copyrights.md
  - https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.Copyrights.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com.tr/dev/jsapi-v2-1/doc/en/llms.txt

# map.Copyrights

Manager for copyright information on the map. Each map already has its own copyright information manager, available as map.copyrights. Don't instantiate new instances of this class unless necessary.

**See** [Map.copyrights](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Map.md#copyrights)

[Constructor](#constructor-summary) | [Events](#events-summary) | [Methods](#methods-summary)

## Constructor {#constructor-summary}

```javascript
map.Copyrights(map)
```

**Parameters:**

#|
|| **Parameter** | **Default value** | **Description**  ||
|| [`map`](#param-map)[*](*star) | — | Type: [Map](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Map.md)

Map. ||
|#

\* Mandatory parameter/option.

**Example:**

```javascript
// Adding static information about copyright info to the map
var accessor = map.copyrights.add('© Gerardus Mercator');
// ...
// Removing information about copyrights
accessor.remove();
```

### events {#events}

#|
|| **Name** | **Description** ||
||  [change](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/map.Copyrights.md#event-change) | Event for changes to copyright information placed on the map. Instance of the [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. Names of fields that are available via the [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#get) method: 
- oldCopyrights - Old array of copyright information.
- newCopyrights - New array of copyright information. ||
|#

## Methods {#methods-summary}

#|
|| **Name** | **Returns** | **Description** ||
|| [add](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/map.Copyrights.md#add)([customCopyrights](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/map.Copyrights.md#add-param-customCopyrights)) | [ICopyrightsAccessor](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICopyrightsAccessor.md) | Adds static copyright information to the map (independent of the current center and zoom level). ||
|| [addProvider](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/map.Copyrights.md#addProvider)([provider](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/map.Copyrights.md#addProvider-param-provider)) | [map.Copyrights](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/map.Copyrights.md) | Adds a new provider of copyright information. ||
|| [get](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/map.Copyrights.md#get)([[point](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/map.Copyrights.md#get-param-point)[, [zoom](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/map.Copyrights.md#get-param-zoom)]]) | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md) | Determines copyright information at the specified point. ||
|| [getPromoLink](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/map.Copyrights.md#getPromoLink)() | String | Returns external link from the "Open in Yandex Maps" block. ||
|| [removeProvider](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/map.Copyrights.md#removeProvider)([provider](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/map.Copyrights.md#removeProvider-param-provider)) | [map.Copyrights](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/map.Copyrights.md) | Removes a provider of copyright information. ||
|#

## Events details {#event_detail}

### change {#change}

Event for changes to copyright information placed on the map. Instance of the [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. Names of fields that are available via the [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#get) method: 
- oldCopyrights - Old array of copyright information.
- newCopyrights - New array of copyright information.

## Methods details {#method_detail}

### add {#add}

```javascript
{ICopyrightsAccessor} add(customCopyrights)
```

Adds static copyright information to the map (independent of the current center and zoom level).

**Returns** an object for managing the added information.

**Parameters:**

#|
|| **Parameter** | **Default value** | **Description**  ||
|| [`customCopyrights`](#add-param-customCopyrights)[*](*star) | — | Type: String\|HTMLElement\|String[]\|HTMLElement[]

Copyright information in string format, a DOM element, or an array of strings/DOM elements. ||
|#

\* Mandatory parameter/option.

### addProvider {#addProvider}

```javascript
{map.Copyrights} addProvider(provider)
```

Adds a new provider of copyright information.

**Returns** self-reference.

**Parameters:**

#|
|| **Parameter** | **Default value** | **Description**  ||
|| [`provider`](#addProvider-param-provider)[*](*star) | — | Type: [ICopyrightsProvider](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICopyrightsProvider.md)

Provider. ||
|#

\* Mandatory parameter/option.

**Example:**

```javascript
// Creating a dynamic provider of copyright information
// that will get up-to-date information about copyrights for
// a particular point on the map from a remote server.
var myProvider = {
    getCopyrights: function (center, zoom) {
        var deferred = ymaps.vow.defer();
        $.ajax('http://some.server/copyrights/?ll=' + center.join(',') + '&z=' + zoom, {
            // The server must return an array of strings
            success: function (res) {
                deferred.resolve(res);
            }
        });
        return deferred.promise();
    }
};
// Adding a provider to the map; now when the center or zoom changes, 
// the map copyright information manager will
// request updated information from the remote server and display
// the received data automatically.
map.copyrights.addProvider(myProvider);
```

### get {#get}

```javascript
{vow.Promise} get([point[, zoom]])
```

Determines copyright information at the specified point.

**Returns** a Promise object that will be resolved and will pass an array of strings or DOM elements as a parameter.

**Parameters:**

#|
|| **Parameter** | **Default value** | **Description**  ||
|| [`point`](#get-param-point) | — | Type: Number[]

The point (in geographical coordinates) that copyright information needs to be determined for. If omitted, the current map center is used. ||
|| [`zoom`](#get-param-zoom) | — | Type: Number

The zoom level that copyright information needs to be determined for. If omitted, the current map zoom level is used. ||
|#


### getPromoLink {#getPromoLink}

```javascript
{String} getPromoLink()
```

**Returns** external link from the "Open in Yandex Maps" block.
# removeProvider

```javascript
{map.Copyrights} removeProvider(provider)
```

Removes a provider of copyright information.

**Returns** self-reference.

**Parameters:**

#|
|| **Parameter** | **Default value** | **Description**  ||
|| [`provider`](#removeProvider-param-provider)[*](*star) | — | Type: [ICopyrightsProvider](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICopyrightsProvider.md)

Provider. ||
|#

\* Mandatory parameter/option.

[*star]: Mandatory parameter/option.