@maptiler/geocoding-control/dist/src/controls/leaflet-options.d.ts

The Javascript & TypeScript Map Control component for MapTiler Geocoding service. Easy to be integrated into any JavaScript mapping application.

import { ControlOptions, Map as LMap, Marker, MarkerOptions, PathOptions, StyleFunction, ZoomPanOptions } from 'leaflet';
import { MaptilerGeocoderOptions } from '../geocoder/geocoder-options';
import { Feature, FlyToFeatures, PickedResultStyle } from '../types';
export type LeafletGeocodingControlOptions = Omit<MaptilerGeocoderOptions, "fetchFullGeometryOnPick"> & {
    /**
     * Marker to be added to the map at the location of the user-selected result using a default set of Marker options.
     *
     * - If `true` or `undefined` then a default marker will be used.
     * - If the value is a [MarkerOptions](https://leafletjs.com/reference.html#marker-option) then the marker will be constructed using these options.
     * - If the value is a function then it can return instance of the [Marker](https://leafletjs.com/reference.html#marker).
     *   Function can accept `Feature` as a parameter which is `undefined` for the reverse location marker.
     * - If `false` or `null` then no marker will be added to the map.
     *
     * Default value is `true`.
     */
    marker?: null | boolean | MarkerOptions | ((map: LMap, feature?: Feature) => undefined | null | Marker);
    /**
     * Displays a marker on the selected feature from the result list. `marker` must be enabled in any way for this to display.
     *
     * Default: `true`.
     */
    markerOnSelected?: boolean;
    /**
     * Marker be added to the map at the location the geocoding results.
     *
     * - If `true` or `undefined` then a default marker will be used.
     * - If the value is a [MarkerOptions](https://leafletjs.com/reference.html#marker-option) then the marker will be constructed using these options.
     * - If the value is a function then it can return instance of the [Marker](https://leafletjs.com/reference.html#marker).
     *   In this case the default pop-up won't be added to the marker.
     *   Function can accept `Feature` as a parameter.
     * - If `false` or `null` then no marker will be added to the map.
     *
     * Default value is `true`.
     */
    showResultMarkers?: null | boolean | MarkerOptions | ((map: LMap, feature: Feature) => undefined | null | Marker);
    /**
     * Animation to picked feature on the map.
     *
     * - If `false` or `null` then animating the map to a selected result is disabled.
     * - If `true` or `undefined` then animating the map will use the default animation parameters.
     * - If the value is [ZoomPanOptions](https://leafletjs.com/reference.html#zoom/pan-options)
     *     then it will be passed as options to the map [flyTo](https://leafletjs.com/reference.html#map-flyto)
     *     or [fitBounds](https://leafletjs.com/reference.html#map-fitbounds) method providing control over the animation of the transition.
     *
     * Default value is `true`.
     */
    flyTo?: null | boolean | ZoomPanOptions;
    /**
     * Specifies if found features (shown in result list) should be also animated to on the map. `flyTo` muset be enabled in any way for this to have any effect.
     *
     * - If `false` or `"never"` then animating the map to found features is disabled.
     * - If `true` or `"always"` then animating the map to found features is enabled.
     * - If `"external"` then animating the map to found features is enabled only when explicitly calling `setQuery` or `submitQuery` methods.
     *
     * Default: `"external"`.
     */
    flyToFeatures?: boolean | FlyToFeatures;
    /**
     * Specifies if selected (not picked) feature should be also animated to on the map.
     *
     * Default: `false`.
     */
    flyToSelected?: boolean;
    /**
     * Style for full feature geometry GeoJSON.
     *
     * - If `false` or `null` then no full geometry is drawn.
     * - If `true` or `undefined` then default-styled full geometry is drawn.
     * - If an T then it must represent the style and will be used to style the full geometry.
     *
     * Default is the default style.
     */
    fullGeometryStyle?: null | boolean | PathOptions | StyleFunction;
    /**
     * Style of the picked result on the map:
     * - `"marker-only"`: Show only a marker at the center of the feature.
     * - `"full-geometry"`: Display the full feature geometry.
     * - `"full-geometry-including-polygon-center-marker"`: Display full geometry with a marker at the polygon center.
     *
     * Default: `"full-geometry"`.
     */
    pickedResultStyle?: PickedResultStyle;
    /**
     * Specifies the zoom level to animate the map to for a geocoded result when no bounding box is present or when the result is a point.
     * If a bounding box is present and not a point, the map will fit to the bounding box.
     *
     * Values are key-value pairs where the key is a `<type>` or `<type>.<category>` and the value is the zoom level.
     *
     * Default: `ZOOM_DEFAULTS`.
     */
    zoom?: Record<string, number>;
} & ControlOptions;
export declare const ZOOM_DEFAULTS: Record<string, number>;
export declare const DEFAULT_GEOMETRY_STYLE: StyleFunction;