Summary

Since a config file is nothing but a plain .json file, all values on all pages are stored as key-value pairs. Below, all default keys will be listed.\

Keys are generated by concatenating the individual keys with periods, e.g.design.backgroundSize.width

List

• design

  • backgroundSize
    • width: Width of the canvas
    • height: Height of the canvas
    • hasBorder: Boolean to control whether the border mode is used.
    • sectionWidth: Width of the border-mode section
    • sectionHeight: Height of the border-mode section
    • sectionX: X-position of the origin of the section on the base image
    • sectionY: Y-position of the origin of the section on the base image
    • scaleMode: String to control how the canvas is fitted into the section
  • background: URL or Hex-string of the page background
  • backgroundType: Type of the background (image, color, iframe)
  • backgroundBounds
    • maxWidth: Width of the most wide ratio allowed
    • maxHeight: Height of the most wide ratio allowed
    • maxWidth: Width of the most narrow ratio allowed
    • maxHeight: Height of the most narrow ratio allowed
    • goTo: Alternative screen if the display ratio is out of bounds
  • orientation
    • lock: Boolean to control whether or not the device can be rotated
    • value: If the device can not be rotated, lock to this value
  • scroll
    • scrollX: Enable horizontal scrolling
    • scrollY: Enable vertical scrolling
  • elements
    • • maintitle: Caption of the element
      • elementType: Type of the element
      • move: Move-into-screen-direction of the element
      • goTo: goTo-target of buttons
      • condition:
        • checkIf: Key to check
        • group: Group to take key from
        • equalsValue: Value to compare the key to
      • handleFunction - execute a system-function
        • name: Function name
        • value: key from the value store to call the function with
        • group: Group to take the value from
        • argument: Additional argument for the function
      • design: target url for iframes
      • resource: location of the background for resources
      • index: Index of the measurement that is to be displayed in the progress bar
      • innerSize
        • width: Width of the slider-element
        • height: Height of the slider-element
        • x_key: Key used to calculate the x-position
        • x_keyGroup: Group to take the value used to calculate the x-position from
        • x_min: Minimum possible value for the x-key
        • x_max: Maximum possible value for the x-key
        • y_key: Key used to calculate the y-position
        • y_keyGroup: Group to take the value used to calculate the y-position from
        • y_min: Minimum possible value for the y-key
        • y_max: Maximum possible value for the y-key
      • background
        • image: Background image of the resource
        • muted: Boolean to control whether videos should be muted
        • width: Width of the background image
        • height: Height of the background image
        • hasBorder: Boolean to enable the border-mode
        • sectionWidth: Width of the section used for border-mode
        • sectionHeight: Height of the section used for border-mode
        • sectionX: X-position of the origin of the section used for border-mode
        • sectionY: Y-position of the origin of the section used for border-mode

• settings

  • timeout
    • timer: Time after which a timeout occurs
    • onExpiration: Target page of the timeout event
  • callFunction: Function to call once this page is entered
  • functionParameters
    • key: Key to check for the if-function
    • group: Group to check for the if-function
    • condition: Condition for the if-function
    • value: Comparison-value for the if-function
  • copyParameter - only for the copy-function
    • {i} - index of the parameter
      • originKey: Key to copy
      • originGroup: Group to copy from
      • targetGroup: Group to copy to
      • targetKey: Key to copy as
  • setParameters - only for the set-function
    • {i} - index of the parameter
      • newValue: Value to store (Or function to execute)
      • newValueType: Type of the new value
      • targetGroup: Group to set to
      • targetKey: Key to set as
      • inputKey1: First key to use
      • inputGroup1: Group to take first key from
      • inputKey2: Second key to use
      • inputGroup2: Group to take second key from
      • min: Minimum for the random-function
      • max: Maximum for the random-function
      • isInt: Boolean to control whether or not to get an integer instead of a float
  • pingURL: URL of the server to ping for the ping-function
  • postURL: URL of the server to ping for the post-function
  • getURL: URL of the server to ping for the download-function
  • getKey: Key used for the download-function
  • eventTargets
    • {target} - function-exit