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

    Properties

    displayComponent? icons? layoutTag? renderType? showMobile? showZoomSlider?

    Properties

    displayComponent?: boolean
    icons?: ZoomIconOptions

    Override the default icons for the zoom buttons.

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

    Render type.

    'independent'

    showMobile?: boolean

    Defines if the zoom buttons 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 offered if there is enough space.

    false

    Settings

    Member Visibility

    On This Page

    Properties