You're currently browsing the Ignition 8.0 docs. Click here to view the latest docs.


General

Component Palette Icon:

IULocgo

Web Browser

Description

The Web Browser component in Designer allows you to embed a full web browser inside of an Ignition Client. This component becomes available in Designer after you download the Web Browser module from the Inductive Automation's website. The Web Browser module installs the same way as any other modules. Once this component is added onto a window, it will behave just like any other web browser when it is inside a Client.

Client machines need to meet the following minimum requirements to use this component. The component may not work properly if the requirements are not met.

Operating System Requirements

Windows

  • Microsoft Windows XP (SP2), 7, 8, Vista, Server 2003 (SP1), Server 2008/2012, 32-bit and 64-bit.
    • Windows version 8 and 8.1 require Java 6 update 38 or greater
  • Oracle (Sun) JRE 1.6.x and higher, 32-bit and 64-bit.

Linux

  • Ubuntu 12.04+, Debian 7.7, RedHat Enterprise Linux 7, openSUSE 13.1, Fedora 20, 32-bit and 64-bit

  • Oracle (Sun) JRE 1.6.x and higher, 32-bit and 64-bit.

    Required Linux Libraries

    Missing Libraries: 32-bit Ubuntu 12.04

    Some 32-bit Linux distros are missing a needed library for running the Web Browser: libXss.so.1

    Steps that fixed it in Ubuntu 12.04:

    sudo apt-get update
sudo apt-get upgrade
sudo apt-get install ia32-libs-multiarch

    Missing Libraries: Ubuntu 17.04

    Ubuntu 17.04 is missing a library that is required for the component to run. Running the following command can resolve the issue:

    sudo apt-get install libgconf-2-4

Mac OS X

  • Mac OS X 10.7.x - 10.10.x (Intel)
  • Apple or Oracle (Sun) JRE 1.6.x and higher, 32-bit and 64-bit.

Windows

  • Microsoft Windows 7, 8, 8.1, 10, Server 2008 R2, Server 2012, Server 2016, 32-bit and 64-bit.
    • Windows version 8 and 8.1 require Java 6 update 38 or greater
  • Oracle (Sun) JRE 1.6.x and higher or IBM JRE 1.7.x and higher, 32-bit and 64-bit.

Linux

  • Ubuntu 14.04+, 17.04 Desktop, Debian 8+, RedHat Enterprise Linux 7, openSUSE 13.3+, Fedora 24+, 64-bit only
  • Oracle (Sun) JRE 1.6.x and higher or IBM JRE 1.7.x and higher, 32-bit and 64-bit.

Required Linux Libraries

Missing Libraries: Ubuntu 17.04

Ubuntu 17.04 is missing a library that is required for the component to run. Running the following command can resolve the issue:

sudo apt-get install libgconf-2-4

Mac OS X

  • Mac OS X 10.9.x - 10.13.x (Intel)
  • Apple or Oracle (Sun) JRE 1.6.x and higher, 32-bit and 64-bit.

The Web Browser Component will only support the following audio and video codecs: Opus, Theora, Vorbis, VP8, VP9, and WAV.

The underlying browser component is available in scripting through the getBrowser() method. Documentation on the browser component is available at the JxBrowser Programmer’s Guide. The Inductive Automation support team is unable to provide detailed advice on scripting with this component. Furthermore, they are unable to provide troubleshooting beyond the basic functionality of the module.


Hardware Notes

ARM

Currently, the jxBrowser does not support the ARM architecture, thus the component will not work properly when used in conjunction with the ARM architecture.

Properties
Properties
NameDescriptionProperty TypeScriptingCategory
Border

The border surrounding this component.

The border is unaffected by rotation.

