A newer version of Max is available. Click here to access the latest version of the Max documentation

jweb Reference

Web browser

jweb

Description

The jweb object uses the cross-platform Chromium Embedded Framework (CEF) to view renderable data in a Max box.

Arguments

None.

Attributes

rendermode [int]

Set page rendering style. When set to ‘offscreen’, jweb will first render to an offscreen buffer, then draw to the patcher. This mode is slower, but useful if you need UI elements to appear in front of the jweb object. When set to ‘onscreen’, jweb will render faster, but render directly in the patcher (without using an offscreen buffer) and over any other UI elements. When set to 'onscreen with transparent background', the background of the jweb object will be rendered transparently. Possible values:

0 = 'Offscreen'
1 = 'Onscreen'
2 = 'Offscreen with Transparent Background'

url [symbol] (default: )

Displays the current URL being displayed.

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points). Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile [symbol]

JS Painter File

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [4 floats]

Sets the color for the object's text in RGBA format.

textjustification [int]

Sets the justification for the object's text. Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

anything

You can send any message to the JavaScript of the contained website. In order to be able to receive messages make sure to setup the JavaScript as described in the Communicating with Max from within jweb guide.

back

The word back reloads the previous page of data, functioning like the 'Back' button in a conventional web browser.

executejavascript

Arguments

script [symbol]
Using executejavascript you can inject and run a JavaScript code snippet in the currently displayed website. The provided code will be inserted and executed in a new script tag.

forward

When a sequence of multiple pages has been loaded, and the object has received the back message, the word forward will advance to the following page in the object's page history. forward functions like the 'Forward' button in a conventional web browser.

(mouse)

TEXT_HERE

read

Arguments

url [symbol]
The word read, followed by a symbol that specifies a URL or a file pathname, will read the webpage or file and attempt to render its contents. Upon successful load of a page, two messages are sent from the object's outlet: url, followed the final URL which was loaded based on the provided argument; and title, followed by the title of the loaded page as a symbol.

readfile

Arguments

file path [symbol]
The word readfile, followed by a symbol that specifies a file pathname, will read the file and attempt to render its contents. The word readfile with no argument opens a file dialog to choose a file. Upon successful load of a page, two messages are sent from the object's outlet: url, followed the final URL which was loaded based on the provided argument; and title, followed by the title of the loaded page as a symbol.

reload

The word reload causes the browser to refresh the current page, functioning like the 'Reload' button in a conventional web browser.

See Also

Name Description
Communicating with Max from within jweb Communicating with Max from within jweb
js Execute Javascript
maxurl Make HTTP requests
Max JS Tutorial 1: Basic JavaScript Max JS Tutorial 1: Basic JavaScript
Max JS Tutorial 2: JavaScript Scripting Max JS Tutorial 2: JavaScript Scripting
Max JS Tutorial 3: JavaScript Tasks, Arguments, and Globals Max JS Tutorial 3: JavaScript Tasks, Arguments, and Globals