@mapcomponents/react-maplibre 0.1.46 → 0.1.51

package/dist/components/MlLayerSwitcher/MlLayerSwitcher.stories.d.ts

@@ -0,0 +1,13 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlLayerSwitcher as component };
+    export namespace argTypes {
+        const url: {};
+        const layer: {};
+    }
+    export { mapContextDecorator as decorators };
+}
+import MlLayerSwitcher from "./MlLayerSwitcher";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlLayerSwitcher/components/LayerBox.d.ts

@@ -0,0 +1,6 @@
+export default LayerBox;
+/**
+ * @component
+ *
+ */
+declare function LayerBox(props: any): JSX.Element;

package/dist/components/MlMarker/MlMarker.d.ts

@@ -0,0 +1,33 @@
+interface MlMarkerProps {
+    /**
+     * Id of the target MapLibre instance in mapContext
+     */
+    mapId?: string;
+    /**
+     * The layerId of an existing layer this layer should be rendered visually beneath
+     * https://maplibre.org/maplibre-gl-js-docs/api/map/#map#addlayer - see "beforeId" property
+     */
+    insertBeforeLayer?: string;
+    /**
+     * Longitude of the marker position
+     */
+    lng: number;
+    /**
+     * Latitude of the marker position
+     */
+    lat: number;
+    /**
+     * Content of the description popup
+     */
+    content?: string;
+}
+/**
+ * Adds a marker to the map and displays the contents of the "content" property in an iframe next to it
+ */
+declare const MlMarker: {
+    (props: MlMarkerProps): JSX.Element;
+    defaultProps: {
+        mapId: undefined;
+    };
+};
+export default MlMarker;

package/dist/components/MlMarker/MlMarker.stories.d.ts

@@ -0,0 +1,9 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlMarker as component };
+    export { mapContextDecorator as decorators };
+}
+import MlMarker from "./MlMarker";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlMeasureTool/MlMeasureTool.d.ts

@@ -0,0 +1,20 @@
+import * as turf from "@turf/turf";
+interface MlMeasureToolProps {
+    /**
+     * String that specify if the Tool measures an area ("polygon") or length ("line")
+     */
+    measureType?: string;
+    /**
+     * String that dictates which unit of measurement is used
+     */
+    unit?: turf.Units;
+}
+declare const MlMeasureTool: {
+    (props: MlMeasureToolProps): JSX.Element;
+    defaultProps: {
+        mapId: undefined;
+        measureType: string;
+        unit: string;
+    };
+};
+export default MlMeasureTool;

package/dist/components/MlMeasureTool/MlMeasureTool.stories.d.ts

@@ -0,0 +1,11 @@
+export default storyoptions;
+export const MeasureLine: any;
+export const MeasurePolygon: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlMeasureTool as component };
+    export const argTypes: {};
+    export { mapContextDecorator as decorators };
+}
+import MlMeasureTool from "./MlMeasureTool";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlNavigationCompass/MlNavigationCompass.d.ts

@@ -0,0 +1,47 @@
+import PropTypes from "prop-types";
+interface MlNavigationCompassProps {
+    mapId?: string;
+    insertBeforeLayer?: string;
+    style?: any;
+    backgroundStyle?: any;
+    needleStyle?: any;
+    rotateRightStyle?: any;
+    rotateLeftStyle?: any;
+}
+/**
+ * Navigation component that displays a compass component which indicates the current oriantation of the map it is registered for and offers controls to turn the bearing 90° left/right or reset north to point up.
+ *
+ * All style props are applied using @emotion/css to allow more complex css selectors.
+ *
+ * @component
+ */
+declare const MlNavigationCompass: {
+    (props: MlNavigationCompassProps): JSX.Element;
+    propTypes: {
+        /**
+         * Component id prefix
+         */
+        idPrefix: PropTypes.Requireable<string>;
+        /**
+         * Style object to adjust css definitions of the component.
+         */
+        style: PropTypes.Requireable<object>;
+        /**
+         * Style object to adjust css definitions of the background.
+         */
+        backgroundStyle: PropTypes.Requireable<object>;
+        /**
+         * Style object to adjust css definitions of the compass needle.
+         */
+        needleStyle: PropTypes.Requireable<object>;
+        /**
+         * Style object to adjust css definitions of the rotate right button.
+         */
+        rotateRightStyle: PropTypes.Requireable<object>;
+        /**
+         * Style object to adjust css definitions of the rotate left button.
+         */
+        rotateLeftStyle: PropTypes.Requireable<object>;
+    };
+};
+export default MlNavigationCompass;

