Skip to main content

OverlayContext

A LocationContext that describes a section of the UI that represents an overlay, i.e. a Modal.

graph LR AbstractContext["AbstractContext<br><span class='properties'>id: string<br />_type: string</span>"] --> AbstractLocationContext; AbstractLocationContext --> OverlayContext; class OverlayContext diagramActive; click AbstractLocationContext "/docs/taxonomy/location-contexts/" "See details" _self

Diagram: OverlayContext inheritance

Properties

typedescription
idstringUnique string to be combined with the Context Type (_type) for Context instance uniqueness.
_typestringString literal used during serialization. Should always match the Context interface name.
setting of the id & type

The tracker will automatically set the id and _type based on the overlay element. When this is not possible on a specific platform, it will ask for a manual id and _type to be set.