POLAR reference
    Preparing search index...

    Interface GeoLocationPluginOptions

    Plugin options for geoLocation plugin.

    interface GeoLocationPluginOptions {
        boundary?: BoundaryOptions;
        checkLocationInitially?: boolean;
        displayComponent?: boolean;
        keepCentered?: boolean;
        layoutTag?:
            | "TOP_LEFT"
            | "TOP_MIDDLE"
            | "TOP_RIGHT"
            | "MIDDLE_LEFT"
            | "MIDDLE_MIDDLE"
            | "MIDDLE_RIGHT"
            | "BOTTOM_LEFT"
            | "BOTTOM_MIDDLE"
            | "BOTTOM_RIGHT";
        renderType?: "iconMenu"
        | "independent";
        showTooltip?: boolean;
        zoomLevel?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    boundary? checkLocationInitially? displayComponent? keepCentered? layoutTag? renderType? showTooltip? zoomLevel?

    Properties

    boundary?: BoundaryOptions

    Set to check whether something should be restricted to an area defined by a layer.

    If

    {
      layerId: 'hamburgBorder',
    }
    checkLocationInitially?: boolean

    If true, the location check will be run on map start-up. If false, the feature has to be triggered with a button press by the user.

    false

    displayComponent?: boolean

    Should the component be visible at all. Only relevant if MapConfiguration.layout | layout is set to 'nineRegions'.

    false

    keepCentered?: boolean

    If true, the map will re-center on the user on any position change. This effectively hinders map panning on moving devices.

    If false, only the first position will be centered on.

    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 if MapConfiguration.layout | layout is set to 'nineRegions', ignored otherwise.

    renderType?: "iconMenu" | "independent"

    Defines if the geoLocation button is rendered independent or as part of the icon menu.

    This is only applicable if the layout is 'nineRegions'.

    'independent'

    showTooltip?: boolean

    If set to true, a tooltip will be shown when hovering the geoposition marker on the map, indicating that it shows the user's position.

    false

    zoomLevel?: number

    Zoom level to zoom to on geolocating the user and panning to the position.

    7

    Settings

    Member Visibility

    On This Page

    Properties