You are reading the documentation for the version 2 of the ShapeDiver viewer API. Free support for this viewer version will be discontinued on June 1st, 2024.

Please refer to the version 3 documentation here. See also the migration guide from version 2 to version 3 here.

Module: ParametricViewer

ShapeDiver 3D Viewer Application, copyright (c) 2018 ShapeDiver GmbH

package.js

Content

  • packaged ShapeDiver 3D Viewer Application
  • common plugins for the ShapeDiver 3D Viewer
  • browser UI
  • iframe embedding helpers
Author:

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:

ApiObjectV2

Type:
  • Object
Mixes In:

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

ShapeDiver 3D Viewer, Copyright © 2015-2019 ShapeDiver GmbH. Documentation generated by JSDoc 3.6.3 on Wed Mar 4th 2020 using the DocStrap template.