POLAR reference
    Preparing search index...

    Interface ScalePluginOptions

    Generic options for all plugins.

    There are two implemented layouting systems in POLAR configured by MapConfiguration.layout.

    If layout is set to 'nineRegions' all plugins are placed in a predefined region grid. Use displayComponent to control visibility and layoutTag to specify the target region.

    If layout is set to 'standard', a plugin can be rendered in one of two ways:

    1. As part of the IconMenu: Configure the plugin in the IconMenu's IconMenuPluginOptions.menus | menus configuration. The IconMenu will handle positioning and rendering the plugin at the designated location.
    2. Independent with CSS positioning: Directly add the plugin with addPlugin. The plugin is responsible for its own positioning using CSS (e.g., position: absolute) within the map container.
    interface ScalePluginOptions {
        displayComponent?: boolean;
        layoutTag?:
            | "TOP_LEFT"
            | "TOP_MIDDLE"
            | "TOP_RIGHT"
            | "MIDDLE_LEFT"
            | "MIDDLE_MIDDLE"
            | "MIDDLE_RIGHT"
            | "BOTTOM_LEFT"
            | "BOTTOM_MIDDLE"
            | "BOTTOM_RIGHT";
        showScaleSwitcher?: boolean;
    }

    Hierarchy (View Summary)

    Index
    displayComponent? layoutTag? showScaleSwitcher?
    displayComponent?: boolean

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

    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 if MapConfiguration.layout | layout is set to 'nineRegions', ignored otherwise.

    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
    Custom Plugin Positioning
    Properties