package/dist/components/MlNavigationCompass/MlNavigationCompass.stories.d.ts

@@ -0,0 +1,10 @@
+export default storyoptions;
+export const Standard: any;
+export const StyleExample: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlNavigationCompass as component };
+    export { mapContextDecorator as decorators };
+}
+import MlNavigationCompass from "./MlNavigationCompass";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlNavigationCompass/MlNavigationCompass.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/MlNavigationTools/MlNavigationTools.d.ts

@@ -0,0 +1,9 @@
+interface MlNavigationToolsProps {
+    mapId?: string;
+    insertBeforeLayer?: string;
+}
+/**
+* @component
+*/
+declare const MlNavigationTools: (props: MlNavigationToolsProps) => JSX.Element;
+export default MlNavigationTools;

package/dist/components/MlNavigationTools/MlNavigationTools.stories.d.ts

@@ -0,0 +1,13 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlNavigationTools as component };
+    export namespace argTypes {
+        const url: {};
+        const layer: {};
+    }
+    export { mapContextDecorator as decorators };
+}
+import MlNavigationTools from "./MlNavigationTools";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlOsmLayer/MlOsmLayer.d.ts

@@ -0,0 +1,18 @@
+export default MlOsmLayer;
+/**
+ * Adds a standard OSM tile layer to the maplibre-gl instancereference by
+ * props.mapId
+ *
+ * @component
+ */
+declare function MlOsmLayer(props: any): JSX.Element;
+declare namespace MlOsmLayer {
+    namespace propTypes {
+        const mapId: PropTypes.Requireable<string>;
+        const idPrefix: PropTypes.Requireable<string>;
+        const sourceOptions: PropTypes.Requireable<object>;
+        const layerOptions: PropTypes.Requireable<object>;
+        const insertBeforeLayer: PropTypes.Requireable<string>;
+    }
+}
+import PropTypes from "prop-types";

package/dist/components/MlOsmLayer/MlOsmLayer.stories_.d.ts

@@ -0,0 +1,16 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlOsmLayer as component };
+    export namespace argTypes {
+        namespace options {
+            namespace control {
+                const type: string;
+            }
+        }
+    }
+    export { mapContextDecorator as decorators };
+}
+import MlOsmLayer from "./MlOsmLayer";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlOsmLayer/MlOsmLayer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/MlScaleReference/MlScaleReference.d.ts

@@ -0,0 +1,2 @@
+export default MlScaleReference;
+declare function MlScaleReference(props: any): JSX.Element;

package/dist/components/MlScaleReference/MlScaleReference.stories.d.ts

@@ -0,0 +1,14 @@
+export default storyoptions;
+export const Toolbar: any;
+export const Overlay: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlScaleReference as component };
+    export namespace argTypes {
+        const url: {};
+        const layer: {};
+    }
+    export { mapContextDecorator as decorators };
+}
+import MlScaleReference from "./MlScaleReference";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlShareMapState/MlShareMapState.d.ts

@@ -0,0 +1,22 @@
+export default MlShareMapState;
+/**
+ * TODO: Add short & useful description
+ *
+ * @param {object} props
+ * @param {string} props.mapId Id of the target MapLibre instance in mapContext
+ *
+ * @component
+ */
+declare function MlShareMapState(props: {
+    mapId: string;
+}): JSX.Element;
+declare namespace MlShareMapState {
+    namespace defaultProps {
+        const mapId: undefined;
+    }
+    namespace propTypes {
+        const mapId_1: PropTypes.Requireable<string>;
+        export { mapId_1 as mapId };
+    }
+}
+import PropTypes from "prop-types";

