fix(ol-layerswitcher-control): support layer properties needed by ol-ext/control/LayerSwitcher

closes #405

Author: d-koppenhagen

Diff for: src/components/layers/OlAnimatedClusterLayer.vue

@@ -18,6 +18,7 @@ import {
 import type { Options } from "ol/layer/Vector";
 import { useDefaults } from "./LayersCommonProps";
 import type VectorSource from "ol/source/Vector";
+import type { LayerSwitcherOptions } from "@/types";
 
 // prevent warnings caused by event pass-through via useOpenLayersEvents composable
 defineOptions({
@@ -33,7 +34,9 @@ interface ClusterOptions extends Options<VectorSource> {
 
 type Props = {
   distance?: number;
-} & ClusterOptions;
+} & ClusterOptions &
+  LayerSwitcherOptions;
+
 const props = withDefaults(defineProps<Props>(), useDefaults<Props>());
 defineEmits<LayerEvents & VectorSourceEvents>();
 

Diff for: src/components/layers/OlAnimatedClusterlayer.vue

@@ -18,6 +18,7 @@ import {
 import type { Options } from "ol/layer/Vector";
 import { useDefaults } from "./LayersCommonProps";
 import type VectorSource from "ol/source/Vector";
+import type { LayerSwitcherOptions } from "@/types";
 
 // prevent warnings caused by event pass-through via useOpenLayersEvents composable
 defineOptions({
@@ -33,7 +34,9 @@ interface ClusterOptions extends Options<VectorSource> {
 
 type Props = {
   distance?: number;
-} & ClusterOptions;
+} & ClusterOptions &
+  LayerSwitcherOptions;
+
 const props = withDefaults(defineProps<Props>(), useDefaults<Props>());
 defineEmits<LayerEvents & VectorSourceEvents>();
 

Diff for: src/components/layers/OlHeatmapLayer.vue

@@ -14,8 +14,9 @@ import {
 } from "@/components/layers/LayersCommonProps";
 import type { LayerEvents } from "@/composables";
 import type { ObjectEvent } from "ol/Object";
+import type { LayerSwitcherOptions } from "@/types";
 
-type Props = LayersCommonProps & Options;
+type Props = LayersCommonProps & Options & LayerSwitcherOptions;
 const props = withDefaults(defineProps<Props>(), useDefaults<Props>());
 
 type Emits = LayerEvents & {

Diff for: src/components/layers/OlImageLayer.vue

@@ -12,8 +12,9 @@ import { useDefaults } from "@/components/layers/LayersCommonProps";
 import type { Options } from "ol/layer/BaseImage";
 import type ImageSource from "ol/source/Image";
 import type { LayerEvents } from "@/composables";
+import type { LayerSwitcherOptions } from "@/types";
 
-type Props = Options<ImageSource>;
+type Props = Options<ImageSource> & LayerSwitcherOptions;
 const props = withDefaults(
   defineProps<Props>(),
   useDefaults<Props, ImageSource>(),

Diff for: src/components/layers/OlLayerGroup.vue

@@ -23,16 +23,14 @@ import {
   type LayerRenderEvents,
 } from "@/composables/useOpenLayersEvents";
 import type { ObjectEvent } from "ol/Object";
+import type { LayerSwitcherOptions } from "@/types";
 
 // prevent warnings caused by event pass-through via useOpenLayersEvents composable
 defineOptions({
   inheritAttrs: false,
 });
 
-type Props = Options & {
-  openInLayerSwitcher?: boolean;
-  title?: string;
-};
+type Props = Options & LayerSwitcherOptions;
 const props = withDefaults(defineProps<Props>(), {
   opacity: 1,
   visible: true,

Diff for: src/components/layers/OlTileLayer.vue

@@ -13,8 +13,9 @@ import { useDefaults } from "@/components/layers/LayersCommonProps";
 import TileSource from "ol/source/Tile";
 import type { LayerEvents } from "@/composables";
 import type { ObjectEvent } from "ol/Object";
+import type { LayerSwitcherOptions } from "@/types";
 
-type Props = Options<TileSource>;
+type Props = Options<TileSource> & LayerSwitcherOptions;
 type Emits = LayerEvents & {
   (e: "change:useInterimTilesOnError", event: ObjectEvent): void;
   (e: "change:preload", event: ObjectEvent): void;
@@ -27,7 +28,7 @@ const props = withDefaults(
 );
 defineEmits<Emits>();
 
-const { layer } = useLayer(TileLayer, toRefs(props), [
+const { layer } = useLayer(TileLayer, toRefs({ ...props }), [
   "change:useInterimTilesOnError",
   "change:preload",
 ]);

Diff for: src/components/layers/OlVectorImageLayer.vue

@@ -11,8 +11,10 @@ import VectorImageLayer, { type Options } from "ol/layer/VectorImage";
 import useLayer from "@/composables/useLayer";
 import { useDefaults } from "@/components/layers/LayersCommonProps";
 import type { LayerEvents } from "@/composables";
+import type { LayerSwitcherOptions } from "@/types";
 
-const props = withDefaults(defineProps<Options>(), useDefaults<Options>());
+type Props = Options & LayerSwitcherOptions;
+const props = withDefaults(defineProps<Props>(), useDefaults<Props>());
 defineEmits<LayerEvents>();
 
 const { layer } = useLayer(VectorImageLayer, props);

Diff for: src/components/layers/OlVectorLayer.vue

@@ -10,8 +10,10 @@ import VectorLayer, { type Options } from "ol/layer/Vector";
 import useLayer from "@/composables/useLayer";
 import { useDefaults } from "@/components/layers/LayersCommonProps";
 import type { LayerEvents } from "@/composables";
+import type { LayerSwitcherOptions } from "@/types";
 
-const props = withDefaults(defineProps<Options>(), useDefaults<Options>());
+type Props = Options & LayerSwitcherOptions;
+const props = withDefaults(defineProps<Props>(), useDefaults<Props>());
 defineEmits<LayerEvents>();
 
 const { layer } = useLayer(VectorLayer, props);

Diff for: src/components/layers/OlVectorTileLayer.vue

@@ -11,8 +11,9 @@ import useLayer from "@/composables/useLayer";
 import { useDefaults } from "@/components/layers/LayersCommonProps";
 import type { LayerEvents } from "@/composables";
 import type { VectorTile } from "ol/source";
+import type { LayerSwitcherOptions } from "@/types";
 
-type Props = Options;
+type Props = Options & LayerSwitcherOptions;
 const props = withDefaults(
   defineProps<Props>(),
   useDefaults<Props, VectorTile>(),

Diff for: src/components/layers/OlWebglTileLayer.vue

@@ -12,8 +12,9 @@ import { useDefaults } from "./LayersCommonProps";
 import type { LayerEvents } from "@/composables";
 import type { ObjectEvent } from "ol/Object";
 import type { Tile } from "ol/source";
+import type { LayerSwitcherOptions } from "@/types";
 
-type Props = Options;
+type Props = Options & LayerSwitcherOptions;
 const props = withDefaults(defineProps<Props>(), useDefaults<Props, Tile>());
 
 type Emits = LayerEvents & {

Diff for: src/components/layers/OlWebglVectorLayer.vue

@@ -11,11 +11,12 @@ import { type LayersCommonProps } from "@/components/layers/LayersCommonProps";
 import { WebGLVectorLayer } from "./WebGLVectorLayerClass";
 import type { WebGLStyle } from "ol/style/webgl";
 import type { LayerEvents } from "@/composables";
+import type { LayerSwitcherOptions } from "@/types";
 
 type Props = LayersCommonProps & {
   disableHitDetection?: boolean;
   styles: WebGLStyle;
-};
+} & LayerSwitcherOptions;
 const props = withDefaults(defineProps<Props>(), {
   disableHitDetection: false,
   styles: () => ({

Diff for: src/demos/LayerswitcherControlDemo.vue

@@ -49,6 +49,6 @@ onMounted(() => {
 });
 
 onMounted(() => {
-  console.log(mapRef.value);
+  console.log(mapRef.value.map.getLayers().getArray());
 });
 </script>

Diff for: src/types.ts

@@ -24,3 +24,11 @@ export type KeysMatching<T extends object, V> = {
 export type ObjectToFactory<T> = {
   [Key in keyof T]: T[Key] extends object | undefined ? () => T[Key] : T[Key];
 };
+
+export type LayerSwitcherOptions = {
+  openInLayerSwitcher?: boolean;
+  title?: string;
+  name?: string;
+  allwaysOnTop?: boolean; // typo in original code, see https://github.com/Viglino/ol-ext/issues/1128
+  baseLayer?: boolean;
+};