Interface: PopupOptions
component.PopupOptions
Interface for the options that define behavior and appearance of a popup.
interface
Properties#
capturePointer#
• Optional capturePointer: boolean
Specify if the popup should capture pointer events.
description If the popup is specified to not capture
pointer events the provided content can still override
this behavior for the individual content HTML elements
by specifying the appropriate CSS.
default true
Defined in#
component/popup/interfaces/PopupOptions.ts:21
clean#
• Optional clean: boolean
Specify that the popup should not have any tooltip like visuals around the provided content.
default false
Defined in#
component/popup/interfaces/PopupOptions.ts:29
float#
• Optional float: Alignment
The direction in which the popup floats with respect to the anchor point or points. If no value is supplied the popup will change float automatically based on the its position in the viewport so that as much of its area as possible is visible.
description For automatic floating (undefined) the popup
will float in eight directions around a point or a position
in a rect. When a rectangle is set without a position option
specified, the popup will float outward from the rectangle
center based on the side it is currently rendered in. The
default floating direction is to the bottom for both points
and rectangles.
default undefined
Defined in#
component/popup/interfaces/PopupOptions.ts:48
offset#
• Optional offset: number | PopupOffset
A pixel offset applied to the popup's location specfied as:
A single number in pixels in the float direction that the popup will be translated with respect to the current anchor point.
An object of number arrays specifying an offset for each float direction. Negative offsets indicate left and up.
default 0
Defined in#
component/popup/interfaces/PopupOptions.ts:61
opacity#
• Optional opacity: number
Opacity of the popup visuals.
default 1
Defined in#
component/popup/interfaces/PopupOptions.ts:68
position#
• Optional position: Alignment
The popup position in a rectangle (does not apply to points). When not set the popup will change position automatically based on the viewport so that as much of it as possible is visible.
default undefined