web

The type web can be used to create a Web Layer. Web layers load a Web view into the display area.

Field Configurations

Key	Type	Description	Default Value
"allowedUrls"	Array	Specifies a list of regular expressions which a link must match in order to be followed. If this list is empty, a URL is initially valid as allowed.	[]
"baseUrl"	String	The base url. Only used if the content is loaded from text. Not used when loading a url.	null
"blockedUrls"	Array	Specifies a list of regular expressions that prevents following a link.	[]
"bounceEnabled"	Boolean	Indicates if the web view should bounce.	true
"interceptAjaxCalls"	Boolean	(iOS only) Determines if AJAX calls should be intercepted by the web layer	false
"loadingOverlay"	Boolean	undefined	null
"navigationEvent"	String	The event for the navigation type 'event'. The clicked URL will be available in the event parameter 'url'.	null
"navigationType"	String	A value of 'none' will disable all user interaction.	"default"
"noViewerText"	String	undefined	null
"progressBarBackground"	Color	The background color of the progress bar when a pdf is loaded.	null
"progressBarColor"	Color	The color of the progress bar when a pdf is loaded.	null
"shownExternallyText"	String	undefined	null
"trustedUrls"	Array	Specifies a list of URLs to which redirections are allowed.	[]
"urlParameter"	String	Optional suffix that will be appended to the url as url parameter	null
"urlSuffix"	String	Optional suffix that will be appended to the url.	null
"webLayerType" (required)	String	Defines from where the WebLayer should retrieve its content.	"fromUrl"

Inherited

From Base Layer

Base Layer

Field Configurations

Key	Type	Description	Default Value
"_value"	Value	[PREVIEW] Dynamic value of the layer.	null
"accessibilityAppendState"	String	Defines this layer appends its state to the accessibility text.	null
"accessibilityText"	String	Text for accessibility navigation. Can be translated.	null
"actions"	ActionList	List of actions, which will be executed when the layer is tapped.	null
"borderColor"	Color	The color of the border in hex color value.	null
"borderRadius"	UnitSize	The radius applies to all corners; with a borderWidth of 0 the border is not drawn and radius is set anyway.	0
"borderWidth"	UnitSize	The width of the border.	0
"bottomLeftRadius"	UnitSize	Radius for the bottom left corner.	0
"bottomRightRadius"	UnitSize	Radius for the bottom right corner.	0
"classes"	Array	List of classes for layer styles.	null
"conditions"	Conditions	List of conditions to alter the layer state.	null
"constraints"	Constraints	A list of constraints defining the position of the layer in a layout.	null
"consumesKeyboard"	Boolean	This layer will be used to shrink, if a keyboard is shown.	null
"dataKey"	String	Name for assigning data to this layer.	null
"focusColor"	Color	The highlight color of this layer when it is focused. Mainly used on TV. If no color is provided, the pressedColor will be used.	null
"hidden"	Boolean	Indicates whether the layer is hidden. Default: false.	false
"isAccessibilityElement"	String	Defines if this layer is important for accessibility navigation. The default depends on the layer type.	null
"layerRotation"	Number	The layer is rotated by the specified degree.	0
"name"	String	Unique name in the layout. Used for alignment or actions.	null
"opacity"	Number	The opacity of the layer.	1
"overInsetBottom"	Boolean	Determines if this layer ignores the save space at the bottom of the device.	false
"overInsetTop"	Boolean	Determines if this layer ignores the save space at the top of the device.	false
"pressedColor"	Color	The highlight color of this layer when it is pressed. Mainly used on TV. If no color is provided, the focusColor will be used.	null
"safeArea"	SafeAreaTypeObject	Determines the safe area behaviour.	null
"shadowElevation"	Number	The elevation of this layer for casting shadows.	0
"state"	String	The state the layer will use as default.	"default"
"states"	LayerStates	A list of named states that affect the appearance of the layer.	null
"topLeftRadius"	UnitSize	Radius for the top left corner.	0
"topRightRadius"	UnitSize	Radius for the top right corner.	0
"touchFeedback"	TouchFeedback	Determines if the layer should show a touch feedback if touched.	"visible"
"trackingKey"	String	Defines a key for a scroll event.	null
"type"	LayerType	The type of the layer	null
"value"	Value	(Initial) value of the layer.	null

Examples

Add the mos website as a web layer

Goal: Create a web layer which will show the mos website.

To achieve this the following code can be used:

{
  "type": "web",
  "name": "exampleWeb",
  "value": "https://mobilitysuite.de/",
  "webLayerType": "fromUrl",
  "constraints": [
    {
      "type": "pos",
      "x": "0",
      "y": "0"
    },
    {
      "type": "pos",
      "anchor": "se",
      "relativeAnchor": "se",
      "x": "0",
      "y": "0"
    }
  ]
}

The value of the web layer is set to the URL of the website.

Result:

A web layer which shows the mos website.