Ismail/nodeMap
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/components/TestScript.md
View File

@@ -6,7 +6,8 @@ Ein einfaches React-Testskript zur Laufzeitüberprüfung von Codefragmenten in `
## Zweck
Dieses Skript durchsucht die geladene `setupPolylines.js`-Datei (per `raw-loader`) nach bestimmten Kontextmenüeinträgen:
Dieses Skript durchsucht die geladene `setupPolylines.js`-Datei (per `raw-loader`) nach bestimmten
Kontextmenüeinträgen:
- „Stützpunkt entfernen“
- „Stützpunkt hinzufügen“
@@ -19,11 +20,11 @@ Dieses Skript durchsucht die geladene `setupPolylines.js`-Datei (per `raw-loader
## Ausgaben
| Zustand | Beschreibung |
|-------------|-----------------------------------------------------|
| ✅ Test bestanden | Der gesuchte Text wurde gefunden |
| ❌ Test fehlgeschlagen | Der gesuchte Text fehlt in der Datei |
| ℹ️ Info | Neutrale Zusatzinformationen in der Konsole |
| Zustand | Beschreibung |
| ---------------------- | ------------------------------------------- |
| ✅ Test bestanden | Der gesuchte Text wurde gefunden |
| ❌ Test fehlgeschlagen | Der gesuchte Text fehlt in der Datei |
| ℹ️ Info | Neutrale Zusatzinformationen in der Konsole |
## Besonderheiten
@@ -42,3 +43,6 @@ Dieses Skript durchsucht die geladene `setupPolylines.js`-Datei (per `raw-loader
- Wird automatisch beim Mount (via `useEffect`) ausgeführt
- `return null` → keine sichtbare Ausgabe
---
[Zurück zur Übersicht](../README.md)

14
docs/components/contextmenu/useMapContextMenu.md
View File

@@ -18,7 +18,15 @@ Wird typischerweise in `initializeMap()` oder `MapComponent` verwendet.
## Parameter
```js
addItemsToMapContextMenu(map, menuItemAdded, setMenuItemAdded, setShowCoordinatesModal, setShowPoiModal, setPopupCoordinates, openPopupWithCoordinates);
addItemsToMapContextMenu(
map,
menuItemAdded,
setMenuItemAdded,
setShowCoordinatesModal,
setShowPoiModal,
setPopupCoordinates,
openPopupWithCoordinates
);
```
## Besonderheiten
@@ -28,3 +36,7 @@ addItemsToMapContextMenu(map, menuItemAdded, setMenuItemAdded, setShowCoordinate
- Modularer Aufbau: `openPopupWithCoordinates` wird extern übergeben
🔙 [Zurück zu contextmenu ](./README.md)
---
[Zurück zur Übersicht](../../README.md)

19
docs/components/gisPolylines/PolylineContextMenu.md
View File

@@ -16,12 +16,12 @@ Wird dynamisch positioniert anhand der Klickkoordinaten (`position.x`, `position
## Props
| Prop | Typ | Beschreibung |
|---------------|-----------|----------------------------------------------------|
| `position` | `{x, y}` | Position in Pixelkoordinaten (z. B. von Mausereignis) |
| `onAddPoint` | `function`| Handler für „Stützpunkt hinzufügen“ |
| `onRemovePoint` | `function` | Handler für „Stützpunkt entfernen“ |
| `onClose` | `function`| Handler zum Schließen des Menüs |
| Prop | Typ | Beschreibung |
| --------------- | ---------- | ----------------------------------------------------- |
| `position` | `{x, y}` | Position in Pixelkoordinaten (z. B. von Mausereignis) |
| `onAddPoint` | `function` | Handler für „Stützpunkt hinzufügen“ |
| `onRemovePoint` | `function` | Handler für „Stützpunkt entfernen“ |
| `onClose` | `function` | Handler zum Schließen des Menüs |
## Styling
@@ -31,4 +31,9 @@ Wird dynamisch positioniert anhand der Klickkoordinaten (`position.x`, `position
## Verwendung
Eingebettet z. B. in `setupPolylines.js` oder `PolylineLayerManager`, um rechte Mausklicks auf Linien zu behandeln.
Eingebettet z. B. in `setupPolylines.js` oder `PolylineLayerManager`, um rechte Mausklicks auf
Linien zu behandeln.
---
[Zurück zur Übersicht](../../README.md)

3
docs/components/gisPolylines/README.md Normal file
View File

@@ -0,0 +1,3 @@
# 📄 Übersicht: docs/components/gisPolylines
- [PolylineContextMenu](PolylineContextMenu.md)

3
docs/components/gisPolylines/icons/CircleIcon.md
View File

@@ -14,3 +14,6 @@ Ein einfacher, grauer runder Marker als Stützpunkt in einer Polyline.
Wird in Polylinien als Zwischenpunkt gesetzt. Inaktiv, aber sichtbar.
---
[Zurück zur Übersicht](../../../README.md)

4
docs/components/gisPolylines/icons/EndIcon.md
View File

@@ -13,3 +13,7 @@ Ein Viereck zur Markierung des Endpunkts einer Polyline.
## Verwendung
Wird am letzten Punkt einer Linie gesetzt, z. B. `lineData.coordinates[line.length - 1]`
---
[Zurück zur Übersicht](../../../README.md)

6
docs/components/gisPolylines/icons/README.md Normal file
View File

@@ -0,0 +1,6 @@
# 📄 Übersicht: docs/components/gisPolylines/icons
- [CircleIcon](CircleIcon.md)
- [EndIcon](EndIcon.md)
- [StartIcon](StartIcon.md)
- [SupportPointIcons](SupportPointIcons.md)

4
docs/components/gisPolylines/icons/StartIcon.md
View File

@@ -13,3 +13,7 @@ Ein SVG-Dreieck zur Markierung des Startpunkts einer Polyline.
## Verwendung
Wird am ersten Punkt einer Polyline platziert.
---
[Zurück zur Übersicht](../../../README.md)

4
docs/components/gisPolylines/icons/SupportPointIcons.md
View File

@@ -18,3 +18,7 @@ Definiert zwei Icons für interaktive Stützpunkte in einer Polyline:
- Hinzufügen/Entfernen von Zwischenpunkten in der Bearbeitungsansicht (editMode)
- Marker erscheinen z. B. bei Maus-Hover oder per Kontextmenü
---
[Zurück zur Übersicht](../../../README.md)

16
docs/components/icons/devices/overlapping/PlusRoundIcon.md
View File

@@ -7,12 +7,12 @@ Wird für zusätzliche UI-Markierungen auf Geräten oder überlappenden Icons ve
## Eigenschaften
| Attribut | Wert |
|--------------|--------------------|
| `iconUrl` | `/img/plus_round.png` |
| `iconSize` | `[22, 22]` |
| `iconAnchor` | `[25, 55]` |
| `className` | `absolute top-0 left-0 z-10` (Tailwind)
| Attribut | Wert |
| ------------ | --------------------------------------- |
| `iconUrl` | `/img/plus_round.png` |
| `iconSize` | `[22, 22]` |
| `iconAnchor` | `[25, 55]` |
| `className` | `absolute top-0 left-0 z-10` (Tailwind) |
## Verwendung
@@ -24,3 +24,7 @@ Wird für zusätzliche UI-Markierungen auf Geräten oder überlappenden Icons ve
- Die Bilddatei `/img/plus_round.png` muss vorhanden sein
- Kann bei Bedarf dynamisch durch ein anderes Icon ersetzt werden
---
[Zurück zur Übersicht](../../../../README.md)

3
docs/components/icons/devices/overlapping/README.md Normal file
View File

@@ -0,0 +1,3 @@
# 📄 Übersicht: docs/components/icons/devices/overlapping
- [PlusRoundIcon](PlusRoundIcon.md)

4
docs/components/mainComponent/MapComponent.md
View File

@@ -69,3 +69,7 @@ Verwendet umfangreiche Redux-Slices zur Steuerung von:
---
📄 Pfad: `/components/mainComponent/MapComponent.js`
---
[Zurück zur Übersicht](../../README.md)

3
docs/components/mainComponent/README.md Normal file
View File

@@ -0,0 +1,3 @@
# 📄 Übersicht: docs/components/mainComponent
- [MapComponent](MapComponent.md)

3
docs/components/mainComponent/hooks/README.md Normal file
View File

@@ -0,0 +1,3 @@
# 📄 Übersicht: docs/components/mainComponent/hooks
- [useInitializeMap](useInitializeMap.md)

29
docs/components/mainComponent/hooks/useInitializeMap.md
View File

@@ -3,7 +3,8 @@
# 🪄 useInitializeMap.js
Custom React-Hook zur Initialisierung der Leaflet-Karte.
Ermöglicht die einfache Übergabe aller nötigen Parameter und abstrahiert die `initializeMap(...)`-Logik.
Ermöglicht die einfache Übergabe aller nötigen Parameter und abstrahiert die
`initializeMap(...)`-Logik.
---
@@ -16,16 +17,16 @@ Ermöglicht die einfache Übergabe aller nötigen Parameter und abstrahiert die
## 🔧 Parameter
| Name | Typ | Beschreibung |
|--------------------------|------------|---------------------------------------------------|
| `map` | `LeafletMap` (Zustand) | Wird initialisiert, wenn `null` |
| `mapRef` | `ref` | Referenz auf `<div id="map">` |
| `setMap` | `function` | Callback zum Setzen der Karteninstanz |
| `setOms` | `function` | Callback für OverlappingMarkerSpiderfier |
| `setMenuItemAdded` | `function` | Wird genutzt, um mehrfaches Menü-Setup zu verhindern |
| `addItemsToMapContextMenu` | `function` | Logik zum Hinzufügen von Kontextmenüeinträgen |
| `hasRights` | `boolean` | Steuerung, ob POI-Menüs angezeigt werden dürfen |
| `setPolylineEventsDisabled` | `function` | Aktiviert/Deaktiviert Polyline-Events global |
| Name | Typ | Beschreibung |
| --------------------------- | ---------------------- | ---------------------------------------------------- |
| `map` | `LeafletMap` (Zustand) | Wird initialisiert, wenn `null` |
| `mapRef` | `ref` | Referenz auf `<div id="map">` |
| `setMap` | `function` | Callback zum Setzen der Karteninstanz |
| `setOms` | `function` | Callback für OverlappingMarkerSpiderfier |
| `setMenuItemAdded` | `function` | Wird genutzt, um mehrfaches Menü-Setup zu verhindern |
| `addItemsToMapContextMenu` | `function` | Logik zum Hinzufügen von Kontextmenüeinträgen |
| `hasRights` | `boolean` | Steuerung, ob POI-Menüs angezeigt werden dürfen |
| `setPolylineEventsDisabled` | `function` | Aktiviert/Deaktiviert Polyline-Events global |
---
@@ -42,7 +43,7 @@ useInitializeMap(
setMenuItemAdded,
addItemsToMapContextMenu,
hasRights,
(value) => dispatch(setDisabled(value))
value => dispatch(setDisabled(value))
);
```
@@ -51,3 +52,7 @@ useInitializeMap(
## 📁 Quelle
Wrappt `initializeMap()` aus `/utils/initializeMap.js`
---
[Zurück zur Übersicht](../../../README.md)

13
docs/components/pois/AddPOIModal.md
View File

@@ -15,14 +15,17 @@ Die Koordinaten (`latlng`) werden automatisch übernommen.
## Props
| Prop | Typ | Beschreibung |
|----------|-----------|--------------------------------------------------|
| `onClose` | `function` | Schließt das Modal |
| `map` | `Leaflet` | (optional) zum Schließen evtl. offener Popups |
| `latlng` | `object` | Koordinaten für den neuen POI |
| Prop | Typ | Beschreibung |
| --------- | ---------- | --------------------------------------------- |
| `onClose` | `function` | Schließt das Modal |
| `map` | `Leaflet` | (optional) zum Schließen evtl. offener Popups |
| `latlng` | `object` | Koordinaten für den neuen POI |
## Redux
- `fetchPoiTypThunk`, `fetchPoiIconsDataThunk`
- `addPoiThunk`, `resetAddPoiStatus`
---
[Zurück zur Übersicht](../../README.md)

12
docs/components/pois/PoiUpdateModal.md
View File

@@ -13,10 +13,10 @@ Ein Dialog zur Aktualisierung oder Löschung bestehender POIs.
## Props
| Prop | Typ | Beschreibung |
|------------|-----------|---------------------------------------|
| `onClose` | `function`| Schließt das Modal |
| `poiData` | `object` | Bestehende POI-Daten zur Bearbeitung |
| Prop | Typ | Beschreibung |
| --------- | ---------- | ------------------------------------ |
| `onClose` | `function` | Schließt das Modal |
| `poiData` | `object` | Bestehende POI-Daten zur Bearbeitung |
## Redux
@@ -27,3 +27,7 @@ Ein Dialog zur Aktualisierung oder Löschung bestehender POIs.
- Dynamische Gerätegruppenfilterung basierend auf `mapLayersVisibility`
- Formfelder mit `react-select` für bessere UX
---
[Zurück zur Übersicht](../../README.md)

4
docs/components/pois/README.md Normal file
View File

@@ -0,0 +1,4 @@
# 📄 Übersicht: docs/components/pois
- [AddPOIModal](AddPOIModal.md)
- [PoiUpdateModal](PoiUpdateModal.md)

12
docs/components/uiWidgets/CoordinateInput.md
View File

@@ -2,8 +2,10 @@
# 📍 CoordinateInput.js
Die Komponente `CoordinateInput` stellt ein einfaches Eingabefeld für geografische Koordinaten (Latitude, Longitude) bereit.
Sie dient typischerweise dazu, einen bestimmten Punkt auf der Karte zu fokussieren bzw. zu markieren.
Die Komponente `CoordinateInput` stellt ein einfaches Eingabefeld für geografische Koordinaten
(Latitude, Longitude) bereit.
Sie dient typischerweise dazu, einen bestimmten Punkt auf der Karte zu fokussieren bzw. zu
markieren.
---
@@ -85,7 +87,7 @@ Beispiel in einer Map-Komponente:
```jsx
<CoordinateInput
onCoordinatesSubmit={(coords) => {
onCoordinatesSubmit={coords => {
const [lat, lng] = coords.split(",").map(Number);
map.setView([lat, lng], 16); // Leaflet
}}
@@ -99,3 +101,7 @@ Beispiel in einer Map-Komponente:
- `MapComponent.js` – kann die übergebenen Koordinaten zur Zentrierung oder Marker-Erstellung nutzen
---
---
[Zurück zur Übersicht](../../README.md)

4
docs/components/uiWidgets/README.md Normal file
View File

@@ -0,0 +1,4 @@
# 📄 Übersicht: docs/components/uiWidgets
- [CoordinateInput](CoordinateInput.md)
- [VersionInfoModal](VersionInfoModal.md)

13
docs/components/uiWidgets/VersionInfoModal.md
View File

@@ -2,7 +2,8 @@
# 🪪 VersionInfoModal.js
Das `VersionInfoModal` ist ein modales Fenster zur Anzeige von Unternehmensinformationen und der aktuellen App-Version.
Das `VersionInfoModal` ist ein modales Fenster zur Anzeige von Unternehmensinformationen und der
aktuellen App-Version.
Es wird meist im Footer oder als Info-Schaltfläche in der Benutzeroberfläche eingeblendet.
---
@@ -38,8 +39,10 @@ Die Komponente informiert Nutzer über:
## 💡 Verhalten
- Wird `showVersionInfoModal` auf `true` gesetzt, erscheint das Modal zentriert über einem halbtransparenten Overlay
- Klick auf den Hintergrund (schwarzes Overlay) oder auf „Schließen“ führt `closeVersionInfoModal()` aus
- Wird `showVersionInfoModal` auf `true` gesetzt, erscheint das Modal zentriert über einem
halbtransparenten Overlay
- Klick auf den Hintergrund (schwarzes Overlay) oder auf „Schließen“ führt `closeVersionInfoModal()`
aus
---
@@ -90,3 +93,7 @@ Die Komponente informiert Nutzer über:
- Automatischer Import von Version via `process.env.NEXT_PUBLIC_APP_VERSION`
---
---
[Zurück zur Übersicht](../../README.md)

13
docs/components/uiWidgets/mapLayersControlPanel/EditModeToggle.md
View File

@@ -2,8 +2,10 @@
# ✏️ EditModeToggle.js
Die Komponente `EditModeToggle` stellt einen interaktiven Umschalter für den Bearbeitungsmodus bereit.
Sie ermöglicht das Ein- und Ausschalten des Modus, in dem POIs, Polylines (Strecken) und Bereiche bearbeitet werden können.
Die Komponente `EditModeToggle` stellt einen interaktiven Umschalter für den Bearbeitungsmodus
bereit.
Sie ermöglicht das Ein- und Ausschalten des Modus, in dem POIs, Polylines (Strecken) und Bereiche
bearbeitet werden können.
---
@@ -79,7 +81,12 @@ const [editMode, setEditMode] = useState(() => localStorage.getItem("editMode")
## 📄 Verwandte Komponenten
- `MapLayersControlPanel.js`: liest `localStorage.editMode` und deaktiviert Layer-Checkboxen im aktiven Modus
- `MapLayersControlPanel.js`: liest `localStorage.editMode` und deaktiviert Layer-Checkboxen im
aktiven Modus
- `PoiUpdateModal`, `AddPOIModal`: nutzen den Bearbeitungsmodus für UI-Freigabe
---
---
[Zurück zur Übersicht](../../../README.md)

13
docs/components/uiWidgets/mapLayersControlPanel/MapLayersControlPanel.md
View File

@@ -2,8 +2,10 @@
# 🧭 MapLayersControlPanel.js
Dieses UI-Widget zeigt eine interaktive Steuereinheit für Layer, POIs und Stationsbereiche auf der rechten Seite der Karte.
Es ist vollständig an den Redux-Store angebunden und reagiert auf Änderungen der Layer-Sichtbarkeit, Bearbeitungsmodus und Stationsauswahl.
Dieses UI-Widget zeigt eine interaktive Steuereinheit für Layer, POIs und Stationsbereiche auf der
rechten Seite der Karte.
Es ist vollständig an den Redux-Store angebunden und reagiert auf Änderungen der Layer-Sichtbarkeit,
Bearbeitungsmodus und Stationsauswahl.
---
@@ -52,7 +54,8 @@ Das `MapLayersControlPanel` ermöglicht Nutzern:
Sonderfall: `TALAS` erhält ein Untermenü für „Kabelstrecken“
- **Lokale Speicherung:**
Sichtbarkeiten, Bearbeitungsmodus und POI-Zustand werden in `localStorage` geschrieben und bei Initialisierung geladen
Sichtbarkeiten, Bearbeitungsmodus und POI-Zustand werden in `localStorage` geschrieben und bei
Initialisierung geladen
- **Bearbeitungsmodus:**
Wenn aktiv (`editMode === true`), sind Layer-Checkboxen deaktiviert
@@ -148,3 +151,7 @@ Das `MapLayersControlPanel` ermöglicht Nutzern:
- `redux/slices/database/pois/poiLayerVisibleSlice.js`
---
---
[Zurück zur Übersicht](../../../README.md)

4
docs/components/uiWidgets/mapLayersControlPanel/README.md Normal file
View File

@@ -0,0 +1,4 @@
# 📄 Übersicht: docs/components/uiWidgets/mapLayersControlPanel
- [EditModeToggle](EditModeToggle.md)
- [MapLayersControlPanel](MapLayersControlPanel.md)