TabletProxy

Available in: Interface Scripts Client Entity Scripts

Methods

Signals

Type Definitions

Properties:
Name Type Description
name string Name of this tablet. Read-only.
toolbarMode boolean Used to transition this tablet into and out of toolbar mode. When tablet is in toolbar mode, all its buttons will appear in a floating toolbar.
landscape boolean
tabletShown boolean Read-only.
buttons TabletProxy#ButtonList Read-only.

Methods

addButton(properties) → {TabletButtonProxy}
Creates a new button, adds it to this and returns it.
Parameters:
Name Type Description
properties object Button properties.
Returns:
Type: TabletButtonProxy
emitScriptEvent(message)
Used to send an event to the HTML/JavaScript embedded in the tablet.
Parameters:
Name Type Description
message object | string
getLandscape() → {boolean}
Returns:
Type: boolean
gotoHomeScreen()
Transition to the home screen.
gotoMenuScreen(submenuopt)
Parameters:
Name Type Attributes Default Description
submenu string <optional>
""
gotoWebScreen(url, injectedJavaScriptUrlopt, loadOtherBaseopt)
Show the specified Web url on the tablet.
Parameters:
Name Type Attributes Default Description
url string URL of web page.
injectedJavaScriptUrl string <optional>
"" URL to an additional JS script to inject into the web page.
loadOtherBase boolean <optional>
false
initialScreen(url)
Parameters:
Name Type Description
url string
isMessageDialogOpen() → {boolean}
Check if the tablet has a message dialog open.
Returns:
Type: boolean
isPathLoaded(path) → {boolean}
Parameters:
Name Type Description
path string
Returns:
Type: boolean
loadQMLOnTop(path)
Parameters:
Name Type Description
path string
loadQMLSource(path, resizableopt)
Parameters:
Name Type Attributes Default Description
path string
resizable boolean <optional>
false
loadWebScreenOnTop(path, injectedJavaScriptURLopt)
Parameters:
Name Type Attributes Default Description
path string
injectedJavaScriptURL string <optional>
""
onHomeScreen() → {boolean}
Check if the tablet is on the home screen.
Returns:
Type: boolean
popFromStack()
pushOntoStack(path) → {boolean}
Parameters:
Name Type Description
path string
Returns:
Type: boolean
removeButton(button)
Removes a button from the tablet.
Parameters:
Name Type Description
button TabletButtonProxy The button to be removed
returnToPreviousApp()
screenChanged(type, url)
Signaled when this tablet screen changes.
Parameters:
Name Type Description
type string "Home", "Web", "Menu", "QML", "Closed".
url string Only valid for Web and QML.
sendToQml(message)
Used to send an event to the QML embedded in the tablet.
Parameters:
Name Type Description
message object | string
setLandscape(landscape)
Set tablet into or out of landscape mode.
Parameters:
Name Type Description
landscape boolean true for landscape, false for portrait.
toolbarModeChanged()

Signals

fromQml(message) → {Signal}
Signaled when this tablet receives an event from the qml embedded in the tablet.
Parameters:
Name Type Description
message object | string
Returns:
Type: Signal
isTabletShownChanged() → {Signal}
Signaled when the tablet becomes visible or becomes invisible.
Returns:
Type: Signal
webEventReceived(message) → {Signal}
Signaled when this tablet receives an event from the html/js embedded in the tablet.
Parameters:
Name Type Description
message object | string
Returns:
Type: Signal

Type Definitions

ButtonList
Type: object