API Docs for:
Show:

GWTK.Map Class

Компонент Карта api для публикации пространственных данных, отображение, масштабирование, перемещение карты, управление слоями

Constructor

GWTK.Map

(
  • id
  • param
)

Parameters:

  • id String

    идентификатор контейнера карты (div'а)

  • param Object

    Параметры карты

Methods

_clearCookie

()

Очистить cookie карты

_getFeatureInfo

()

Получить информацию об объектах карты

_invoke

()

Создать событие в карте

_readCookie

(
  • filter
)

Восстановить параметры карты из cookie

Parameters:

  • filter String

    имя ключа cookie

_readCookieOverlays

()

Восстановить из cookie инструмент измерения расстояний

_readCookiePanels

()

Восстановить из cookie видимые панели карты

_setMapCenter

() GWTK.Point

Установить положение центра отображаемого фрагмента карты по значениям координат центра в параметрах карты

Returns:

GWTK.Point:

прямоугольные координаты центра отображаемого фрагмента (x,y)

_writeCookie

()

Записать cookie карты

_writeCookiePanels

()

Записать в cookie видимые панели карты

addLayer

(
  • layparam
)
Object

Добавить слой в карту

Parameters:

  • layparam Object

    параметры слоя, layparam должен содержаться параметрах карты

Returns:

Object:

, класс управления слоем карты, при ошибке возвращает null

addListener

()

Добавить слушателя

addVirtualLayer

(
  • layparam
)

Добавить слой виртуальной папки

Parameters:

  • layparam Object

    параметры слоя виртуальной папки

closeLayer

(
  • layparam
)
Object

Открыть слой. Добавляет слой и параметры слоя в карту.

Parameters:

  • layparam Object

    параметры слоя

Returns:

Object:

, класс управления слоем карты, при ошибке возвращает -1. Если слой с идентификатором layparam.id уже существует в карте, возвращает 0

createLayer

(
  • layparam
)

Создать слой без отображения. Создается объект слоя, добавляется в список слоев карты с признаком "onlyset":1. DOM-элементы слоя не создаются и не добавляются к карте

Parameters:

  • layparam Object

    параметры слоя

createPane

(
  • className
  • container
  • animated
)

Создать панель div

Parameters:

  • className String

    имя css класса

  • container Object

    родительский элемент

  • animated Bool

    признак, что панель используется при анимации

fixView

()

Сохранить положение карты в cookie

getAreaUnits

() String

Запросить текущие Единицы измерения площади

Returns:

String:

название единицы ('sq m' или 'ha' или 'sq km') или null

getFeatureInfo

(
  • point
)

Получить информацию об объектах карты по координатам точки

Parameters:

  • point GWTK.Point

    координаты точки в окне карты (x,y), пикселы

getLayerOptionsById

(
  • id
)
Object

Запросить параметры слоя по его идентификатору

Parameters:

  • id String

    идентификатор слоя

Returns:

Object:

возвращает JSON-параметры слоя, при ошибке возвращает null

getLayersId

()

Запросить список идентификаторов слоев карты

getLinearUnits

() String

Запросить текущие Единицы измерения длины

Returns:

String:

название единицы ('m' или 'km') или null

getMapBBox

() Object

Запросить географические габариты текущего окна карты

Returns:

Object:

{ "SW": [lat, lng], "NE": [lat, lng]}, географические координаты углов окна

getMapBBox

() Object

Запросить габариты текущего окна карты (BBox)

Returns:

Object:

{ "min": [x, y], "max": [x, y]}, прямоугольные координаты углов

getMapTopLeft

() GWTK.point

Запросить прямоугольные координаты верхнего левого угла отображаемого фрагмента карты

Returns:

GWTK.point:

прямоугольные координаты (x, y)

getMeasurementShow

()

Запросить признак отображения пространственных характеристик при отборе объектов

getScaleZoom

(
  • scale
)
Number

Запросить масштабный коэффициент (уровень матрицы тайлов) для масштаба

Parameters:

  • scale Number

    масштаб

Returns:

Number:

масштабный коэффициент (уровень матрицы тайлов)

getWindowSize

() Array

Запросить размер окна карты слушателя

Returns:

Array:

, [ширина, высота]

getZoomingRatio

(
  • zoomto
)

Запросить коэффициент изменения текущего масштаба

Parameters:

  • zoomto Number

    уровень приближения матрицы тайлов

getZoomScale

() Number

Запросить масштаб отображения карты для уровня матрицы тайлов

Returns:

Number:

масштаб карты

initContainer

(
  • id
)

Инициализация контейнера карты

Parameters:

  • id String

    , идентификатор HTML-элемента

initEvents

()

Назначение обработчиков событий карты

initEvents

()

Назначение обработчиков событий кнопок тулбара карты

initialize

()

Инициализация класса карты

initMeasurementUnits

()

Инициализация параметров Единиц измерения

initPanes

()

Инициализация панелей карты

initTools

()

Настройка состава инструментов карты

mapTool

(
  • toolname
)

Запросить объект инструмента (контрола) карты по его имени

Parameters:

  • toolname String

    имя контрола карты

move

(
  • dx
  • dy
)

Переместить панели карты

Parameters:

  • dx Number

    размер смещения по горизонтали, пиксел

  • dy Number

    размер смещения по вертикали, пиксел

onDataLoadedWmts

(
  • response
)

Обработчик ответа операции выбора объектов карты в точке

Parameters:

  • response Object

    данные ответа

openLayer

(
  • layparam
)
Object

Открыть слой. Добавляет слой и параметры слоя в карту.

Parameters:

  • layparam Object

    параметры слоя

Returns:

Object:

, класс управления слоем карты, при ошибке возвращает -1. Если слой с идентификатором layparam.id уже существует в карте, возвращает 0

overlayAppend

(
  • geo
  • point
  • view
  • id
  • type
  • size
)

Добавить отметку в оверлей карты

Parameters:

  • geo GWTK.LatLng

    географические координаты отметки

  • point GWTK.Point

    координаты отметки в окне карты

  • view Bool

    показать/скрыть отметку

  • id String

    идентификатор отметки

  • type Bool

    изменить размер отметки

  • size Array

    размер рисунка отметки [ширина, высота]

overlayClear

()

Удалить все отметки с панели оверлеев

overlayRefresh

()

Обновить объекты на оверлее

overlayRemove

()

Удалить оверлеи в карте

placemarkRemove

()

Удалить отметки на оверлее и в списке в карте

preResetMap

(
  • options
  • remove
)

Предварительное обновление карты (без отображения)

Parameters:

  • options Object

    параметры карты, options.layers - параметры добавляемых слоев (новых)

  • remove String

    список идентификаторов слоев (через запятую), которые необходимо закрыть. При remove = '*' удаляются все имеющиеся слои карты.

refreshLayer

(
  • layparam
)

Обновить слой

Parameters:

  • layparam Object

    параметры слоя

removeListener

()

Удалить слушателя

renderMap

(
  • options
  • skipcontenttree
)

Вывести карту (после выполнения preResetMap)

Parameters:

  • options Object

    параметры карты, options.layers - параметры добавляемых слоев (новых)

  • skipcontenttree Bool

    признак "Пропустить настройку дерева данных". Если в options есть описание дерева данных, выполняется обновление компонента состава карты.

resetMap

(
  • options
  • remove
  • skipcontenttree
)

Обновить карту

Parameters:

  • options Object

    параметры карты, options.layers - параметры добавляемых слоев (новых)

  • remove String

    список идентификаторов слоев (через запятую), которые необходимо закрыть. При remove = '*' удаляются все имеющиеся слои карты.

  • skipcontenttree Bool

    признак "Пропустить настройку дерева данных". Если в options есть описание дерева данных, выполняется обновление компонента состава карты.

restoreView

()

Восстановить положение карты из cookie

setBounds

(
  • latlngbounds
  • crs
)

Установить габариты карты

Parameters:

  • latlngbounds GWTK.latLngBounds

    габариты

  • crs Number

    код системы координат

setLayerLegend

(
  • layer
)

Запросить легенду слоя карты

Parameters:

  • layer Object

    , слой карты

setLayerLegendById

(
  • xid
)

Запросить легенду слоя карты по id слоя

Parameters:

  • xid String

    идентификатор слоя карты

setLayers

()

Установить слои карты по списку слоев в параметрах карты

setLegend

()

Запросить легенды слоев карты

setMapCenter

(
  • center
  • refresh
)

Установить положение центра отображаемого фрагмента карты

Parameters:

  • center GWTK.Point

    прямоугольные координаты центра отображаемого фрагмента (x,y), метры

  • refresh Bool

    признак обновления рисунка карты

setMatrix

(
  • tilematrixset
)

Установить тип матрицы тайлов

Parameters:

  • tilematrixset String

    имя матрицы тайлов

setMaxBounds

(
  • maxbounds
)

Установить максимальные габариты карты

Parameters:

  • maxbounds GWTK.latLngBounds

    габариты

setOptions

()

Установить параметры карты

setQueries

()

Настроить класс Wmts-запросов

setScaleUI

(
  • zoom
)

Вывести в панель масштаб отображения карты

Parameters:

  • zoom Number

    масштабный коэффициент (уровень матрицы тайлов)

setTextSearch

()

Настроить панель поиска

setTextSearchPagerPane

()

Настроить панель навигации для поиска

setTextSearchResPane

()

Настроить панель результатов поиска

setView

(
  • crs
  • center
  • zoom
)

Установить вид карты

Parameters:

  • crs Number

    EPSG код системы координат

  • center Array

    координаты центра отображаемого фрагмента, [широта, долгота]

  • zoom Number

    масштабный коэффициент (уровень матрицы тайлов)

setViewport

(
  • center
)

Установить положение просмотра

Parameters:

  • center Array

    координаты центра отображаемого фрагмента, [широта, долгота]

setWindowSize

(
  • width
  • height
)

Установить размер окна карты слушателя

Parameters:

  • width Number

    ширина, пиксел

  • height Number

    высота, пиксел

setZoom

(
  • zoom
)

Установить масштаб отображения карты

Parameters:

  • zoom Number

    масштабный коэффициент (уровень матрицы тайлов)

showMap

()

Отобразить карту

showMapExtent

(
  • a,b
  • c,d
  • roundedup
)

Отобразить экстент карты в текущем окне

Parameters:

  • a,b Number,Number

    геодезичесие координаты юго-западного угла экстента, (lat,lng, градусы)

  • c,d Number,Number

    геодезичесие координаты северо-восточного угла экстента (lat,lng, градусы)

  • roundedup Bool

    признак округления масштаба в большую сторону. Функция масштабирует карту, чтобы вписать экстент в окно. Если для карты установлен максимальный масштаб отображения, он не превышается.

squareMetersToUnits

(
  • area
)
Object

Преобразовать значение площади в кв м в текущие единицы площади

Parameters:

  • area Object

    площадь, кв м

Returns:

Object:

или null при ошибке {'area': площадь, 'unit': название единицы ('sq m'/'ha'/'sq km'), 'str_area': area & unit}

squareMetersToUnits

() Object

Преобразовать значение площади в кв м в текущие единицы площади

Returns:

Object:

или null при ошибке {'perimeter': длина, 'unit': название единицы ('m'/'ft'/'km'/'Nm'), 'str_perimeter': perimeter & unit}

zoomIn

(
  • delta
)

Увеличить изображение карты

Parameters:

  • delta Number

    шаг увеличения

zooming

(
  • delta
  • pos
)

Выполнить масштабирование в точке с указанным приращением масштаба

Parameters:

  • delta Number

    приращение масштаба (шаг)

  • pos GWTK.Point

    координаты точки в окне карты (pixel)

zoomLimit

(
  • zoom
)

Границы масштабирования изображения карты

Parameters:

  • zoom Number

    масштабный коэффициент (уровень матрицы тайлов)

zoomOut

(
  • delta
)

Уменьшить изображение карты

Parameters:

  • delta Number

    шаг уменьшения