docs: [Zurück zur Übersicht](../README.md) in Alle in README für jeder Verzeichnis

This commit is contained in:
ISA
2025-06-24 08:22:48 +02:00
parent 82a1e11797
commit 0347ec9d98
243 changed files with 1425 additions and 283 deletions

15
docs/utils/README.md Normal file
View File

@@ -0,0 +1,15 @@
# 📄 Übersicht: docs/utils
- [addContextMenuToMarker](addContextMenuToMarker.md)
- [contextMenuUtils](contextMenuUtils.md)
- [geometryUtils](geometryUtils.md)
- [initializeMap](initializeMap.md)
- [mapUtils](mapUtils.md)
- [markerUtils](markerUtils.md)
- [mysqlPool](mysqlPool.md)
- [openInNewTab](openInNewTab.md)
- [openInSameWindow](openInSameWindow.md)
- [poiUtils](poiUtils.md)
- [setupDevices](setupDevices.md)
- [setupPOIs](setupPOIs.md)
- [zoomAndCenterUtils](zoomAndCenterUtils.md)

View File

@@ -26,3 +26,7 @@ addContextMenuToMarker(marker, idLD, name);
## Kontext
- Wird z.B. in `createAndSetDevices.js` verwendet
---
[Zurück zur Übersicht](../README.md)

View File

@@ -30,3 +30,7 @@ Ab Version 1.1.20 verfügen alle Geräte-Marker über ein kontextbasiertes Leafl
- Marker müssen `options.idDevice` und `options.link` gesetzt haben
- Registrierung erfolgt über `addContextMenuToMarker(marker)`
- Redux `selectedDevice` wird nicht mehr benötigt
---
[Zurück zur Übersicht](../README.md)

View File

@@ -0,0 +1,3 @@
# 📄 Übersicht: docs/utils/devices
- [createAndSetDevices](createAndSetDevices.md)

View File

