Constants | Orbit 3D Mapping Viewer SDK

Class Constants holds some predefined values for use in the SDK.

All options with a 'LOGIN_' prefix

Hierarchy

Constants

Index

Properties

Static ADD_VIEW_ERROR_PHOTO_NOT_FOUND

ADD_VIEW_ERROR_PHOTO_NOT_FOUND: string = "photo_not_found"

The add-view error when a photo could not be found

Static ADD_VIEW_ERROR_RENDER_MODE_NOT_AVAILABLE

ADD_VIEW_ERROR_RENDER_MODE_NOT_AVAILABLE: string = "render_mode_not_available"

The add-view error when the requested render mode was not available

Static ADD_VIEW_ERROR_TOO_MANY_VIEWS

ADD_VIEW_ERROR_TOO_MANY_VIEWS: string = "too_many_views"

The add-view error when the maximum number of view is already open

Static CRS_WGS84

CRS_WGS84: string = "4326"

The EPSG code of the well-known WGS84 coordinate reference system.

Static LOGINMODE_GUEST_CLOUD

LOGINMODE_GUEST_CLOUD: string = "guest_cloud"

A value of the Constants.LOGIN_MODE login option.
Use this value to specify a guest login to the 3D Mapping Cloud.

Static LOGINMODE_GUEST_PUBLISHER

LOGINMODE_GUEST_PUBLISHER: string = "guest_publisher"

A value of the Constants.LOGIN_MODE login option.
Use this value to specify a guest login to the 3DM Publisher. This login mode requires 2 extra options: LOGIN_HOST and LOGIN_PUBLICATION_NAME.

Static LOGINMODE_PUBLISHER

LOGINMODE_PUBLISHER: string = "publisher"

A value of the Constants.LOGIN_MODE login option.
Use this value to specify a login to the 3D Mapping Publisher.

Static LOGIN_BOOKMARK_PUBLIC_ID

LOGIN_BOOKMARK_PUBLIC_ID: string = "bookmarkPublicId"

Login option: The bookmark public identifier.
Use in combination with login mode Constants.LOGINMODE_CLOUD_GUEST to specify the bookmark to open.

Static LOGIN_HOST

LOGIN_HOST: string = "host"

Login option: The login host URL.
Use in combination with login mode Constants.LOGINMODE_PUBLISHER to specify the host to connect to.

Static LOGIN_MODE

LOGIN_MODE: string = "mode"

Login option: The login mode to use.
Values for this option are provided as constants with a 'LOGINMODE' prefix : Constants.LOGINMODE_PUBLISHER, Constants.LOGINMODE_GUEST_CLOUD, ...

Static LOGIN_PASSWORD

LOGIN_PASSWORD: string = "password"

Login option: The login password.
Use in combination with login mode Constants.LOGINMODE_PUBLISHER to specify the password to use.

Static LOGIN_PUBLICATION_NAME

LOGIN_PUBLICATION_NAME: string = "publicationName"

Login option: The login publication name.
Use in combination with login mode Constants.LOGINMODE_PUBLISHER to specity the name of the publication to open.

Static LOGIN_PUBLICATION_PUBLIC_ID

LOGIN_PUBLICATION_PUBLIC_ID: string = "publicationPublicId"

Login option: The publication public identifier.
Use in combination with login mode Constants.LOGINMODE_CLOUD_GUEST to specify the publication to open.

Static LOGIN_PUBLISHER_API_VERSION

LOGIN_PUBLISHER_API_VERSION: string = "publisherApiVersion"

Login option: The login publisher api version.
Use number '2' as a value to force a login to the flash publisher.
Use number '3' as a value to force a login to the html5 publisher.
Lease unspecified to try html5 first with a fallback on flash.

Static LOGIN_USERNAME

LOGIN_USERNAME: string = "username"

Login option: The login username.
Use in combination with login mode Constants.LOGINMODE_PUBLISHER to specify the username to use.

Static RENDER_MODE_2D

RENDER_MODE_2D: string = "2d"

The 2D render mode

Static RENDER_MODE_3D

RENDER_MODE_3D: string = "3d"

The 3D render mode

Static RENDER_MODE_PHOTO_OBLIQUE

RENDER_MODE_PHOTO_OBLIQUE: string = "photo_oblique"

The oblique photo render mode

Static RENDER_MODE_PHOTO_PLANAR

