Module: ParametricViewer

Type Definitions

ApiExtensions

Type:

• Object

Properties:

Name	Type	Description
getApiV1	function	returns an object of type ApiInterfaceV1
getApiV2	function	returns an object of type ApiInterfaceV2
apps	Object	instantiated browser UI apps Properties Name Type Description controls Object parameter UI settings Object settings UI overlays Object controller of elements which overlay the viewport (buttons, spinners, loading icons, message boxes) domElements Object controller of HTML elements anchored at 3D positions (text tags) exportModal Object modal export dialog

ApiObjectV1

Type:

• Object

Mixes In:

• module:ApiInterfaceV1~ApiInterfaceV1
• module:ParametricViewer~ApiExtensions

ApiObjectV2

Type:

• Object

Mixes In:

• module:ApiInterfaceV2~ApiInterfaceV2
• module:ParametricViewer~ApiExtensions

BrowserUserInterfaceApps

Type:

• Object

Properties:

Name	Type	Description
controls	function	constructor for the parameter and settings UI
overlays	function	constructor for controller of elements which overlay the viewport (buttons, spinners, loading icons, message boxes)
domElements	function	constructor of controller of HTML elements anchored at 3D positions (text tags)
exportModal	function	constructor of modal export dialog

BuildData

Type:

• Object

Properties:

Name	Type	Description
build_version	String	version of the build, e.g. "2.1.0"
build_date	String	date of the build, e.g. "2018-10-09T09:31:41.437Z"

PluginData

Type:

• Object

Properties:

Name	Type	Description
runtimeIds	Array.<String>	runtime ids of plugins which have been instantiated by the ParametricViewer constructor
CommPlugin	function	constructor for the ShapeDiver Communication Plugin
PluginPrototype	function	constructor for the ShapeDiver 3D Viewer Plugin prototype