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

 Печать Предыдущая страница Стартовая страница Следующая страница

Данные из сообщения (event.data) включают в себя следующие параметры:

• type — тип, всегда 'gwtkse';

• cmd — команда;

• data — объект с параметрами для выполнения команды.

 

{

  type: 'gwtkse';

  cmd: string;

  data: any;

}

 

Данные, отправляемые в ответном сообщении (event.data) включают в себя следующие параметры:

• type — тип, всегда 'gwtkse';

• response — объект с данными ответа;

• cmd — команда, которая была вызвана;

• status — статус выполнения ('Success' — выполнено, 'Error' — ошибка выполнения);

• result — результат выполнения команды (в случае 'Success');

• error — текст ошибки выполнения команды (в случае 'Error').

 

{

  type: 'gwtkse';

  response: {

    cmd: string;

    status: ‘Success’ | ’Error’;

    result?: any;

    error?: string;

  }

}

Обрабатываемые команды головного приложения

 

Команда (cmd)

Описание

'goTo'

Перейти в точку на карте.

Параметры:

{point: {    lat: 30,    lon: 30  }}

point – координаты точки в градусах (lat – широта, lon – долгота).

 

Результат:

true

'mapShowExtent'

Показать экстент в окне карты.

Параметры:

{bbox: [25, 50, 40, 55 ]}

bbox – координаты экстента в градусах ([долгота, широта, долгота, широта]).

 

Результат:

true

'mapShowExtentPlane'

Показать экстент в окне карты.

Параметры:

{bbox: [3617883.450,6904070.977,3619883.450,6906070.977 ],

projectionId: 'GoogleMapsCompatible'}

bbox – координаты экстента в метрах ([долгота, широта, долгота, широта]).

projectionId – идентификатор проекции (если не задан, то берется с карты)

 

Результат:

true

'mapSearchObjectsByIdList'

Поиск объектов карты по идентификаторам объектов и отображение результата на карте.

Параметры:

{idLayer:'guestmap',

ids:'Гостевая карта.95',

serviceUrl: 'http://localhost/GISWebServiceSE/service.php' }}

idLayer – идентификатор слоя сервиса карт,

ids – список идентификаторов объектов карты в виде gml.id через запятую,

serviceUrl – url-адрес сервиса карт (если не задан, то берется с карты)

 

Результат:

{ objectCount: 1, filePath: '', layer: 'guestmap', ids: 'Гостевая карта.95'}

objectCount – количество найденных объектов,

filePath – путь к файлу, если объектов слишком много,

layer – идентификатор слоя сервиса карт,

ids – список идентификаторов объектов карты в виде gml.id через запятую

'mapSetSearchResultsFromGeoJSON'

Установить результат поиска объектов из GeoJSON.

Параметры:

{geoJSON:{"type":"FeatureCollection","crs":{...},"bbox": [...],"features": [...]  },

options:{ hideObjectPanel: false, alias: 'Моя карта 1', …}}

geoJSON – объекты в формате GeoJSON,

options :

 hideObjectPanel  - флаг, чтобы не открывать панель объектов,,

 alias – название слоя,

 … - другие параметры слоя (id, url,..)

 

Результат:

[{"type":"Feature","bbox": […],"geometry": {…}, properties:{…}}]

Массив добавленных объектов в формате GeoJSON

'mapGetFileData'

Получение данных из файла.

Параметры:

{ serviceUrl: 'http://localhost/GISWebServiceSE/service.php', filePath: 'some/path/to/file'}

serviceUrl – адрес сервиса карт,

filePath – путь к файлу на сервере.

 

Результат:

{data:{"type":"FeatureCollection","crs":{...},"bbox": [...],"features": [...]  },

error: string}

data - объекты в формате GeoJSON

'mapGetObjectsByFileData'

Установить результат поиска объектов из файла на сервере.

Параметры:

{ serviceUrl: 'http://localhost/GISWebServiceSE/service.php', filePath: 'some/path/to/file'}

serviceUrl – адрес сервиса карт,

filePath – путь к файлу на сервере.

 

Результат:

{ objectCount: 5000, filePath: 'some/path/to/file', layer: 'guestmap', ids: 'Гостевая карта.95,..'}

objectCount – количество найденных объектов,

filePath – путь к файлу, если объектов слишком много,

layer – идентификатор слоя сервиса карт,

ids – список идентификаторов объектов карты в виде gml.id через запятую

'mapGetSelectedFeaturesIdList'

Получить список идентификаторов выделенных объектов.

 

Результат:

['object_2C7A9FE1-6C86-4870-B946-884F707266C7']

массив GUID выделенных объектов

'mapGetSelectedFeaturesGmlIdList'

Получить список GML идентификаторов выделенных объектов.

 

Результат:

['Гостевая карта.95']

массив GML выделенных объектов

'mapWriteProtocolMessage'

Записать сообщение в протокол событий карты.

Параметры:

