We use release channels to roll out updates to the 2D Viewer API.

Stable is the default for production ready applications.

Beta is stable enough for testing in a production environment but receives updates at any time. We will notify when we intend to promote the current Beta to Stable. This will start a period of time where we will not update the Beta channel and allow for testing.

Development reflects the current state of development and receives updates multiple times a day. We do not recommend using this channel in a production environment and it may break at any time. We do not provide support for this channel.

You can select the channel by passing a query parameter in the URL when fetching the 2D Viewer dependency.

Create 2D viewer token

Release Channels

Changelog

Catenda API Documentation

2D Viewer SDK

Getting Started

getBuildings

Untitled

addImage

clearImages

hideImage

removeImage

showImage

getLocation

loadUrl

transformModel

unloadModel

addMarker

clearMarkers

removeMarker

clearColors

setColor

captureScreenshot

deselect

deselectAll

getSelected

select

getBoundingBox

getSpaces

setSpaceNameFormat

setSpaceNames

getStoreyByElevation

getStoreys

getStoreysByElevation

hideStorey

hideStoreys

showStorey

getRotation

lookAt

lookAtBoundingBox

moveTo

setRotation

setViewport

addEventListener

getViewpoint

hideViewpoint

setViewpoint

showViewpoint

methods

viewer2d.click

viewer2d.contextmenu

viewer2d.dblclick

viewer2d.markerclick

viewer2d.markerdrag

viewer2d.markerdragend

viewer2d.markerhover

viewer2d.select

viewer2d.viewpoint

events

Box2

Box3

Icon

Storey

Vector2

Vector3

types

Download OpenAPI file

API Reference

Using jQuery