@mapcomponents/react-maplibre 1.3.2 → 1.5.0-2

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

@@ -1,35 +0,0 @@
-import React from 'react';
-export interface MapState {
-    lat?: number;
-    lng?: number;
-    zoom?: number;
-    bearing?: number;
-    pitch?: number;
-    layers?: {
-        visible: boolean;
-        id: string;
-    }[];
-}
-/**
- * TODO: Add short & useful description
- *
- * @param {object} props
- * @param {string} props.mapId Id of the target MapLibre instance in mapContext
- *
- * @component
- */
-export interface MlShareMapStateProps {
-    mapId?: string;
-    idPrefix?: string;
-    active?: boolean;
-}
-export interface LayerStatesInterface {
-    [key: string]: boolean;
-}
-declare const MlShareMapState: {
-    (props: MlShareMapStateProps): React.JSX.Element;
-    defaultProps: {
-        mapId: undefined;
-    };
-};
-export default MlShareMapState;

package/dist/src/components/MlSketchTool/MlSketchTool.d.ts

@@ -1,50 +0,0 @@
-import React from 'react';
-import { Feature } from 'geojson';
-import { SxProps } from '@mui/system/styleFunctionSx/styleFunctionSx';
-export interface MlSketchToolProps {
-    /**
-     * Id of the target MapLibre instance in mapContext
-     */
-    mapId?: string;
-    /**
-     * 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;
-    /**
-     * Style attribute for the button-style
-     * https://mui.com/system/getting-started/the-sx-prop/
-     */
-    buttonStyleOverride?: SxProps;
-    /**
-     * Callback function that is called each time GeoJson data has changed within MlSketchTool.
-     * First parameter contains all geometries in the `geometries` prop.
-     */
-    onChange?: (para: SketchStateType) => void;
-    /**
-     * Determines whether the instruction text should be shown.
-     */
-    showInstruction?: boolean;
-    /**
-     * Callback function triggered when the "Show instructions" checkbox is toggled.
-     */
-    onShowInstructionChange?: (value: boolean) => void;
-}
-type SketchStateType = {
-    selectedGeoJson?: Feature;
-    activeGeometryIndex?: number;
-    geometries: Feature[];
-    drawMode?: keyof MapboxDraw.Modes;
-};
-/**
- * Component template
- *
- */
-declare const MlSketchTool: {
-    (props: MlSketchToolProps): React.JSX.Element;
-    defaultProps: {
-        mapId: undefined;
-        buttonStyleOverride: {};
-    };
-};
-export default MlSketchTool;

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

