Skip to main content
OverlayOptions
Base options for an overlay.
NameTypeDescription
attributes?Record<string,string>Optional custom attributes to write to the overlay's element.
cssClass?stringOptional CSS class(es) to add to the overlay's element.
direction?number1 to point forwards (the default), -1 to point backwards. Only taken into consideration in some overlay types.
events?Record<OverlayEvents,(value:any, event:any) => any>Optional event handlers to attach to the overlay.
id?stringOptional ID for the overlay. Can be used to retrieve the overlay from a connection.
location?numberDefaults to 0.5. See docs.
visibility?OverlayVisibilityWhether the overlay is always visible, or only on hover. Defaults to OVERLAY_VISIBILITY_ALWAYS.