POLAR reference
    Preparing search index...

    Interface LoadingIndicatorOptions

    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 LoadingIndicatorOptions {
        displayComponent?: boolean;
        layoutTag?:
            | "TOP_LEFT"
            | "TOP_MIDDLE"
            | "TOP_RIGHT"
            | "MIDDLE_LEFT"
            | "MIDDLE_MIDDLE"
            | "MIDDLE_RIGHT"
            | "BOTTOM_LEFT"
            | "BOTTOM_MIDDLE"
            | "BOTTOM_RIGHT";
        loaderStyle?: | "KernLoader"
        | "BasicLoader"
        | "RingLoader"
        | "RollerLoader"
        | "CircleLoader"
        | "SpinnerLoader"
        | null;
    }

    Hierarchy (View Summary)

    Index
    displayComponent? layoutTag? loaderStyle?
    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.

    loaderStyle?:
        | "KernLoader"
        | "BasicLoader"
        | "RingLoader"
        | "RollerLoader"
        | "CircleLoader"
        | "SpinnerLoader"
        | null

    Choose between different loader styles.

    Supported options:

    KernLoader
    KernLoader
    		 BasicLoader
    BasicLoader
    		 RingLoader
    RingLoader
    RollerLoader
    RollerLoader
    		 CircleLoader
    CircleLoader
    		 SpinnerLoader
    SpinnerLoader

    It is also possible to choose null as a loaderStyle to hide the loader.

    'KernLoader'

    Settings
    Member Visibility

    On This Page
    Custom Plugin Positioning
    Properties