@@ -1,40 +0,0 @@
-import React from 'react';
-import { Feature, FeatureCollection } from 'geojson';
-/**
- * MlSpatialElevationProfile returns a Button that will add a standard OSM tile layer to the maplibre-gl instance.
- *
- * @component
- */
-interface geojson {
-    features: Feature | FeatureCollection | undefined;
-}
-export interface MlSpatialElevationProfileProps {
-    /**
-     * Id of the target MapLibre instance in mapContext
-     */
-    mapId?: string;
-    /**
-     * GeoJSON data that is supposed to be rendered by this component.
-     */
-    geojson: geojson | FeatureCollection | undefined;
-    /**
-     * Prefix of the component id this component uses when adding elements to the MapLibreGl-instance
-     */
-    idPrefix?: string;
-    /**
-     * Number describes the factor of the height of the elevation
-     */
-    elevationFactor?: number;
-    /**
-     * 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;
-}
-declare const MlSpatialElevationProfile: {
-    (props: MlSpatialElevationProfileProps): React.JSX.Element;
-    defaultProps: {
-        elevationFactor: number;
-    };
-};
-export default MlSpatialElevationProfile;

package/dist/src/components/MlSpatialElevationProfile/util/getElevationData.d.ts

@@ -1,13 +0,0 @@
-import { FeatureCollection } from 'geojson';
-interface geometry {
-    coordinates: Array<number>;
-}
-interface line {
-    geometry: geometry;
-}
-interface _geojsonInfo {
-    line: line;
-    min: number;
-}
-export default function getElevationData(_geojsonInfo: _geojsonInfo, elevationFactor: number): FeatureCollection;
-export {};

package/dist/src/components/MlTemporalController/MlTemporalController.d.ts

@@ -1,181 +0,0 @@
-import React from 'react';
-import { FeatureCollection } from 'geojson';
-import { LineLayerSpecification, CircleLayerSpecification, FillLayerSpecification, SymbolLayoutProps, SymbolPaintProps } from 'maplibre-gl';
-import { useLayerProps } from 'src/hooks/useLayer';
-export interface MlTemporalControllerProps {
-    /**
-     * Id of the target MapLibre instance in mapContext
-     */
-    mapId?: string;
-    /**
-     * 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;
-    /**
-     * GeoJSON data that is supposed to be rendered by this component.
-     */
-    geojson: FeatureCollection;
-    /**
-     * If true,the component creates and loads a MlGeoJsonLayer to show the data.
-     */
-    ownLayer?: boolean;
-    /**
-     * MapLibre attribution shown in the bottom right of the map, if this layer is visible
-     */
-    attribution?: string;
-    /**
-     * Type of the layer that will be added to the MapLibre instance.
-     * Possible values: "line", "circle", "fill"
-     */
-    type?: 'fill' | 'line' | 'circle';
-    /**
-     * Property field where the time informations is available.
-     */
-    timeField: string;
-    /**
-     * Lowest time value to be shown in the time line.
-     * By default, it is set to the lowest value in the time field.
-     */
-    minVal?: number;
-    /**
-     *When true, a label layer will be added by the component. In that case, the "labelField" propertie is mandatory.
-     */
-    label?: boolean;
-    /**
-     * Property field where the label information is available.
-     */
-    labelField?: string;
-    /**
-     * Highest time value to be shown in the time line.
-     * By default, it is set to the highest value in the time field.
-     */
-    maxVal?: number;
-    /**
-     * the value at which the component is to be loaded.
-     * If not specified, the component starts at the minimum value.
-     */
-    initialVal?: number;
-    /**
-     * When true, the features will be accumulated in the map.
-     * This option ist by default false.
-     */
-    accumulate?: boolean;
-    /**
-     * When true, the component will fit the map bounds to the shown features.
-     * This option ist by default true.
-     */
-    fitBounds?: boolean;
-    /**
-     * Boolean value that disables and enables the controls drawer.
-     */
-    showControls?: boolean;
-    /**
-     * Paint property object for the features layer.
-     * 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['paint'];
-    /**
-     * Sets the color of the features rendered by this component.
-     */
-    featuresColor?: string;
-    /**
-     * How many units the timeline runs through at each step.
-     * By default it is set to 1.
-     */
-    step?: number;
-    /**
-     *  The time between each addition to the counter, expressed in milliseconds.
-     *  By default, 200 ms.
-     */
-    interval?: number;
-    /**
-     * A numeric value that sets how many steps before the feature starts to appear.
-     * By default it is set to 5 steps.
-     */
-    fadeIn?: number;
-    /**
-     * A numeric value that sets how many steps the feature fades out after it proper time value.
-     * By default it is set to 5 steps.
-     */
-    fadeOut?: number;
-    /**
-     * Sets the color of the features rendered by this component.
-     */
-    labelColor?: string;
-    /**
-     * Layout property object, that is passed to the labels layer.
-     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#symbol
-     */
-    labelLayout?: SymbolLayoutProps;
-    /**
-     * Paint property object for the features layer.
-     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#symbol
-     */
-    labelPaint?: SymbolPaintProps;
-    /**
-     * Hover event handler that is executed whenever a geometry rendered by this component is hovered.
-     */
-    /**
-     * A numeric value that sets how many steps before the labels start to appear.
-     * By default it is set to 5 steps.
-     */
-    labelFadeIn?: number;
-    /**
-     * A numeric value that sets how many steps the labels fade out after their proper time value.
-     * By default it is set to 5 steps.
-     */
-    labelFadeOut?: number;
-    /**
-     * If true, the current time value will be displayed in the controlls panel.
-     */
-    displayCurrentValue?: boolean;
-    /**
-     * Click event handler that is executed whenever a geometry rendered by this component is clicked.
-     */
-    onClick?: useLayerProps['onClick'];
-    /**
-     * Click event handler that is executed whenever a geometry rendered by this component is hovered.
-     */
-    onHover?: useLayerProps['onHover'];
-    /**
-     * Leave event handler that is executed whenever a geometry rendered by this component is
-     * left/unhovered.
-     */
-    onLeave?: useLayerProps['onLeave'];
-    /**
-     * Callback function defined by the user to recive the current time value and paint property in the parent component.
-     */
-    onStateChange?: React.Dispatch<React.SetStateAction<TemporalControllerValues | undefined>>;
-}
-/**
- * Select a GeoJSON object to be displayed in a temporal line.
- *@component
- */
-export interface TemporalControllerValues {
-    current: number;
-    paint: CircleLayerSpecification['paint'] | FillLayerSpecification['paint'] | LineLayerSpecification['paint'];
-}
-declare const MlTemporalController: {
-    (props: MlTemporalControllerProps): React.JSX.Element;
-    defaultProps: {
-        mapId: undefined;
-        ownLayer: boolean;
-        type: string;
-        step: number;
-        interval: number;
-        fadeIn: number;
-        fadeOut: number;
-        labelFadeIn: number;
-        labelFadeOut: number;
-        accumulate: boolean;
-        fitBounds: boolean;
-        label: boolean;
-        attribution: string;
-        displayCurrentValue: boolean;
-    };
-};
-export default MlTemporalController;

