This is documentation of an archived release.
For documentation on the current version, please check Knowledge Base.
For documentation on the current version, please check Knowledge Base.
WebClient Settings
The table below describes the available WebClient settings.
API methods getSetting(name) and setSetting(name,value) can be used to override settings for the entire lifetime of the component. Calling setSetting() will override any settings the publication may have for itself. You can clear the override by setting a null value.
- Setting = Name of the setting.
- User Setting = Can the user change this setting through the UI?
- Since = The version of the webclient that first supported this setting.
- Values = Information about possible values.
- Description = General discussion about this setting.
Global
| Setting | User Setting | Since | Values | Description |
|---|---|---|---|---|
| EnableDefaultSnapshotPopup | 17.0.1 | true, false (default) | Enable the default built-in snapshot popup. | |
| ApplyStartupParametersOnLoad | 11.1.0 | true (default), false | Load the startup location after opening a publication? | |
| OpenViewerCount | * | 10.4.0 | 1 (default), 2, 3 or 4 | The number of panorama photo's to open when opening viewers based on a location. |
| AddOverlaysToSnapshots | * | 10.4.1 | true, false (default) | Add viewer overlays when generating snapshots? |
| MapPosition | * | 10.5.1 | 'north' (default), 'east', 'south' or 'west' | The position of the map view relative to the viewers panel. |
| ViewerLayout | * | 10.5.1 | 'horizontal' (default), 'vertical', or 'tiled' | The used method for layouting the individual viewers. Tiled layout defaults to a grid with 2 columns. |
| ViewDepth | * | 10.5.1 | A positive distance. | The global viewing depth when browsing 3d spatial data. This setting influences the photo position search distance as well as the vector overlay rendering distance. |
| ZoomScrollDirection | 10.4.0 | 'natural' (default) or 'inversed' | The zoom-direction when using the mouse wheel to zoom. | |
| Locale | 10.4.0 | 'nl_BE' or 'en_US' (default) | The user-interface language locale to use. Find the list of available locale codes here. |
|
| TriangulationMeasurementCount | 10.4.0 | 2 (default), 3 or 4 | The number of measurements required for each coordinate, when measuring using triangulation (without pointcloud). | |
| SnapshotWidth | 11.0.3 | A number of pixels (or null). | The maximum width for a snapshot image. When this setting is active when the user clicks the “snapshot” icon or the application calls the getSnapshot() function, the resulting snapshot image will be resized to fit the given width. |
|
| SnapshotHeight | 11.0.3 | A number of pixels (or null). | The maximum height for a snapshot image. When this setting is active when the user clicks the “snapshot” icon or the application calls the getSnapshot() function, the resulting snapshot image will be resized to fit the given height. |
|
| ApplyStartupParametersOnLoad | 11.1.0 | true (default), false | Apply the startup parameters after loading a publication? The startup parameters define a map location and scale. A viewer is also opened at this location. Setting this setting to false doesn't prevent you from calling applyStartupParameters() later on. | |
| ToolbarSnapshotVisibility | 17.0.1 | true (default), false | Visibility of the snapshot button. | |
| ToolbarMetadataVisibility | 17.0.1 | true (default), false | Visibility of the metadata button. | |
| ToolbarLayersVisibility | 17.0.1 | true (default), false | Visibility of the layers button. | |
| ToolbarMeasureVisibility | 17.0.1 | true (default), false | Visibility of the measure button. | |
| ToolbarCategoriesVisibility | 17.0.1 | true (default), false | Visibility of the categories button. | |
| ToolbarImagecorrectionVisibility | 17.0.1 | true (default), false | Visibility of the image correction button. | |
| ToolbarSettingsVisibility | 17.0.1 | true (default), false | Visibility of the settings button. |
Panorama Specific
| Setting | User Setting | Since | Values | Description |
|---|---|---|---|---|
| PanoramaTiltMin | 10.5.1 | An angle. | The minimum tilt angle for the panorama viewer. | |
| PanoramaTiltMax | 10.5.1 | An angle. | The maximum tilt angle for the panorama viewer. | |
| PanoramaTiltStandard | 10.5.1 | An angle. | The standard tilt angle for the panorama viewer. Uses as initial tilt angle for new viewers and also used when resetting the view by clicking the viewer state widget. | |
| PanoramaFollowFocus | 11.0.3 | true, false (default) | Controls the “follow-focus” mode. If this mode is enabled, changing the focus coordinate will automatically let all panorama viewers focus on that coordinate. |
Depricated since 10.5.1 :
- ViewerOrientation : Use MapPosition in combination with ViewerLayout instead.
Depricated since 11.0.3 :
- PanoramaSnapshotWidth : Use SnapshotWidth instead.
- PanoramaSnapshotHeight : Use SnapshotHeight instead.
Oblique Specific
| Setting | User Setting | Since | Value | Description |
|---|---|---|---|---|
| ObliqueFollowFocus | * | 11.0.3 | true (default), false | Controls the “follow-focus” mode. If this mode is enabled, changing the focus coordinate lets all viewers focus on that coordinate. |
| ObliqueFollowZoom | * | 11.0.3 | true (default), false | Controls the “follow-zoom” mode. If this mode is enabled, oblique viewers automatically track zoom changes in the other viewers or the build-in map. |
| ObliqueRenderFootprints | * | 11.0.3 | true, false (default) | Controls rendering of the photo footprints on the build-in map component. If this setting is enabled, footprint outlines will be rendered on build-the map. If the build-in map is disabled, this does nothing. |
| ObliqueViewerSelection | * | 11.0.3 | n,e,s,w,ns,we,nesw | The selection of oblique viewers to show (n,e,s,w,ns,we or nesw) |
| ObliqueKeepNorthUp | * | 11.0.3 | true, false (default) | Keep north up at all times? |
| ObliqueDefaultZoomFactor | 11.0.3 | 2.0 | The default zoom factor for oblique viewers. |
Last modified:: 2019/03/25 11:36