UISetting¶

Enumeration UISetting

Index

Enumeration Members

ADD_BUTTON_ENABLED ADD_BUTTON_FUNCTION ALLOW_ANNOTATIONS_FROM_UNTRUSTED_SOURCE ANNOTATION_EDITING_ENABLED BRANDING_LABEL BRANDING_URL CAPPING_CREATION_ENABLED CIRCLE_UNIT COLOR_PICKER_PALETTE_ENTRIES CONTEXT_MENU_ENABLED CONTEXT_MENU_FUNCTION CUSTOM_ICON_MAP CUSTOM_TOOLBAR_ICON_MAP CUSTOM_TREE_ICON_MAP DETAILED_DOUBLE_MEASUREMENT_RESULTS GROUP_MODEL_VIEWS_BY_SCOPE_NODE 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 SESSION_STORAGE_LINK_TEMPLATE SHARE_SESSION_ENABLED SHARE_SESSION_LINK_TEMPLATE SLAM_PROVIDER_TYPE TREEVIEW_FILTER_FUNCTION TREEVIEW_FORCE_REAL_TOGGLE_VISIBLE TREEVIEW_LABEL_FUNCTION UNIT VARIANTS_BUTTON_FUNCTION

Enumeration Members

ADD_BUTTON_ENABLED

ADD_BUTTON_ENABLED: "addButtonEnabled"

Enables/disables the Add button in webvis-full

ADD_BUTTON_FUNCTION

ADD_BUTTON_FUNCTION: "addButtonFunction"

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

Default

undefined

ALLOW_ANNOTATIONS_FROM_UNTRUSTED_SOURCE

ALLOW_ANNOTATIONS_FROM_UNTRUSTED_SOURCE: "allowAnnotationsFromUntrustedSource"

Enables/Disables content validation for annotations from an untrusted source. Allowed values: "never", "always" or "ask"

Default

"never"

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.

COLOR_PICKER_PALETTE_ENTRIES

COLOR_PICKER_PALETTE_ENTRIES: "colorPickerPaletteEntries"

Specifies the palette entries of the color picker.

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

DETAILED_DOUBLE_MEASUREMENT_RESULTS

DETAILED_DOUBLE_MEASUREMENT_RESULTS: "detailedDoubleMeasurementResults"

Specifies if the results for double measurements include detailed information such as the specific measurement points, the delta between them, and more.

Detailed results are enabled by default

GROUP_MODEL_VIEWS_BY_SCOPE_NODE

GROUP_MODEL_VIEWS_BY_SCOPE_NODE: "groupModelViewsByScopeNode"

Specifies if model views should be grouped by their associated scope node within the Aux inspector dialog.

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.

SESSION_STORAGE_LINK_TEMPLATE

SESSION_STORAGE_LINK_TEMPLATE: "sessionStorageLinkTemplate"

Specifies the template for the session storage link. The template can include the following placeholders, which will be replaced internally when generating the link:

${SPACE_ID} The identifier of the stored space.
${HUB_URL} The configured URL of the connected instant3Dhub.
${ORIGIN} The origin of the current page, including the protocol and port (if specified).
${SELF} The full URL of the current page, URL parameters will be merged.

E.g.:

https://my-domain.com/my-app.html?storeSpaceId=${SPACE_ID} ${ORIGIN}/my-app.html?storeSpaceId=${SPACE_ID} ${SELF}?storeSpaceId=${SPACE_ID}

SHARE_SESSION_ENABLED

SHARE_SESSION_ENABLED: "shareSessionEnabled"

Enables or disables session sharing

SHARE_SESSION_LINK_TEMPLATE

SHARE_SESSION_LINK_TEMPLATE: "sharedSessionLinkTemplate"

Specifies the template for the session share link. The template can include the following placeholders, which will be replaced internally when generating the link:

${SPACE_ID} The identifier of the stored space.
${HUB_URL} The configured URL of the connected instant3Dhub.
${ORIGIN} The origin of the current page, including the protocol and port (if specified).
${SELF} The full URL of the current page, URL parameters will be merged.

E.g.:

https://my-domain.com/my-app.html?sharedSpaceId=${SPACE_ID} ${ORIGIN}/my-app.html?sharedSpaceId=${SPACE_ID} ${SELF}?sharedSpaceId=${SPACE_ID}

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.

TREEVIEW_FORCE_REAL_TOGGLE_VISIBLE

TREEVIEW_FORCE_REAL_TOGGLE_VISIBLE: "treeViewForceRealToggleVisible"

Enables/Disables always showing tracking indicators for tree items

TREEVIEW_LABEL_FUNCTION

TREEVIEW_LABEL_FUNCTION: "treeViewLabelFunction"

A function which can be used to modify the label of a node in the tree view.

The function receives the current Context, the node ID and the original label as arguments and is expected to return a custom label as string.

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

Was this page helpful? Please leave a thumbs up or down.