@3ddv/dvm v2.3.0

README

This package is a helper to use DVM. Instead of just adding the script to your website, you can use this package to:

• Use ES6 import/export syntax.
• Get Typescript definitions.

Using this package will still continue to download the core DVM from our CDN, adding it to your website.

If you use this package, you must not add manually the dvm.js script in your html.

Installation

npm install --save @3ddv/dvm

How to use it

This package exports the following functions:

• loadModule: equivalent to DVM.loadModule.
• setDVMVersion: You can specify from which namespace you want to download DVM. By default, it will be downloaded from stable. It has to be called before the first loadModule call. You should leave it by default unless we specify something else. This would be the equivalent to include the specific script.
• setDefaultModuleVersion: You can specify the default version branch for a specific module. By default, all modules uses stable branch.
• getBuiltinDVMVersion: Returns the builtin version of DVM.
• getBuiltinModuleVersion: Returns the builtin version of a module.

import { loadModule, setDVMVersion, setDefaultModuleVersion } from '@3ddv/dvm';

setDVMVersion('stable'); // stable is already set by default
setDefaultModuleVersion('map_viewer', 'stable');

loadModule('map_viewer', { container: 'container-id' })
  .then((viewer) => {
    return viewer.loadMap({ venue_id: 'venue' });
  })
  .then(() => {
    console.log("map loaded");
  });

Builtin versions

You can specify the specific version with which this package was published:

import { loadModule, setDVMVersion, setDefaultModuleVersion } from '@3ddv/dvm';

setDVMVersion('builtin');
setDefaultModuleVersion('map_viewer', 'builtin');
setDefaultModuleVersion('3d_viewer', 'builtin');

loadModule('map_viewer', { container: 'container-id' })
    .then((viewer) => {
      ...
    });