OverlayWindow

Available in: Interface Scripts

Methods

Signals

Type Definitions

Parameters:
Name Type Attributes Default Description
properties OverlayWindow.Properties <optional>
null
Properties:
Name Type Description
position Vec2
size Vec2
visible boolean

Methods

clearDebugWindow()
close()
emitScriptEvent(message)
Parameters:
Name Type Description
message object
emitWebEvent(message)
Parameters:
Name Type Description
message object
getEventBridge() → {object}
Returns:
Type: object
getPosition() → {Vec2}
Returns:
Type: Vec2
getSize() → {Vec2}
Returns:
Type: Vec2
initQml(properties)
Parameters:
Name Type Description
properties OverlayWindow.Properties
isVisible() → {boolean}
Returns:
Type: boolean
raise()
sendToQml(message)
Parameters:
Name Type Description
message object
setPosition(position)
Parameters:
Name Type Description
position Vec2
setPosition(x, y)
Parameters:
Name Type Description
x number
y number
setSize(size)
Parameters:
Name Type Description
size Vec2
setSize(width, height)
Parameters:
Name Type Description
width number
height number
setTitle(title)
Parameters:
Name Type Description
title string
setVisible(visible)
Parameters:
Name Type Description
visible boolean

Signals

closed() → {Signal}
Returns:
Type: Signal
fromQml(message) → {Signal}
Parameters:
Name Type Description
message object
Returns:
Type: Signal
hasClosed() → {Signal}
Returns:
Type: Signal
hasMoved(position) → {Signal}
Parameters:
Name Type Description
position Vec2
Returns:
Type: Signal
moved(position) → {Signal}
Parameters:
Name Type Description
position Vec2
Returns:
Type: Signal
positionChanged() → {Signal}
Returns:
Type: Signal
qmlToScript(message) → {Signal}
Parameters:
Name Type Description
message object
Returns:
Type: Signal
resized(size) → {Signal}
Parameters:
Name Type Description
size Size
Returns:
Type: Signal
scriptEventReceived(message) → {Signal}
Parameters:
Name Type Description
message object
Returns:
Type: Signal
sizeChanged() → {Signal}
Returns:
Type: Signal
visibleChanged() → {Signal}
Returns:
Type: Signal
webEventReceived(message) → {Signal}
Parameters:
Name Type Description
message object
Returns:
Type: Signal

Type Definitions

Properties
Type: object
Properties:
Name Type Description
title string
source string
width number
height number
visible boolean