Tracks
Tracks - пространство имён, предназначенное для группировки методов по работе с треками
{ // Track || TrackCustom
data: TrackData || TrackCustomData,
id: string,
params: TrackParams || TrackCustomParams,
}
{ // TrackData
Anomalies: [string, number][], // аномалии
Bounds: [number, number, number, number], // граница трека [minLng, minLat, maxLng, maxLat]
ChartItems: string[], // элементы графика
Id: string, // идентификатор трека
Mileage: number, // длина трека в км
Parkings: [number, string, number, number][], // парковки
PointsCount: number, // количество точек трека
Rides: [number, string, number, number][], // поездки
Stops: [number, string, number, number][], // остановки
Success: boolean, // флаг успешности построения трека
}
{ // TrackCustomData
Bounds: [number, number, number, number], // граница кастомного трека [minLng, minLat, maxLng, maxLat]
Id: string, // идентификатор кастомного трека
PointsCount: number, // количество точек кастомного трека
WKB: string, // двоичное представление формата WKT в шестнадцатеричных строках кастомного трека
}
{ // TrackParams
id: string, // индентификатор трека
objectId: number, // идентификатор объекта трека
from: string, // от (период времени)
to: string, // до (период времени)
useRideDetector: boolean, // флаг использования детектора поездок
rebuildOnFailures: boolean, // флаг попытки перестроить трек в случае возникновения ошибки
color: string, // цвет трека
fillGaps: boolean, // флаг заполнения разрыва. Если в треке разрыв между точками более чем указано в настройках, то произойдёт достраивание трека по дорогам из OSRM. Как правило такой трек отображается пунктиром
showStopsInTracks: boolean, // флаг показа остановок на треке
showParkingsInTracks: boolean, // флаг показа парковок на треке
setBounds: boolean, // флаг установки границ карты после построения трека
}
{ // TrackCustomParams
id: string, // идентификатор кастомного трека
points: [number, number][], // координаты точек кастомного трека
strokeColor: string, // цвет кастомного трека
strokeWidth: number, // ширина линии кастомного трека
visible: boolean, // флаг видимости кастомного трека
fillGaps: boolean, // флаг заполнения разрыва. Если в треке разрыв между точками более чем указано в настройках, то произойдёт достраивание трека по дорогам из OSRM. Как правило такой трек отображается пунктиром
}
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
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
create
Создаёт трек
Пример вызова:
jsApi.tracks.create('{"data": {"id": "ad23395e-0a0f-4751-8913-bfba85e68dc1", "objectId": 109652, "from": "2023-05-24T20:00:00.000Z", "to": "2023-05-25T20:00:00.000Z", "useRideDetector": true, "rebuildOnFailures": true}}')
1
{
data: {
id: string, // идентификатор трека (опциональный параметр)
objectId: number, // идентификатор объекта трека
from: string, // от (период времени)
to: string, // до (период времени)
useRideDetector: boolean, // флаг использования детектора поездок (опциональный параметр)
rebuildOnFailures: boolean, // флаг попытки перестроить трек в случае возникновения ошибки
color: string, // цвет трека (опциональный параметр)
fillGaps: boolean, // флаг заполнения разрыва. Если в треке разрыв между точками более чем указано в настройках, то произойдёт достраивание трека по дорогам из OSRM. Как правило такой трек отображается пунктиром (опциональный параметр)
showStopsInTracks: boolean, // флаг показа остановок на треке (опциональный параметр)
showParkingsInTracks: boolean, // флаг показа парковок на треке (опциональный параметр)
setBounds: boolean, // флаг установки границ карты после построения трека (опциональный параметр)
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Возвращаемый результат:
{
Anomalies: [string, number][], // аномалии
Bounds: [number, number, number, number], // граница трека [minLng, minLat, maxLng, maxLat]
ChartItems: string[], // элементы графика
Id: string, // идентификатор трека
Mileage: number, // длина трека в км
Parkings: [number, string, number, number][], // парковки
PointsCount: number, // количество точек трека
Rides: [number, string, number, number][], // поездки
Stops: [number, string, number, number][], // остановки
Success: boolean, // флаг успешности построения трека
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
Воздействие на интерфейс:
createCustom
Создаёт кастомный трек
Пример вызова:
jsApi.tracks.createCustom('{"data": {"id": "ad23395e-0a0f-4751-8913-bfba85e68dc1", "points": [[50.700376,38.657324], [50.703036,38.656576], [50.705804,38.65606], [50.706484,38.655856], [50.7072453,38.65536], [50.709496,38.653608], [50.709552,38.653608], [50.709608,38.653616], [50.7097,38.653688], [50.709776,38.653796], [50.710708,38.65642], [50.712072,38.660084], [50.71348,38.663944]], "strokeColor": "#0000FF", "strokeWidth": 13, "visible": true}}')
1
{
data: { // TrackCustomParams
id: string, // идентификатор кастомного трека (опциональный параметр)
points: [number, number][], // координаты точек кастомного трека
strokeColor: string, // цвет кастомного трека (опциональный параметр)
strokeWidth: number, // ширина линии кастомного трека (опциональный параметр)
visible: boolean, // флаг видимости кастомного трека (опциональный параметр)
fillGaps: boolean, // флаг заполнения разрыва. Если в треке разрыв между точками более чем указано в настройках, то произойдёт достраивание трека по дорогам из OSRM. Как правило такой трек отображается пунктиром (опциональный параметр)
}
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
Возвращаемый результат:
{ // TrackCustomData
Bounds: [number, number, number, number], // граница кастомного трека [minLng, minLat, maxLng, maxLat]
Id: string, // идентификатор кастомного трека
PointsCount: number, // количество точек кастомного трека
WKB: string, // двоичное представление формата WKT в шестнадцатеричных строках кастомного трека
}
1
2
3
4
5
6
2
3
4
5
6
Воздействие на интерфейс:
delete
Удаляет треки. Удалять можно по id или категории(ям)
Пример вызова:
jsApi.tracks.delete('{"data":{"ids":["ad23395e-0a0f-4751-8913-bfba85e68dc1"]}}')
jsApi.tracks.delete('{"data":{"categories":["Bus"]}}')
jsApi.tracks.delete('{"data":{"ids":["ad23395e-0a0f-4751-8913-bfba85e68dc1"], "categories": ["Bus"]}}')
1
2
3
2
3
{ // Удаление по id
data: {
ids: Track.id || TrackCustom.id[], // id треков, которые нужно удалить
}
}
1
2
3
4
5
2
3
4
5
{ // Удаление по категории(ям)
data: {
categories: Track.params.category || TrackCustom.params.category[], // категории треков, которые нужно удалить
}
}
1
2
3
4
5
2
3
4
5
Возвращаемый результат: ничего не возвращает
Воздействие на интерфейс:
show
Делает трек видимым
Пример вызова:
jsApi.tracks.show('{"data": "ad23395e-0a0f-4751-8913-bfba85e68dc1"}')
1
{
data: Track.Id, // идентификатор трека
}
1
2
3
2
3
Возвращаемый результат: ничего не возвращает
Воздействие на интерфейс:
hide
Делает трек невидимым
Пример вызова:
jsApi.tracks.hide('{"data": "ad23395e-0a0f-4751-8913-bfba85e68dc1"}')
1
{
data: Track.Id, // идентификатор трека
}
1
2
3
2
3
Возвращаемый результат: ничего не возвращает
Воздействие на интерфейс:
clear
Удаляет все треки на карте
Пример вызова:
jsApi.tracks.clear()
1
Не требует аргументов
Возвращаемый результат: ничего не возвращает
Воздействие на интерфейс: