POLAR reference
    Preparing search index...

    Interface FooterPluginOptions

    Plugin options for footer plugin.

    interface FooterPluginOptions {
        leftEntries: PluginContainer[];
        rightEntries: PluginContainer[];
        displayComponent?: boolean;
        layoutTag?:
            | "TOP_LEFT"
            | "TOP_MIDDLE"
            | "TOP_RIGHT"
            | "MIDDLE_LEFT"
            | "MIDDLE_MIDDLE"
            | "MIDDLE_RIGHT"
            | "BOTTOM_LEFT"
            | "BOTTOM_MIDDLE"
            | "BOTTOM_RIGHT";
    }

    Hierarchy (View Summary)

    Index

    Properties

    leftEntries rightEntries displayComponent? layoutTag?

    Properties

    leftEntries: PluginContainer[]

    Plugins that are going to be directly rendered on the left side of the footer.

    rightEntries: PluginContainer[]

    Plugins that are going to be directly rendered on the right side of the footer.

    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.

    Settings

    Member Visibility

    On This Page

    Properties