POLAR reference
    Preparing search index...

    Interface ZoomPluginOptions

    Plugin options for zoom plugin.

    interface ZoomPluginOptions {
        displayComponent?: boolean;
        icons?: ZoomIconOptions;
        layoutTag?:
            | "TOP_LEFT"
            | "TOP_MIDDLE"
            | "TOP_RIGHT"
            | "MIDDLE_LEFT"
            | "MIDDLE_MIDDLE"
            | "MIDDLE_RIGHT"
            | "BOTTOM_LEFT"
            | "BOTTOM_MIDDLE"
            | "BOTTOM_RIGHT";
        renderType?: "iconMenu"
        | "independent";
        showMobile?: boolean;
        showZoomSlider?: boolean;
    }

    Hierarchy (View Summary)

    Index
    displayComponent? icons? layoutTag? renderType? showMobile? showZoomSlider?
    displayComponent?: boolean

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

    false

    icons?: ZoomIconOptions

    Override the default icons for the zoom buttons.

    { zoomIn: 'kern-icon--zoom-in', zoomOut: 'kern-icon--zoom-out' }

    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"

    Render type.

    'independent'

    showMobile?: boolean

    Defines if the zoom buttons and slider should be visible on small devices.

    false

    showZoomSlider?: boolean

    Defines if a zoom slider is offered in addition to the zoom buttons. The zoom slider is (regardless of this setting) only displayed if there is enough space.

    false

    Settings
    Member Visibility

    On This Page
    Properties