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

Interactive 2GIS maps API, based on Leaflet

<h2 id="асинхронные-запросы (ajax)">Асинхронные запросы (AJAX)</h2><p><dl class="api-incut"><ul class="page-contents"><li><a href="#dgajax">DG.ajax</a><ul><li><a href="#методы">Методы</a></li><li><a href="#опции">Опции</a></li></ul></dl></p>
<h3 id="dgajax">DG.ajax</h3><p>Функция DG.ajax позволяет отправлять кросс-доменные AJAX запросы.</p>
<pre><code>var promise = DG.ajax(&#39;http://www.geonames.org/postalCodeLookupJSON&#39;, {
    type: &#39;get&#39;,
    data: {
        postalcode: 10504,
        country: &#39;US&#39;
    },
    success: function(data) {
        console.log(&#39;success&#39;, data);
    },
    error: function(error) {
        console.log(&#39;error&#39;, error);
    }
});

// для отмены запроса:
// promise.abort();
</code></pre><h4 id="методы">Методы</h4><table>
    <thead>
        <tr>
            <th>Вызов</th>
            <th>Возвращает</th>
            <th>Описание</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><code><b>DG.ajax</b>(
                <nobr>&lt;String&gt; <i>url</i>,</nobr>
                <nobr>&lt;<a href="#опции">Ajax options</a>&gt; <i>options?</i> )</nobr>
            </code></td>
            <td><code>Promise</code></td>
            <td>Отправляет запрос на сервер и возвращает объект Promise с методом abort, с помощью
                которого можно прервать отправку запроса. В качестве входящих параметров принимает URL,
                на который будет отправлен запрос и необязательный объект опций.</td>
        </tr>
    </tbody>
</table>

<h4 id="опции">Опции</h4><table>
    <thead>
        <tr>
            <th>Опция</th>
            <th>Тип</th>
            <th>Значение<br>по умолчанию</th>
            <th>Описание</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><code><b>data</b></code></td>
            <td><code>Object</code></td>
            <td><code>null</code></td>
            <td>Данные, которые будут переданы на сервер.</td>
        </tr>
        <tr>
            <td><code><b>type</b></code></td>
            <td><code>String</code></td>
            <td><code>get</code></td>
            <td>Тип запроса (&#39;get&#39;, &#39;post&#39; или &#39;jsonp&#39;).</td>
        </tr>
        <tr>
            <td><code><b>success</b></code></td>
            <td><code>Function</code></td>
            <td><code>null</code></td>
            <td>Функция, которая срабатывает в случае успешного ответа сервера.
                В качестве параметра принимает полученные данные.</td>
        </tr>
        <tr>
            <td><code><b>error</b></code></td>
            <td><code>Function</code></td>
            <td><code>null</code></td>
            <td>Функция, которая срабатывает при возникновении ошибки.
                В качестве параметра принимает информацию об ошибке.</td>
        </tr>
        <tr>
            <td><code><b>url</b></code></td>
            <td><code>String</code></td>
            <td><code>null</code></td>
            <td>URL, на который будет отправлен запрос.</td>
        </tr>
        <tr>
            <td><code><b>timeout</b></code></td>
            <td><code>Number</code></td>
            <td><code>null</code></td>
            <td>Время ожидания запроса (в миллисекундах).</td>
        </tr>
    </tbody>
</table>