POLAR reference
    Preparing search index...

    Interface ExportPluginOptions

    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 ExportPluginOptions {
        displayComponent?: boolean;
        download?: boolean;
        formats?: ("jpg" | "jpeg" | "pdf" | "png")[];
        layoutTag?:
            | "TOP_LEFT"
            | "TOP_MIDDLE"
            | "TOP_RIGHT"
            | "MIDDLE_LEFT"
            | "MIDDLE_MIDDLE"
            | "MIDDLE_RIGHT"
            | "BOTTOM_LEFT"
            | "BOTTOM_MIDDLE"
            | "BOTTOM_RIGHT";
    }

    Hierarchy (View Summary)

    Index
    displayComponent? download? formats? layoutTag?
    displayComponent?: boolean

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

    false

    download?: boolean

    If true, the screenshot will be both stored in the store and offered as a download to the user. If false, it will only be stored – in that case, the leading application must show a fitting indication (e.g. by firing a toast or showing the screenshot) to the user.

    false

    formats?: ("jpg" | "jpeg" | "pdf" | "png")[]

    Defines the export formats to be offered in the export menu.

    ['png']

    'jpg' and 'jpeg' are effectively the same format, so you can provide whatever you prefer. Providing both is not recommended due to the confusing nature of having both options.

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