View
Description
A View is a collection of features. An application visual frame is a view. An experience is made up of a group of views, we can navigate between these views using view actions. Triggers and actions are written for a view work only for that view.
Properties
Background Image: This property is used to set the view background.
Background Color: This property is used to set the color of the view background.
Name: We can name a view as per its functions using this property.
Touch Sends Feature to Front: If this property is selected, features under this view will come to the front layer when the feature detects a touch.
Events
Triggers
Key Pressed
Key Pressed: This trigger listens to the event of a key being pressed. It listens for the key that is specified in the parameter key
Parameter
Key: Character that it’s listening for
Timer
Timer: This starts a timer and executes the actions when the time is up. You can have it run multiple times by specifying the number of runs, 0 is to keep running indefinitely
Parameter
Duration: duration of time before executing actions
Number Of Runs: Specifies the number of runs, 0 is to keep running indefinitely
Touch
Tap: This trigger will execute the actions when the view detects a tap on it.
Double Tap: This trigger will execute the actions when the view detects a double tap on it.
Long Press: This trigger will execute the actions when the view detects a long press.
Pressed: This trigger will execute the actions when the view detects a press and hold.
Released: This trigger will execute the actions when the view detects a press released.
Gesture
Swipe: This trigger will execute the actions when the view detects a swipe gesture on it. We need to set the type of swipe gesture using parameter swipe type
Parameter
Swipe Type: This is a list parameter containing different type gestures like Left, Right, Horizontal, Vertical, Up and Down. Based on this parameter swipe trigger will executes the actions
Global Variables: This is an optional parameter, we can set the amount or weight of the gesture into a global variable when the event happened.
View
View Entered: This trigger will execute as soon as the view starts.
Api Triggers
API Call Complete: This trigger will execute the actions when a particular api has run successfully.
Parameter
API Asset: This specifies the api to listen to
API Call Error: This trigger will execute the actions when a particular api has encountered an error.
Parameter
API Asset: This specifies the api to listen to
API Call Started: This trigger will execute the actions when a particular api has been called.
Parameter
API Asset: This specifies the api to listen to
Player Connector
Player Connector Data Received: This trigger will execute the actions when data is received from a specified device.
Parameter
Player Connector: Specify the player connection from which data is to be received to trigger this event.
XML Asset: When data is received it will be stored into this XML data asset
RFID
RFID Tag Found: This trigger will execute the actions and RFID tag is detected by a compatible reader.
Parameter
Tag Id: The tag id which when scanned will trigger this event
Scanner Serial Number: This is the serial number of the scanner which must detect the tag in order to trigger this event
RFID Tag Lost: This trigger will execute the actions and RFID tag is removed from a compatible reader.
Parameter
Tag Id: The tag id which when removed will trigger this event
Scanner Serial Number: This is the serial number of the scanner which the tag must have been removed from in order to trigger this event
Actions
Print: This action calls the print function of the operating system of the device, it will print this feature the way it looks when the action is executed. For this to work the printer setting must be set up properly on the OS.
Parameter
Show settings popup: The printer setting popup of the OS can be shown before printing if selected
Feature
Create Image Feature: This action will create an image feature.
Parameter
x: This is the horizontal center point of the feature on the view.
y: This is the vertical center point of the feature on the view.
width: This is the width of this feature.
height: This is the height of the feature.
Alpha: This sets the transparency of the feature.
Image_Asset: This sets the Image for the feature.
Fill_Behaviour: Based on this property images fills into the feature. It has 3 options Fit, Fill, and Deform.
Create Video Feature: This action will create a Video feature.
Parameter
x: This is the horizontal center point of the feature on the view.
y: This is the vertical center point of the feature on the view.
width: This is the width of this feature.
height: This is the height of the feature.
Alpha: This sets the transparency of the feature.
Video_Path: This sets the path of the video.
Repeat: If this sets to true video will play in a loop.
Auto_Start: If this sets video start plays automatically.
Show_Controls: if this sets feature will show the video controls.
Toggle_Play_Pause_On_Touch: If this sets video feature toggles between play and pause whenever it detects a touch.
Create Document Feature: This action will create a document feature.
Parameter
x: This is the horizontal center point of the feature on the view.
y: This is the vertical center point of the feature on the view.
width: This is the width of this feature.
height: This is the height of the feature.
Alpha: This sets the transparency of the feature.
Document_Asset: This sets the path of the document.
Scroll_Type: This sets the direction of scrolling. It can be Horizontal or Vertical.
Number_Of_Pages_Shown: This property takes the numeric input and this controls the number of pages displays at the feature.
Show_Controls: if this sets feature will show the document controls.