POLAR reference
    Preparing search index...

    Interface FullscreenPluginOptions

    Plugin options for fullscreen plugin.

    interface FullscreenPluginOptions {
        displayComponent?: boolean;
        layoutTag?:
            | "TOP_LEFT"
            | "TOP_MIDDLE"
            | "TOP_RIGHT"
            | "MIDDLE_LEFT"
            | "MIDDLE_MIDDLE"
            | "MIDDLE_RIGHT"
            | "BOTTOM_LEFT"
            | "BOTTOM_MIDDLE"
            | "BOTTOM_RIGHT";
        renderType?: "iconMenu"
        | "independent";
        targetContainer?: string | HTMLElement;
    }

    Hierarchy (View Summary)

    Index

    Properties

    displayComponent? layoutTag? renderType? targetContainer?

    Properties

    displayComponent?: boolean

    Should the component be visible at all.

    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 for nine-regions layout, ignored otherwise.

    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'

    targetContainer?: string | HTMLElement

    Defines the target container to show in fullscreen mode. This defaults to the web component (i.e., the map with its plugin controls).

    If a string is provided, it is interpreted as the id of an HTMLElement which is searched by document.getElementById. For usage within Shadow DOMs, please provide the HTMLElement itself.

    Settings

    Member Visibility

    On This Page

    Properties