RENDER_MODE_PHOTO_PLANAR: string = "photo_uav"

The planar/nadir photo render mode

Static RENDER_MODE_PHOTO_SPHERICAL

RENDER_MODE_PHOTO_SPHERICAL: string = "photo_spherical"

The spherical photo render mode

Static RENDER_MODE_SLICE

RENDER_MODE_SLICE: string = "photo_slice"

The oblique photo render mode

Static SDK_DATE

SDK_DATE: string = "2020.05.08"

The build date of the SDK

Static SDK_VERSION

SDK_VERSION: string = "20.5.0"

The version of the SDK

Static STARTUP_APP_STATE

STARTUP_APP_STATE: string = "appState"

Startup option: The initial state of the application at startup.
The value for this startup option should be a serialized state string, previously provided by the Viewer3DM.onAppStateChanged signal.

Static STARTUP_AUTO_LOGIN

STARTUP_AUTO_LOGIN: string = "autoLogin"

Startup option: Automatically login using a set of login credentials.
Setting this startup option disables the login panel and only allows the user to retry the autologin credentials.
The value for this startup option should be an AMap instance containing the various LOGIN_xxx settings.

Static STARTUP_CRS

STARTUP_CRS: string = "crs"

Startup option: Set the EPSG code of the CRS to be used when returning geometry data (default is Constants.CRS_WGS84)

Static STARTUP_FOCUS_POSITION

STARTUP_FOCUS_POSITION: string = "startupFocusPosition"

Startup option: Override the focus position on all views, when opening a workspace.
The value for this startup option should be a Coordinate instance.
Every view will bring this position into view (opening the closest or best photo as needed).

Static STARTUP_FOV

STARTUP_FOV: string = "startupFov"

Startup option: Startup horizontal field-of-view for Spherical Views.
The value for this startup option should be an number.

Static STARTUP_PAN

STARTUP_PAN: string = "startupPan"

Startup option: Startup pan angle for Spherical and 3D Views.
This overrides the workspace configuration or pan angle derived from STARTUP_FOCUS_POSITION.
The value for this startup option should be :

A Number : This pan/heading angle will be applied on all 3D and Spherical Views.
The string value driving direction : This will be applied on all Spherical Views and reset the heading to driving direction.

Static STARTUP_PRESET_LOGIN

STARTUP_PRESET_LOGIN: string = "presetLogin"

Startup option: Preset a set of login credentials.
Presets the login panel fields with the credentials provided.
The value for this startup option should be an AMap instance containing the various LOGIN_xxx settings.

Static STARTUP_SLICE_PAN

STARTUP_SLICE_PAN: string = "startupSlicePan"

Startup option: Startup pan angle (heading) for Slice Views.
The value for this startup option should be an number.

Static STARTUP_SLICE_PIXELSIZE

STARTUP_SLICE_PIXELSIZE: string = "startupSlicePixelsize"

Startup option: Startup pixelsize for Slice Views (expressed in meter/pixel).
The value for this startup option should be an number.

Static STARTUP_SLICE_ROLL

STARTUP_SLICE_ROLL: string = "startupSliceRoll"

Startup option: Startup roll angle for Slice Views.
The value for this startup option should be an number.

Static STARTUP_SLICE_THICKNESS

STARTUP_SLICE_THICKNESS: string = "startupSliceThickness"

Startup option: Startup slice thickness for Slice Views (expressed in cm).
The value for this startup option should be an number.

Static STARTUP_SLICE_TILT

STARTUP_SLICE_TILT: string = "startupSliceTilt"

Startup option: Startup tilt angle for Slice Views.
The value for this startup option should be an number.

Static STARTUP_THROTTLE_ANIMATION_SIGNALS

STARTUP_THROTTLE_ANIMATION_SIGNALS: string = "throttleAnimationSignals"

Startup option: Controls whether signal dispatches are throttled during animations.
This option limits the maximum frequency of dispatches of the onFieldOfViewsChanged signal to one per 100ms. The value for this startup option should be a boolean instance (default is false).

Static STARTUP_TILT

STARTUP_TILT: string = "startupTilt"

Startup option: Startup tilt angle for Spherical and 3D Views.
The value for this startup option should be an number.

Static STARTUP_USE_SHADOW_DOM

STARTUP_USE_SHADOW_DOM: string = "useShadowDom"

Startup option: Force use of the shadow dom (enabled by default if the browser supports it)