package/dist/components/MlShareMapState/MlShareMapState.stories.d.ts

@@ -0,0 +1,10 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlShareMapState as component };
+    export const argTypes: {};
+    export { mapContextDecorator as decorators };
+}
+import MlShareMapState from "./MlShareMapState";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlSpatialElevationProfile/MlSpatialElevationProfile.d.ts

@@ -0,0 +1,20 @@
+export default MlSpatialElevationProfile;
+/**
+ * MlSpatialElevationProfile returns a Button that will add a standard OSM tile layer to the maplibre-gl instance.
+ *
+ * @component
+ */
+declare function MlSpatialElevationProfile(props: any): JSX.Element;
+declare namespace MlSpatialElevationProfile {
+    namespace defaultProps {
+        const elevationFactor: number;
+    }
+    namespace propTypes {
+        export const mapId: PropTypes.Requireable<string>;
+        export const idPrefix: PropTypes.Requireable<string>;
+        const elevationFactor_1: PropTypes.Requireable<number>;
+        export { elevationFactor_1 as elevationFactor };
+        export const insertBeforeLayer: PropTypes.Requireable<string>;
+    }
+}
+import PropTypes from "prop-types";

package/dist/components/MlSpatialElevationProfile/MlSpatialElevationProfile.stories.d.ts

@@ -0,0 +1,16 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlSpatialElevationProfile as component };
+    export namespace argTypes {
+        namespace options {
+            namespace control {
+                const type: string;
+            }
+        }
+    }
+    export { mapContextDecorator as decorators };
+}
+import MlSpatialElevationProfile from "./MlSpatialElevationProfile";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlSpatialElevationProfile/MlSpatialElevationProfile.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/MlThreeJsLayer/MlThreeJsLayer.d.ts

@@ -0,0 +1,15 @@
+export default MlThreeJsLayer;
+/**
+ * Renders obj or gltf 3D Models on the MapLibreMap referenced by props.mapId
+ *
+ * @component
+ */
+declare function MlThreeJsLayer(props: any): JSX.Element;
+declare namespace MlThreeJsLayer {
+    namespace propTypes {
+        const mapId: PropTypes.Requireable<string>;
+        const init: PropTypes.Requireable<(...args: any[]) => any>;
+        const onDone: PropTypes.Requireable<(...args: any[]) => any>;
+    }
+}
+import PropTypes from "prop-types";

package/dist/components/MlThreeJsLayer/MlThreeJsLayer.stories.d.ts

@@ -0,0 +1,16 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlThreeJsLayer as component };
+    export namespace argTypes {
+        namespace options {
+            namespace control {
+                const type: string;
+            }
+        }
+    }
+    export { mapContextDecorator as decorators };
+}
+import MlThreeJsLayer from "./MlThreeJsLayer";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlThreeJsLayer/MlThreeJsLayer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/MlThreeJsLayer/lib/GLTFLoader.d.ts

@@ -0,0 +1,17 @@
+export default GLTFLoader;
+declare class GLTFLoader {
+    constructor(manager: any);
+    dracoLoader: any;
+    ktx2Loader: any;
+    meshoptDecoder: any;
+    pluginCallbacks: any[];
+    load(url: any, onLoad: any, onProgress: any, onError: any): void;
+    setDRACOLoader(dracoLoader: any): GLTFLoader;
+    setDDSLoader(): void;
+    setKTX2Loader(ktx2Loader: any): GLTFLoader;
+    setMeshoptDecoder(meshoptDecoder: any): GLTFLoader;
+    register(callback: any): GLTFLoader;
+    unregister(callback: any): GLTFLoader;
+    parse(data: any, path: any, onLoad: any, onError: any): void;
+    parseAsync(data: any, path: any): Promise<any>;
+}

package/dist/components/MlTransitionGeoJsonLayer/MlTransitionGeoJsonLayer.d.ts

