Enables or disables the default mouse and touch interactions provided by the viewer. Enabled by default.
The type of camera model to represent the scene with. Can be either perspective or orthographic, and defaults to perspective.
The Client ID associated with your Vertex Application.
An object or JSON encoded string that defines configuration settings for the viewer.
Sets the default environment for the viewer. This setting is used for auto-configuring network hosts.
Use the config property for manually setting hosts.
Specifies when a depth buffer is requested from rendering. Possible values are: * undefined: A depth buffer is never requested.
final: A depth buffer is only requested on the final frame.
all: A depth buffer is requested for every frame.
Depth buffers can increase the amount of data that's sent to a client and can impact rendering performance. Values of undefined or final should be used when needing the highest rendering performance.
Specifies whether to enable temporal refinement of still images.
Specifies how selected features should be highlighted.
Specifies if and how to render feature lines.
Specifies when a feature map is returned from rendering. Feature maps include information about the surfaces, edges and cross sections that are in a frame.
Possible values are: * undefined: A feature map is never requested.
final: A feature map is only requested on the final frame.
all: A feature map is requested for every frame.
Feature maps can increase the amount of data that's sent to a client and can impact rendering performance. Values of undefined or final should be used when needing the highest rendering performance.
The last frame that was received, which can be used to inspect the scene and camera information.
Enables or disables the default keyboard shortcut interactions provided by the viewer. Enabled by default, requires cameraControls being enabled.
The controller for accessing model views associated with the scene view.
Specifies whether to use the default lights for the scene. When false, default lights are used. When true, no default lights are used, and the lights must be specified separately.
Specifies how phantom parts should appear. The opacity must be between 0 and 1, where 0 is completely hidden and 1 is completely visible.
The controller for accessing and viewing PMI.
An optional value that will debounce frame updates when resizing this viewer element.
Enables or disables the default rotation interaction being changed to rotate around the pointer down location.
Specifies if and how to compare to another scene
Specifies the halo selection properties. Parameter notes:
lineWidth values supported currently are 0-5. This width is currently the value x2. For example, 1 will have a pixel width of 2.
color is optional. This will be the color of the selected items in the viewer.
opacity is also optional. The opacity will be applied to everything selected besides the highlighted outer line.
A URN of the scene resource to load when the component is mounted in the DOM tree. The specified resource is a URN in the following format: * urn:vertex:scene:<sceneid>
A token that can be used to make API calls to other Vertex services.
Represents the current viewport of the viewer. The viewport represents the dimensions of the canvas where a frame is rendered. It contains methods for translating between viewport coordinates, frame coordinates and world coordinates.
Emits an event when the state for annotation changes.
Emits an event when the camera type changes.
Emits an event when the connection status changes for the viewer
Emits an event whenever the user double taps or clicks a location in the viewer. The event includes the location of the first tap or click.
Emits an event when a frame has been drawn to the viewer's canvas. The event will include details about the drawn frame, such as the Scene information related to the scene.
Emits an event when a frame has been received by the viewer. The event will include details about the drawn frame, such as the Scene information related to the scene.
Emits an event when the user hs finished an interaction.
Emits an event when the user has started an interaction.
Emits an event whenever the user taps or clicks a location in the viewer and the configured amount of time passes without receiving a mouseup or touchend. The event includes the location of the tap or click.
Emits an event when a frame is received with a different scene attribute.
Emits an event when the scene is ready to be interacted with.
Emits an event whenever the user taps or clicks a location in the viewer. The event includes the location of the tap or click.
This event can be used in combination with the scene method to query for items at the point of the tap.
Emits an event when a provided oauth2 token is about to expire, or is about to expire, causing issues with establishing a websocket connection, or performing API calls.
The annotation controller for accessing annotations associated with the scene view.