Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MapOverlayOptions

A data type that represents the configuration options for a map view's overlays.

Hierarchy

  • MapOverlayOptions

Index

Properties

Properties

Optional branding

branding: { html?: string; img?: string }

Optional branding element to display over the map view.

Element can either be a static image (url) or and HTML string. If both properties are provided, the HTML string will be used. This branding element can be customized using CSS overrides as needed.

Type declaration

  • Optional html?: string

    HTML string content. Takes precedence over img when both are provided.

  • Optional img?: string

    URL for the image source.

Optional timestamp

timestamp: string

Timestamp output format.

Optional title

title: string

Map title, which will be displayed in a title bar element across the top-left of the map view. Title bar can be customized using CSS overrides as needed.

Generated using TypeDoc