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