POLAR reference
    Preparing search index...

    Interface IconMenuPluginOptions

    Plugin options for iconMenu plugin.

    interface IconMenuPluginOptions {
        menus: Menu[][];
        buttonComponent?: Component;
        displayComponent?: boolean;
        focusInitiallyOpen?: string;
        focusMenus?: (Menu & { icon: string })[];
        initiallyOpen?: string;
        layoutTag?:
            | "TOP_LEFT"
            | "TOP_MIDDLE"
            | "TOP_RIGHT"
            | "MIDDLE_LEFT"
            | "MIDDLE_MIDDLE"
            | "MIDDLE_RIGHT"
            | "BOTTOM_LEFT"
            | "BOTTOM_MIDDLE"
            | "BOTTOM_RIGHT";
    }

    Hierarchy (View Summary)

    Index

    Properties

    menus buttonComponent? displayComponent? focusInitiallyOpen? focusMenus? initiallyOpen? layoutTag?

    Properties

    menus: Menu[][]

    Defines which plugins should be rendered as part of the icon menu. If MapConfiguration.layout | mapConfiguration.layers is set to 'standard', multiple groups can be added through different arrays to differentiate plugins visually. Using multiple groups (arrays) doesn't yield any change if MapConfiguration.layout | mapConfiguration.layers is set to 'nineRegions'.

    {
      initiallyOpen: 'draw',
      displayComponent: true,
      menus: [
        [
          {
            plugin: PolarPluginFullscreen({}),
            icon: 'kern-icon--fullscreen',
            id: 'fullscreen',
          },
          {
            plugin: PolarPluginDraw({}),
            icon: 'kern-icon-fill--draw',
            id: 'draw',
            hint: 'Draw or write something on the map'
          },
        ]
      ]
    }
    buttonComponent?: Component

    If MapConfiguration.layout | mapConfiguration.layers is set to 'nineRegions', then this parameter allows overriding the IconMenuButton.vue component for custom design and functionality. Coding knowledge is required to use this feature, as any implementation will have to rely upon the Pinia store model and has to implement the same props as the default IconMenuButton.vue. Please refer to the implementation.

    displayComponent?: boolean
    focusInitiallyOpen?: string

    ID of the plugin which should be open on start in the focusMenu.

    Only applicable if the device doesn't have a small display.

    focusMenus?: (Menu & { icon: string })[]

    If MapConfiguration.layout | mapConfiguration.layers is set to 'standard', a second menu that includes the hints as labels of the buttons is being displayed at the bottom of the map.

    Content is shown in the top left corner.

    Plugins like GeoLocation can not be added here, as only plugins containing content are allowed.

    initiallyOpen?: string

    ID of the plugin which should be open on start.

    Only applicable if the device doesn't have a small display.

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

    If MapConfiguration.layout | mapConfiguration.layers is set to 'nineRegions', then this parameter declares the positioning of the IconMenu. However, if buttonComponent is not set, then only "TOP_RIGHT" is allowed as value.

    Settings

    Member Visibility

    On This Page

    Properties