ARgo

Constructor

new ARgo()

Source:: argo.js, line 943

Properties

(static) assetsFolder :string

Type:

string

Source:: argo.js, line 947

(static) CURRENT_PAGE :string

Gets or sets the currently loaded page.

Type:

string

Source:: argo.js, line 1136
See:: ARgo.PAGES

(static) isDebuggable

Gets or sets if the app is hosted in a debuggable native client.

Source:: argo.js, line 984

(static, readonly) LABELS :String

Text of available 3D labels.

Type:

String

Properties

Name	Type	Description
`ROUTER_PORTS`	String

Source:: argo.js, line 1089

(static) LOG_MESSAGES :string

Log Messages

Type:

string

Properties

Name	Type	Description
`LOAD_BACKGROUND`	string
`LOAD_MODEL_ROUTER`	string
`LOAD_MODEL_AR_ROUTER`	string
`LOAD_MODEL_MARKER`	string
`LOAD_MODEL_ARROW`	string
`LOAD_MODEL_BLOCK`	string
`LOAD_MODEL_RJ45`	string
`LOAD_MODEL_AR_RJ45`	string
`LOAD_MODEL_CHARGER`	string
`LOAD_MODEL_AR_CHARGER`	string
`LOAD_TRACKER_BOX`	string
`LOAD_TRACKER_ROUTER`	string
`LOAD_TRACKABLE_BOX`	string
`LOAD_TRACKABLE_ROUTER`	string
`LOAD_POSITIONABLE`	string
`TARGET_BOX_RECOGNIZED`	string
`TARGET_ROUTER_RECOGNIZED`	string
`TARGET_BOX_LOST`	string
`TARGET_ROUTER_LOST`	string

Source:: argo.js, line 1001

(static, readonly) MODELS :string

Available models.

Type:

string

Properties

Name	Type	Description
`ROUTER_ITEM`	string
`RJ45_ITEM`	string
`ROUTER`	string
`RJ45`	string
`CHARGER_ITEM`	string
`CHARGER`	string

Source:: argo.js, line 1055

(static) NATIVE_COMMANDS :string

Available native commands.

Type:

string

Properties

Name	Type	Description
`INIT`	string
`BACK`	string
`LOG`	string
`ERROR`	string

Source:: argo.js, line 990

(static, readonly) PAGES :String

Available UI pages.

Type:

String

Properties

Name	Type	Description
`WELCOME`	String
`SCENARIO`	String
`BOX_SCENARIO`	String
`ROUTER_SCENARIO`	String
`MAIN`	String
`CONTENTS`	String
`CONTENTS_ITEM`	String
`INSTRUCTIONS_1`	String
`ROUTER`	String
`ROUTER_GRAPH`	String
`RJ45_GRAPH`	String
`RJ45`	String
`CHARGER_GRAPH`	String
`CHARGER`	String

Source:: argo.js, line 1028

(static, readonly) PARTS :String

Available 3D model parts.

Type:

String

Properties

Name	Type	Description
`M`	String
`ETHERNET`	String
`DSL`	String
`POWER`	String

Source:: argo.js, line 1124

(static, readonly) SOUNDS :Sound

Available sounds.

Type:

Sound

Properties

Name	Type	Description
`LOCATE`	Sound
`INSTRUCTION`	Sound
`BOX_HELP`	Sound
`BOX`	Sound
`ROUTER`	Sound
`ROUTER_HELP`	Sound
`ROUTER_GRAPH`	Sound
`ROUTER_BACK`	Sound
`RJ45_GRAPH`	Sound
`CABLE_VIEW`	Sound
`AR_OPTION`	Sound
`POWER_GRAPH`	Sound

Source:: argo.js, line 1069

(static, readonly) TARGETS :object

Available targets by tracker.

Type:

object

Properties

Name	Type	Description
`BOX`	object
`ROUTER`	String	Available targets in the router tracker.

Source:: argo.js, line 1098

Methods

(static) close()

Asks the native host to close this view and return to main app.

Source:: argo.js, line 1658

(static) disableCamera()

Disables the device's camera.

Source:: argo.js, line 1355

(static) enableCamera()

Prepares the environment for camera usage.

Source:: argo.js, line 1347

(static) gotoPage(callingPage)

Called from HTML to proceed to a page based on a radio input choice.

Parameters:

Name	Type	Description
`callingPage`	String	The calling page containing the radio inputs. The radio inputs must be part of a `form` with an `id`: "pageIdForm" and they should share a `name` as: "pageIdFormChoice"

Source:: argo.js, line 1253
See:: ARgo.PAGES

(static) hasPage(pageId) → {boolean}

Gets if a valid page with the specified id, is available in the UI.

Parameters:

Name	Type	Description
`pageId`	string	HTML `id` of the page to seek for.

Source:: argo.js, line 1235

Returns:

Type: boolean

(static) hideDialogs()

Hides all dialogs currently visible.

Source:: argo.js, line 1430

(static) hideInfoBar()

Hides info bar, footer buttons and any dialogs currently open.

Source:: argo.js, line 1457

(static) hidePopup()

Hides elements with the .popupText CSS class.

Source:: argo.js, line 1437

(static) loadPage(page, preventARResetopt)

Called from HTML to move to a page.

Parameters:

Name	Type	Attributes	Description
`page`	PAGES		The page to be loaded.
`preventARReset`	boolean	<optional>	Prevent reseting the AR environment.

Source:: argo.js, line 1325
See:: ARgo.PAGES

(static) log(message, dataopt)

Log a message to the console and the app's online analytics.

Parameters:

Name	Type	Attributes	Description
`message`	string
`data`	Object	<optional>

Source:: argo.js, line 1649
See:: ARgo.LOG_MESSAGES

(static) onAndroidGoBack()

Called by the native hosting Activity on Android devices.

Source:: argo.js, line 1610

(static) onPageChanged(pageSelector)

Occurs in response to the pagechange event.

Parameters:

Name	Type	Description
`pageSelector`	String	The selector of the page we've just moved to (e.g. `#myPage`).

Source:: argo.js, line 1478

Listens to Events:

Document.event:pagechange

(static) reset(isCommonARopt)

Resets the AR environment to default state.

Parameters:

Name	Type	Attributes	Description
`isCommonAR`	boolean	<optional>	Indicates if the reset should retain the state of all Wikitude context (trackers, models, camera state etc).

Source:: argo.js, line 1365

(static) resetDialogs()

Resets state of previously hidden dialogs.

Source:: argo.js, line 1413

(static) resetPages()

Resets and refreshes the content of pages.

Source:: argo.js, line 1396

(static) sendCommand(command, messageopt, dataopt)

Sends a predefined command to the native host.

Parameters:

Name	Type	Attributes
`command`	string
`message`	string	<optional>
`data`	Object	<optional>

Source:: argo.js, line 1638
See:: ARgo.NATIVE_COMMANDS

(static) showDialog(dialogSelector)

Shows the dialog associated with the specified page. Its id should be of the form: "pageIdDialog"

Parameters:

Name	Type	Description
`dialogSelector`	String	The selector of the page (e.g. `#myPage`)

Source:: argo.js, line 1423

(static) showInfoBar()

Hides the loading message and shows info bar and footer buttons.

Source:: argo.js, line 1466

(static) showPopup(idopt)

Shows the element(s) with the .popupText CSS class available in the currently loaded page.

Parameters:

Name	Type	Attributes	Description
`id`	string	<optional>

Source:: argo.js, line 1446