Open Pioneer Trails Packages
    Preparing search index...

    Interface MapContainerProps

    Options that specify which map to use. See useMapModel.

    When not setting any of these properties on a component, the default map (from the DefaultMapProvider) will be used. If that is not available either, an error will be thrown.

    interface MapContainerProps {
        "aria-label"?: string;
        "aria-labelledby"?: string;
        children?: ReactNode;
        map?: MapModel;
        mapId?: string;
        role?: string;
        viewPadding?: MapPadding;
        viewPaddingChangeBehavior?: "none" | "preserve-center" | "preserve-extent";
    }

    Hierarchy (View Summary)

    Index

    Properties

    aria-label? aria-labelledby? children? map? mapId? role? viewPadding? viewPaddingChangeBehavior?

    Properties

    "aria-label"?: string

    Optional aria-label property. Do not use together with aria-label.

    This property is directly applied to the map's container div element.

    "aria-labelledby"?: string

    Optional aria-labelledby property. Do not use together with aria-label.

    This property is directly applied to the map's container div element.

    children?: ReactNode
    map?: MapModel

    The map model to use.

    mapId?: string

    The id of the map. The map will be looked up in the MapRegistry service.

    Use the map property instead.

    DefaultMapProvider

    role?: string

    Optional role property.

    This property is directly applied to the map's container div element.

    viewPadding?: MapPadding

    Sets the map's padding directly. Do not use the view's padding property directly on the OL map.

    See: https://openlayers.org/en/latest/apidoc/module-ol_View-View.html#padding)

    viewPaddingChangeBehavior?: "none" | "preserve-center" | "preserve-extent"

    Behavior performed by the map when the view padding changes.

    • none: Do nothing.
    • preserve-center: Ensures that the center point remains the same by animating the view.
    • preserve-extent: Ensures that the extent remains the same by zooming.
    "preserve-center"

    Settings

    Member Visibility

    On This Page

    Properties