POLAR reference
    Preparing search index...

    Interface ReverseGeocoderPluginOptions

    Plugin options for reverse geocoder plugin.

    interface ReverseGeocoderPluginOptions {
        url: string;
        addressTarget?: StoreReference;
        coordinateSources?: StoreReference[];
        displayComponent?: boolean;
        layoutTag?:
            | "TOP_LEFT"
            | "TOP_MIDDLE"
            | "TOP_RIGHT"
            | "MIDDLE_LEFT"
            | "MIDDLE_MIDDLE"
            | "MIDDLE_RIGHT"
            | "BOTTOM_LEFT"
            | "BOTTOM_MIDDLE"
            | "BOTTOM_RIGHT";
        renderType?: "iconMenu"
        | "independent";
        zoomTo?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    url addressTarget? coordinateSources? displayComponent? layoutTag? renderType? zoomTo?

    Properties

    url: string

    URL of a WPS service to use for reverse geocoding.

    addressTarget?: StoreReference

    Store state parameter that should receive the result of the reverse geocoding.

    coordinateSources?: StoreReference[]

    Array of store fields that contain a coordinate. If a coordinate is refreshed, reverse geocoding for that coordinate is done automatically.

    displayComponent?: boolean

    Should the component be visible at all.

    false

    layoutTag?:
        | "TOP_LEFT"
        | "TOP_MIDDLE"
        | "TOP_RIGHT"
        | "MIDDLE_LEFT"
        | "MIDDLE_MIDDLE"
        | "MIDDLE_RIGHT"
        | "BOTTOM_LEFT"
        | "BOTTOM_MIDDLE"
        | "BOTTOM_RIGHT"

    The region where the plugin should be rendered. Required for nine-regions layout, ignored otherwise.

    renderType?: "iconMenu" | "independent"

    Defines if the plugin is rendered independent or as part of the icon menu. This is automatically set by the icon menu; you should not need to touch this.

    'independent'

    zoomTo?: number

    Zoom level to zoom to when a successful answer was received.

    Settings

    Member Visibility

    On This Page

    Properties