Open Pioneer Trails Packages
    Preparing search index...

    Interface MapContainerProps

    interface MapContainerProps {
        "aria-label"?: string;
        "aria-labelledby"?: string;
        children?: ReactNode;
        containerProps?: BoxProps;
        map?: MapModel;
        role?: string;
        rootProps?: BoxProps;
        viewPadding?: MapPadding;
        viewPaddingChangeBehavior?: "none" | "preserve-center" | "preserve-extent";
        [key: `data-${string}`]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: `data-${string}`]: unknown

      Arbitrary data attributes.

      NOTE: The component may use data properties for its own behavior. Make sure not to overwrite required attributes.

    Index

    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
    containerProps?: BoxProps

    Arbitrary html properties that will be applied to the map container's element. This is the element that renders the OpenLayers map.

    Use these at your own risk since they may be overwritten by the map container itself.

    Use cases: setting custom data attributes, registering custom event handlers, ...

    map?: MapModel

    The map model to use.

    role?: string

    Optional role property.

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

    "application"
    
    rootProps?: BoxProps

    Arbitrary html properties that will be applied to the map container's root element. This is the element that contains the map container and any UI elements (like map anchors, for example).

    Use these at your own risk since they may be overwritten by the map container root itself.

    Use cases: setting custom data attributes, registering custom event handlers, ...

    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"