package/dist/src/components/MlTemporalController/utils/MlTemporalControllerLabels.d.ts

@@ -1,20 +0,0 @@
-import React from 'react';
-import { SymbolLayerSpecification, SymbolLayoutProps } from 'maplibre-gl';
-import { FeatureCollection } from 'geojson';
-interface MlTemporalControllerLabelsProps {
-    data: FeatureCollection;
-    currentVal: number;
-    fadeIn: number;
-    fadeOut: number;
-    step: number;
-    labelField: string;
-    labelColor: string;
-    timeField: string;
-    minVal: number;
-    accumulate: boolean;
-    isPlaying: boolean;
-    labelLayout?: SymbolLayoutProps;
-    labelPaint?: SymbolLayerSpecification;
-}
-export default function MlTemporalControllerLabels(props: MlTemporalControllerLabelsProps): React.JSX.Element;
-export {};

package/dist/src/components/MlTemporalController/utils/TemporalControllerPlayer.d.ts

@@ -1,22 +0,0 @@
-import React from 'react';
-export interface TemporalControllerPlayerProps {
-    currentVal: number;
-    isPlaying: boolean;
-    step: number;
-    interval: number;
-    minVal: number;
-    maxVal: number;
-    returnCurrent: React.Dispatch<React.SetStateAction<number>>;
-    returnPlaying: React.Dispatch<React.SetStateAction<boolean>>;
-    fadeIn: number;
-    open: boolean;
-    fadeOut: number;
-    featuresColor: string;
-    labels: boolean;
-    labelColor: string;
-    labelFadeIn: number;
-    labelFadeOut: number;
-    accumulate: boolean;
-    display: boolean;
-}
-export default function TemporalControllerPlayer(props: TemporalControllerPlayerProps): React.JSX.Element;

package/dist/src/components/MlTemporalController/utils/paintPicker.d.ts

