-
+
diff --git a/examples/github-io/components/TheHeader.vue b/examples/github-io/components/TheHeader.vue
index 778839133a..b5bb021719 100644
--- a/examples/github-io/components/TheHeader.vue
+++ b/examples/github-io/components/TheHeader.vue
@@ -1,48 +1,47 @@
-
-
-
-
- ![POLAR]()
-
-
-
-
+ -->
+
+
+ Docs
+
+
+
+
+ Find us on GitHub
+
+
@@ -53,16 +52,11 @@ import polarLogoSvg from './assets/polar-logo.svg'
padding: 2.5rem 0 2.5rem;
position: relative;
z-index: 1;
-}
-.lp-header .lp-container {
- max-width: none;
- padding: 0 4rem;
-}
-.lp-header__bar {
- display: grid;
- grid-template-columns: 1fr 1fr 1fr;
+
+ display: flex;
+ justify-content: space-around;
align-items: center;
- gap: 2rem;
+ gap: 1.5rem;
}
.lp-header__logo {
text-decoration: none;
@@ -70,22 +64,18 @@ import polarLogoSvg from './assets/polar-logo.svg'
align-items: center;
}
.lp-header__icon {
- height: 68px;
+ height: 4rem;
+ min-width: 12rem;
width: auto;
flex-shrink: 0;
}
-/* Centered pill */
.lp-header__nav {
- display: flex;
- justify-content: center;
-}
-.lp-header__pill {
display: flex;
align-items: center;
gap: 8px;
border-radius: 9999px;
padding: 10px;
- height: 88px;
+ height: 4rem;
background: linear-gradient(
160deg,
rgba(255, 255, 255, 0.18) 0%,
@@ -108,6 +98,7 @@ import polarLogoSvg from './assets/polar-logo.svg'
font-size: 1.2rem;
font-weight: 500;
padding: 0.6rem 1.4rem;
+ height: 100%;
border-radius: 999px;
transition:
background 0.15s,
@@ -142,7 +133,7 @@ import polarLogoSvg from './assets/polar-logo.svg'
font-weight: 600;
border-radius: 9999px;
padding: 16px 20px 16px 28px;
- height: 88px;
+ height: 4rem;
width: 300px;
background: linear-gradient(
160deg,
@@ -159,23 +150,24 @@ import polarLogoSvg from './assets/polar-logo.svg'
box-sizing: border-box;
transition: background 0.15s;
white-space: nowrap;
- margin-left: auto;
}
.lp-header__github:hover .kern-icon {
background-color: #003087;
}
.lp-header__github-icon {
flex-shrink: 0;
- fill: #004787;
+ width: 2.0625rem;
+ height: 2rem;
}
.lp-header__github:hover {
background: rgba(255, 255, 255, 0.62);
}
@media (max-width: 768px) {
- .lp-header .lp-container {
+ .lp-header {
padding: 0 1.5rem;
}
- .lp-header__bar {
+ .lp-header {
+ display: grid;
grid-template-columns: 1fr auto;
grid-template-rows: auto auto;
gap: 1rem;
@@ -185,8 +177,9 @@ import polarLogoSvg from './assets/polar-logo.svg'
grid-row: 2;
order: unset;
justify-content: stretch;
+ margin-bottom: 2rem;
}
- .lp-header__pill {
+ .lp-header__nav {
height: auto;
padding: 8px;
border-radius: 1rem;
@@ -194,11 +187,6 @@ import polarLogoSvg from './assets/polar-logo.svg'
width: 100%;
justify-content: space-around;
}
- .lp-header__link {
- font-size: 0.95rem;
- padding: 0.4rem 0.75rem;
- gap: 0.25rem;
- }
/* GitHub button: compact icon-only pill */
.lp-header__github {
width: auto;
@@ -206,19 +194,13 @@ import polarLogoSvg from './assets/polar-logo.svg'
padding: 0.6rem 0.9rem;
gap: 0;
font-size: 0;
- margin-left: 0;
}
.lp-header__github .kern-icon {
display: none;
}
-}
-@media (max-width: 480px) {
- .lp-header__pill {
- flex-wrap: wrap;
- }
.lp-header__link {
- font-size: 0.85rem;
- padding: 0.35rem 0.5rem;
+ width: 50%;
+ justify-content: center;
}
}
diff --git a/examples/github-io/components/VideoSection.vue b/examples/github-io/components/VideoSection.vue
index 60317b1944..f5efc2c08c 100644
--- a/examples/github-io/components/VideoSection.vue
+++ b/examples/github-io/components/VideoSection.vue
@@ -1,34 +1,18 @@
-
- Hear us talk
+ Media
- Our FOSSGIS Adventure. + FOSSGIS 2024 (German)
- 2024 we gave a small talk at FOSSGIS about ... + Watch our latest talk for a comprehensive explanation of architecture + and configuration.
-
-
- ![POLAR FOSSGIS 2024 talk thumbnail]()
-
-
+
@@ -38,63 +22,26 @@
diff --git a/examples/github-io/components/assets/OSGeo_community.png b/examples/github-io/components/assets/OSGeo_community.png
new file mode 100644
index 0000000000..caaf4203ca
Binary files /dev/null and b/examples/github-io/components/assets/OSGeo_community.png differ
diff --git a/examples/github-io/components/assets/github-icon.svg b/examples/github-io/components/assets/github-icon.svg
deleted file mode 100644
index 24718fb2ec..0000000000
--- a/examples/github-io/components/assets/github-icon.svg
+++ /dev/null
@@ -1,3 +0,0 @@
-
diff --git a/examples/github-io/components/roadmapData.ts b/examples/github-io/components/roadmapData.ts
index e7ababcf9d..01e3859d3f 100644
--- a/examples/github-io/components/roadmapData.ts
+++ b/examples/github-io/components/roadmapData.ts
@@ -16,9 +16,9 @@ export interface Phase {
}
export const phases: Phase[] = [
- {
+ /* {
status: 'done',
- label: 'Q4 · 2023',
+ label: '2023',
sublabel: 'Completed',
accentIcon: 'check',
milestoneIcon: 'check',
@@ -28,30 +28,25 @@ export const phases: Phase[] = [
body: 'Initial release with OpenLayers integration, plugin system, and i18n support.',
accentIcon: 'orbit',
},
- {
- title: 'Plugin Suite Expanded',
- body: 'Added address search, reverse geocoder, scale bar, fullscreen toggle, layer chooser, and toast notifications.',
- accentIcon: 'extension',
- },
],
},
{
status: 'done',
- label: 'Q1 · 2025',
+ label: '2024',
sublabel: 'Completed',
accentIcon: 'check',
milestoneIcon: 'check',
items: [
+ {
+ title: 'Plugin Suite Expanded',
+ body: 'Added address search, reverse geocoder, scale bar, fullscreen toggle, layer chooser, and toast notifications.',
+ accentIcon: 'extension',
+ },
{
title: 'More Geostuff',
body: 'Extended GeoJSON handling, cluster visualisation, and improved WMS/WFS layer management.',
accentIcon: 'map',
},
- {
- title: 'New Plugin - Routing',
- body: 'Added routing plugin with support for multiple transport modes and customizable route styling.',
- accentIcon: 'alt-route',
- },
{
title: 'Added Monument Icon Package',
body: 'Integrated the monument icon set, expanding the icon library for cultural heritage use cases.',
@@ -63,10 +58,38 @@ export const phases: Phase[] = [
accentIcon: 'settings',
},
],
+ }, */
+ {
+ status: 'done',
+ label: 'Q1 · 2025',
+ sublabel: 'Completed',
+ accentIcon: 'check',
+ milestoneIcon: 'check',
+ items: [
+ {
+ title: 'New Plugin - Routing',
+ body: 'Added routing plugin with support for multiple transport modes and customizable route styling.',
+ accentIcon: 'alt-route',
+ },
+ ],
+ },
+ {
+ status: 'done',
+ label: 'Q1 · 2026',
+ sublabel: 'Completed',
+ accentIcon: 'check',
+ milestoneIcon: 'check',
+ items: [
+ {
+ title: 'OSGeo Community Project',
+ body: 'POLAR has been accepted as an OSGeo community project, fostering open collaboration and wider adoption.',
+ accentIcon: 'groups',
+ },
+ ],
},
{
status: 'progress',
- label: 'Q2 · 2025',
+ label: 'Q2 · 2026',
sublabel: 'In Progress',
accentIcon: 'location-on',
milestoneIcon: '',
@@ -84,7 +107,7 @@ export const phases: Phase[] = [
{
title: 'Fixing more bugs',
body: 'Further improvements across the core and plugin ecosystem.',
- accentIcon: 'settings',
+ accentIcon: 'bug-report',
},
],
},
@@ -107,18 +130,4 @@ export const phases: Phase[] = [
},
],
},
- {
- status: 'planned',
- label: 'Q2 · 2027',
- sublabel: 'Planned',
- accentIcon: 'palette',
- milestoneIcon: '',
- items: [
- {
- title: 'Something Wonderful',
- body: 'Stay tuned — we have exciting things in the works for the next major release.',
- accentIcon: 'looks',
- },
- ],
- },
]
diff --git a/examples/github-io/variables.css b/examples/github-io/variables.css
index f0b74a9c91..47960714ee 100644
--- a/examples/github-io/variables.css
+++ b/examples/github-io/variables.css
@@ -1,6 +1,4 @@
:root {
- --polar-navy: #003087;
- --polar-blue: #003087;
--polar-cyan: #00adef;
--polar-hero-from: #00adef;
--polar-hero-to: #003087;
@@ -29,4 +27,4 @@
--polar-grey-500: #6e7597;
--polar-grey-600: #565c7f;
--polar-text-default: #171a2b;
-}
\ No newline at end of file
+}
diff --git a/examples/iceberg/components/IcebergMap.vue b/examples/iceberg/components/IcebergMap.vue
index 5933cf3fa9..3a05bbde85 100644
--- a/examples/iceberg/components/IcebergMap.vue
+++ b/examples/iceberg/components/IcebergMap.vue
@@ -142,6 +142,7 @@ watch(map, (map) => {
toZoomLevel: 7,
}),
pluginReverseGeocoder({
+ type: 'wps',
url: 'https://geodienste.hamburg.de/HH_WPS',
coordinateSources: [
{
diff --git a/examples/iceberg/tsconfig.json b/examples/iceberg/tsconfig.json
index 4d7d536a36..166437d5e9 100644
--- a/examples/iceberg/tsconfig.json
+++ b/examples/iceberg/tsconfig.json
@@ -22,6 +22,7 @@
],
"paths": {
"@polar/polar": ["../../src/core/index.ts"],
+ "@polar/polar/client": ["../../src/client.ts"],
"@polar/polar/store": ["../../src/core/stores/index.ts"],
"@polar/polar/plugins/*": ["../../src/plugins/*/index.ts"],
"@polar/polar/plugins/*/store": ["../../src/plugins/*/store.ts"],
diff --git a/examples/snowbox/debug-assistant.js b/examples/snowbox/debug-assistant.js
new file mode 100644
index 0000000000..49a8b521ff
--- /dev/null
+++ b/examples/snowbox/debug-assistant.js
@@ -0,0 +1,25 @@
+import { getStore } from '@polar/polar'
+
+function initializeDebugAssistant() {
+ const map = document.getElementById('snowbox')
+ const coreStore = getStore(map, 'core')
+ const activePluginIds = coreStore.activePluginIds
+
+ window.map = map
+ window.olMap = coreStore.map
+ window.coreStore = coreStore
+ window.activePluginIds = activePluginIds
+ for (const pluginId of activePluginIds) {
+ window[`${pluginId}Store`] = coreStore.getPluginStore(pluginId)
+ }
+}
+
+// We want to load as late as possible.
+// Especially, the timeout stuff from snowbox code should be done when doing this.
+setTimeout(() => {
+ initializeDebugAssistant()
+
+ // 7 seconds may be long sometimes, inform the developer about it.
+ // eslint-disable-next-line no-console
+ console.info('POLAR debug assistant was successfully initialized')
+}, 7000)
diff --git a/examples/snowbox/index.html b/examples/snowbox/index.html
index 4358f22741..df068f3b75 100644
--- a/examples/snowbox/index.html
+++ b/examples/snowbox/index.html
@@ -8,6 +8,7 @@
+
diff --git a/src/core/components/PolarMap.ce.vue b/src/core/components/PolarMap.ce.vue
index a3e62b3417..f57c76755a 100644
--- a/src/core/components/PolarMap.ce.vue
+++ b/src/core/components/PolarMap.ce.vue
@@ -33,11 +33,13 @@ defineExpose({ el: polarMapContainer })
const emit = defineEmits(['updateListeners', 'wheel'])
const mainStore = useMainStore()
-const { hasWindowSize, hasSmallDisplay, center, zoom } = storeToRefs(mainStore)
+const { hasWindowSize, hasSmallDisplay, center, extent, zoom } =
+ storeToRefs(mainStore)
const contextMenuStore = useContextMenuStore()
function onMove() {
center.value = mainStore.map.getView().getCenter() || center.value
+ extent.value = mainStore.map.getView().calculateExtent()
zoom.value = mainStore.map.getView().getZoom() ?? zoom.value
}
diff --git a/src/core/stores/index.ts b/src/core/stores/index.ts
index 5d55749a4e..72f3f5d3f2 100644
--- a/src/core/stores/index.ts
+++ b/src/core/stores/index.ts
@@ -4,9 +4,12 @@
*/
/* eslint-enable tsdoc/syntax */
+import type { Feature } from 'ol'
+
import { acceptHMRUpdate, defineStore, storeToRefs } from 'pinia'
import { computed } from 'vue'
+import { updateSelection } from '../utils/map/setupMarkers'
import { useContextMenuStore } from './contextMenu'
import { useMainStore } from './main'
import { useMarkerStore } from './marker'
@@ -25,18 +28,19 @@ export const useCoreStore = defineStore('core', () => {
const mainStoreRefs = storeToRefs(mainStore)
const contextMenuStore = useContextMenuStore()
- const markerStore = useMarkerStore()
const moveHandleStore = useMoveHandleStore()
const pluginStore = usePluginStore()
+ const markerStore = useMarkerStore()
+ const markerStoreRefs = storeToRefs(markerStore)
+
return {
/**
* The current center coordinates of the map.
*
- * @alpha
- * @readonly
+ * @internal
*/
- center: computed(() => mainStore.center),
+ center: mainStoreRefs.center,
/**
* Color scheme the client should be using.
@@ -75,6 +79,14 @@ export const useCoreStore = defineStore('core', () => {
*/
deviceIsHorizontal: computed(() => mainStore.deviceIsHorizontal),
+ /**
+ * Extent of the map.
+ *
+ * @alpha
+ * @readonly
+ */
+ extent: computed(() => mainStore.extent),
+
/**
* Whether the map has a maximum height of {@link SMALL_DISPLAY_HEIGHT} and
* a maximum width of {@link SMALL_DISPLAY_WIDTH}.
@@ -120,6 +132,22 @@ export const useCoreStore = defineStore('core', () => {
*/
zoom: mainStoreRefs.zoom,
+ /**
+ * Returns the layer with the given ID.
+ *
+ * @param layerId - ID of the layer
+ * @alpha
+ */
+ getLayer: mainStore.getLayer,
+
+ /**
+ * List of all active plugin's IDs.
+ *
+ * @readonly
+ * @alpha
+ */
+ activePluginIds: computed(() => pluginStore.activePluginIds),
+
/**
* Before instantiating the map, all required plugins have to be added. Depending on how you use POLAR, this may
* already have been done. Ready-made clients (that is, packages prefixed `@polar/client-`) come with plugins prepared.
@@ -229,6 +257,26 @@ export const useCoreStore = defineStore('core', () => {
*/
selected: computed(() => markerStore.selected),
+ /**
+ * Feature that is hovered by the user with a marker.
+ * NOTE: Set _polarLayerId!
+ *
+ * @alpha
+ */
+ hoveredFeature: markerStoreRefs.hovered,
+
+ /**
+ * Feature that was selected by the user with a marker.
+ *
+ * @alpha
+ */
+ selectedFeature: computed({
+ get: () => markerStore.selected,
+ set: (feature) => {
+ updateSelection(mainStore.map, feature as Feature)
+ },
+ }),
+
/**
* Coordinates that were selected by the user with a marker.
*
diff --git a/src/core/stores/main.ts b/src/core/stores/main.ts
index fcecf83ac4..83b81ff050 100644
--- a/src/core/stores/main.ts
+++ b/src/core/stores/main.ts
@@ -27,6 +27,7 @@ export const useMainStore = defineStore('main', () => {
defaults
)
)
+ const extent = ref([0, 0, 0, 0])
const language = ref('')
const lightElement = ref(null)
const map = shallowRef({} as Map)
@@ -89,6 +90,10 @@ export const useMainStore = defineStore('main', () => {
return { ...register, ...polar } as typeof polar
}
+ function getLayer(layerId: string) {
+ return map.value.getAllLayers().find((layer) => layer.get('id') === layerId)
+ }
+
function setup() {
addEventListener('resize', updateHasSmallDisplay)
updateHasSmallDisplay()
@@ -113,6 +118,7 @@ export const useMainStore = defineStore('main', () => {
serviceRegister,
shadowRoot,
center,
+ extent,
zoom,
// Getters
layout,
@@ -122,6 +128,7 @@ export const useMainStore = defineStore('main', () => {
deviceIsHorizontal,
// Actions
centerOnFeature,
+ getLayer,
updateHasSmallDisplay,
getLayerMapConfiguration,
setup,
diff --git a/src/core/stores/plugin.ts b/src/core/stores/plugin.ts
index d38d36da26..a710afe784 100644
--- a/src/core/stores/plugin.ts
+++ b/src/core/stores/plugin.ts
@@ -10,7 +10,7 @@ import type {
import { toMerged } from 'es-toolkit'
import i18next from 'i18next'
import { acceptHMRUpdate, defineStore } from 'pinia'
-import { markRaw, reactive } from 'vue'
+import { computed, markRaw, reactive } from 'vue'
import { useMainStore } from './main'
@@ -18,6 +18,8 @@ export const usePluginStore = defineStore('plugin', () => {
const plugins = reactive([])
const mainStore = useMainStore()
+ const activePluginIds = computed(() => plugins.map((plugin) => plugin.id))
+
function addPlugin(plugin: PluginContainer) {
const { id, locales, options, storeModule } = plugin
@@ -81,6 +83,7 @@ export const usePluginStore = defineStore('plugin', () => {
return {
plugins,
+ activePluginIds,
addPlugin,
removePlugin,
getPluginStore,
diff --git a/src/core/types.ts b/src/core/types.ts
index f76740ce9d..a77fea15ae 100644
--- a/src/core/types.ts
+++ b/src/core/types.ts
@@ -9,3 +9,4 @@ export * from './types/theme'
export * from './types/utils'
export const CoreId = 'core'
+export const SharedId = 'shared'
diff --git a/src/core/types/locales.ts b/src/core/types/locales.ts
index 150b6ce1c3..6116a1ac45 100644
--- a/src/core/types/locales.ts
+++ b/src/core/types/locales.ts
@@ -1,12 +1,17 @@
+import type { resourcesEn as shared } from '@/locales'
import type { resourcesEn as core } from '../locales'
-import type { CoreId } from '../types'
+import type { CoreId, SharedId } from '../types'
import type { BundledPluginId, BundledPluginLocaleResources } from './plugin'
/** @internal */
export type LocaleResources = {
- [T in typeof CoreId | BundledPluginId]: T extends BundledPluginId
+ [
+ T in typeof CoreId | typeof SharedId | BundledPluginId
+ ]: T extends BundledPluginId
? BundledPluginLocaleResources
- : typeof core
+ : T extends typeof SharedId
+ ? typeof shared
+ : typeof core
}
type ToLocaleOverride = T extends string
diff --git a/src/core/types/plugin.ts b/src/core/types/plugin.ts
index 28c6eae760..b9ecdbf434 100644
--- a/src/core/types/plugin.ts
+++ b/src/core/types/plugin.ts
@@ -22,6 +22,9 @@ import type { useFullscreenStore as FullscreenStore } from '@/plugins/fullscreen
import type { PluginId as GeoLocationPluginId } from '@/plugins/geoLocation'
import type { resourcesEn as GeoLocationResources } from '@/plugins/geoLocation/locales'
import type { useGeoLocationStore as GeoLocationStore } from '@/plugins/geoLocation/store'
+import type { PluginId as GfiPluginId } from '@/plugins/gfi'
+import type { resourcesEn as GfiResources } from '@/plugins/gfi/locales'
+import type { useGfiStore as GfiStore } from '@/plugins/gfi/store'
import type { PluginId as IconMenuPluginId } from '@/plugins/iconMenu'
import type { resourcesEn as IconMenuResources } from '@/plugins/iconMenu/locales'
import type { useIconMenuStore as IconMenuStore } from '@/plugins/iconMenu/store'
@@ -148,6 +151,7 @@ export type BundledPluginId =
| typeof FooterPluginId
| typeof FullscreenPluginId
| typeof GeoLocationPluginId
+ | typeof GfiPluginId
| typeof IconMenuPluginId
| typeof LayerChooserPluginId
| typeof LoadingIndicatorId
@@ -177,6 +181,7 @@ export type BundledPluginStores =
| GetPluginStore
| GetPluginStore
| GetPluginStore
+ | GetPluginStore
| GetPluginStore
| GetPluginStore
| GetPluginStore
@@ -223,6 +228,7 @@ export type BundledPluginLocaleResources =
typeof GeoLocationPluginId,
typeof GeoLocationResources
>
+ | GetPluginResources
| GetPluginResources
| GetPluginResources<
T,
diff --git a/src/core/utils/map/setupMarkers.ts b/src/core/utils/map/setupMarkers.ts
index de632359f7..b9e649effa 100644
--- a/src/core/utils/map/setupMarkers.ts
+++ b/src/core/utils/map/setupMarkers.ts
@@ -90,7 +90,14 @@ function resolveClusterClick(map: Map, feature: Feature) {
})
}
-function updateSelection(
+/**
+ * Update the selected marker in the map.
+ *
+ * @param map - Map
+ * @param feature - Feature to select
+ * @param centerOnFeature - Should the map center on the feature?
+ */
+export function updateSelection(
map: Map,
feature: Feature | null,
centerOnFeature = false
@@ -208,10 +215,9 @@ export function setupMarkers(map: Map) {
stopWatcher = watch(
() => store.hovered,
- (feature) => {
- if (feature !== null && feature !== toRaw(store.selected)) {
- store.hovered?.setStyle(undefined)
- store.hovered = null
+ (feature, oldFeature) => {
+ if (oldFeature !== null && oldFeature !== toRaw(store.selected)) {
+ oldFeature.setStyle(undefined)
}
if (feature !== null && feature !== toRaw(store.selected)) {
store.hovered = markRaw(feature)
@@ -221,7 +227,7 @@ export function setupMarkers(map: Map) {
.hoverStyle,
isMultiFeature
)
- store.hovered.setStyle(style)
+ feature.setStyle(style)
}
}
)
diff --git a/src/core/vuePlugins/i18next.ts b/src/core/vuePlugins/i18next.ts
index 1fd14adb43..93577ed6a0 100644
--- a/src/core/vuePlugins/i18next.ts
+++ b/src/core/vuePlugins/i18next.ts
@@ -4,8 +4,10 @@ import i18next from 'i18next'
import LanguageDetector from 'i18next-browser-languagedetector'
import I18NextVue from 'i18next-vue'
+import sharedLocales from '@/locales'
+
import locales from '../locales'
-import { CoreId } from '../types'
+import { CoreId, SharedId } from '../types'
export const I18Next: Plugin = {
async install(app) {
@@ -27,6 +29,11 @@ export const I18Next: Plugin = {
supportedLngs: locales.map(({ type }) => type),
})
+ // This is no plugin itself, but bundled for usage of all plugins
+ sharedLocales.forEach((lng) => {
+ i18next.addResourceBundle(lng.type, SharedId, lng.resources, true)
+ })
+
// eslint-disable-next-line no-console
console.info(`Successfully initialized i18next.`)
} catch (error: unknown) {
diff --git a/src/lib/getFeatures/nominatim.ts b/src/lib/getFeatures/nominatim.ts
new file mode 100644
index 0000000000..a44d9875de
--- /dev/null
+++ b/src/lib/getFeatures/nominatim.ts
@@ -0,0 +1,60 @@
+import type { Point } from 'geojson'
+import type { PolarGeoJsonFeatureCollection } from '@/core'
+import type { NominatimParameters } from './types'
+
+import { transform as transformCoordinates } from 'ol/proj'
+
+export default async function (
+ signal: AbortSignal,
+ url: string,
+ inputValue: string,
+ queryParameters: NominatimParameters
+): Promise {
+ const { epsg, maxFeatures, ...native } = queryParameters
+
+ const fetchUrl = new URL(url)
+ Object.entries({
+ ...Object.fromEntries(
+ Object.entries(native).map(([key, value]) => [
+ key,
+ Array.isArray(value) ? value.join(',') : value,
+ ])
+ ),
+ ...(maxFeatures ? { limit: maxFeatures } : {}),
+ q: inputValue,
+ format: 'geojson',
+ polygon_geojson: 0, // TODO: Setting this to 1 is currently not supported well by addressSearch plugin. The plugin expects a point geometry.
+ polygon_threshold: 5,
+ }).forEach(([key, value]) => {
+ fetchUrl.searchParams.set(key, value.toString())
+ })
+
+ return await fetch(fetchUrl, {
+ signal,
+ })
+ .then((response) => response.json())
+ .then((featureCollection) => ({
+ ...featureCollection,
+ features: featureCollection.features.map((feature) => ({
+ ...feature,
+ title: feature.properties.display_name,
+ geometry: {
+ ...feature.geometry,
+ coordinates:
+ epsg === 'EPSG:4326'
+ ? feature.geometry.coordinates
+ : feature.geometry.type === 'Polygon'
+ ? feature.geometry.coordinates.map((ring) =>
+ ring.map((coord) =>
+ transformCoordinates(coord, 'EPSG:4326', epsg)
+ )
+ )
+ : transformCoordinates(
+ (feature.geometry as Point).coordinates,
+ 'EPSG:4326',
+ epsg
+ ),
+ },
+ })),
+ }))
+}
diff --git a/src/lib/getFeatures/types.ts b/src/lib/getFeatures/types.ts
index d8f3b85be5..9bad088be8 100644
--- a/src/lib/getFeatures/types.ts
+++ b/src/lib/getFeatures/types.ts
@@ -288,3 +288,85 @@ export interface WfsParameters extends QueryParameters {
*/
useRightHandWildcard?: boolean
}
+
+export interface NominatimParameters extends QueryParameters {
+ /**
+ * Include address details in result?
+ */
+ addressdetails?: boolean
+
+ /**
+ * Name and/or type of POI.
+ */
+ amenity?: string
+
+ /**
+ * Whether to consider the viewbox as exact instead of fuzzy filter.
+ */
+ bounded?: boolean
+
+ /**
+ * City.
+ */
+ city?: string
+
+ /**
+ * Country.
+ */
+ country?: string
+
+ /**
+ * Country code (ISO 3166-1alpha2).
+ */
+ countrycodes?: string[]
+
+ /**
+ * County.
+ */
+ county?: string
+
+ /**
+ * Include entrances to buildings in results?
+ */
+ entrances?: boolean
+
+ /**
+ * Add extra tags to result?
+ */
+ extratags?: boolean
+
+ /**
+ * Which feature types to include.
+ */
+ featureType?: 'country' | 'state' | 'city' | 'settlement'
+
+ /**
+ * Which type(s) of results to return.
+ */
+ layer?: ('address' | 'poi' | 'railway' | 'natural' | 'manmade')[]
+
+ /**
+ * Include more names in alternate languages?
+ */
+ namedetails?: boolean
+
+ /**
+ * Postal code.
+ */
+ postalcode?: string
+
+ /**
+ * State.
+ */
+ state?: string
+
+ /**
+ * House number and street name.
+ */
+ street?: string
+
+ /**
+ * Viewbox to prefer for searching the given term.
+ */
+ viewbox?: [number, number, number, number]
+}
diff --git a/src/lib/getRefStore.ts b/src/lib/getRefStore.ts
new file mode 100644
index 0000000000..db4b396b1d
--- /dev/null
+++ b/src/lib/getRefStore.ts
@@ -0,0 +1,14 @@
+import type { StoreReference } from '@/core'
+
+import { useCoreStore } from '@/core/stores'
+
+/**
+ * Get the store for a `StoreReference`.
+ *
+ * @param ref - Store reference
+ * @returns Referenced store
+ */
+export function getRefStore(ref: StoreReference) {
+ const coreStore = useCoreStore()
+ return ref.plugin ? coreStore.getPluginStore(ref.plugin) : coreStore
+}
diff --git a/src/locales.ts b/src/locales.ts
new file mode 100644
index 0000000000..071900ed54
--- /dev/null
+++ b/src/locales.ts
@@ -0,0 +1,59 @@
+/* eslint-disable tsdoc/syntax */
+/**
+ * This is the documentation for the locales keys for POLAR shared components.
+ * These locales are *NOT* exported, but documented only.
+ *
+ * @module locales/shared
+ */
+/* eslint-enable tsdoc/syntax */
+
+import type { Locale } from '@/core/types'
+
+/**
+ * German locales for POLAR shared components.
+ * For overwriting these values, pass a partial object of this in `locales`.
+ */
+export const resourcesDe = {
+ pagination: {
+ currentPage: 'Aktuelle Seite, Seite {{page}}',
+ page: 'Seite {{page}}',
+ next: 'Nächste Seite',
+ previous: 'Vorherige Seite',
+ wrapper: 'Seitenauswahl',
+ },
+} as const
+
+/**
+ * English locales for POLAR shared components.
+ * For overwriting these values, pass a partial object of this in `locales`.
+ */
+export const resourcesEn = {
+ pagination: {
+ currentPage: 'Aktuelle Seite, Seite {{page}}',
+ page: 'Seite {{page}}',
+ next: 'Nächste Seite',
+ previous: 'Vorherige Seite',
+ wrapper: 'Seitenauswahl',
+ },
+} as const
+
+/**
+ * POLAR shared components locales.
+ *
+ * @privateRemarks
+ * The first entry will be used as fallback.
+ *
+ * @internal
+ */
+const locales: Locale[] = [
+ {
+ type: 'de',
+ resources: resourcesDe,
+ },
+ {
+ type: 'en',
+ resources: resourcesEn,
+ },
+]
+
+export default locales
diff --git a/src/plugins/addressSearch/types.ts b/src/plugins/addressSearch/types.ts
index 989824e6f4..89daffbfd4 100644
--- a/src/plugins/addressSearch/types.ts
+++ b/src/plugins/addressSearch/types.ts
@@ -126,7 +126,7 @@ export interface AddressSearchPluginOptions extends PluginOptions {
/** Possible search methods by type. */
// eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
-export type SearchType = 'bkg' | 'wfs' | 'mpapi' | string
+export type SearchType = 'bkg' | 'wfs' | 'mpapi' | 'nominatim' | string
export type SearchDisplayMode = 'mixed' | 'categorized'
@@ -176,7 +176,7 @@ export interface SearchMethodConfiguration {
/**
* The object further describes details for the search request.
- * Its contents vary by service type, see {@link BKGParameters}, {@link MpapiParameters} or {@link WfsParameters}.
+ * Its contents vary by service type, see {@link BKGParameters}, {@link MpapiParameters}, {@link WfsParameters} or {@link NominatimParameters}.
*/
queryParameters?: QueryParameters
diff --git a/src/plugins/addressSearch/utils/methodContainer.ts b/src/plugins/addressSearch/utils/methodContainer.ts
index e9c6d78d77..b0ccb01ab7 100644
--- a/src/plugins/addressSearch/utils/methodContainer.ts
+++ b/src/plugins/addressSearch/utils/methodContainer.ts
@@ -2,10 +2,11 @@ import type { SearchMethodFunction } from '../types'
import bkg from '@/lib/getFeatures/bkg'
import mpapi from '@/lib/getFeatures/mpapi'
+import nominatim from '@/lib/getFeatures/nominatim'
import { getWfsFeatures } from '@/lib/getFeatures/wfs'
export function getMethodContainer() {
- const methods = { bkg, mpapi, wfs: getWfsFeatures }
+ const methods = { bkg, mpapi, nominatim, wfs: getWfsFeatures }
return {
registerSearchMethods: (
diff --git a/src/plugins/fullscreen/types.ts b/src/plugins/fullscreen/types.ts
index aa1e5c3864..482994e094 100644
--- a/src/plugins/fullscreen/types.ts
+++ b/src/plugins/fullscreen/types.ts
@@ -10,9 +10,8 @@ export const PluginId = 'fullscreen'
*/
export interface FullscreenPluginOptions extends PluginOptions {
/**
- * Defines if the fullscreen button is rendered independent or as part of the icon menu.
- *
- * This is only applicable if the layout is `'nineRegions'`.
+ * Defines if the plugin is rendered independent or as part of the icon menu.
+ * This is automatically set by the icon menu; you should not need to touch this.
*
* @defaultValue `'independent'`
*/
diff --git a/src/plugins/geoLocation/types.ts b/src/plugins/geoLocation/types.ts
index 3e99ddd847..95d509b10c 100644
--- a/src/plugins/geoLocation/types.ts
+++ b/src/plugins/geoLocation/types.ts
@@ -33,10 +33,8 @@ export interface GeoLocationPluginOptions extends LayerBoundPluginOptions {
keepCentered?: boolean
/**
- * Defines if the geoLocation button is rendered independent or as part of the
- * icon menu.
- *
- * This is only applicable if the layout is `'nineRegions'`.
+ * Defines if the plugin is rendered independent or as part of the icon menu.
+ * This is automatically set by the icon menu; you should not need to touch this.
*
* @defaultValue `'independent'`
*/
diff --git a/src/plugins/gfi/components/GfiFeature.ce.vue b/src/plugins/gfi/components/GfiFeature.ce.vue
new file mode 100644
index 0000000000..07cfd067c8
--- /dev/null
+++ b/src/plugins/gfi/components/GfiFeature.ce.vue
@@ -0,0 +1,104 @@
+
+
+
+
+
+
+
+
+
diff --git a/src/plugins/gfi/components/GfiFeatureList.ce.vue b/src/plugins/gfi/components/GfiFeatureList.ce.vue
new file mode 100644
index 0000000000..ba1291e255
--- /dev/null
+++ b/src/plugins/gfi/components/GfiFeatureList.ce.vue
@@ -0,0 +1,68 @@
+
+
+
+ {{ gfiStore.listGetText(feature, 'subSubtitle') }} +
+
+
+
+
+
+
diff --git a/src/plugins/gfi/components/GfiUI.ce.vue b/src/plugins/gfi/components/GfiUI.ce.vue
new file mode 100644
index 0000000000..837d46db2e
--- /dev/null
+++ b/src/plugins/gfi/components/GfiUI.ce.vue
@@ -0,0 +1,71 @@
+
+
+
+
+
+
+
+
+
diff --git a/src/plugins/gfi/composables/useFeatureDisplayLayer.ts b/src/plugins/gfi/composables/useFeatureDisplayLayer.ts
new file mode 100644
index 0000000000..47b364dab9
--- /dev/null
+++ b/src/plugins/gfi/composables/useFeatureDisplayLayer.ts
@@ -0,0 +1,87 @@
+import type { Feature as GeoJsonFeature } from 'geojson'
+import type { Feature, Map } from 'ol'
+import type { Style } from 'ol/style'
+import type { Ref } from 'vue'
+
+import { GeoJSON } from 'ol/format'
+import VectorLayer from 'ol/layer/Vector'
+import { Vector } from 'ol/source'
+import { onScopeDispose, watch } from 'vue'
+
+function getFeatureDisplayLayer() {
+ const featureDisplayLayer = new VectorLayer({
+ source: new Vector({
+ features: [],
+ }),
+ })
+
+ featureDisplayLayer.set('polarInternalId', 'pluginGfiFeatureDisplay')
+ featureDisplayLayer.setZIndex(90)
+ // NOTE: This may be changed in the future to not use the default styling of @masterportal/masterportalapi
+ featureDisplayLayer.set('styleId', 'defaultHighlightFeaturesPoint')
+
+ return featureDisplayLayer
+}
+
+function isVectorSource(source): source is Vector {
+ return source instanceof Vector
+}
+
+/**
+ * reset feature layer's features.
+ */
+function clear(featureDisplayLayer: VectorLayer): void {
+ const source = featureDisplayLayer.getSource()
+ if (isVectorSource(source)) {
+ source.clear()
+ }
+}
+
+/**
+ * add feature from jsonable GeoJson object.
+ */
+function addFeature(
+ feature: GeoJsonFeature,
+ featureDisplayLayer: VectorLayer
+): void {
+ const source = featureDisplayLayer.getSource()
+ if (isVectorSource(source)) {
+ // Since ol@10, readFeature may also return a Feature[]?
+ source.addFeature(new GeoJSON().readFeature(feature) as Feature)
+ }
+}
+
+export function useFeatureDisplayLayer(options: {
+ map: Map
+ style: Ref
+
+ | + {{ $t(($) => $.header.field, { ns: 'gfi' }) }} + | ++ {{ $t(($) => $.header.value, { ns: 'gfi' }) }} + | +
|---|---|
| + {{ + $t(($) => $['layer'][props.layerId]['property'][key], { + ns: 'gfi', + defaultValue: key, + }) + }} + | +
+
+
+
+ |
+
+ {{ $t(($) => $.list.header, { ns: 'gfi' }) }} +
+ + {{ $t(($) => $.list.emptyView, { ns: 'gfi' }) }} + + ++ {{ gfiStore.listGetText(feature, 'title') }} +
+ {{ gfiStore.listGetText(feature, 'subtitle') }} ++ {{ gfiStore.listGetText(feature, 'subSubtitle') }} +