@cognite/reveal

Reveal viewer

Documentation for the latest version is available at https://cognitedata.github.io/reveal/docs/

We have demos here!

---

Code Example

import { Cognite3DViewer } from "@cognite/reveal";
import { CogniteClient } from "@cognite/sdk";

const appId = "com.cognite.reveal.example";
const client = new CogniteClient({ appId });

client.loginWithOAuth({ project: "publicdata" });

const viewer = new Cognite3DViewer({
  sdk: client,
  domElement: document.querySelector("#your-element-for-viewer")
});
viewer.addModel({ modelId: 4715379429968321, revisionId: 5688854005909501 });

Installation

npm install @cognite/reveal

There are 2 different types of projects:

1. These where CDN is available (no restrictive Content-Security-Policy is set)
2. Projects with CSP that forbids to fetch scripts from apps-cdn.cognitedata.com.

By default, Reveal tries to fetch its worker/wasm files from apps-cdn.cognitedata.com. If there is no CSP in your project or apps-cdn.cognitedata.com is whitelisted, then it will just work without any additional steps.

In case if you see an error like that:

Refused to load the script 'https://cdn.jsdelivr.net/npm/@cognite/reveal-parser-worker@1.0.0/dist/cdn/reveal.parser.worker.js' because it violates the following Content Security Policy directive: "script-src 'self' https://localhost:* blob:"

See the next steps in our documentation.