Open Pioneer Trails Packages
    Preparing search index...

    Interface OverlayOptions

    Options that define the initial state of an overlay.

    interface OverlayOptions {
        advanced?: OlOverlayOptions;
        ariaRole?: string;
        className?: string;
        content?: ReactNode;
        offset?: number[];
        position?: Coordinate | OverlayPosition | "follow-pointer";
        positioning?: OverlayPositioning;
        stopEvent?: boolean;
        tag?: string;
    }
    Index

    Properties

    advanced? ariaRole? className? content? offset? position? positioning? stopEvent? tag?

    Properties

    advanced?: OlOverlayOptions

    Raw OpenLayers overlay properties. OlOverlayOptions override corresponding OverlayProperties, except for id and element.

    warning Using OpenLayers options can create inconsistencies that lead to errors. The OpenLayers API can change with updates of OpenLayers.

    ariaRole?: string

    Role of the HTML element that wraps the overlay's content.

    className?: string

    CSS classes of the HTML element that wraps the overlay's content.

    Optionalcontent

    content?: ReactNode

    Displayed content of the overlay.

    Overlay.setContent.

    offset?: number[]

    Offsets in pixels relative to the overlay`s coordinates on the map. The first element in the array is the horizontal offset.

    Overlay.setOffset

    position?: Coordinate | OverlayPosition | "follow-pointer"

    Configures the position of the overlay. The overlay is not rendered if position is undefined (the default).

    See OverlayPosition for all supported position options.

    The following shorthands are available:

    • A plain Coordinate array can be used to specify a static coordinate on the map.
    • undefined hides the overlay.
    • "follow-pointer" can be used as a shorthand to follow the user's cursor.
    positioning?: OverlayPositioning

    Positioning of an overlay relative to its coordinates on the map.

    Overlay.setPositioning

    stopEvent?: boolean

    Determines if event propagation to the map viewport should be stopped.

    By default stopEvent is true.

    tag?: string

    Optional, readonly tag that helps identifying the overlay instance.

    Settings

    Member Visibility

    On This Page

    Properties