@@ -1,59 +0,0 @@
-import { LineLayerSpecification, CircleLayerSpecification, FillLayerSpecification } from 'maplibre-gl';
-interface paintPickerProps {
-    type: 'fill' | 'line' | 'circle' | undefined;
-    timeField: string;
-    currentVal: number;
-    minVal: number;
-    isPlaying: boolean;
-    fadeIn: number;
-    fadeOut: number;
-    step: number;
-    featuresColor: string;
-    accumulate: boolean;
-    userPaint: CircleLayerSpecification['paint'] | FillLayerSpecification['paint'] | LineLayerSpecification['paint'];
-}
-export default function paintPicker(props: paintPickerProps): {
-    "circle-radius"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<number>;
-    "circle-color"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<import("maplibre-gl").ColorSpecification>;
-    "circle-blur"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<number>;
-    "circle-opacity"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<number>;
-    "circle-translate"?: import("maplibre-gl").PropertyValueSpecification<[number, number]>;
-    "circle-translate-anchor"?: import("maplibre-gl").PropertyValueSpecification<"map" | "viewport">;
-    "circle-pitch-scale"?: import("maplibre-gl").PropertyValueSpecification<"map" | "viewport">;
-    "circle-pitch-alignment"?: import("maplibre-gl").PropertyValueSpecification<"map" | "viewport">;
-    "circle-stroke-width"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<number>;
-    "circle-stroke-color"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<import("maplibre-gl").ColorSpecification>;
-    "circle-stroke-opacity"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<number>;
-} | {
-    "fill-antialias"?: import("maplibre-gl").PropertyValueSpecification<boolean>;
-    "fill-opacity"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<number>;
-    "fill-color"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<import("maplibre-gl").ColorSpecification>;
-    "fill-outline-color"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<import("maplibre-gl").ColorSpecification>;
-    "fill-translate"?: import("maplibre-gl").PropertyValueSpecification<[number, number]>;
-    "fill-translate-anchor"?: import("maplibre-gl").PropertyValueSpecification<"map" | "viewport">;
-    "fill-pattern"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<import("maplibre-gl").ResolvedImageSpecification>;
-} | {
-    "line-opacity"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<number>;
-    "line-color"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<import("maplibre-gl").ColorSpecification>;
-    "line-translate"?: import("maplibre-gl").PropertyValueSpecification<[number, number]>;
-    "line-translate-anchor"?: import("maplibre-gl").PropertyValueSpecification<"map" | "viewport">;
-    "line-width"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<number>;
-    "line-gap-width"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<number>;
-    "line-offset"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<number>;
-    "line-blur"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<number>;
-    "line-dasharray"?: import("maplibre-gl").PropertyValueSpecification<Array<number>>;
-    "line-pattern"?: import("maplibre-gl").DataDrivenPropertyValueSpecification<import("maplibre-gl").ResolvedImageSpecification>;
-    "line-gradient"?: import("maplibre-gl").ExpressionSpecification;
-} | {
-    'circle-color': string;
-} | {
-    'fill-color': string;
-    'fill-outline-color': string;
-} | {
-    'line-color': string;
-} | {
-    'fill-color': string;
-    'fill-opacity': (string | number | string[])[];
-    'fill-outline-color': (string | number | string[])[];
-};
-export {};

package/dist/src/components/MlTemporalController/utils/useFilterData.d.ts

@@ -1,14 +0,0 @@
-import { FeatureCollection } from 'geojson';
-export interface useTemporalControllerProps {
-    geojson: FeatureCollection;
-    timeField: string;
-    initialVal?: number;
-    minVal?: number;
-    maxVal?: number;
-    mapId: string | undefined;
-}
-export default function useFilterData(props: useTemporalControllerProps): {
-    filteredData: FeatureCollection<import("geojson").Geometry, import("geojson").GeoJsonProperties> | undefined;
-    minVal: any;
-    maxVal: any;
-};

package/dist/src/components/MlTerrainLayer/MlTerrainLayer.d.ts

@@ -1,28 +0,0 @@
-import React from 'react';
-import { TerrainSpecification } from 'maplibre-gl';
-interface MlTerrainLayerProps {
-    /**
-     * Id of the target MapLibre instance in mapContext
-     */
-    mapId?: string;
-    /**
-     * Source of tiles with possibles options
-     */
-    sourceOptions?: object;
-    /**
-     * Options for new exaggeration value
-     */
-    terrainOptions?: TerrainSpecification;
-}
-export type { MlTerrainLayerProps };
-/**
- * Create Terrain Layer Component
- *
- */
-declare const MlTerrainLayer: {
-    (props: MlTerrainLayerProps): React.JSX.Element;
-    defaultProps: {
-        mapId: undefined;
-    };
-};
-export default MlTerrainLayer;

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

@@ -1,13 +0,0 @@
-import React from 'react';
-/**
- * Renders obj or gltf 3D Models on the MapLibreMap referenced by props.mapId
- *
- * @component
- */
-export interface MlThreeJsLayerProps {
-    mapId?: string;
-    init?: () => void;
-    onDone?: () => void;
-}
-declare const MlThreeJsLayer: (props: MlThreeJsLayerProps) => React.JSX.Element;
-export default MlThreeJsLayer;

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

@@ -1,12 +0,0 @@
-import React from 'react';
-import { Feature, FeatureCollection } from 'geojson';
-import { MlGeoJsonLayerProps } from '../MlGeoJsonLayer/MlGeoJsonLayer';
-export type MlTransitionGeoJsonLayerProps = MlGeoJsonLayerProps & {
-    transitionTime?: number;
-    geojson?: Feature | FeatureCollection | null;
-};
-/**
- * Adds source and layer of types "line", "fill" or "circle" to display GeoJSON data on the map.
- */
-declare const MlTransitionGeoJsonLayer: (props: MlTransitionGeoJsonLayerProps) => React.JSX.Element;
-export default MlTransitionGeoJsonLayer;

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

