POLAR reference
    Preparing search index...

    Interface PinsPluginOptions

    Plugin options for pins plugin.

    interface PinsPluginOptions {
        boundary?: BoundaryOptions;
        coordinateSources?: { getterName: string; pluginName: PluginId }[];
        displayComponent?: boolean;
        initial?: InitialPin;
        layoutTag?:
            | "TOP_LEFT"
            | "TOP_MIDDLE"
            | "TOP_RIGHT"
            | "MIDDLE_LEFT"
            | "MIDDLE_MIDDLE"
            | "MIDDLE_RIGHT"
            | "BOTTOM_LEFT"
            | "BOTTOM_MIDDLE"
            | "BOTTOM_RIGHT";
        minZoomLevel?: number;
        movable?: PinMovable;
        renderType?: "iconMenu"
        | "independent";
        style?: PinStyle;
        toZoomLevel?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    boundary? coordinateSources? displayComponent? initial? layoutTag? minZoomLevel? movable? renderType? style? toZoomLevel?

    Properties

    boundary?: BoundaryOptions

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

    If

    {
      layerId: 'hamburgBorder',
    }
    coordinateSources?: { getterName: string; pluginName: PluginId }[]

    The pins plugin may react to changes in other plugins. This parameter specifies the paths to such store positions.

    The position must, when subscribed to, return a GeoJSON feature.

    Please mind that, when referencing another plugin, that plugin must be added through addPlugin before this plugin for the connection to work.

    [{
      pluginName: 'addressSearch',
      getterName: 'chosenAddress'
    }]
    displayComponent?: boolean

    Should the component be visible at all.

    false

    initial?: InitialPin

    Configuration options for setting an initial pin.

    {
      coordinate: [611694.909470, 5975658.233007],
      centerOn: true,
      epsg: 'EPSG:25832'
    }
    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.

    minZoomLevel?: number

    Minimum zoom level for sensible marking.

    0
    movable?: PinMovable

    Whether a user may drag and re-click the pin ('drag'), only re-click it ('click') or may only be placed programmatically ('none').

    'none'
    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'

    style?: PinStyle

    Display style configuration.

    toZoomLevel?: number

    Zoom level to use on outside input by e.g. address search.

    0

    Settings

    Member Visibility

    On This Page

    Properties