map.Copyrights
Менеджер размещённой на карте информации об авторских правах. У каждой карты уже есть собственный менеджер информации об авторских правах, доступный как map.copyrights. Не инстанцируйте экземпляры этого класса без необходимости.
См.: Map.copyrights
Конструктор | События | Методы
Конструктор
map.Copyrights(map)
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: Map Карта. |
* Обязательный параметр/опция.
Пример:
// Добавим статическую информацию об авторских правах на карту.
var accessor = map.copyrights.add('© Gerardus Mercator');
// ...
// Удаление информации об авторских правах.
accessor.remove();
События
Имя |
Описание |
Событие изменения размещённой на карте информации об авторских правах. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
|
Методы
Имя |
Возвращает |
Описание |
Добавляет на карту статическую (не зависящую от текущего центра и масштаба карты) информацию об авторских правах. |
||
Добавляет нового провайдера информации об авторских правах. |
||
Определяет информацию об авторских правах в указанной точке. |
||
String |
Возвращает внешнюю ссылку из блока "Открыть в Яндекс Картах". |
|
Удаляет провайдера информации об авторских правах. |
Описание событий
change
Событие изменения размещённой на карте информации об авторских правах. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
- oldCopyrights - старый массив информации об авторских правах;
- newCopyrights - новый массив информации об авторских правах;
Описание методов
add
{ICopyrightsAccessor} add(customCopyrights)
Добавляет на карту статическую (не зависящую от текущего центра и масштаба карты) информацию об авторских правах.
Возвращает объект, позволяющий управлять добавленной информацией.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: String |
HTMLElement|String[]|HTMLElement[] Информация об авторских правах в виде строки, DOM-элемента либо массива строк/DOM-элементов. |
* Обязательный параметр/опция.
addProvider
{map.Copyrights} addProvider(provider)
Добавляет нового провайдера информации об авторских правах.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: ICopyrightsProvider Провайдер. |
* Обязательный параметр/опция.
Пример:
// Создание динамического поставщика информации об авторских правах
// что позволит получить актуальную информацию об авторских правах для
// конкретная точка на карте с удаленного сервера.
var myProvider = {
getCopyrights: function (center, zoom) {
var deferred = ymaps.vow.defer();
$.ajax('http://some.server/copyrights/?ll=' + center.join(',') + '&z=' + zoom, {
// Сервер должен возвращать массив строк
success: function (res) {
deferred.resolve(res);
}
});
return deferred.promise();
}
};
// Добавление поставщика на карту; теперь, когда центр или масштаб меняются,
// менеджер информации об авторских правах на карту будет
// запросить обновленную информацию с удаленного сервера и отобразить ее
// полученные данные автоматически.
map.copyrights.addProvider(myProvider);
get
{vow.Promise} get([point[, zoom]])
Определяет информацию об авторских правах в указанной точке.
Возвращает Promise объект, который будет подтверждён массивом строк/DOM-элементов.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Number[] Точка (в географических координатах), для которой требуется определить информацию об авторских правах. Если не указана, берётся текущий центр карты. |
|
— |
Тип: Number Уровень масштабирования, для которого требуется определить информацию об авторских правах. Если не указан, берётся текущий уровень масштабирования карты. |
getPromoLink
{String} getPromoLink()
Возвращает внешнюю ссылку из блока "Открыть в Яндекс Картах".
removeProvider
{map.Copyrights} removeProvider(provider)
Удаляет провайдера информации об авторских правах.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: ICopyrightsProvider Провайдер. |
* Обязательный параметр/опция.
Обязательный параметр.