Message API/docs/getting-started/overview

Overview

A technical overview of the implementation stack and host integration.

Introduction

Viewsoft is a high-performance web-based document viewing and annotation platform designed for seamless integration into enterprise applications.

It allows you to embed complex engineering document viewing capabilities directly into your web app without requiring client-side plugins.

Components

The platform provides specialized viewing components and integration patterns for building enterprise-grade viewer experiences.

  • Annotation: Professional markup, shapes, and technical callouts. View Docs
  • Measurement: Precise calibration, length, and area measurements. View Docs
  • File Integration: Patterns for uploading, managing, and exporting documents. View Docs

Installation & Setup

Before integrating, you'll need the core binaries provided by the ViewsoftInstaller.exe.

The installer bundles the document engine, the processing backend, and the Canvas UI into a single Windows deployment.

  • 1Run as Administrator to install all three MSI packages.
  • 2Verify the setup by visiting the default Canvas port.
  • 3See the Installer Overview for full instructions.

Start now

Get started with Viewsoft based on your role or immediate need.

Host Responsibilities

Your application orchestrates the user experience and drives the viewer lifecycle.

  • Embed and size the iframe within your responsive layout.
  • Orchestrate viewer sessions by providing file contexts and metadata.
  • Handle viewer events (markups, exports) to keep your local state in sync.
  • Trigger tool and navigation commands based on user intent.

Canvas Responsibilities

The Canvas handles the complex logic of rendering and document state.

It emits real-time updates so the Host can reflect file state and tool activity.

  • Render multi-format documents and maintain active tool state.
  • Emit progress, file, and tool-action events to the host.
  • Process incoming commands like tool selection, tab switching, and exports.

Isolation & Messaging

The iframe boundary keeps the rendering engine isolated from your application logic.

Origin validation ensures that only trusted messages from your host origin are processed by the Canvas.