2gis-maps

<h2 id="вспомогательные-классы">Вспомогательные классы</h2><dl class="api-incut"><ul class="page-contents"><li><a href="#dgbrowser">DG.Browser</a><ul><li><a href="#свойства">Свойства</a></li></ul></li><li><a href="#dgutil">DG.Util</a><ul><li><a href="#функции">Функции</a></li><li><a href="#свойства-1">Свойства</a></li></ul></li><li><a href="#dglineutil">DG.LineUtil</a><ul><li><a href="#функции-1">Функции</a></li></ul></li><li><a href="#dgpolyutil">DG.PolyUtil</a><ul><li><a href="#функции-2">Функции</a></li></ul></dl> <h3 id="dgbrowser">DG.Browser</h3>Объект со статическими свойствами, описывающими браузер пользователя, например: <pre><code>if (DG.Browser.ie6) { alert('Вам срочно нужно обновить свой браузер!'); } </code></pre><h4 id="свойства">Свойства</h4><table> <thead> <tr> <th>Свойство</th> <th>Тип</th> <th>Описание</th> </tr> </thead> <tbody> <tr id="browser-ie"> <td><code>ie</code></td> <td><code>Boolean</code></td> <td><code>true</code> для всех версий Internet Explorer (не Edge).</td> </tr> <tr id="browser-ielt9"> <td><code>ielt9</code></td> <td><code>Boolean</code></td> <td><code>true</code> для всех версий Internet Explorer ниже версии 9.</td> </tr> <tr id="browser-edge"> <td><code>edge</code></td> <td><code>Boolean</code></td> <td><code>true</code> для браузера Edge.</td> </tr> <tr id="browser-webkit"> <td><code>webkit</code></td> <td><code>Boolean</code></td> <td><code>true</code> для браузеров на основе WebKit, таких как Chrome и Safari (включая мобильные версии).</td> </tr> <tr id="browser-gecko"> <td><code>gecko</code></td> <td><code>Boolean</code></td> <td><code>true</code> для браузеров на основе gecko, таких как Firefox.</td> </tr> <tr id="browser-android"> <td><code>android</code></td> <td><code>Boolean</code></td> <td><code>true</code> для мобильных браузеров работающих на базе платформы Android.</td> </tr> <tr id="browser-android23"> <td><code>android23</code></td> <td><code>Boolean</code></td> <td><code>true</code> для мобильных браузеров на старых версиях Android устройств (2 и 3).</td> </tr> <tr id="browser-chrome"> <td><code>chrome</code></td> <td><code>Boolean</code></td> <td><code>true</code> для браузера Chrome.</td> </tr> <tr id="browser-safari"> <td><code>safari</code></td> <td><code>Boolean</code></td> <td><code>true</code> для браузера Safari.</td> </tr> <tr id="browser-ie3d"> <td><code>ie3d</code></td> <td><code>Boolean</code></td> <td><code>true</code> для всех версий Internet Explorer, поддерживающих CSS transform.</td> </tr> <tr id="browser-webkit3d"> <td><code>webkit3d</code></td> <td><code>Boolean</code></td> <td><code>true</code> для всех браузеров на основе WebKit, поддерживающих CSS transform.</td> </tr> <tr id="browser-gecko3d"> <td><code>gecko3d</code></td> <td><code>Boolean</code></td> <td><code>true</code> для всех браузеров на основе gecko, поддерживающих CSS transform.</td> </tr> <tr id="browser-opera12"> <td><code>opera12</code></td> <td><code>Boolean</code></td> <td><code>true</code> для всех версий Opera, поддерживающих CSS transform (версия 12+).</td> </tr> <tr id="browser-any3d"> <td><code>any3d</code></td> <td><code>Boolean</code></td> <td><code>true</code> для всех браузеров, поддерживающих CSS transform.</td> </tr> <tr id="browser-mobile"> <td><code>mobile</code></td> <td><code>Boolean</code></td> <td><code>true</code> для браузеров, работающих на современных мобильных устройствах.</td> </tr> <tr id="browser-mobilewebkit"> <td><code>mobileWebkit</code></td> <td><code>Boolean</code></td> <td><code>true</code> для мобильных браузеров на основе WebKit.</td> </tr> <tr id="browser-mobilewebkit3d"> <td><code>mobileWebkit3d</code></td> <td><code>Boolean</code></td> <td><code>true</code> для мобильных браузеров на основе WebKit, поддерживающих CSS transform.</td> </tr> <tr id="browser-mobileopera"> <td><code>mobileOpera</code></td> <td><code>Boolean</code></td> <td><code>true</code> для мобильной версии Opera.</td> </tr> <tr id="browser-mobilegecko"> <td><code>mobileGecko</code></td> <td><code>Boolean</code></td> <td><code>true</code> для мобильных браузеров на основе gecko.</td> </tr> <tr id="browser-touch"> <td><code>touch</code></td> <td><code>Boolean</code></td> <td><code>true</code> для всех браузеров, поддерживающих <a href="https://developer.mozilla.org/docs/Web/API/Touch_events">touch events</a>.</td> </tr> <tr id="browser-mspointer"> <td><code>msPointer</code></td> <td><code>Boolean</code></td> <td><code>true</code> для браузеров, поддерживающих touch events модель от Microsoft (например, IE10).</td> </tr> <tr id="browser-pointer"> <td><code>pointer</code></td> <td><code>Boolean</code></td> <td><code>true</code> для всех браузеров, поддерживающих <a href="https://msdn.microsoft.com/en-us/library/dn433244%28v=vs.85%29.aspx">pointer events</a>.</td> </tr> <tr id="browser-retina"> <td><code>retina</code></td> <td><code>Boolean</code></td> <td><code>true</code> для браузеров, работающих на устройствах с Retina экраном.</td> </tr> <tr id="browser-canvas"> <td><code>canvas</code></td> <td><code>Boolean</code></td> <td><code>true</code> для браузеров, поддерживающих <a href="https://developer.mozilla.org/docs/Web/API/Canvas_API"><code><canvas></code></a>.</td> </tr> <tr id="browser-vml"> <td><code>vml</code></td> <td><code>Boolean</code></td> <td><code>true</code> для браузеров, поддерживающих <a href="https://ru.wikipedia.org/wiki/VML">VML</a>.</td> </tr> <tr id="browser-svg"> <td><code>svg</code></td> <td><code>Boolean</code></td> <td><code>true</code> для браузеров, поддерживающих <a href="https://developer.mozilla.org/docs/Web/SVG">SVG</a>.</td> </tr> </tbody> </table> <h3 id="dgutil">DG.Util</h3>Общие служебные методы и свойства. <h4 id="функции">Функции</h4><table> <thead> <tr> <th>Функция</th> <th>Возвращает</th> <th>Описание</th> </tr> </thead> <tbody> <tr id="util-extend"> <td><code>extend( <Object> dest, <Object> src? ) </code></td> <td><code>Object</code></td> <td>Объединяет свойства объекта <code>src</code> (или нескольких объектов) и свойства объекта <code>dest</code> и возвращает последний. Также доступен под псевдонимом <code>DG.extend</code>.</td> </tr> <tr id="util-create"> <td><code>create( <Object> proto, <Object> properties? ) </code></td> <td><code>Object</code></td> <td>Полифил для <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/create">Object.create</a></td> </tr> <tr id="util-bind"> <td><code>bind( <Function> fn, … ) </code></td> <td><code>Function</code></td> <td>Возвращает функцию, которая выполняет функцию <code>fn</code> с определенным объектом контекста <code>obj</code> (так, чтобы ключевое слово <code>this</code> внутри функции указывало на <code>obj</code>). Также доступно под псевдонимом <code>DG.bind</code>.</td> </tr> <tr id="util-stamp"> <td><code>stamp( <Object> obj ) </code></td> <td><code>Number</code></td> <td>Возвращает уникальный ID объекта, создавая его при необходимости. Полезно для получения быстрого доступа к объекту, находящемуся в группе.</td> </tr> <tr id="util-throttle"> <td><code>throttle( <Function> fn, <Number> time, <Object> context ) </code></td> <td><code>Function</code></td> <td>Возвращает обертку над функцией <code>fn</code>, которая гарантирует, что функция не будет вызвана более чем один раз в заданный интервал времени <code>time</code> (например, используется при запросах к тайлам во время перетаскивания карты), опционально можно передать контекст (<code>context</code>), с которым будет вызываться функция.</td> </tr> <tr id="util-wrapnum"> <td><code>wrapNum( <Number> num, <Number[]> range, <Boolean> includeMax? ) </code></td> <td><code>Number</code></td> <td>Возвращает число <code>num</code> приведенное к диапазону <code>range</code> (modulo). Получившееся значение будет всегда меньше <code>range[1]</code>, если только опция <code>includeMax</code> не выставлена в <code>true</code>.</td> </tr> <tr id="util-falsefn"> <td><code>falseFn()</code></td> <td><code>Function</code></td> <td>Возвращает функцию, вызов которой всегда будет давать результат <code>false</code>.</td> </tr> <tr id="util-formatnum"> <td><code>formatNum( <Number> num, <Number> digits? ) </code></td> <td><code>Number</code></td> <td>Возвращает число <code>num</code>, округленное до <code>digits</code> десятичных знаков (5 знаков по умолчанию).</td> </tr> <tr id="util-trim"> <td><code>trim( <String> str ) </code></td> <td><code>String</code></td> <td>Полифил для <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String/Trim">String.prototype.trim</a></td> </tr> <tr id="util-splitwords"> <td><code>splitWords( <String> str ) </code></td> <td><code>String[]</code></td> <td>Обрезает и разделяет строку на части, используя в качестве разделителя пробел, возвращает массив с этими частями.</code></td> </tr> <tr id="util-setoptions"> <td><code>setOptions( <Object: options: Object> obj ) </code></td> <td><code>Object</code></td> <td>Объединяет свойства <code>options</code> со свойствами объекта <code>obj</code>, возвращая получившийся объект. См. <code>Class options</code>. Также доступен под псевдонимом <code>DG.setOptions</code>.</td> </tr> <tr id="util-getparamstring"> <td><code>getParamString( <Object> obj, <String> existingUrl?, <Boolean> uppercase? ) </code></td> <td><code>String</code></td> <td>Преобразует объект в URL-строку, например, <code>{a: "foo", b: "bar"}</code> будет преобразован в <code>'?a=foo&b=bar'</code>. Если задан параметр <code>existingUrl</code> результирующая строка будет подготовлена для добавления в конец переданного URL. Также возможно приведение названий свойств к верхнему регистру (параметр <code>uppercase</code>). Простейший шаблонизатор также воспринимает строки в формате <code>'Hello {a}, {b}'</code> и объект вида <code>{a: 'foo', b: 'bar'}</code>. При таком вызове метод возвращает строку <code>('Hello foo, bar')</code>.</td> </tr> <tr id="util-isarray"> <td><code>isArray(obj)</code></td> <td><code>Boolean</code></td> <td>Полифил для <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray">Array.isArray</a></td> </tr> <tr id="util-indexof"> <td><code>indexOf()</code></td> <td><code>Number</code></td> <td>Полифил для <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf">Array.prototype.indexOf</a></td> </tr> <tr id="util-requestanimframe"> <td><code>requestAnimFrame( <Function> fn, <Object> context?, <Boolean> immediate? ) </code></td> <td><code>requestId: Number</code></td> <td>Использует планировщик для вызова функции <code>fn</code> при событии обновлении окна браузера (repaint). Функция <code>fn</code> вызывается с контекстом <code>context</code>, если он задан. Когда задан параметр <code>immediate</code>, <code>fn</code> функция вызывается сразу же, если браузер не поддерживает нативно <a href="https://developer.mozilla.org/docs/Web/API/window/requestAnimationFrame"><code>window.requestAnimationFrame</code></a>, в противном случае вызов откладывается, до возникновения события перерисовки. Возвращает id, который может быть использован для отмены задания планировщика.</td> </tr> <tr id="util-cancelanimframe"> <td><code>cancelAnimFrame( <Number> id ) </code></td> <td><code></code></td> <td>Отменяет предыдущий <code>requestAnimFrame</code>. См. также <a href="https://developer.mozilla.org/docs/Web/API/window/cancelAnimationFrame">window.cancelAnimationFrame</a>.</td> </tr> </tbody> </table> <h4 id="свойства-1">Свойства</h4><table> <thead> <tr> <th>Свойство</th> <th>Тип</th> <th>Описание</th> </tr> </thead> <tbody> <tr id="util-lastid"> <td><code>lastId</code></td> <td><code>Number</code></td> <td>Последний уникальный ID, используемый <a href="#util-stamp"><code>stamp()</code></a></td> </tr> <tr id="util-emptyimageurl"> <td><code>emptyImageUrl</code></td> <td><code>String</code></td> <td>URI, содержащий пустое GIF изображение, закодированное в base64. Используется для освобождения памяти неиспользуемых картинок в мобильных WebKit браузерах (память освобождается установкой свойства <code>src</code> в данное значение).</td> </tr> </tbody> </table> <h3 id="dglineutil">DG.LineUtil</h3>Набор методов для обработки ломаных. <h4 id="функции-1">Функции</h4><table> <thead> <tr> <th>Функция</th> <th>Возвращает</th> <th>Описание</th> </tr> </thead> <tbody> <tr id="lineutil-simplify"> <td><code>simplify( <Point[]> points, <Number> tolerance ) </code></td> <td><code>Point[]</code></td> <td>Уменьшает количество точек в ломаной и возвращает новую упрощенную ломаную. Позволяет увеличить производительность обработки/отображения ломаных на карте. Параметр <code>tolerance</code> влияет на величину упрощения (чем меньше значение, тем лучше качество геометрии и ниже производительность).</td> </tr> <tr id="lineutil-pointtosegmentdistance"> <td><code>pointToSegmentDistance( <<a href="/doc/maps/ru/manual/basic-types#dgpoint">Point</a>> p, <<a href="/doc/maps/ru/manual/basic-types#dgpoint">Point</a>> p1, <<a href="/doc/maps/ru/manual/basic-types#dgpoint">Point</a>> p2 ) </code></td> <td><code>Number</code></td> <td>Возвращает расстояние между точкой <code>p</code> и сегментом между точками <code>p1</code> и <code>p2</code>.</td> </tr> <tr id="lineutil-closestpointonsegment"> <td><code>closestPointOnSegment( <<a href="/doc/maps/ru/manual/basic-types#dgpoint">Point</a>> p, <<a href="/doc/maps/ru/manual/basic-types#dgpoint">Point</a>> p1, <<a href="/doc/maps/ru/manual/basic-types#dgpoint">Point</a>> p2 ) </code></td> <td><code>Number</code></td> <td>Возвращает ближайшую точку на сегменте <code>p1</code> <code>p2</code> до точки <code>p</code>.</td> </tr> </tbody> </table> <h3 id="dgpolyutil">DG.PolyUtil</h3>Набор служебных функций для работы с многоугольниками. <h4 id="функции-2">Функции</h4><table> <thead> <tr> <th>Функция</th> <th>Возвращает</th> <th>Описание</th> </tr> </thead> <tbody> <tr id="polyutil-clippolygon"> <td><code>clipPolygon( <Point[]> points, <<a href="/doc/maps/ru/manual/basic-types#dgbounds">Bounds</a>> bounds, <Boolean> round? ) </code></td> <td><code>Point[]</code></td> <td>Обрезает многоугольник, заданный координатами <code>points</code> по заданным границам (используя алгоритм <a href="https://en.wikipedia.org/wiki/Sutherland%E2%80%93Hodgman_algorithm">Sutherland-Hodgeman</a>а).</td> </tr> </tbody> </table>