Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create README.md for frontlines #29

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions frontlines/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Файлы описания расположения войск и линий фронта
Данная папка содержит файлы описания расположения войск, линий фронта и прочих полигонов/линий,
которые должны отображаться на карте.

Все файлы, расположенные здесь, автоматически упаковываются в _webpack_ бандл и отрисовываются на карте,
если условия для их изображения удовлетворены (например, даты действия полигона удовлетворяют динамически
выбранному фильтру дат).

Форматом файлов является [GeoJSON](https://geojson.org/).
Поддерживаются все доступные GeoJSON типы [геометрий](https://datatracker.ietf.org/doc/html/rfc7946#section-3.1).

Пример линии в GeoJSON:
```
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Тут можно влепить ```json и тогда будет еще и подсветка json-овского синтаксиса :)

{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"description": "Электрический кабель проложенный по дну. Кабель Жизни.",
"actionHeader": "Кабель действовал"
"dateStart": "1942-09-23",
"dateEnd": "1943-12-31",
"color": "#800080"
},
"geometry": {
"type": "LineString",
"coordinates": [
[31.08496, 60.11055],
[31.52218, 60.06583]
]
}
}
]
}
```

## Поддерживаемые свойства (properties)
Поддерживаются все свойства доступные для класса [Path](https://leafletjs.com/reference.html#path) библиотеки [leaflet](https://leafletjs.com/).
Больше деталей по синтаксису описания свойств класса _Path_ доступны по [ссылке](https://leafletjs.com/reference.html#path) -
некоторые из свойств ссылаются на более детальное описание атрибутов [SVG](https://developer.mozilla.org/en-US/docs/Web/SVG).

Дополнительно поддерживаются следующие свойства:
* **description**: строка описания, отображающаяся в заглавии _popup_ при клике на полигон/линию.
* **dateStart**, **dateEnd**: строки в формате "ГГГГ-ММ-ДД" описывающие время "действия" полигона/линии.
* **actionHeader**: заголовок фразы отображающейся в _popup_, описывающей время "действия" полигона/линии.
Если это свойство не указано, то будет использован заголовок "Линия фронта действовала".

**Для примера выше будет отображено следующее:**
> <b>Электрический кабель проложенный по дну. Кабель Жизни.</b>
>
> Кабель действовал с:</br>
> 1942-09-23</br>
> по:</br>
> 1943-12-31</br>