Setting: Difference between revisions
Jump to navigation
Jump to search
Created page with "Setting is an item that stores configuration properties of your project. ===List of available settings=== {{article end}} {{editor tools nav}}" |
No edit summary |
||
| (67 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
Setting is an item that stores configuration properties of your project. | Setting is an item that stores configuration properties of your project. | ||
==List of available settings== | |||
{|class=wikitable | |||
!Name | |||
!Default Value | |||
!Description | |||
|- | |||
| {{Anchor|ACTIVE_SCENARIO|ACTIVE_SCENARIO}} | |||
| 0 | |||
| Currently active [[Scenario]] | |||
|- | |||
| {{Anchor|AI_EDITING|AI_EDITING}} | |||
| true | |||
| When true AI Agents are allowed to edit project data. | |||
|- | |||
| {{Anchor|AREA_GROUPS|AREA_GROUPS}} | |||
| | |||
| Group [[Area]]s based on these [[Attribute]] names in {{software client}} | |||
|- | |||
| {{Anchor|AUTO_CALCULATION|AUTO_CALCULATION}} | |||
| false | |||
| If true, [[Indicator]]s, [[Panel]]s, and [[Overlay]]s are automatically recalculated on data changes | |||
|- | |||
| {{Anchor|BASE_PANELS|BASE_PANELS}} | |||
| HOVER_PANEL NAVIGATION_PANEL TOPBAR_PANEL LEFT_MENU_PANEL FEEDBACK_PANEL | |||
| Basic [[Panel]]s set (that are not [[Trigger]]ed by special Functionality) | |||
|- | |||
| {{Anchor|CURRENCY|CURRENCY}} | |||
| EURO | |||
| Project currency | |||
|- | |||
| {{Anchor|DECIMALS|DECIMALS}} | |||
| 6 | |||
| Decimal accuracy used in [[Attribute]]s and [[Function Value]]s | |||
|- | |||
| {{Anchor|DEFAULT_GEOPLUGINS|DEFAULT_GEOPLUGINS}} | |||
| | |||
| Default [[Geo Plugin]]s in new Project Wizard. Stored as pairs of [[Maplink]] and [[Geo Plugin]] ID, separated by spaces. | |||
|- | |||
| {{Anchor|DEFAULT_GROUND_LOWER_PRICE_M3|DEFAULT_GROUND_LOWER_PRICE_M3}} | |||
| 50 | |||
| Default price for lowering 1 m3 of ground | |||
|- | |||
| {{Anchor|DEFAULT_GROUND_RAISE_PRICE_M3|DEFAULT_GROUND_RAISE_PRICE_M3}} | |||
| 50 | |||
| Default price for raising 1 m3 of ground | |||
|- | |||
| {{Anchor|DEFAULT_GROUNDPRICE_M2|DEFAULT_GROUNDPRICE_M2}} | |||
| 400 | |||
| Default price per square meter of ground | |||
|- | |||
| {{Anchor|DETAILED|DETAILED}} | |||
| true | |||
| High resolution project | |||
|- | |||
| {{Anchor|EXPORT_CRS|EXPORT_CRS}} | |||
| EPSG:3857 | |||
| Default export CRS for [[Polygon]] data in {{software client}} | |||
|- | |||
| {{Anchor|GRID_CELL_SIZE_M|GRID_CELL_SIZE_M}} | |||
| 2 | |||
| [[Overlay]] grid cell size in meters | |||
|- | |||
| {{Anchor|IMPORT_CRS|IMPORT_CRS}} | |||
| | |||
| Default import CRS for [[Polygon]] data in {{software client}} | |||
|- | |||
| {{Anchor|IMPORT_CRS_FORCE_XY|IMPORT_CRS_FORCE_XY}} | |||
| true | |||
| Default import CRS (force XY) for [[Polygon]] data in {{software client}} | |||
|- | |||
| {{Anchor|ITERATIONS|ITERATIONS}} | |||
| 1 | |||
| Amount of [[Simulation Core|Iteration]]s during a recalculation update. Min Value: 1 and Max Value: 1000 | |||
|- | |||
| {{Anchor|KEEP_ALIVE|KEEP_ALIVE}} | |||
| NEVER | |||
| Keep Project alive (active) based on this [[Setting]] | |||
|- | |||
| {{Anchor|LIMIT_MAP|LIMIT_MAP}} | |||
| MULTIPOLYGON EMPTY | |||
| Limits Project map generation and later calculation to this [[MultiPolygon]] | |||
|- | |||
| {{Anchor|MAP_SIZE_M|MAP_SIZE_M}} | |||
| 0 0 | |||
| Project map size in X (east) and Y (south) in meters | |||
|- | |||
| {{Anchor|MAX_TOTAL_GRIDCELLS|MAX_TOTAL_GRIDCELLS}} | |||
| 0 | |||
| Maximum amount of [[Overlay]] grid cells per Project | |||
|- | |||
| {{Anchor|MEASUREMENT_SYSTEM_TYPE|MEASUREMENT_SYSTEM_TYPE}} | |||
| SI | |||
| Unit system for [[Measurement]]s | |||
|- | |||
| {{Anchor|MIN_CELL_M|MIN_CELL_M}} | |||
| 0 | |||
| Minimum [[Overlay]] grid cell size in meters | |||
|- | |||
| {{Anchor|MODEL_STYLE|MODEL_STYLE}} | |||
| TEXTURED | |||
| Model ([[Building]]s, bridges, trees, etc.) style used for visualization in {{software client}} | |||
|- | |||
| {{Anchor|PROJECT_NAME|PROJECT_NAME}} | |||
| Project Name | |||
| Project name | |||
|- | |||
| {{Anchor|RASTERIZATION|RASTERIZATION}} | |||
| COMBINED | |||
| Selected rasterization method to convert [[Polygon]] into the [[Overlay]] [[Grid]] raster | |||
|- | |||
| {{Anchor|RECALCULATION_REQUIRED|RECALCULATION_REQUIRED}} | |||
| false | |||
| If true, a manual recalculation update is required | |||
|- | |||
| {{Anchor|RECENT_CRSS|RECENT_CRSS}} | |||
| EPSG:3857 EPSG:4326 | |||
| Recently used export CRS values in {{software client}} | |||
|- | |||
| {{Anchor|REGION|REGION}} | |||
| NORTHWESTERN_EUROPE | |||
| Project Region: used to define the default [[Function]]s | |||
|- | |||
| {{Anchor|RESERVED_LAND|RESERVED_LAND}} | |||
| MULTIPOLYGON EMPTY | |||
| [[MultiPolygon]] for reserved land used in sale transactions | |||
|- | |||
| {{Anchor|SATELLITE_BRIGHTNESS|SATELLITE_BRIGHTNESS}} | |||
| -1 | |||
| Compensates for dark satellite backgrounds in {{software client}} visualization | |||
|- | |||
| {{Anchor|SATELLITE_COLOR|SATELLITE_COLOR}} | |||
| | |||
| RGBA color to use instead of Satellite imagery for visualization in {{software client}} | |||
|- | |||
| {{Anchor|SATELLITE_FILE_NAME|SATELLITE_FILE_NAME}} | |||
| default | |||
| Name of the satellite background asset files | |||
|- | |||
| {{Anchor|SCHEDULED_UPDATE|SCHEDULED_UPDATE}} | |||
| | |||
| Scheduled update [[Time]]stamp in milliseconds | |||
|- | |||
| {{Anchor|SCHEDULED_UPDATE_MAIL|SCHEDULED_UPDATE_MAIL}} | |||
| | |||
| Email [[Address]] to notify when the Scheduled Update has finished | |||
|- | |||
| {{Anchor|SCHEDULED_UPDATE_SMS|SCHEDULED_UPDATE_SMS}} | |||
| | |||
| Phone number to notify via SMS when the Scheduled Update has finished | |||
|- | |||
| {{Anchor|SECTOR_SIZE_M|SECTOR_SIZE_M}} | |||
| 500 | |||
| [[Height sector]] tile size in meters | |||
|- | |||
| {{Anchor|SHOW_ACTION_LOG|SHOW_ACTION_LOG}} | |||
| true | |||
| Show [[Action Log]] [[Panel]] in {{software client}} | |||
|- | |||
| {{Anchor|SHOW_BUILDING_AND_MEASURE_POPUP|SHOW_BUILDING_AND_MEASURE_POPUP}} | |||
| false | |||
| Show interaction [[Popup]] when a [[Building]] is placed | |||
|- | |||
| {{Anchor|SHOW_WATER_POPUP|SHOW_WATER_POPUP}} | |||
| false | |||
| Show interaction [[Popup]] for the water authority when a waterway is placed | |||
|- | |||
| {{Anchor|SKY_TYPE|SKY_TYPE}} | |||
| DEFAULT | |||
| Sky visualization type in {{software client}} | |||
|- | |||
| {{Anchor|SOLAR_PANEL_POSITION|SOLAR_PANEL_POSITION}} | |||
| 0.0 -0.5 -1.0 | |||
| Solar [[Panel]] positioning used for visualization in {{software client}} | |||
|- | |||
| {{Anchor|STATE|STATE}} | |||
| NOTHING | |||
| [[Simulation]] [[Timestate]] | |||
|- | |||
| {{Anchor|SUN_DATES|SUN_DATES}} | |||
| | |||
| Project sun dates used for Sun visualization in {{software client}} | |||
|- | |||
| {{Anchor|SUPER_USER_MESSAGE|SUPER_USER_MESSAGE}} | |||
| | |||
| Super user message to all clients | |||
|- | |||
| {{Anchor|SUPPORT|SUPPORT}} | |||
| PREMIUM | |||
| License support level | |||
|- | |||
| {{Anchor|SURROUNDING_MAP_EXTEND_M|SURROUNDING_MAP_EXTEND_M}} | |||
| 0 0 | |||
| Surrounding map extent for visualization of Satellite and Elevation around the Project map | |||
|- | |||
| {{Anchor|TIME_ZONE|TIME_ZONE}} | |||
| | |||
| Project [[Time]][[Zone]] offset | |||
|- | |||
| {{Anchor|TIMESTAMP_FORMAT|TIMESTAMP_FORMAT}} | |||
| dd/MM HH:mm:ss | |||
| Timestamp Format for importing and exporting date/[[Time]] values, such as in CSV files | |||
|- | |||
| {{Anchor|TQL_TOKEN|TQL_TOKEN}} | |||
| true | |||
| When true allow TQL Queries to access the [[API token]]. | |||
|- | |||
| {{Anchor|TRAFFIC_VISUAL_MULTIPLIER|TRAFFIC_VISUAL_MULTIPLIER}} | |||
| 4.0 | |||
| Traffic visualization multiplier in {{software client}} (not used in calculations) | |||
|- | |||
| {{Anchor|WATER_HEIGHT|WATER_HEIGHT}} | |||
| -20000.0 | |||
| Average water elevation reference [[Point]] used for visualization in {{software client}} | |||
|- | |||
| {{Anchor|WATER_TYPE|WATER_TYPE}} | |||
| CANAL | |||
| Water visualization type in {{software client}} | |||
|- | |||
| {{Anchor|WEB_ALLOW_LOGIC_EVENT|WEB_ALLOW_LOGIC_EVENT}} | |||
| true | |||
| Allow logic Endpoint execution for Web Viewers | |||
|- | |||
| {{Anchor|WEB_ALLOW_PARTICIPANT_EVENT|WEB_ALLOW_PARTICIPANT_EVENT}} | |||
| true | |||
| Allow participant Endpoint execution for Web Viewers | |||
|- | |||
| {{Anchor|WEB_ALLOW_QUERIES|WEB_ALLOW_QUERIES}} | |||
| false | |||
| | |||
|- | |||
| {{Anchor|WEB_BASE_MAP|WEB_BASE_MAP}} | |||
| SATELLITE | |||
| Background type used in Web Viewers | |||
|- | |||
| {{Anchor|WEB_DEFAULT_APP|WEB_DEFAULT_APP}} | |||
| 2d | |||
| Default Web Viewer type (2D or 3D) | |||
|- | |||
| {{Anchor|WEB_FRONT_PANEL|WEB_FRONT_PANEL}} | |||
| -1 | |||
| Open Web Viewers with this [[Panel]] ID instead of default map | |||
|- | |||
| {{Anchor|WEB_MAP_CUSTOM_PANEL|WEB_MAP_CUSTOM_PANEL}} | |||
| -1 | |||
| [[Panel]] ID used to retrieve and replace custom content for the 2D and 3D Viewers | |||
|- | |||
| {{Anchor|WEB_MODEL_SHADOW|WEB_MODEL_SHADOW}} | |||
| true | |||
| 3D Web Viewer shadow visualization enabled | |||
|- | |||
| {{Anchor|WEB_MODEL_SPACING|WEB_MODEL_SPACING}} | |||
| 2.0 | |||
| 3D Web Viewer model spacing, distance between e.g. trees | |||
|- | |||
| {{Anchor|WEB_MODEL_STYLE|WEB_MODEL_STYLE}} | |||
| WHITE | |||
| Web Viewer Model style (COLORED or WHITE) | |||
|- | |||
| {{Anchor|WEB_MODEL_TEXTURE|WEB_MODEL_TEXTURE}} | |||
| MEDIUM | |||
| 3D Web Viewer [[Texture]] quality/size (SMALL, MEDIUM, LARGE) | |||
|- | |||
| {{Anchor|WIND_DIRECTION|WIND_DIRECTION}} | |||
| 135 | |||
| Wind direction angle in degrees | |||
|- | |||
| {{Anchor|WIND_SPEED_M_PER_S|WIND_SPEED_M_PER_S}} | |||
| 5.0 | |||
| Wind speed in meters per second | |||
|- | |||
| {{Anchor|WIZARD_TIME_MINUTES|WIZARD_TIME_MINUTES}} | |||
| -1 | |||
| Project map generation [[Time]] in minutes | |||
|- | |||
| {{Anchor|WORLD_REFERENCE_POINT|WORLD_REFERENCE_POINT}} | |||
| 0 0 | |||
| World reference [[Point]] (upper left corner) used to convert local coordinates to EPSG 3857 world coordinates | |||
|} | |||
{{article end | |||
|api=*[[Api session items settings]] | |||
*[[Api session event editor setting]] | |||
}} | |||
{{editor tools nav}} | {{editor tools nav}} | ||
Latest revision as of 14:56, 11 November 2026
Setting is an item that stores configuration properties of your project.
List of available settings
| Name | Default Value | Description |
|---|---|---|
| ACTIVE_SCENARIO | 0 | Currently active Scenario |
| AI_EDITING | true | When true AI Agents are allowed to edit project data. |
| AREA_GROUPS | Group Areas based on these Attribute names in Tygron Client | |
| AUTO_CALCULATION | false | If true, Indicators, Panels, and Overlays are automatically recalculated on data changes |
| BASE_PANELS | HOVER_PANEL NAVIGATION_PANEL TOPBAR_PANEL LEFT_MENU_PANEL FEEDBACK_PANEL | Basic Panels set (that are not Triggered by special Functionality) |
| CURRENCY | EURO | Project currency |
| DECIMALS | 6 | Decimal accuracy used in Attributes and Function Values |
| DEFAULT_GEOPLUGINS | Default Geo Plugins in new Project Wizard. Stored as pairs of Maplink and Geo Plugin ID, separated by spaces. | |
| DEFAULT_GROUND_LOWER_PRICE_M3 | 50 | Default price for lowering 1 m3 of ground |
| DEFAULT_GROUND_RAISE_PRICE_M3 | 50 | Default price for raising 1 m3 of ground |
| DEFAULT_GROUNDPRICE_M2 | 400 | Default price per square meter of ground |
| DETAILED | true | High resolution project |
| EXPORT_CRS | EPSG:3857 | Default export CRS for Polygon data in Tygron Client |
| GRID_CELL_SIZE_M | 2 | Overlay grid cell size in meters |
| IMPORT_CRS | Default import CRS for Polygon data in Tygron Client | |
| IMPORT_CRS_FORCE_XY | true | Default import CRS (force XY) for Polygon data in Tygron Client |
| ITERATIONS | 1 | Amount of Iterations during a recalculation update. Min Value: 1 and Max Value: 1000 |
| KEEP_ALIVE | NEVER | Keep Project alive (active) based on this Setting |
| LIMIT_MAP | MULTIPOLYGON EMPTY | Limits Project map generation and later calculation to this MultiPolygon |
| MAP_SIZE_M | 0 0 | Project map size in X (east) and Y (south) in meters |
| MAX_TOTAL_GRIDCELLS | 0 | Maximum amount of Overlay grid cells per Project |
| MEASUREMENT_SYSTEM_TYPE | SI | Unit system for Measurements |
| MIN_CELL_M | 0 | Minimum Overlay grid cell size in meters |
| MODEL_STYLE | TEXTURED | Model (Buildings, bridges, trees, etc.) style used for visualization in Tygron Client |
| PROJECT_NAME | Project Name | Project name |
| RASTERIZATION | COMBINED | Selected rasterization method to convert Polygon into the Overlay Grid raster |
| RECALCULATION_REQUIRED | false | If true, a manual recalculation update is required |
| RECENT_CRSS | EPSG:3857 EPSG:4326 | Recently used export CRS values in Tygron Client |
| REGION | NORTHWESTERN_EUROPE | Project Region: used to define the default Functions |
| RESERVED_LAND | MULTIPOLYGON EMPTY | MultiPolygon for reserved land used in sale transactions |
| SATELLITE_BRIGHTNESS | -1 | Compensates for dark satellite backgrounds in Tygron Client visualization |
| SATELLITE_COLOR | RGBA color to use instead of Satellite imagery for visualization in Tygron Client | |
| SATELLITE_FILE_NAME | default | Name of the satellite background asset files |
| SCHEDULED_UPDATE | Scheduled update Timestamp in milliseconds | |
| SCHEDULED_UPDATE_MAIL | Email Address to notify when the Scheduled Update has finished | |
| SCHEDULED_UPDATE_SMS | Phone number to notify via SMS when the Scheduled Update has finished | |
| SECTOR_SIZE_M | 500 | Height sector tile size in meters |
| SHOW_ACTION_LOG | true | Show Action Log Panel in Tygron Client |
| SHOW_BUILDING_AND_MEASURE_POPUP | false | Show interaction Popup when a Building is placed |
| SHOW_WATER_POPUP | false | Show interaction Popup for the water authority when a waterway is placed |
| SKY_TYPE | DEFAULT | Sky visualization type in Tygron Client |
| SOLAR_PANEL_POSITION | 0.0 -0.5 -1.0 | Solar Panel positioning used for visualization in Tygron Client |
| STATE | NOTHING | Simulation Timestate |
| SUN_DATES | Project sun dates used for Sun visualization in Tygron Client | |
| SUPER_USER_MESSAGE | Super user message to all clients | |
| SUPPORT | PREMIUM | License support level |
| SURROUNDING_MAP_EXTEND_M | 0 0 | Surrounding map extent for visualization of Satellite and Elevation around the Project map |
| TIME_ZONE | Project TimeZone offset | |
| TIMESTAMP_FORMAT | dd/MM HH:mm:ss | Timestamp Format for importing and exporting date/Time values, such as in CSV files |
| TQL_TOKEN | true | When true allow TQL Queries to access the API token. |
| TRAFFIC_VISUAL_MULTIPLIER | 4.0 | Traffic visualization multiplier in Tygron Client (not used in calculations) |
| WATER_HEIGHT | -20000.0 | Average water elevation reference Point used for visualization in Tygron Client |
| WATER_TYPE | CANAL | Water visualization type in Tygron Client |
| WEB_ALLOW_LOGIC_EVENT | true | Allow logic Endpoint execution for Web Viewers |
| WEB_ALLOW_PARTICIPANT_EVENT | true | Allow participant Endpoint execution for Web Viewers |
| WEB_ALLOW_QUERIES | false | |
| WEB_BASE_MAP | SATELLITE | Background type used in Web Viewers |
| WEB_DEFAULT_APP | 2d | Default Web Viewer type (2D or 3D) |
| WEB_FRONT_PANEL | -1 | Open Web Viewers with this Panel ID instead of default map |
| WEB_MAP_CUSTOM_PANEL | -1 | Panel ID used to retrieve and replace custom content for the 2D and 3D Viewers |
| WEB_MODEL_SHADOW | true | 3D Web Viewer shadow visualization enabled |
| WEB_MODEL_SPACING | 2.0 | 3D Web Viewer model spacing, distance between e.g. trees |
| WEB_MODEL_STYLE | WHITE | Web Viewer Model style (COLORED or WHITE) |
| WEB_MODEL_TEXTURE | MEDIUM | 3D Web Viewer Texture quality/size (SMALL, MEDIUM, LARGE) |
| WIND_DIRECTION | 135 | Wind direction angle in degrees |
| WIND_SPEED_M_PER_S | 5.0 | Wind speed in meters per second |
| WIZARD_TIME_MINUTES | -1 | Project map generation Time in minutes |
| WORLD_REFERENCE_POINT | 0 0 | World reference Point (upper left corner) used to convert local coordinates to EPSG 3857 world coordinates |
API Endpoints