@@ -1,21 +0,0 @@
-import { FC } from 'react';
-export interface MlUseMapDebuggerProps {
-    mapId?: string;
-    watch?: string[];
-    filter?: {
-        [key: string]: any;
-    };
-}
-type MlUseMapDebuggerComponent = FC<MlUseMapDebuggerProps> & {
-    defaultProps: MlUseMapDebuggerProps;
-};
-/**
- * Renders a collapsible top-drawer containing live map debug information
- *
- * @param {MlUseMapDebuggerProps} props
- * @param {string} props.mapId Id of the target MapLibre instance in mapContext
- *
- * @component
- */
-declare const MlUseMapDebugger: MlUseMapDebuggerComponent;
-export default MlUseMapDebugger;

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

@@ -1,22 +0,0 @@
-import React from 'react';
-import { LayerSpecification } from 'maplibre-gl';
-import { VectorSourceSpecification } from 'maplibre-gl';
-export type ExtendedLayerSpecification = LayerSpecification & {
-    masterVisible?: boolean;
-};
-export type MlVectorTileLayerProps = {
-    mapId?: string;
-    insertBeforeLayer?: string;
-    layerId?: string;
-    sourceOptions?: VectorSourceSpecification;
-    url?: string;
-    layers: ExtendedLayerSpecification[];
-};
-/**
- * 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) => React.JSX.Element;
-export default MlVectorTileLayer;

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

@@ -1,22 +0,0 @@
-import React from "react";
-export interface MlWmsFeatureInfoPopupProps {
-    /**
-     * Id of the target MapLibre instance in mapContext
-     */
-    mapId?: string;
-}
-/**
- * TODO: Add short & useful description
- *
- * @param {object} props
- * @param {string} props.mapId Id of the target MapLibre instance in mapContext
- *
- * @component
- */
-declare const MlWmsFeatureInfoPopup: {
-    (props: MlWmsFeatureInfoPopupProps): React.JSX.Element;
-    defaultProps: {
-        mapId: undefined;
-    };
-};
-export default MlWmsFeatureInfoPopup;

package/dist/src/components/MlWmsLayer/MlWmsLayer.d.ts

@@ -1,58 +0,0 @@
-import React from 'react';
-import { RasterLayerSpecification, RasterSourceSpecification } from 'maplibre-gl';
-export interface MlWmsLayerProps {
-    urlParameters?: {
-        [key: string]: string;
-    };
-    url: string;
-    visible?: boolean;
-    attribution?: string;
-    mapId?: string;
-    sourceOptions?: RasterSourceSpecification;
-    layerOptions?: RasterLayerSpecification;
-    insertBeforeLayer?: string;
-    layerId?: string;
-}
-/**
- * Adds a WMS raster source & layer to the maplibre-gl instance
- *
- * @param {object} props
- * @param {object} props.urlParameters URL query parameters that will be added to the WMS URL. A layers property (string) is mandatory. Any value defined on this attribute will extend the default object
- * @param {string} props.url WMS URL
- * @param {bool}	 props.visible Sets layer "visibility" property to "visible" if true or "none" if false
- * @param {string} props.attribution MapLibre attribution shown in the bottom right of the map, if this layer is visible
- * @param {string} props.mapId Id of the target MapLibre instance in mapContext
- * @param {object} props.sourceOptions Object that is passed to the MapLibre.addSource call as config option parameter
- * @param {object} props.layerOptions Object that is passed to the MapLibre.addLayer call as config option parameter
- * @param {string} props.insertBeforeLayer 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
- *
- * @component
- */
-declare const MlWmsLayer: {
-    (props: MlWmsLayerProps): React.JSX.Element;
-    defaultProps: {
-        visible: boolean;
-        urlParameters: {
-            bbox: string;
-            format: string;
-            service: string;
-            version: string;
-            request: string;
-            srs: string;
-            width: number;
-            height: number;
-            styles: string;
-        };
-        attribution: string;
-        sourceOptions: {
-            minZoom: number;
-            maxZoom: number;
-        };
-        layerOptions: {
-            minZoom: number;
-            maxZoom: number;
-        };
-    };
-};
-export default MlWmsLayer;