Open Visualisation Framework
v0.4.0
Overview
Open Visualisation Environment
Basic Concepts
Installing OVE
Using OVE
Potential Pitfalls
Developing OVE Applications
OVE Applications
Introduction
Alignment App
Audio App
Charts App
Controller App
HTML App
Images App
Maps App
Networks App
PDF App
Replicator App
SVG App
Videos App
WebRTC App
Whiteboard App
OVE Services
Introduction
OVE Persistence Service - In-Memory
OVE UI
Introduction
Demo UI
Launcher UI
Preview UI
Status UI
OVE Asset Manager
Introduction
Installing OVE Asset Manager
Using OVE Asset Manager
OVE Asset Manager REST API
Development Guide
Reference
OVE Python Client Library
Distributed.js Library
Background Utility
Spaces.json File
MapLayers.json File
Open Visualisation Framework
Docs
»
<no title>
Edit on GitHub
Overview
Open Visualisation Environment
Basic Concepts
Runtime environment
High availability of server-side application components
Installing OVE
Installation by running OVE installers
Prerequisites
Downloading the OVE installers
Building installers for non-supported platforms
Running the installers
Resolving port conflicts
Environment variables
Other configuration files
Using your own certificates for OpenVidu
Starting and stopping the OVE Docker applications
Installation from source code
Prerequisites
Downloading source code
Setting up local nginx installation
Compiling source code for a local Node.js environment
Starting and stopping OVE using the PM2 process manager
Starting and stopping OVE UIs in Development
Compiling source code for a Docker environment
Starting and stopping the OVE Docker containers
Running OVE
Using OVE
Setting up OVE
Launching browsers
Launching OVE Apps
Launching OVE Apps using OVE UI
Launching OVE Apps using the Python Client Library
Launching OVE Apps using OVE Core APIs
Hosting content
Locally hosted static content
Using the OVE Asset Manager
Controlling OVE Apps and designing interactive visualisations
Potential Pitfalls
Technical considerations
Ergonomic considerations
User interaction considerations
Developing OVE Applications
Application structure
The index.html file
Logging
The index.js file and server-side application initialization
The swagger-extensions.yaml file
Server-side Helper methods
Clint-side application initialization
Resizing
Client-side Helper methods
The OVE object
Handling state
Interpreting geometry
Communicating via WebSockets
Debugging Communication via WebSockets
Communicating within a web browser
Embedding OVE within an existing web application
OVE Applications
Introduction
Alignment App
Launching the App
Controlling the App
Audio App
Application State
Launching the App
Controlling the App
Charts App
Application State
Launching the App
Controlling the App
Controller App
Application State
Launching the App
Controlling the App
HTML App
Utilities
Application State
Launching the App
Controlling the App
Images App
Application State
Launching the App
Controlling the App
Maps App
Application State
Designing Custom Overlays
Launching the App
Controlling the App
Key considerations when using the App
Networks App
Application State
Launching the App
Controlling the App
PDF App
Application State
Launching the App
Controlling the App
Replicator App
Application State
Selecting what to replicate
Launching the App
SVG App
Application State
Launching the App
Controlling the App
Videos App
Application State
Launching the App
Controlling the App
WebRTC App
Application State
Launching the App
Controlling the App
Whiteboard App
Launching the App
Controlling the App
OVE Services
Introduction
OVE Persistence Service - In-Memory
Registering a Persistence Service
OVE UI
Introduction
Demo UI
Launcher UI
Using the Launcher UI
Preview UI
Status UI
OVE Asset Manager
Introduction
Concepts
Components
Installing OVE Asset Manager
Installation by running OVE installers
S3 Store - MinIO Configuration
Alternative installation for a Docker environment without using OVE installers
Installation for a non-Docker environment
User Interface
Workers
Using OVE Asset Manager
Managing workers
Managing projects and assets
Project list
Asset list
OVE Asset Manager REST API
Development Guide
Starting the services locally
Dependencies
Adding new AM Backend functionality
Adding new UI functionality
Adding a new Worker
Reference
OVE Python Client Library
Installation
Example Usage
Distributed.js Library
Background Utility
Spaces.json File
Examples
Single client
2x2
grid of screens
Non-contiguous arrangements and bezel correction
MapLayers.json File
OpenLayers configuration format
Using the CARTO platform with OpenLayers
Leaflet configuration format
Using the CARTO platform with Leaflet
Read the Docs
v: v0.4.0
Versions
latest
stable
v0.4.0
v0.3.3
v0.3.2
v0.3.1
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.