2gis-maps
Version:
Interactive 2GIS maps API, based on Leaflet
55 lines (53 loc) • 2.45 kB
HTML
<h2 id="модуль-определения проекта 2gis">Модуль определения проекта 2GIS</h2><p>Проект — это агломерация, включающая крупный город и ближайшие населённые пункты.
Данный плагин позволяет получить информацию о просматриваемом в текущий момент времени проекте.</p>
<p><dl class="api-incut"><ul class="page-contents"><li><a href="#примеры-использования">Примеры использования</a></li><li><a href="#события">События</a><ul><li><a href="#методы">Методы</a></li></ul></dl></p>
<h3 id="примеры-использования">Примеры использования</h3><p>Подписка на событие projectchange:</p>
<pre><code>map.on('projectchange', function (e) {
console.log(e);
});
</code></pre><p>Подписка на событие projectleave:</p>
<pre><code>map.on('projectleave', function (e) {
console.log(e);
});
</code></pre><h3 id="события">События</h3><table>
<thead>
<tr>
<th>Событие</th>
<th>Данные</th>
<th>Описание</th>
</tr>
</thead>
<tbody>
<tr>
<td>projectchange</td>
<td>ProjectEvent</td>
<td>Возникает, когда пользователь переходит из одного проекта в другой.</td>
</tr>
<tr>
<td>projectleave</td>
<td>ProjectEvent</td>
<td>Возникает, когда пользователь выходит за пределы текущего проекта.</td>
</tr>
</tbody>
</table>
<h4 id="методы">Методы</h4><table>
<thead>
<tr>
<th>Метод</th>
<th>Возвращает</th>
<th>Описание</th>
</tr>
</thead>
<tbody>
<tr>
<td>getProjectsList</td>
<td>Object</td>
<td>Возвращает все доступные проекты.</td>
</tr>
<tr>
<td>getProject</td>
<td>Object</td>
<td>Возвращает текущий проект.</td>
</tr>
</tbody>
</table>