2gis-maps/dist/doc/ru/manual/dg-ruler.html

Interactive 2GIS maps API, based on Leaflet

<h2 id="линейка">Линейка</h2><p>Отображает на карте линейку, позволяющую измерять расстояния между географическими точками.</p>
<p><dl class="api-incut"><ul class="page-contents"><li><a href="#dgruler">DG.Ruler</a><ul><li><a href="#пример-использования">Пример использования</a></li><li><a href="#создание">Создание</a></li><li><a href="#опции">Опции</a></li><li><a href="#методы">Методы</a></li></ul></dl></p>
<h3 id="dgruler">DG.Ruler</h3><h4 id="пример-использования">Пример использования</h4><p>Создание и отображение линейки на карте:</p>
<pre><code>var latLngs = [
    [51.7314, 36.1938],
    [51.7307, 36.1894],
    [51.7297, 36.1926],
    [51.7299, 36.1968],
    [51.7307, 36.1968]]
DG.ruler(latLngs).addTo(map);
</code></pre><h4 id="создание">Создание</h4><table>
    <thead>
        <tr>
            <th>Конструктор</th>
            <th>Использование</th>
            <th>Описание</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><code><b>DG.Ruler</b>(
                <nobr>&lt;<a href="/doc/maps/ru/manual/basic-types#dglatlng">LatLng</a>[]&gt; <i>latlngs</i>,</nobr>
                <nobr>&lt;<a href="#dgruler-options">Ruler options</a>&gt; <i>options?</i> )</nobr>
            </code></td>
            <td><code>DG.ruler(&hellip;)</code></td>
            <td>Создает объект линейки по переданному массиву географических точек и необязательному объекту опций.</td>
        </tr>
    </tbody>
</table>

<h4 id="опции">Опции</h4><table id='dgruler-options'>
    <thead>
        <tr>
            <th>Опция</th>
            <th>Тип</th>
            <th>Значение<br>по умолчанию</th>
            <th>Описание</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><code><b>editable</b></code></td>
            <td><code>Boolean</code></td>
            <td><code><span class="string">&#39;true&#39;</span></td>
            <td>Возможно ли изменять промежуточные точки линейки.</td>
        </tr>
    </tbody>
</table>

<h4 id="методы">Методы</h4><table>
    <thead>
        <tr>
            <th>Метод</th>
            <th>Возвращает</th>
            <th>Описание</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><code><b>addTo</b>(
                <nobr>&lt;<a href="/doc/maps/ru/manual/map#dgmap">Map</a>&gt; <i>map</i> )</nobr>
            </code></td>
            <td><code>this</code></td>
            <td>Добавляет линейку на карту.</td>
        </tr>
        <tr>
            <td><code><b>getTotalDistance</b>()</nobr></code></td>
            <td><code>Number</code></td>
            <td>Возвращает расстояние (в метрах) между начальной и конечной точками.</td>
        </tr>
        <tr>
            <td><code><b>addLatLng</b>(
                <nobr>&lt;<a href="/doc/maps/ru/manual/basic-types#dglatlng">LatLng</a>&gt; <i>latlng</i> )</nobr>
            </code></td>
            <td><code>this</code></td>
            <td>Добавляет точку в линейку.</td>
        </tr>
        <tr>
            <td><code><b>setLatLngs</b>(
                <nobr>&lt;<a href="/doc/maps/ru/manual/basic-types#dglatlng">LatLng</a>[]&gt; <i>latlngs</i> )</nobr>
            </code></td>
            <td><code>this</code></td>
            <td>Заменяет все точки линейки массивом переданных географических точек.</td>
        </tr>
        <tr>
            <td><code><b>getLatLngs</b>()</code></td>
            <td><code><a href="/doc/maps/ru/manual/basic-types#dglatlng">LatLng</a>[]</code></td>
            <td>Возвращает массив точек линейки.</td>
        </tr>
        <tr>
            <td><code><b>spliceLatLngs</b>(
                <nobr>&lt;Number&gt; <i>index</i></nobr>,
                <nobr>&lt;Number&gt; <i>pointsToRemove</i></nobr>,
                <nobr>&lt;<a href="/doc/maps/ru/manual/basic-types#dglatlng">LatLng</a>&gt; <i>latlng?</i>, &hellip; )</nobr>
            </code></td>
            <td><code><a href="/doc/maps/ru/manual/basic-types#dglatlng">LatLng</a>[]</code></td>
            <td>Позволяет добавлять, удалять или заменять точки в линейке. Синтаксис аналогичен
                <a target="_blank" href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/splice">Array#splice</a>.
                Возвращает массив удаленных точек.</td>
        </tr>
    </tbody>
</table>