@shapediver/viewer.session
v3.6.0
Published
This is the npm package for the ShapeDiver Viewer Session API. For more information on ShapeDiver, please visit our [homepage](https://shapediver.com/).
Downloads
1,271
Readme
@shapediver/viewer.session
This is the npm package for the ShapeDiver Viewer Session API. For more information on ShapeDiver, please visit our homepage.
For the documentation of the Viewer, there are three main pages:
- The Viewer help desk which offers introductions, descriptions and guides.
- The Viewer API documentation which offers the technical documentation of the API.
- The Viewer examples page which offers various examples (with github links and CodeSandBoxes).
If you have any questions or need help with the viewer, please visit the ShapeDiver Forum.
Installation
npm install --save @shapediver/viewer.session
Usage
The ShapeDiver Viewer consists of simple components that you can use in your own application. You can see here how you can create those components and some things that you can do with them. Please have a look at the specific documentations or the help desk for further information.
createSession
The session is the component that connects to the ShapeDiver servers. This component is used to change parameters, to create exports and to manage the outputs. For more information on what all of these terms mean, please visit our help desk page.
import { createSession } from '@shapediver/viewer.session';
const session = await createSession({
id: 'mySession',
ticket: MY_TICKET,
modelViewUrl: MY_MODEL_VIEW_URL
});
Once a session is created, the initial outputs are already loaded (unless specified otherwise in the method options).