v1.5 Documentation

These reference documents are designed to help you when things don't go as planned. The individual screen type documents are useful for looking up availalbe JSON properties.

Menus
Content Screens
Settings Screens
Splash Screens
Other Actions
Splash Screen
Splash screens are used to introduce the application and usually animate-away after a few seconds. Note: Splash screens are used in the Global Theme and should not be used anywhere else. In other words, don't connect a button in a menu to a splash screen.
Sample JSON
{"itemId":"99999", "itemType":"BT_screen_splash", "itemNickname":"My Splash Screen", "backgroundColor":"#000000", "backgroundImageNameSmallDevice":"logo.png", "backgroundImageNameLargeDevice":"logo.png", "backgroundImageScale":"center", "startTransitionAfterSeconds":"1", "transitionDurationSeconds":"1", "transitionType":"fade"}
* Required     * Overrides Global Theme
Splash Screen Properties
Item Id * "itemId":"a unique id"
A unique number or string identifiying this item from all other items in the configuration file.
Item Type * "itemType":"BT_screen_splash"
Used by the mobile app to determine what type of item to create.
Item Nickname * "itemNickname":"A unique nickname"
The nickname of the item in the buzztouch control panel.
Start Transition After Seconds * "startTransitionAfterSeconds":"1"
The number of seconds after the screen loads. Use -1 to prevent the transition from happening until the user taps the screen.
Transition Duration Seconds * "transitionDurationSeconds":"1"
The number of seconds the transition should last.
Transition Type * "transitionType":"fade"
Options: fade, shrink, curl
Background Color, Image
Background Color * "backgroundColor":"#000000"
Hexidecimal color or a keyword: "clear" or "stripes" (do not enter quotes).
Background Color Transparency * "backgroundColorOpacity":"100"
Numeric Value: 1 - 100, 1 is totally transparent.
Background Color Gradient Top * "backgroundColorGradientTop":"#000000"
Hexidecimal color. Background gradients flow top-to-bottom and are placed "on-top" of a possible background color.
Background Color Gradient Bottom * "backgroundColorGradientTop":"#FFFFFF"
Hexidecimal color. Background gradients flow top-to-bottom and are placed "on-top" of a possible background color.
Background Image Small Device * "backgroundImageNameSmallDevice":"background-small.png"
OR
"backgroundImageURLSmallDevice":"URL to background-small.png"
The file name of the image added to the project or the URL to the image. Background images are placed "on-top" of possible background colors. Use an image name OR a URL, not both.
Background Image Large Device * "backgroundImageNameLargeDevice":"background-large.png"
OR
"backgroundImageURLLargeDevice":"URL to background-large.png"
The file name of the image added to the project or the URL to the image. Background images are placed "on-top" of possible background colors. Use an image name OR a URL, not both.
Background Image Transparency * "backgroundImageOpacity":"100"
Number: 1 - 100, 1 is totally transparent.
Background Image Scale * "backgroundImageScale":"center"
Options: center, fullScreen, fullScreenPreserve, top, bottom, topLeft, topRight, bottomLeft, bottomRight.