Orbit 3D Mapping Viewer SDK
    Preparing search index...

    Class Constants

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

    All options with a 'LOGIN_' prefix

    Index

    Constructors

    constructor

    Properties

    ADD_VIEW_ERROR_PHOTO_NOT_FOUND ADD_VIEW_ERROR_RENDER_MODE_NOT_AVAILABLE ADD_VIEW_ERROR_SLICE_INVALID ADD_VIEW_ERROR_TOO_MANY_VIEWS CRS_FIRST_RESOURCE CRS_KEEP_ORIGINAL CRS_WGS84 ERROR_INVALID_ARGUMENT ERROR_PHOTO_NOT_FOUND FOCUS_LIMIT_TO_VIEW LOGIN_ACCESS_PROVIDER LOGIN_BOOKMARK_PUBLIC_ID LOGIN_HOST LOGIN_MODE LOGIN_PASSWORD LOGIN_PATH_PREFIX LOGIN_PROVIDER_BENTLEY_IMS LOGIN_PUBLICATION_NAME LOGIN_PUBLICATION_PUBLIC_ID LOGIN_PUBLISHER_API_VERSION LOGIN_USERNAME LOGINMODE_BENTLEY_CLOUD LOGINMODE_BENTLEY_PUBLISHER LOGINMODE_CLOUD LOGINMODE_GUEST_CLOUD LOGINMODE_GUEST_PUBLISHER LOGINMODE_PUBLISHER NOTIFICATION_TYPE_ERROR NOTIFICATION_TYPE_INFO NOTIFICATION_TYPE_WARNING RENDER_MODE_2D RENDER_MODE_3D RENDER_MODE_PHOTO_OBLIQUE RENDER_MODE_PHOTO_PLANAR RENDER_MODE_PHOTO_SPHERICAL RENDER_MODE_SLICE SDK_DATE SDK_VERSION SET_FOCUS_ERROR_NO_PHOTO_FOUND SETTING_GESTURE_PRESET SETTING_GROUND_HEIGHT SETTING_SYNCHRONIZE_REFERENCE_FROM_VIEWS SETTING_SYNCHRONIZE_VIEWS SETTING_SYNCHRONIZE_VIEWS_FROM_REFERENCE SLICE_MODE_FREE_3POINTS SLICE_MODE_HORIZONTAL_1POINT SLICE_MODE_HORIZONTAL_3POINT SLICE_MODE_VERTICAL_2POINTS STARTUP_ADD_MAPOBJECT_CAMERA_PROPERTIES STARTUP_ADD_MAPOBJECT_RESOURCE_PROPERTIES STARTUP_ALLOW_INCLUDE_CREDENTIALS STARTUP_APP_STATE STARTUP_AUTO_LOGIN STARTUP_BENTLEY_IMS_CLIENT_ID STARTUP_BENTLEY_IMS_ENABLE STARTUP_BENTLEY_IMS_REDIRECT_URL STARTUP_CRS STARTUP_DIRECTION STARTUP_DISABLE_NOTIFICATIONS STARTUP_FOCUS_POSITION STARTUP_FOV STARTUP_PAN STARTUP_PHOTO_ID STARTUP_PIXELSIZE STARTUP_PRESET_LOGIN STARTUP_ROLL STARTUP_SKIP_VIEWS STARTUP_SLICE_MODE STARTUP_SLICE_POINT1 STARTUP_SLICE_POINT2 STARTUP_SLICE_POINT3 STARTUP_SLICE_THICKNESS STARTUP_THROTTLE_ANIMATION_SIGNALS STARTUP_TILT STARTUP_USE_SHADOW_DOM STARTUP_VIEW_POSITION STARTUP_WORKSPACE_STATE

    Constructors

    Properties

    ADD_VIEW_ERROR_PHOTO_NOT_FOUND: string = "photo_not_found"

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

    ADD_VIEW_ERROR_RENDER_MODE_NOT_AVAILABLE: string = "render_mode_not_available"

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

    ADD_VIEW_ERROR_SLICE_INVALID: string = "slice_invalid"

    The add-view error when a slice could not be created because the parameters were invalid or incomplete.

    ADD_VIEW_ERROR_TOO_MANY_VIEWS: string = "too_many_views"

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

    CRS_FIRST_RESOURCE: string = "firstResource"

    A value for the Constants.STARTUP_CRS startup option.
    Use this value to define that the communication CRS should be set to the CRS of the first opened resource.

    The Viewer3DM.onSettingChanged signal will fire an event when the value for Constants.STARTUP_CRS is set. The updated value can be retrieved using the Viewer3DM.getSetting function.

    CRS_KEEP_ORIGINAL: string = "keepOriginal"

    A value for the Constants.STARTUP_CRS startup option.
    Use this value to define that there is no communication CRS and objects should keep their original CRS.

    The Viewer3DM.onSettingChanged signal will fire an event when the value for Constants.STARTUP_CRS is set. The updated value can be retrieved using the Viewer3DM.getSetting function.

    CRS_WGS84: string = "4326"

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

    ERROR_INVALID_ARGUMENT: string = "invalid_argument"

    The generic 'photo-not-found' error.

    ERROR_PHOTO_NOT_FOUND: string = "photo_not_found"

    The generic 'photo-not-found' error.

    FOCUS_LIMIT_TO_VIEW: string = "focusLimitToView"

    Focus option: Limit focusing to one specific view instead of all views.
    Note that the workspace focus position is still updated when using this focus option.

    • Special identifiers are "reference" (reference view) and "activeview" (the last focused/active view).
    • Note that view synchronization may still update other views, as a reaction to updating a single view.
    LOGIN_ACCESS_PROVIDER: string = "accessProvider"

    Login option: The login access provider to use.
    When not provided, the Publisher's internal user database is used.
    When a code is provided (String) then the login takes place in the context of an Access Provider with that code, that is known by the Publisher installation.
    Example: "bi" is the default code to make use of the Bentley IMS (providing the Publisher Installation is properly configured).

    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.

    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.

    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, ...

    LOGIN_PASSWORD: string = "password"

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

    LOGIN_PATH_PREFIX: string = "pathPrefix"

    Login option: The optional login path prefix.
    This parameter should be used when the publisher is hosted behind a proxy path.
    Use in combination with login mode Constants.LOGINMODE_PUBLISHER to specify the path prefix to use.

    LOGIN_PROVIDER_BENTLEY_IMS: string = "bi"

    A value for the Constants.LOGIN_ACCESS_PROVIDER login option.
    Use this value to specify using Bentley IMS for login (could be not supported).

    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.

    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.

    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.

    LOGIN_USERNAME: string = "username"

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

    LOGINMODE_BENTLEY_CLOUD: string = "cloud_bentley"

    A value of the Constants.LOGIN_MODE login option.
    Use this value to specify a login (using Bentley IMS) to 3DM Cloud.
    *

    Replace with Constants.LOGINMODE_CLOUD and add Constants.LOGIN_ACCESS_PROVIDER=bi.

    LOGINMODE_BENTLEY_PUBLISHER: string = "publisher_bentley"

    A value of the Constants.LOGIN_MODE login option.
    Use this value to specify a login (using Bentley IMS) to the 3DM Publisher.
    This login mode requires 2 extra options: LOGIN_HOST and LOGIN_PUBLICATION_NAME. *

    Replace with Constants.LOGINMODE_PUBLISHER and add Constants.LOGIN_ACCESS_PROVIDER=bi.

    LOGINMODE_CLOUD: string = "cloud"

    A value of the Constants.LOGIN_MODE login option.
    Use this value to specify a login to the 3DM 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 3DM Cloud.

    LOGINMODE_GUEST_PUBLISHER: string = "guest_publisher"

    A value for 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.

    LOGINMODE_PUBLISHER: string = "publisher"

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

    NOTIFICATION_TYPE_ERROR: string = "error"

    Identifies the 'error' notification type.
    Used by the Notification class.

    NOTIFICATION_TYPE_INFO: string = "info"

    Identifies the 'info' notification type.
    Used by the Notification class.

    NOTIFICATION_TYPE_WARNING: string = "warning"

    Identifies the 'warning' notification type.
    Used by the Notification class.

    RENDER_MODE_2D: string = "2d"

    The 2D render mode

    RENDER_MODE_3D: string = "3d"

    The 3D render mode

    RENDER_MODE_PHOTO_OBLIQUE: string = "photo_oblique"

    The oblique photo render mode

    RENDER_MODE_PHOTO_PLANAR: string = "photo_uav"

    The planar/nadir photo render mode

    RENDER_MODE_PHOTO_SPHERICAL: string = "photo_spherical"

    The spherical photo render mode

    RENDER_MODE_SLICE: string = "slice"

    The oblique photo render mode

    SDK_DATE: string = "2024.08.27"

    The build date of the SDK

    SDK_VERSION: string = "24.4.0"

    The version of the SDK

    SET_FOCUS_ERROR_NO_PHOTO_FOUND: string = "no_photo_found"

    The set-focus error when a view failed to find a photo for the given focus coordinate.

    SETTING_GESTURE_PRESET: string = "gesturePreset"

    Identifies the setting to apply a gesture preset. Possible values are : 'google', 'orbit', 'ocp' or 'itwin'.

    SETTING_GROUND_HEIGHT: string = "groundHeight"

    Identifies the setting for overriding ground height

    SETTING_SYNCHRONIZE_REFERENCE_FROM_VIEWS: string = "synchronizeReferenceFromViews"

    Identifies the setting to synchronize the reference view when one of the views changes.

    SETTING_SYNCHRONIZE_VIEWS: string = "synchronizeViews"

    Identifies the setting to synchronize views.

    SETTING_SYNCHRONIZE_VIEWS_FROM_REFERENCE: string = "synchronizeViewsFromReference"

    Identifies the setting to synchronize the views when the reference view changes.

    SLICE_MODE_FREE_3POINTS: string = "12"

    The mode for creating a slice with 3 clicks This slice mode requires you to also specify Constants.STARTUP_SLICE_POINT1, Constants.STARTUP_SLICE_POINT2 and Constants.STARTUP_SLICE_POINT3.

    SLICE_MODE_HORIZONTAL_1POINT: string = "11"

    The mode for creating a horizontal slice with 1 click
    This slice mode requires you to also specify Constants.STARTUP_SLICE_POINT1.

    SLICE_MODE_HORIZONTAL_3POINT: string = "16"

    The mode for creating a horizontal slice with 3 clicks This slice mode requires you to also specify Constants.STARTUP_SLICE_POINT1, Constants.STARTUP_SLICE_POINT2 and Constants.STARTUP_SLICE_POINT3.

    SLICE_MODE_VERTICAL_2POINTS: string = "12"

    The mode for creating a vertical slice with 2 clicks This slice mode requires you to also specify Constants.STARTUP_SLICE_POINT1 and Constants.STARTUP_SLICE_POINT2.

    STARTUP_ADD_MAPOBJECT_CAMERA_PROPERTIES: string = "startupAddMapobjectCameraProperties"

    Startup option: Add extra camera properties to resource-related MapObject instances (field-of-view or footprints).
    The value for this startup option should be boolean.

    • If a MapObject is of type TYPE_FOOTPRINT or TYPE_FOV, the following camera metadata will be added to the MapObject's properties if available : pan, tilt, roll.
    STARTUP_ADD_MAPOBJECT_RESOURCE_PROPERTIES: string = "startupAddMapobjectResourceProperties"

    Startup option: Add extra resource properties to resource-related MapObject instances (field-of-view or footprints).
    The value for this startup option should be boolean.

    • If a MapObject has its resourceId property filled in, the following resource metadata will be copied to the MapObject's properties if available : collection_start, collection_stop, copyright, copyright_url.
    • A field 'name' will be added with the resource name.
    • If available, a field 'description' will be added with the resource description.
    STARTUP_ALLOW_INCLUDE_CREDENTIALS: string = "allowIncludeCredentials"

    Startup option: Sets whether API requests will be requested to include credentials (cookies) when making cross-domain requests.
    The value for this startup option should be a boolean instance (default is false).

    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.

    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.

    STARTUP_BENTLEY_IMS_CLIENT_ID: string = "bentleyImsClientId"

    Startup option: The Bentley IMS ClientID to use.

    STARTUP_BENTLEY_IMS_ENABLE: string = "bentleyImsEnable"

    Startup option: Flag to enable Bentley IMS Login. When provided BENTLEY_IMS_REDIRECT_URL is also expected to be provided.
    The value for this startup option should be a boolean.

    No longer necessary. The 3DM Publisher instance you are connecting to, will decide whether BentleyIMS is available or not.

    STARTUP_BENTLEY_IMS_REDIRECT_URL: string = "bentleyImsRedirectUrl"

    Startup option: The Bentley IMS Redirect URL to use.

    STARTUP_CRS: string = "crs"

    Startup option: Set the EPSG code of the SDK Communication CRS.
    This CRS is used by the SDK when returning geometry data (default is Constants.CRS_WGS84)

    Constants.CRS_FIRST_RESOURCE

    STARTUP_DIRECTION: string = "startupDirection"

    Startup option: Startup camera direction when opening an Oblique photo by position.
    Values for this option are : N, E, S or W.

    STARTUP_DISABLE_NOTIFICATIONS: string = "disableNotifications"

    Startup option: Disable the workspace notifications appearing on the viewer?
    Use this setting if you use the onNotification Signal to present the notifications in the host environment.
    The value for this startup option should be a boolean.

    STARTUP_FOCUS_POSITION: string = "startupFocusPosition"

    Startup option: Startup focus position for a view.
    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).

    STARTUP_FOV: string = "startupFov"

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

    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.
    STARTUP_PHOTO_ID: string = "startupPhotoId"

    Startup option: Startup photo position for a photo view.
    The value for this startup option should be a string. This option can only be used as an option for addViewWithOptions.

    STARTUP_PIXELSIZE: string = "startupSlicePixelsize"

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

    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.

    STARTUP_ROLL: string = "startupSliceRoll"

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

    STARTUP_SKIP_VIEWS: string = "startupSkipViews"

    Startup option: Skip focusing views on viewer startup.
    The value for this startup option should be a boolean.
    Use this option if you want to focus the viewer on a specific coordinate, but also want to know if all views were successfully focused.
    To do that, first set this option, then wait for the onWorkspaceOpened signal to dispatch. After that, call the setFocusPosition() function and use the returned promise.

    STARTUP_SLICE_MODE: string = "startupSliceMode"

    Startup option: Startup slice mode for Slice Views.
    If this mode is specified, a slice is constructed using 1 to 3 points, to be specified using Constants.STARTUP_SLICE_POINT1, etc...
    Values for this option are provided as constants with a 'SLICE_MODE_' prefix : Constants.SLICE_MODE_HORIZONTAL_1POINT, Constants.SLICE_MODE_VERTICAL_2POINTS, ...

    STARTUP_SLICE_POINT1: string = "startupSlicePoint1"

    Startup option: First point for creating a slice view.
    The value for this startup option should be a Coordinate.

    STARTUP_SLICE_POINT2: string = "startupSlicePoint2"

    Startup option: Second point for creating a slice view.
    The value for this startup option should be a Coordinate.

    STARTUP_SLICE_POINT3: string = "startupSlicePoint3"

    Startup option: Third point for creating a slice view.
    The value for this startup option should be a Coordinate.

    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.

    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).

    STARTUP_TILT: string = "startupTilt"

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

    STARTUP_USE_SHADOW_DOM: string = "useShadowDom"

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

    STARTUP_VIEW_POSITION: string = "startupViewPosition"

    Startup option: Startup view position for a view.
    The value for this startup option should be a Coordinate instance. This option can only be used as an option for the addViewWithOptions() and setFocusWithOptions() functions and only affects 3D or UAV views.

    STARTUP_WORKSPACE_STATE: string = "workspaceState"

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    ADD_VIEW_ERROR_PHOTO_NOT_FOUNDADD_VIEW_ERROR_RENDER_MODE_NOT_AVAILABLEADD_VIEW_ERROR_SLICE_INVALIDADD_VIEW_ERROR_TOO_MANY_VIEWSCRS_FIRST_RESOURCECRS_KEEP_ORIGINALCRS_WGS84ERROR_INVALID_ARGUMENTERROR_PHOTO_NOT_FOUNDFOCUS_LIMIT_TO_VIEWLOGIN_ACCESS_PROVIDERLOGIN_BOOKMARK_PUBLIC_IDLOGIN_HOSTLOGIN_MODELOGIN_PASSWORDLOGIN_PATH_PREFIXLOGIN_PROVIDER_BENTLEY_IMSLOGIN_PUBLICATION_NAMELOGIN_PUBLICATION_PUBLIC_IDLOGIN_PUBLISHER_API_VERSIONLOGIN_USERNAMELOGINMODE_BENTLEY_CLOUDLOGINMODE_BENTLEY_PUBLISHERLOGINMODE_CLOUDLOGINMODE_GUEST_CLOUDLOGINMODE_GUEST_PUBLISHERLOGINMODE_PUBLISHERNOTIFICATION_TYPE_ERRORNOTIFICATION_TYPE_INFONOTIFICATION_TYPE_WARNINGRENDER_MODE_2DRENDER_MODE_3DRENDER_MODE_PHOTO_OBLIQUERENDER_MODE_PHOTO_PLANARRENDER_MODE_PHOTO_SPHERICALRENDER_MODE_SLICESDK_DATESDK_VERSIONSET_FOCUS_ERROR_NO_PHOTO_FOUNDSETTING_GESTURE_PRESETSETTING_GROUND_HEIGHTSETTING_SYNCHRONIZE_REFERENCE_FROM_VIEWSSETTING_SYNCHRONIZE_VIEWSSETTING_SYNCHRONIZE_VIEWS_FROM_REFERENCESLICE_MODE_FREE_3POINTSSLICE_MODE_HORIZONTAL_1POINTSLICE_MODE_HORIZONTAL_3POINTSLICE_MODE_VERTICAL_2POINTSSTARTUP_ADD_MAPOBJECT_CAMERA_PROPERTIESSTARTUP_ADD_MAPOBJECT_RESOURCE_PROPERTIESSTARTUP_ALLOW_INCLUDE_CREDENTIALSSTARTUP_APP_STATESTARTUP_AUTO_LOGINSTARTUP_BENTLEY_IMS_CLIENT_IDSTARTUP_BENTLEY_IMS_ENABLESTARTUP_BENTLEY_IMS_REDIRECT_URLSTARTUP_CRSSTARTUP_DIRECTIONSTARTUP_DISABLE_NOTIFICATIONSSTARTUP_FOCUS_POSITIONSTARTUP_FOVSTARTUP_PANSTARTUP_PHOTO_IDSTARTUP_PIXELSIZESTARTUP_PRESET_LOGINSTARTUP_ROLLSTARTUP_SKIP_VIEWSSTARTUP_SLICE_MODESTARTUP_SLICE_POINT1STARTUP_SLICE_POINT2STARTUP_SLICE_POINT3STARTUP_SLICE_THICKNESSSTARTUP_THROTTLE_ANIMATION_SIGNALSSTARTUP_TILTSTARTUP_USE_SHADOW_DOMSTARTUP_VIEW_POSITIONSTARTUP_WORKSPACE_STATE