Skip to main content

Viewer Plugins

VAMS includes a plugin-based viewer architecture with 17 built-in viewer plugins for visualizing 3D models, point clouds, media files, documents, and data. This page provides a configuration reference for viewer plugins.

For the complete list of viewers, supported extensions, and extension-to-viewer mapping, see File Viewers.


Viewer Configuration

Viewer plugins are configured in web/src/visualizerPlugin/config/viewerConfig.json. Each viewer entry supports the following fields:

FieldTypeDescription
idstringUnique plugin identifier
namestringDisplay name shown in the viewer dropdown
descriptionstringTooltip description for the viewer
componentPathstringPath for Vite dynamic import resolution
supportedExtensionsstring[]File extensions this viewer handles
supportsMultiFilebooleanWhether the viewer can display multiple files simultaneously
canFullscreenbooleanWhether fullscreen mode is supported
prioritynumberLower number = higher preference when multiple viewers match
loadStrategystring"lazy" (loaded on demand) or "eager" (loaded at startup)
categorystringViewer category (3d, media, document, data, preview)
enabledbooleanWhether the plugin is active
featuresEnabledRestrictionstring[]Feature flags required for this viewer to be available
requiresPreprocessingbooleanWhether the viewer needs a pipeline to pre-process files
customParametersobjectViewer-specific configuration (e.g., Cesium ion token, BabylonJS settings)

Creating Custom Viewers

For instructions on developing and registering custom viewer plugins, refer to the viewer plugin development guide at web/src/visualizerPlugin/README.md and the FAQ.