BIMserver-JavaScript-API

A JavaScript API for the OpenSource BIMserver.

Usage

$3

Download the combined minified library and include it in your HTML.

``html

`

The ?_v=%VERSION% addition is there for efficient caching purposes. Any server system serving these files can tell the client to cache these files indefinitely.

$3

If you are using a transpiler such as Typescript or Babel, or a bundler such as Webpack or Rollup, you can import the module using the Import syntax.

It is also possible to load the ES6 module directly into the browser, however not all browser support this yet.

`javascript
import { BimServerClient } from './js/bimserverclient.js';
const api = new BimServerClient("../..");
api.init((client, version) => {
console.log(version.version);
});
`

$3

When the location on the API is not known in advance, you can use dynamic loading, in most browsers you'll need to use a "dev" version for this to work (Chrome 64 for example).

`javascript
var address = "http://addressofapi";
Promise.all([
address + "/bimserverclient.js",
address + "/bimserverapipromise.js"
].map(x => import(x)))
.then(([BimServerClient, BimServerApiPromise]) => {
var api = new BimServerClient.BimServerClient("../..");
api.init((client, version) => {
document.getElementById("version").innerHTML = JSON.stringify(version.version, 0, 2);
});
});
`

$3

To do.

API documentation

To do.

Build the library

* Install Node.js
* Clone (or download and unzip) the project to your file system:
`
git clone https://github.com/opensourceBIM/BIMserver-JavaScript-API.git
`
* Go to the project directory
`
cd BIMserver-JavaScript-API
`
* Install build dependencies
`
npm install
`
* Run the build script
`
npm run build
`
The compiled file is located at build/bimserverapi.js`