Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

UISettingΒΆ

Enumeration UISetting

Enumeration Members

ADD_BUTTON_ENABLED ALLOW_ANNOTATIONS_FROM_UNTRUSTED_SOURCE ANNOTATION_EDITING_ENABLED BRANDING_LABEL BRANDING_URL CAPPING_CREATION_ENABLED CIRCLE_UNIT CONTEXT_MENU_ENABLED CONTEXT_MENU_FUNCTION CUSTOM_ICON_MAP CUSTOM_TOOLBAR_ICON_MAP CUSTOM_TREE_ICON_MAP HOVERING_LABEL_MODE LABEL_TOOLTIP_ENABLED LABEL_TOOLTIP_FUNCTION LANGUAGE LOG_LEVEL MODELVIEW_PRINT_CONTENT_FUNCTION MODELVIEW_PRINT_RESOURCE_NAME_FUNCTION NOTIFICATION_FILTER OPEN_VARIANTS_DIALOG_ON_NODE_ADD PRINT_LAYOUT PRINT_QUALITY SESSION_STORAGE_ENABLED SHARE_SESSION_ENABLED SLAM_PROVIDER_TYPE TREEVIEW_FILTER_FUNCTION UNIT VARIANTS_BUTTON_FUNCTION

Enumeration Members

ADD_BUTTON_ENABLED

ADD_BUTTON_ENABLED: "addButtonEnabled"

Enables/disables the Add button in webvis-full

ALLOW_ANNOTATIONS_FROM_UNTRUSTED_SOURCE

ALLOW_ANNOTATIONS_FROM_UNTRUSTED_SOURCE: "allowAnnotationsFromUntrustedSource"

Enables/Disables content validation for annotations from an untrusted source

ANNOTATION_EDITING_ENABLED

ANNOTATION_EDITING_ENABLED: "annotationEditingEnabled"

Enables/Disables the Annotation editing on double-click

BRANDING_LABEL

BRANDING_LABEL: "brandingLabel"

Label used for branding. It is shown as an HTML link on the viewer and linked to BRANDING_URL.

BRANDING_URL

BRANDING_URL: "brandingURL"

URL to which the Branding Label points.

CAPPING_CREATION_ENABLED

CAPPING_CREATION_ENABLED: "cappingCreationEnabled"

Enables/Disables Capping Geometry creation

CIRCLE_UNIT

CIRCLE_UNIT: "circleUnit"

Specifies unit used to visualize circle properties.

CONTEXT_MENU_ENABLED

CONTEXT_MENU_ENABLED: "contextMenuEnabled"

Enables/Disables the default ContextMenu

CONTEXT_MENU_FUNCTION

CONTEXT_MENU_FUNCTION: "contextMenuFunction"

A function to modify the context menu's contents

CUSTOM_ICON_MAP

CUSTOM_ICON_MAP: "customIconMap"

Allows to add custom UI icons

CUSTOM_TOOLBAR_ICON_MAP

CUSTOM_TOOLBAR_ICON_MAP: "customToolbarIconMap"

Custom Toolbar Icons

CUSTOM_TREE_ICON_MAP

CUSTOM_TREE_ICON_MAP: "customTreeIconMap"

CustomTreeIconMap

HOVERING_LABEL_MODE

HOVERING_LABEL_MODE: "hoveringLabelMode"

Mode selection for hovering label

LABEL_TOOLTIP_ENABLED

LABEL_TOOLTIP_ENABLED: "labelTooltipEnabled"

Enables or disables the display of the 3D label tooltip.

LABEL_TOOLTIP_FUNCTION

LABEL_TOOLTIP_FUNCTION: "labelTooltipFunction"

A function to define the content of tooltips.

LANGUAGE

LANGUAGE: "language"

Sets the language for the UI s.

LOG_LEVEL

LOG_LEVEL: "uiLogLevel"

Sets the log level for the UI.

MODELVIEW_PRINT_CONTENT_FUNCTION

MODELVIEW_PRINT_CONTENT_FUNCTION: "modelviewPrintContentFunction"

Specifies a function which returns additional content for the modelview printing Function signature is function(context:contextAPI, nodeID:number, modelViewID:number) : Promise

MODELVIEW_PRINT_RESOURCE_NAME_FUNCTION

MODELVIEW_PRINT_RESOURCE_NAME_FUNCTION: "modelviewPrintResourceNameFunction"

Specifies a function which returns custom name for the resource drop-down of the ModelViewPrintDialog Function signature is function(context:contextAPI, nodeID:number) : Promise

NOTIFICATION_FILTER

NOTIFICATION_FILTER: "notificationFilter"

Specifies a list of UINotificationLevels which should be displayed.

OPEN_VARIANTS_DIALOG_ON_NODE_ADD

OPEN_VARIANTS_DIALOG_ON_NODE_ADD: "openVariantsDialogOnNodeAdd"

Enables or disables the automatic opening of the VariantsDialog for added Models which includes Variant information.

PRINT_LAYOUT

PRINT_LAYOUT: "printLayout"

Sets the print layout potrait / landscape

PRINT_QUALITY

PRINT_QUALITY: "printQuality"

Sets the print quality

SESSION_STORAGE_ENABLED

SESSION_STORAGE_ENABLED: "sessionStorageEnabled"

Enable/Disable the session storage.

SHARE_SESSION_ENABLED

SHARE_SESSION_ENABLED: "shareSessionEnabled"

Enables or disables session sharing

SLAM_PROVIDER_TYPE

SLAM_PROVIDER_TYPE: "slamProviderType"

The type of the SLAM provider. This is used to provide an easy way to develop AR experiences.

Possible Values: "debugIos", "sequence". When "sequence" is selected you can specify additional parameters by appending them with a semicolon:

Possible Parameters are: url: Url to manifest.json for imageSequence (escaped url) fps: playback fps for image sequence startFrame: Start Frame for image sequence endFrame: End Frame for image sequence

E.g.: sequence;url=;fps=30

TREEVIEW_FILTER_FUNCTION

TREEVIEW_FILTER_FUNCTION: "treeViewFilterFunction"

A filtering function which simply defines whether a node, given as argument, should be visible in the tree view. The function returns false for nodes, which should be hidden. Instead, the children of the affected node will be displayed, unless they are also hidden by the filtering function.

The respective node will be shown if it has no children

The function can return a boolean or a promise-like returning a boolean.

UNIT

UNIT: "unit"

Sets the unit for data inside the webVis UI.

VARIANTS_BUTTON_FUNCTION

VARIANTS_BUTTON_FUNCTION: "variantsButtonFunction"

Specifies a function which is called when the user clicks on the variants button of a tree item. The specified function overrides the default behavior of opening the standard variant dialog.

Default

undefined