Pointerra 3D Viewer JavaScript API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IClientOptions

Index

Properties

Properties

Optional apiAddress

apiAddress: string

Pointerra REST API path (normally https://app.pointerra.io/api)

Optional bookmarks

bookmarks: { allowEdit?: boolean }

Type declaration

  • Optional allowEdit?: boolean

Optional bootstrapped

bootstrapped: boolean

Optional drawings

drawings: { allowEdit?: boolean; allowExport?: boolean }

Type declaration

  • Optional allowEdit?: boolean
  • Optional allowExport?: boolean

Optional enableEdgeEnhancement

enableEdgeEnhancement: boolean

Optional enableSSAO

enableSSAO: boolean

Optional enableScreenshots

enableScreenshots: boolean

Optional features

features: { streetView?: boolean }

Type declaration

  • Optional streetView?: boolean

Optional initialViewRect

initialViewRect: ILatLonBoundingBox

Optional jwt

jwt: any

JWT as an alternative to API token

Optional measurements

measurements: { allowEdit?: boolean; allowExport?: boolean }

Type declaration

  • Optional allowEdit?: boolean
  • Optional allowExport?: boolean

Optional plugins

plugins: IClientPlugin[]

Optional poi

poi: { allowEdit?: boolean; allowExport?: boolean; showPropertiesWhenClicked?: boolean }

Type declaration

  • Optional allowEdit?: boolean
  • Optional allowExport?: boolean
  • Optional showPropertiesWhenClicked?: boolean

Optional pointcloudId

pointcloudId: string

Optional pointerraAccessToken

pointerraAccessToken: string

Pointerra API token to use for REST API calls. This needs to be supplied for access to non-public point clouds/resources

Optional renderQuality

renderQuality: string

Optional scanId

scanId: string

Optional sceneProperties

sceneProperties: ISceneProperties

Optional showBasemap

showBasemap: boolean

staticFilesPrefix

staticFilesPrefix: string

The root path to where Pointerra static files are hosted

targetElement

targetElement: string | HTMLElement | ElementFunction

Specifies the div element to render the viewer control into

Optional viewer

viewer: IUIOptions

Optional viewerProperties

viewerProperties: IViewerProperties

Optional wasmPrefix

wasmPrefix: string

Optional workerPrefix

workerPrefix: string