@@ -12,7 +12,8 @@ und konfiguriert Kontexteinträge für Interaktionen wie:
- Statusinformationen einblenden
- Redux-Aktionen für ausgewähltes Gerät auslösen
Die erzeugten Marker werden über `setMarkersFunction(markersData)` an die aufrufende Komponente übergeben.
Die erzeugten Marker werden über `setMarkersFunction(markersData)` an die aufrufende Komponente
übergeben.
---
@@ -105,3 +106,7 @@ if (!contextMenuCreated) {
---
📄 Pfad: `/docs/frontend/utils/devices/createAndSetDevices.md`
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -12,3 +12,7 @@ Mathematische Funktionen zur Berechnung geometrischer Werte auf der Karte.
## Zweck
- Interne Hilfsfunktionen für Strecken, Tooltip-Positionen etc.
---
[Zurück zur Übersicht](../README.md)

View File

@@ -13,3 +13,7 @@ Initialisiert die Leaflet-Karte mit Basislayern, Gruppen und globalen Events.
- Erstellt LayerGroups (Devices, POIs, Linien)
- Bindet Kontextmenü
- Stellt Default-Zoom und Position ein
---
[Zurück zur Übersicht](../README.md)

View File

@@ -8,3 +8,7 @@ Allgemeine Hilfsfunktionen für Leaflet (z.B. Zoom, Marker-Checks, Layer-Find
- `zoomToBounds(layerGroup)`
- `findLayerById(map, id)`
---
[Zurück zur Übersicht](../README.md)

View File

@@ -12,3 +12,7 @@ Hilfsfunktionen zur Erstellung und Konfiguration von Leaflet-Markern.
## Kontext
- Wird in `setupDevices.js` und `setupPOIs.js` verwendet
---
[Zurück zur Übersicht](../README.md)

View File

@@ -14,3 +14,7 @@ const connection = await pool.getConnection();
- Reuse von Verbindungen
- Fehlervermeidung bei vielen gleichzeitigen Abfragen
---
[Zurück zur Übersicht](../README.md)

View File

@@ -13,3 +13,7 @@ openInNewTab(url);
## Intern
- nutzt `window.open` mit `noopener,noreferrer`
---
[Zurück zur Übersicht](../README.md)

View File

@@ -13,3 +13,7 @@ openInSameWindow("/target");
## Verhalten
- `window.location.href = url`
---
[Zurück zur Übersicht](../README.md)

View File

@@ -12,3 +12,7 @@ Hilfsfunktionen zur Handhabung von POIs (z.B. Icons, Typzuordnung, Interaktio
## Verwendung
- In `setupPOIs.js` und Thunks für POI-Handling
---
[Zurück zur Übersicht](../README.md)

View File

@@ -0,0 +1,8 @@
# 📄 Übersicht: docs/utils/polylines
- [contextMenu](contextMenu.md)
- [eventHandlers](eventHandlers.md)
- [monitorContextMenu](monitorContextMenu.md)
- [polylineSubscription](polylineSubscription.md)
- [redrawPolyline](redrawPolyline.md)
- [setupPolylines](setupPolylines.md)

View File

@@ -6,5 +6,11 @@ Funktionen zum Steuern des Polyline-Kontextmenüs (Schließen, Zurücksetzen, et
## exportierte Funktionen
- `closePolylineSelectionAndContextMenu(map)`: Setzt Polyline-Auswahl zurück und schließt das Kontextmenü
- `monitorContextMenu(map)`: Überwacht via `localStorage`, ob das Menü automatisch geschlossen werden soll
- `closePolylineSelectionAndContextMenu(map)`: Setzt Polyline-Auswahl zurück und schließt das
Kontextmenü
- `monitorContextMenu(map)`: Überwacht via `localStorage`, ob das Menü automatisch geschlossen
werden soll
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -7,4 +7,8 @@ Bindet Maus-Events an Polylinien (z.B. Hover-Effekte).
## exportierte Funktionen
- `enablePolylineEvents(polylines, lineColors)`
- `disablePolylineEvents(polylines)`
- `disablePolylineEvents(polylines)`
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -7,4 +7,8 @@ Erweiterte Überwachung des Kontextmenüs über `localStorage`.
## Funktion
- Importiert `closePolylineSelectionAndContextMenu`
- Ruft regelmäßig `setTimeout` auf, um `contextMenuExpired` zu prüfen
- Ruft regelmäßig `setTimeout` auf, um `contextMenuExpired` zu prüfen
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -7,4 +7,8 @@ Abonnement auf den Redux-Store, um auf `forceClose` im Kontextmenü zu reagieren
## Verhalten
- Erkennt `polylineContextMenu.forceClose`
- Ruft `contextmenu.hide()` auf und resetet Redux-Status
- Ruft `contextmenu.hide()` auf und resetet Redux-Status
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -7,8 +7,12 @@ Zeichnet eine Polyline mit neuen Koordinaten und Tooltip neu.
## Funktion
```js
redrawPolyline(lineData, lineColors, tooltipContents, map)
redrawPolyline(lineData, lineColors, tooltipContents, map);
```
- Entfernt vorherige Polyline
- Erstellt neue mit Tooltip und Hover-Effekten
- Erstellt neue mit Tooltip und Hover-Effekten
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -4,13 +4,15 @@
## Zweck
Diese Datei enthält die zentrale Funktion `setupPolylines`, die in der Kartenkomponente (Leaflet) Polylinien sowie Marker basierend auf Gerätekonfigurationen zeichnet und verwaltet.
Diese Datei enthält die zentrale Funktion `setupPolylines`, die in der Kartenkomponente (Leaflet)
Polylinien sowie Marker basierend auf Gerätekonfigurationen zeichnet und verwaltet.
Sie wird verwendet, um:
- Polylinien basierend auf Koordinaten zu zeichnen
- Stützpunkte visuell als Marker anzuzeigen
- Marker kontextsensitiv mit Optionen (z.B. „Stützpunkt entfernen“, „Koordinaten anzeigen“) auszustatten
- Marker kontextsensitiv mit Optionen (z.B. „Stützpunkt entfernen“, „Koordinaten anzeigen“)
auszustatten
- Linien aktualisieren und neue Koordinaten in die Datenbank schreiben
- Kontextmenü-Interaktionen zu ermöglichen
@@ -29,7 +31,8 @@ Sie wird verwendet, um:
## Dynamische URL mit Port-Steuerung
Die Datei verwendet **keine feste API-Basis-URL** mehr aus `.env.local`.
Stattdessen wird `NEXT_PUBLIC_API_PORT_MODE` genutzt, um zwischen Entwicklungs- und Produktionsumgebung zu unterscheiden:
Stattdessen wird `NEXT_PUBLIC_API_PORT_MODE` genutzt, um zwischen Entwicklungs- und
Produktionsumgebung zu unterscheiden:
```env
NEXT_PUBLIC_API_PORT_MODE=dev
@@ -40,7 +43,10 @@ NEXT_PUBLIC_API_PORT_MODE=dev
```js
const mode = process.env.NEXT_PUBLIC_API_PORT_MODE;
const baseUrl = mode === "dev" ? `${window.location.protocol}//${window.location.hostname}:80/talas5/` : `${window.location.origin}/talas5/`;
const baseUrl =
mode === "dev"
? `${window.location.protocol}//${window.location.hostname}:80/talas5/`
: `${window.location.origin}/talas5/`;
```
---
@@ -57,7 +63,8 @@ const baseUrl = mode === "dev" ? `${window.location.protocol}//${window.location
## Speicherorte
- Polylinien und LineColors werden unter `window.polylines` und `window.lineColors` global gespeichert
- Polylinien und LineColors werden unter `window.polylines` und `window.lineColors` global
gespeichert
- Aktive Redux-Slices:
- `polylineContextMenuSlice`
- `addPoiOnPolylineSlice`
@@ -74,3 +81,7 @@ const baseUrl = mode === "dev" ? `${window.location.protocol}//${window.location
---
📄 Pfad: `/docs/frontend/utils/polylines/setupPolylines.md`
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -13,3 +13,7 @@ Fügt alle Geräte (Devices) zur Karte hinzu.
- Marker-Erstellung
- Eventbindung
- Layer-Zuweisung
---
[Zurück zur Übersicht](../README.md)

View File

@@ -4,7 +4,8 @@
## Zweck
Zeichnet alle POI-Marker auf die Leaflet-Karte basierend auf Datenbankeinträgen. Bindet Popup, Kontextmenü, Drag'n'Drop und Redux-Zustand ein.
Zeichnet alle POI-Marker auf die Leaflet-Karte basierend auf Datenbankeinträgen. Bindet Popup,
Kontextmenü, Drag'n'Drop und Redux-Zustand ein.
## Parameter
@@ -30,3 +31,7 @@ Zeichnet alle POI-Marker auf die Leaflet-Karte basierend auf Datenbankeinträgen
const poi = { idPoi: 7, idPoiTyp: 2, position: "POINT(8.5 53.1)", description: "Mast", idLD: 123 };
const poiData = [{ idPoi: 7, path: "poi-marker-icon-2.png" }];
```
---
[Zurück zur Übersicht](../README.md)

View File

@@ -8,3 +8,7 @@ Hilfsfunktionen zum Zoomen auf Marker oder Linien.
- `zoomToMarker(map, marker)`
- `centerOnCoordinates(map, coords)`
---
[Zurück zur Übersicht](../README.md)