|Manuals

constructor

The constructor must be called to initialize a HostSurfer instance. It can be invoked without parameters, as they are all optional.

var hs = new zScope.HostSurfer({
  view: {
    id: "outputContainer"
  },
  term: {
    url: "https://myzscopeserver/myconnection/"
    float: { ... }
  },
  rules: {
    baseUrl: "/myrules"
    paths: ["rule1", "rule2"..., "ruleN"]
  }
});

Call Parameters

Parameter name Explanation
view Specifies where the HTML rendering will be placed.
term Specifies the parameters for the terminal emulation to be used and its layout.
rules Indicates the screen rules information associated with the application.

Attributes for the view parameter:

Attribute name Explanation
id Indicates the HTML element ID where the rendering for the underlying screen will be placed.

Attributes for the term parameter:

Attribute name Explanation
url An url pointing to a z/Scope Anywhere connection.
float A JSON with the coordinates where a floating panel with the terminal emulation will be placed. If this parameter is not specified, the terminal emulation is embedded on the page. It accepts the top, bottom, left, right, width and height attributes.

Attributes for the rules parameter:

Attribute name Explanation
baseUrl The base URL where the screen-rule files will be loaded from. If omitted, is assumed that files are located in the root directory.
paths An array with the screen-rule files to load.

Return Object

This function returns a HostSurfer object