POLAR reference
    Preparing search index...

    Interface ScalePluginOptions

    Generic options for all plugins

    interface ScalePluginOptions {
        displayComponent?: boolean;
        layoutTag?:
            | "TOP_LEFT"
            | "TOP_MIDDLE"
            | "TOP_RIGHT"
            | "MIDDLE_LEFT"
            | "MIDDLE_MIDDLE"
            | "MIDDLE_RIGHT"
            | "BOTTOM_LEFT"
            | "BOTTOM_MIDDLE"
            | "BOTTOM_RIGHT";
        renderType?: "iconMenu"
        | "independent";
        showScaleSwitcher?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    displayComponent? layoutTag? renderType? showScaleSwitcher?

    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'

    showScaleSwitcher?: boolean

    If set to true, the 1 : x text will be replaced with a select element that allows switching between scale values. Requires the configuration parameter MapConfiguration.options to be set.

    false

    Settings

    Member Visibility

    On This Page

    Properties