{type: 'debug', text: 'Текст сообщения, description:'Описание, в данном случае отладочного события', stack:'Стек->Вызова->ошибки'}

text – основной текст сообщения

Необязательные параметры:

type – тип сообщения ('error', 'warning', 'info', 'debug'), по умолчанию 'info'

description – дополнительный текст сообщения

stack – стек вызова (в виде строки)

 

Результат:

true

'mapOpenLayers'

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

Параметры:

{options:[{

alias: 'Новый слой',

id:'user_layer_001', //если не задать, будет сгенерирован GUID

hidden:0,

url:

'https://localhost/GISWebServiceSE/service.php?

SERVICE=WMS&REQUEST=GetMap&VERSION=1.3.0&FORMAT=image/png&

LAYERS=guestmap&BBOX=%bbox&HEIGHT=%h&WIDTH=%w&CRS=%crs&dt=%dt'}]}

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

 

Результат:

[{id: 'user_layer_001', alias: 'Новый слой'}]

массив описаний слоев

'mapRemoveLayers'

Удаляет слои и их параметры из карты.

Параметры:

{ids:['user_layer_001']}

ids – список идентификаторов слоев

 

Результат:

{layerIds: ['user_layer_001']}

layerIds - список идентификаторов слоев карты

'mapSetView'

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

Параметры:

{ zoom: 14, point: [7528772.48, 4278324.90], projectionId: 'GoogleMapsCompatible'}

point – координаты точки,

Необязательные параметры:

zoom – уровень масштаба (от 0 до 23),

projectionId – идентификатор проекции (если не задан, то берется с карты)

 

Результат:

true

'mapShowLayerById'

Включить отображение слоев на карте.

Параметры:

{ids: 'noginsk'}

ids – список идентификаторов слоев карты (массив строк, либо в одной строке через запятую)

 

Результат:

{layerIds: [ 'noginsk']}

layerIds - список идентификаторов слоев карты

'mapHideLayerById'

Выключить отображение слоев на карте.

Параметры:

{ids: 'noginsk'}

ids – список идентификаторов слоев карты (массив строк, либо в одной строке через запятую)

 

Результат:

{layerIds: [ 'noginsk']}

layerIds - список идентификаторов слоев карты

'mapSelectGeoJSON'

Выделить на карте объекты из GeoJSON.

Параметры:

{geoJSON:{"type":"FeatureCollection","crs":{...},"bbox": [...],"features": [...] }}

geoJSON – объекты в формате GeoJSON

 

Результат:

true

'mapFitSelectedObjects'

Вписать выделенные объекты в окно карты.

 

Результат:

true

'mapClearSelectedObjects'

Очистить список выделенных объектов карты.

 

Результат:

true

'mapShowObjectInfoFromGeoJSON'

Отобразить окно «Информация об объекте» с объектами из GeoJSON.

Параметры:

{geoJSON:{"type":"FeatureCollection","crs":{...},"bbox": [...],"features": [...] },

action: 'opencard',

force: false }

geoJSON – объекты в формате GeoJSON

Необязательные параметры:

action – действие ('opencard' – только открыть карточку и выделить объект,

'fitmapobject' – только выделить и перейти к объекту,

'opencardandfitobject' – открыть карточку, выделить и перейти к объекту)

force – флаг принудительного масштабирования к объекту и позиционирование его в центре

 

Результат:

true

'mapShowObjectInfoByFilter'

Отобразить окно «Информация об объекте» с объектами, найденными по фильтру.

Параметры:

{filter: {layerId: 'noginsk', attrKey: 'building_levels', attrValue: '3' },

action: 'opencard',

force: false }

filter – фильтр для поиска объектов (layerId – идентификатор слоя, attrKey: ключ семантики, attrValue – значение семантики)

Необязательные параметры:

action – действие ('opencard' – только открыть карточку и выделить объект,

'fitmapobject' – только выделить и перейти к объекту,

'opencardandfitobject' – открыть карточку, выделить и перейти к объекту)

force – флаг принудительного масштабирования к объекту и позиционирование его в центре

 

Результат:

true

'mapSearchViaYandex'

Найти объекты текстовым поиском с использованием Яндекса (при условии настройки в администраторе).

Параметры:

{text: 'Ногинск'}

text – строка поиска

 

Результат:

{"type":"FeatureCollection","crs":{...},"bbox": [...],"features": [...] }

коллекция найденных объектов в формате GeoJSON

'mapSearchViaPanoramaAddressBase'

Найти объекты текстовым поиском по адресной базе Панорамы (при условии настройки в администраторе).

Параметры:

{text: 'Ногинск'}

text – строка поиска

 

Результат:

{"type":"FeatureCollection","crs":{...},"bbox": [...],"features": [...] }

коллекция найденных объектов в формате GeoJSON

'mapSearchViaNspd'

Найти объекты текстовым поиском с использованием НСПД (при условии настройки в администраторе).

Параметры:

{text: 'Ногинск', types: [1]}

text – строка поиска

Необязательные параметры:

types – массив типов объектов для поиска (если не задан, поиск выполнится по всем):

1 – «Объекты недвижимости», 2 – «Кадастровое деление», 4 – «Административно-территориальное деление»,

5 – «Зоны и территории», 7 – «Территориальные зоны», 15 – «Комплексы объектов»

 

Результат:

{"type":"FeatureCollection","crs":{...},"bbox": [...],"features": [...] }

коллекция найденных объектов в формате GeoJSON