@@ -0,0 +1,73 @@
+import { Feature, FeatureCollection } from "@turf/turf";
+import { CircleLayerSpecification, FillLayerSpecification, LineLayerSpecification, MapLayerMouseEvent } from "maplibre-gl";
+interface MlTransitionGeoJsonLayerProps {
+    /**
+     * Id of the target MapLibre instance in mapContext
+     */
+    mapId: string;
+    /**
+     * GeoJSON data that is supposed to be rendered by this component.
+     */
+    geojson: Feature | FeatureCollection | undefined;
+    /**
+     * Type of the layer that will be added to the MapLibre instance.
+     * Possible values: "line", "circle", "fill"
+     */
+    type?: "fill" | "line" | "circle";
+    /**
+     * Paint property object, that is passed to the addLayer call.
+     * Possible props depend on the layer type.
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#line
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#circle
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#fill
+     */
+    paint?: CircleLayerSpecification['paint'] | FillLayerSpecification['paint'] | LineLayerSpecification['layout'];
+    /**
+     * Layout property object, that is passed to the addLayer call.
+     * Possible props depend on the layer type.
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#line
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#circle
+     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#fill
+     */
+    layout?: CircleLayerSpecification['layout'] | FillLayerSpecification['layout'] | LineLayerSpecification['layout'];
+    /**
+     * Javascript object that is spread into the addLayer commands first parameter.
+     */
+    options?: CircleLayerSpecification | FillLayerSpecification | LineLayerSpecification;
+    /**
+     * Javascript object with optional properties "fill", "line", "circle" to override implicit layer type default paint properties.
+     */
+    defaultPaintOverrides?: {
+        circle?: CircleLayerSpecification['paint'];
+        fill?: FillLayerSpecification['paint'];
+        line?: LineLayerSpecification['paint'];
+    };
+    /**
+     * Id of an existing layer in the mapLibre instance to help specify the layer order
+     * This layer will be visually beneath the layer with the "insertBeforeLayer" id.
+     */
+    insertBeforeLayer: string;
+    /**
+     * Hover event handler that is executed whenever a geometry rendered by this component is hovered.
+     */
+    onHover?: MapLayerMouseEvent;
+    /**
+     * Click event handler that is executed whenever a geometry rendered by this component is clicked.
+     */
+    onClick?: MapLayerMouseEvent;
+    /**
+     * Leave event handler that is executed whenever a geometry rendered by this component is
+     * left/unhovered.
+     */
+    onLeave?: MapLayerMouseEvent;
+    /**
+     * Creates transition animation whenever the geojson prop changes.
+     * Only works with layer type "line" and LineString GeoJSON data.
+     */
+    transitionTime: number;
+}
+/**
+ * Adds source and layer of types "line", "fill" or "circle" to display GeoJSON data on the map.
+ */
+declare const MlTransitionGeoJsonLayer: (props: MlTransitionGeoJsonLayerProps) => JSX.Element;
+export default MlTransitionGeoJsonLayer;

package/dist/components/MlTransitionGeoJsonLayer/MlTransitionGeoJsonLayer.stories.d.ts

@@ -0,0 +1,13 @@
+export default storyoptions;
+export const Linestring: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlTransitionGeoJsonLayer as component };
+    export namespace argTypes {
+        const url: {};
+        const layer: {};
+    }
+    export { mapContextDecorator as decorators };
+}
+import MlTransitionGeoJsonLayer from "./MlTransitionGeoJsonLayer";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlTransitionGeoJsonLayer/MlTransitionGeoJsonLayer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/MlTransitionGeoJsonLayer/util/transitionFunctions.d.ts

@@ -0,0 +1,2 @@
+export function _showNextTransitionSegment(props: any, map: any, transitionInProgressRef: any, transitionGeojsonDataRef: any, transitionGeojsonCommonDataRef: any, currentTransitionStepRef: any, msPerStep: any, transitionTimeoutRef: any, setDisplayGeojson: any): void;
+export function _transitionToGeojson(props: any, transitionGeojsonCommonDataRef: any, transitionGeojsonDataRef: any, transitionInProgressRef: any, oldGeojsonRef: any, msPerStep: any, currentTransitionStepRef: any, map: any, transitionTimeoutRef: any, setDisplayGeojson: any): void;