Border.borderCommon
EnabledIf disabled, a component cannot be used.boolean.componentEnabledCommon
FTP Proxy PortFTP Proxy Port sets the proxy port for FTP connections. This setting is only used when Use Proxies is checked.int.ftpProxyPortData
FTP Proxy ServerFTP Proxy Server sets the proxy server for FTP connections. This setting is only used when Use Proxies is checked. Can be emptyString.ftpProxyServerData
HTTP Proxy PortHTTP Proxy Port sets the proxy port for HTTP connections. This setting is only used when Use Proxies is checked.int.httpProxyPortData
HTTP Proxy ServerHTTP Proxy Server sets the proxy server for HTTP connections. This setting is only used when Use Proxies is checked. Can be emptyString.httpProxyServerData
HTTPS Proxy PortHTTPS Proxy Port sets the proxy port for HTTPS connections. This setting is only used when Use Proxies is checked.int.httpsProxyPortData
HTTPS Proxy ServerHTTPS Proxy Server sets the proxy server for HTTPS connections. This setting is only used when Use Proxies is checked. Can be emptyString.httpsProxyServerData
ModeData source for browser. Mode controls whether Starting URL or Starting HTML will be used.int.modeData
NameThe name of this component.String.nameCommon
Popups AllowedThis flag is used to allow popups in the web page displayed.boolean.popupsAllowedBehavior
Proxy ExceptionsA comma delimited list of rules for websites that will bypass the proxy servers. An example sting would be "*foo.com,<local>,127.0.1". This setting is only used when Use Proxies is checked.String.proxyExceptionsData
Proxy PasswordThe password to use for proxy authentication. This setting is only used when Use Proxies and Use Proxy Authentication are checked.String.proxyPasswordData
Proxy UsernameThe username to use for proxy authentication. This setting is only used when Use Proxies and Use Proxy Authentication are checked.String.proxyUsernameData
SOCKS Proxy PortThe port number for SOCKS proxies.int.socksProxyPort
SOCKS Proxy ServerThe host name to use for SOCKS proxies. Can be empty.String.socksProxyServer
Show Navigation ButtonsShow the navigation buttons at the top of the frame.boolean.showNavigationBehavior
Starting HTML

The initial HTML displayed when the Mode is set to HTML.

Starting HTML is

<html><body>&nbsp;</body></html>

by default, which gives a blank page.

String.startingHtmlData
Starting URLThe initial URL displayed when the Mode is set to URL. Starting URL is blank by default.String.startingUrlData
Touchscreen ModeControls when this input components responds if touchscreen mode is enabled.int.touchscreenModeBehavior
Use Proxies If checked, the Web Browser will try to use the proxy settings.boolean.useProxiesData
Use Proxy AuthenticationIf checked, the browser will use the username and password for proxy authentication. This setting is only used when Use Proxies is checked.boolean.useProxyAuthenticationData
VisibleIf disabled, the component will be hidden.boolean.visibleCommon
Zoom LevelThe zoom level the web page is displayed in. 0.0 is normal, positive numbers zoom in, negative numbers zoom out.double.zoomLevelBehavior
Scripting
Scripting Functions
  •  Description

This function will return the underlying browser object. See JxBrowser Programmer’s Guide for more information.

  • Parameters

none 

  •  Return

Object - The Browser Object

Extension Functions

This component does not have extension functions associated with it.

Event Handlers

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

.sourceThe component that fired this event.
.newValueThe new value that this property changed to.
.oldValueThe value that this property was before it changed. Note that not all components include an accurate oldValue in their events.
.propertyName

The name of the property that changed.

Remember to always filter out these events for the property that you are looking for! Components often have many properties that change.

Customizers
Examples

Setting Chromium Switches via JVM Arguments 

The Web Browser component is based off of the JxBrowser library, which in turn is based upon the Chromium engine. As a result, the Web Browser component can be further customized by manipulating Chromium Switches.

Caution: Implementing these switches is considered unsupported because they can drastically change the behavior of the Web Browser component. The exception to this case is when a member of our support team requests a switch be added to help troubleshoot an issue. For the sake of clarity, instructions on how to manipulate the switches via the Designer Launcher and Vision Client Launcher are listed below, but we generally do not recommend users implement these switches. 

If you're going to make use of a switch, then you would do so on the Designer Launcher's/Vision Client Launcher application, under the JVM Arguments field. Below is an example on how to configure a switch for a client using the Vision Client Launcher. The same method applies for the Designer Launcher.

  1. Open the Vision Client Launcher.
  2. Once open, either create a new application or manage the settings on an existing application. 

  3. Once the Settings are open, add a new entry into the JVM Arguments text area. Arguments for Chromium Switches must have a prefix of "-Dignition.chromium.switch." followed by the argument. Below is a example where we set the argument "mute-audio" :

    -Dignition.chromium.switch.mute-audio




  4. Following this change, audio from the Web Browser Component will be muted once the client is launched. 
  • No labels