gis logexpert

Points

Points - пространство имён, предназначенное для группировки методов по работе с точками

{ // PointGroup
  id: string | number, // идентификатор группы точек
  iconId: string | number, // идентификатор иконки группы точек (опциональный параметр)
  size: string | number, // размер иконки группы точек (опциональный параметр)
  show: boolean, // состояние видимости группы точек (опциональный параметр, по умолчанию false)
}

{ // Point
  id: string, // идентификатор точки
  category: string, // категория точки
  selected: boolean, //
  name: string, // имя точки (опциональный параметр)
  info: string, //
  lat: number, // широта (координаты точки)
  lon: number, // долгота (координаты точки)
  type: string, // тип точки (point/marker/icon)
  params: PointParams || IconParams || MarkerParams, // параметры точки. Для разных типов, разные параметры
}

{ // CommonParams
    defaultOpacity: number, // прозрачность по-умолчанию (опциональный параметр)
    hoverOpacity: number, // прозрачность по ховеру (опциональный параметр)
    bgColor: string, // цвет фона (опциональный параметр)
    textColor: string, // цвет текста (опциональный параметр)
    textSize: number, // размер шрифта (опциональный параметр)
    textStroke: string, // обводка текста (опциональный параметр)
    textStrokeWeight: number, // размер обводки текста (опциональный параметр)
}

{ // PointParams
    ...СommonParams,
    radius: number, // радиус точки (опциональный параметр)
    strokeColor: string, // цвет обводки точки (опциональный параметр)
    color: string, // радиус точки (опциональный параметр)
    dotStrokeSize: number, // размера канта точки (опциональный параметр)
}

{ // IconParams
    ...СommonParams,
    id: string || number, // id иконки (опциональный параметр)
    size: number, // размер иконки (опциональный параметр)
    img: string, // url иконки (не нужно передавать, сам расчитывается из id иконки)
}

{ // MarkerParams
    ...СommonParams,
    markerId: string || number, // id маркера (опциональный параметр)
    markerColor: string, // цвет маркера (опциональный параметр)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

create

Создаёт точки

Пример вызова:


jsApi.points.create('{"data":{"group":{"id":"1","iconId":2},"items":[{"id":"1","type":"point","name":"Point #1","lat":50.700376,"lon":38.657324,"params":{"color":"red"}},{"id":"3","type":"marker","name":"Point #3", "category": "Bus", "lat":50.703036,"lon":38.656576,"params":{}},{"id":"2","type":"icon", "name":"Point #4", "lat":50.705804,"lon":38.65606,"params":{"size":50}}]}}')
1
2
{
  data: {
    group: PointGroup, // группа точек 
    items: Point[], // точки, входящие в указанную группу
  }
}
1
2
3
4
5
6

Возвращаемый результат: ничего не возвращает

Воздействие на интерфейс: Создание точек

update

Обновляет параметры точек. Для обновления передаются только те данные, которые требуется обновить

Пример вызова:

jsApi.points.update('{"data":{"group":{"id":"1","iconId":2},"items":[{"id":"1","lat":50.700476,"lon":38.657924,"params":{"color":"green"}},{"id":"3","lat":50.713036,"lon":38.606576},{"id":"2","lat":50.708804,"lon":38.66606,"params":{"size":120}}]}}')
1
{
  data: {
    group: PointGroup, // группа точек
    items: Point[], // точки, входящие в указанную группу c данными, которые нужно обновить
  }
}
1
2
3
4
5
6

Возвращаемый результат: ничего не возвращает

Воздействие на интерфейс: Обновление параметов точек

grouping

Группирует иконки, точки и маркеры

Пример вызова:

jsApi.points.grouping('{"data":{"1":false,"2":true}}')
1
{
  data: {
    [PointGroup.id]: boolean, // флаг группировки точек
  }
}
1
2
3
4
5

Возвращаемый результат: ничего не возвращает

Воздействие на интерфейс: Группирование точек

delete

Удаляет точки. Удалять можно по группе или категории(ям)

Пример вызова:

jsApi.points.delete('{"data":{"group":{"id":"2","iconId":2},"id":["2.3"]}}')
jsApi.points.delete('{"data":{"category":["Bus"]}}')
1
2
{ // Удаление по группе
  data: {
    group: PointGroup, // группа точек
    id: Point.id[], // идентификаторы точек, которые нужно удалить
  }
}
1
2
3
4
5
6
{ // Удаление по категории(ям)
  data: {
    category: Category[], // категории, в которых нужно удалить точки
  }
}
1
2
3
4
5

Возвращаемый результат: ничего не возвращает

Воздействие на интерфейс: Удаление точек по группе или категории(ям)

updateGroups

Обновляет группы точек. Для обновления передаются только те данные, которые требуется обновить

Пример вызова:

jsApi.points.updateGroups('{"data":[{"id":"1","iconId":1}]}')
1
{
  data: PointGroup[], // группа точек, передаются только те данные, которые нужно изменить
}
1
2
3

Возвращаемый результат: ничего не возвращает

Воздействие на интерфейс: Обновление групп точек

setShowName

Показывает/скрывает имена всех точек на карте

Пример вызова:

jsApi.points.setShowName('{"data":false}')
1
{ 
    data: boolean, // флаг видимости имени точек
}
1
2
3

Возвращаемый результат: ничего не возвращает

Воздействие на интерфейс: Показ/скрытие имён точек

clear

Удаляет все точки на карте

Пример вызова:

jsApi.points.clear()
1

Не требует аргументов

Возвращаемый результат: ничего не возвращает

Воздействие на интерфейс: Удаление всех точек