package/dist/components/MlUseMapDebugger/MlUseMapDebugger.d.ts

@@ -0,0 +1,22 @@
+export default MlUseMapDebugger;
+/**
+ * Renders a collapsable top-drawer containing live map debug information
+ *
+ * @param {object} props
+ * @param {string} props.mapId Id of the target MapLibre instance in mapContext
+ *
+ * @component
+ */
+declare function MlUseMapDebugger(props: {
+    mapId: string;
+}): JSX.Element;
+declare namespace MlUseMapDebugger {
+    namespace defaultProps {
+        const mapId: undefined;
+    }
+    namespace propTypes {
+        const mapId_1: PropTypes.Requireable<string>;
+        export { mapId_1 as mapId };
+    }
+}
+import PropTypes from "prop-types";

package/dist/components/MlUseMapDebugger/MlUseMapDebugger.stories.d.ts

@@ -0,0 +1,13 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlUseMapDebugger as component };
+    export namespace argTypes {
+        const url: {};
+        const layer: {};
+    }
+    export { mapContextDecorator as decorators };
+}
+import MlUseMapDebugger from "./MlUseMapDebugger";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlVectorTileLayer/MlVectorTileLayer.d.ts

@@ -0,0 +1,37 @@
+import PropTypes from "prop-types";
+interface MlVectorTileLayerProps {
+    mapId?: string;
+    insertBeforeLayer?: string;
+    layerId?: string;
+    sourceOptions?: any;
+    url?: string;
+    layers?: any;
+}
+/**
+ * Adds a vector-tile source and 0...n vector-tile-layers to the MapLibre instance referenced by
+ * props.mapId
+ *
+ * @component
+ */
+declare const MlVectorTileLayer: {
+    (props: MlVectorTileLayerProps): JSX.Element;
+    propTypes: {
+        /**
+         * Id of the target MapLibre instance in mapContext
+         */
+        mapId: PropTypes.Requireable<string>;
+        /**
+         * Options object that will be used as first parameter on the MapLibreGl.addSource call see MapLibre source options documentation.
+         */
+        sourceOptions: PropTypes.Requireable<object>;
+        /**
+         * Object that hold layers
+         */
+        layers: PropTypes.Requireable<object>;
+        /**
+         * String of the URL of a wms layer
+         */
+        url: PropTypes.Requireable<string>;
+    };
+};
+export default MlVectorTileLayer;

package/dist/components/MlVectorTileLayer/MlVectorTileLayer.stories.d.ts

@@ -0,0 +1,13 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlVectorTileLayer as component };
+    export namespace argTypes {
+        const url: {};
+        const layer: {};
+    }
+    export { mapContextDecorator as decorators };
+}
+import MlVectorTileLayer from "./MlVectorTileLayer";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlVectorTileLayer/MlVectorTileLayer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/MlWmsFeatureInfoPopup/MlWmsFeatureInfoPopup.d.ts

@@ -0,0 +1,22 @@
+export default MlWmsFeatureInfoPopup;
+/**
+ * TODO: Add short & useful description
+ *
+ * @param {object} props
+ * @param {string} props.mapId Id of the target MapLibre instance in mapContext
+ *
+ * @component
+ */
+declare function MlWmsFeatureInfoPopup(props: {
+    mapId: string;
+}): JSX.Element;
+declare namespace MlWmsFeatureInfoPopup {
+    namespace defaultProps {
+        const mapId: undefined;
+    }
+    namespace propTypes {
+        const mapId_1: PropTypes.Requireable<string>;
+        export { mapId_1 as mapId };
+    }
+}
+import PropTypes from "prop-types";

package/dist/components/MlWmsFeatureInfoPopup/MlWmsFeatureInfoPopup.stories.d.ts

@@ -0,0 +1,13 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlWmsFeatureInfoPopup as component };
+    export namespace argTypes {
+        const url: {};
+        const layer: {};
+    }
+    export { mapContextDecorator as decorators };
+}
+import MlWmsFeatureInfoPopup from "./MlWmsFeatureInfoPopup";
+import mapContextDecorator from "../../decorators/MapContextDecorator";