Web Browser Component
Component Palette Icon:
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.
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.
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
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.
The Web Browser Component will only support the following 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.
|
Name |
Description |
Property Type |
Scripting |
Category |
|
Border |
The border surrounding this component. NOTE that the border is unaffected by rotation. |
Border |
.border |
Common |
|
Enabled |
If disabled, a component cannot be used. |
boolean |
.componentEnabled |
Common |
|
FTP Proxy Port |
FTP Proxy Port sets the proxy port for FTP connections. This setting is only used when Use Proxies is checked. |
int |
.ftpProxyPort |
Data |
|
FTP Proxy Server |
FTP Proxy Server sets the proxy server for FTP connections. This setting is only used when Use Proxies is checked. Can be empty |
String |
.ftpProxyServer |
Data |
|
HTTP Proxy Port |
HTTP Proxy Port sets the proxy port for HTTP connections. This setting is only used when Use Proxies is checked. |
int |
.httpProxyPort |
Data |
|
HTTP Proxy Server |
HTTP Proxy Server sets the proxy server for HTTP connections. This setting is only used when Use Proxies is checked. Can be empty |
String |
.httpProxyServer |
Data |
|
HTTPS Proxy Port |
HTTPS Proxy Port sets the proxy port for HTTPS connections. This setting is only used when Use Proxies is checked. |
int |
.httpsProxyPort |
Data |
|
HTTPS Proxy Server |
HTTPS Proxy Server sets the proxy server for HTTPS connections. This setting is only used when Use Proxies is checked. Can be empty |
String |
.httpsProxyServer |
Data |
|
Mode |
Data source for browser. Mode controls whether Starting URL or Starting HTML will be used. |
int |
.mode |
Data |
|
Name |
The name of this component. |
String |
.name |
Common |
|
Popups Allowed |
This flag is used to allow popups in the web page displayed. |
boolean |
.popupsAllowed |
Behavior |
|
Proxy Exceptions |
A 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 |
.proxyExceptions |
Data |
|
Proxy Password |
The password to use for proxy authentication. This setting is only used when Use Proxies and Use Proxy Authentication are checked. |
String |
.proxyPassword |
Data |
|
Proxy Username |
The username to use for proxy authentication. This setting is only used when Use Proxies and Use Proxy Authentication are checked. |
String |
.proxyUsername |
Data |
|
Show Navigation Buttons |
Show the navigation buttons at the top of the frame. |
boolean |
.showNavigation |
Behavior |
|
Starting HTML |
The initial HTML displayed when the Mode is set to HTML. Starting HTML is <html><body> </body></html>by default, which gives a blank page. |
String |
.startingHtml |
Data |
|
Starting URL |
The initial URL displayed when the Mode is set to URL. Starting URL is blank by default. |
String |
.startingUrl |
Data |
|
Use Proxies |
If checked, the Web Browser will try to use the proxy settings. |
boolean |
.useProxies |
Data |
|
Use Proxy Authentication |
If checked, the browser will use the username and password for proxy authentication. This setting is only used when Use Proxies is checked. |
boolean |
.useProxyAuthentication |
Data |
|
Visible |
If disabled, the component will be hidden. |
boolean |
.visible |
Common |
|
Zoom Level |
The zoom level the web page is displayed in. 0.0 is normal, positive numbers zoom in, negative numbers zoom out. |
double |
.zoomLevel |
Behavior |
.getBrowser()
-
Description
This function will return the underlying browser object. See JxBrowser Programmer’s Guide for more information.
-
Parameters
none
-
Return
Object - The Browser Object
-
Scope
Client
This component does not have extension functions associated with it.
propertyChange
propertyChange
Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.
|
.source |
The component that fired this event |
|
.newValue |
The new value that this property changed to. |
|
.oldValue |
The 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. NOTE: remember to always filter out these events for the property that you are looking for! Components often have many properties that change. |
There are no examples associated with this component.