@maplibre/maplibre-gl-inspect
    Preparing search index...

    Type Alias MaplibreInspectOptions

    This is the main type for the available options for MapLibre Inspect

    type MaplibreInspectOptions = {
        assignLayerColor?: (layerId: string, alpha: number) => string;
        backgroundColor?: string;
        blockHoverPopupOnClick?: boolean;
        buildInspectStyle?: (
            originalMapStyle: StyleSpecification,
            coloredLayers: LayerSpecification[],
            opts: { backgroundColor?: string },
        ) => StyleSpecification;
        popup?: Popup;
        queryParameters?: QueryRenderedFeaturesOptions;
        renderPopup?: (
            features: GeoJSONFeatureWithSourceLayer[],
        ) => string | HTMLElement;
        selectThreshold?: number;
        showInspectButton?: boolean;
        showInspectMap?: boolean;
        showInspectMapPopup?: boolean;
        showInspectMapPopupOnHover?: boolean;
        showMapPopup?: boolean;
        showMapPopupOnHover?: boolean;
        sources?: { [key: string]: string[] };
        toggleCallback?: (showInspectMap: boolean) => void;
        useInspectStyle?: boolean;
    }
    Index

    Properties

    assignLayerColor? backgroundColor? blockHoverPopupOnClick? buildInspectStyle? popup? queryParameters? renderPopup? selectThreshold? showInspectButton? showInspectMap? showInspectMapPopup? showInspectMapPopupOnHover? showMapPopup? showMapPopupOnHover? sources? toggleCallback? useInspectStyle?

    Properties

    assignLayerColor?: (layerId: string, alpha: number) => string
    backgroundColor?: string

    Background color for the inspect map

    '#fff'
    blockHoverPopupOnClick?: boolean

    Block hover popup on click

    false
    buildInspectStyle?: (
        originalMapStyle: StyleSpecification,
        coloredLayers: LayerSpecification[],
        opts: { backgroundColor?: string },
    ) => StyleSpecification
    popup?: Popup

    Maplibre GL Popup

    queryParameters?: QueryRenderedFeaturesOptions

    Query parameters for querying rendered features

    renderPopup?: (
        features: GeoJSONFeatureWithSourceLayer[],
    ) => string | HTMLElement
    selectThreshold?: number

    Select threshold

    5
    showInspectButton?: boolean

    Show the inspect button

    true
    showInspectMap?: boolean

    Show the inspect map

    false
    showInspectMapPopup?: boolean

    Show the inspect map popup

    true
    showInspectMapPopupOnHover?: boolean

    Show the inspect map popup on hover

    true
    showMapPopup?: boolean

    Show the map popup

    false
    showMapPopupOnHover?: boolean

    Show the map popup on hover

    true
    sources?: { [key: string]: string[] }

    Sources to be used for inspecting, setting this will disable the automatic source detection. This is a dictionary containing the source IDs and their vector layer IDs

    toggleCallback?: (showInspectMap: boolean) => void

    Callback for toggling the inspect map

    useInspectStyle?: boolean

    Use inspect style

    true

    Settings

    Member Visibility

    On This Page

    Properties