The floating window component cq-floating-window
.
Creates a floating window that users can move and resize.
- Since:
-
8.2.0
Classes
Members
-
windowImplementation
-
A reference to the class that implements the floating window.
- Since:
-
8.2.0
- Default Value:
Methods
-
onShortcut(params)
-
The listener for "floatingWindow" events where the
type
parameter of the event is "shortcut" (see floatingWindowEventListener).Creates and positions a floating window.
Parameters:
Name Type Description params
object Listener parameters.
Properties
Name Type Argument Description content
string The contents of the floating window, typically an HTML string.
container
HTMLElement <optional>
The DOM element that visually contains the floating window. The window is positioned on screen relative to the element (see WebComponents.cq-floating-window.DocWindow#positionRelativeTo). Defaults to
document.body
.title
string <optional>
Text that appears in the title bar of the floating window.
width
number <optional>
The width of the floating window in pixels.
status
boolean <optional>
The state of the floating window: true, to open the window; false, to close it. If the parameter is not provided, the floating window is toggled (opened if closed, closed if open).
tag
string <optional>
A label that identifies the floating window type; for example, "shortcut", which indicates that the floating window contains the keyboard shortcuts legend. See the
tag
parameter of floatingWindowEventListener.onClose
function <optional>
A callback to execute when the floating window is closed.
- Since:
-
8.2.0
-
setContext(context)
-
Initializes the context of the floating window component. Dynamically adds a listener for the "floatingWindow" event based on the
type
parameter of the event (see floatingWindowEventListener).Parameters:
Name Type Description context
CIQ.UI.Context The chart user interface context.
- Since:
-
8.2.0