CommandFusion iViewer
Scripting Documentation

Introduction to iViewer JavaScript

• Introduction to iViewer JavaScript development
• iViewer JavaScript Module Development Guidelines
• Javascript startup mechanism, lifetime and execution context
• iViewer Remote Monitor and JavaScript debugger
• Javascript language documentation and resources
• FAQ and How-Tos

iViewer JavaScript API reference

The iViewer Javascript API provides a number of functions you can use to perform common tasks, interact with the GUI and with external systems.

• API changes history
• The CF object and its exposed variables
• GUI API
  • Events
    • CF.PreloadingCompleteEvent GUI caching completed
    • CF.JoinChangeEvent a join changed
    • CF.InputFieldEditedEvent an input field being edited was modified
    • CF.GUISuspendedEvent the app was put to background
    • CF.GUIResumedEvent the app came back to foreground
    • CF.ObjectPressedEvent user pressed a button or slider
    • CF.ObjectDraggedEvent user is dragging a slider
    • CF.ObjectReleasedEvent user lifted finger from a button or slider
    • CF.KeyboardUpEvent the software keyboard popped up
    • CF.KeyboardDownEvent the software keyboard slided down
  • Functions
    • CF.getJoin() get value and tokens of a join
    • CF.getJoins() get value and tokens of multiple joins
    • CF.setJoin() set value of a join
    • CF.setJoins() set value and/or tokens of multiple joins
    • CF.setToken() set a join token
    • CF.getProperties() get the visual properties of a join
    • CF.setProperties() set and animate visual properties changes
    • CF.getGuiDescription() obtain a summary of all GUI objects
• Lists API
  • Events
    • CF.ListWillStartScrollingEvent list will start scrolling
    • CF.ListDidScrollEvent list is scrolling, first visible item just changed
    • CF.ListDidEndScrollingEvent list did end scrolling
  • Functions
    • CF.listAdd() add or insert items in a list
    • CF.listUpdate() modify items in a list
    • CF.listRemove() remove items from a list
    • CF.listScroll() programatically scroll lists
    • CF.listInfo() get info about a list
    • CF.listContents() get partial or complete list contents
• Display API
  • Events
    • CF.OrientationChangeEvent device changed orientation
    • CF.PageFlipEvent current page changed
  • Functions
    • CF.flipToPage() flip to another page
• Sound API
  • Functions
    • CF.playSound() starts playing a sound
    • CF.stopSound() stops playing a sound
    • CF.muteSound() mutes a sound currently playing
    • CF.unmuteSound() un-mutes a sound currently playing
• Network API
  • Events
    • CF.NetworkStatusChangeEvent network went up or down
    • CF.ConnectionStatusChangeEvent a system connected or disconnected
    • CF.FeedbackMatchedEvent a feedback item was matched
  • Functions
    • CF.setSystemProperties() change a system's settings
    • CF.send() send data to a system
    • CF.runCommand() run a command
    • CF.runMacro() run a macro
    • CF.stopMacro() stop one or all macros
    • CF.request() perform HTTP/HTTPS requests
    • CF.startLookup() start a permanent Bonjour (mDNS/ZeroConf) lookup
    • CF.stopLookup() stop a Bonjour lookup
    • CF.startPublishing() start publishing a Bonjour service on the network
    • CF.stopPublishing() stop publishing a Bonjour service on the network
• Video API
  • Events
    • CF.MovieInfoReceivedEvent new information about movie is available
    • CF.MovieLoadStateChangedEvent video buffering started, partially done or completed
    • CF.MoviePlaybackStateChangedEvent playback started, stopped or paused
• Sensors API
  • Sensors
    • Accelerometer
    • Gyroscope
    • Attitude
    • Heading
    • GPS Location
    • iBeacon detection
  • Functions
    • CF.startMonitoring()
    • CF.stopMonitoring()
• Utilities API
  • Events
    • CF.DevicePropertyChangedEvent a device property changed
    • CF.ApplicationCallbackEvent app was launched via URL
    • CF.PushNotificationEvent a push notification was received
  • Functions
    • CF.log() debug function to log to monitor
    • CF.logObject() debug function to dump objects
    • CF.crc() compute CRCs
    • CF.hash() compute hashes
    • CF.openURL() open URLs in web browser, open other applications
    • CF.loadGUI() load or reload a GUI with settings customization options
    • CF.loadAsset() load asset files directly from JavaScript
    • CF.setDeviceProperty() set a device property, (i.e. screen brightness)
    • CF.interceptHardwareKey() intercept one of the device's hardware keys (ANDROID only)