Setting: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (6 intermediate revisions by the same user 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 | {|class=wikitable | ||
| Line 8: | Line 8: | ||
!Description | !Description | ||
|- | |- | ||
|ACTIVE_SCENARIO | | ACTIVE_SCENARIO | ||
|0 | | 0 | ||
|Currently active Scenario | | Currently active [[Scenario]] | ||
|- | |- | ||
|AREA_GROUPS | | AREA_GROUPS | ||
| | | | ||
|Group | | Group [[Area]]s based on these [[Attribute]] names in Tygron Client | ||
|- | |- | ||
|AUTO_CALCULATION | | AUTO_CALCULATION | ||
|false | | false | ||
|When true | | When true [[Indicator]]s, [[Panel]]s and [[Overlay]]s are automatically recalculated on data changes | ||
|- | |- | ||
|BASE_PANELS | | BASE_PANELS | ||
|HOVER_PANEL NAVIGATION_PANEL TOPBAR_PANEL LEFT_MENU_PANEL FEEDBACK_PANEL | | HOVER_PANEL NAVIGATION_PANEL TOPBAR_PANEL LEFT_MENU_PANEL FEEDBACK_PANEL | ||
|Basic | | Basic [[Panel]]s set (that are not [[Trigger]]ed by special [[Function]]ality) | ||
|- | |- | ||
|CURRENCY | | CURRENCY | ||
|EURO | | EURO | ||
|Project currency | | Project currency | ||
|- | |- | ||
|DECIMALS | | DECIMALS | ||
|6 | | 6 | ||
|Decimal accuracy used in | | Decimal accuracy used in [[Attribute]]s and [[Function Value]]s | ||
|- | |- | ||
|DEFAULT_GEOPLUGINS | | DEFAULT_GEOPLUGINS | ||
| | | | ||
|Default Geo | | Default [[Geo Plugin]]s in new Project Wizard. Stored as pairs of [[Maplink]] and [[Geo Plugin]] ID, separated by spaces. | ||
|- | |- | ||
|DEFAULT_GROUND_LOWER_PRICE_M3 | | DEFAULT_GROUND_LOWER_PRICE_M3 | ||
|50 | | 50 | ||
|Default price to lower one m3 ground | | Default price to lower one m3 ground | ||
|- | |- | ||
|DEFAULT_GROUND_RAISE_PRICE_M3 | | DEFAULT_GROUND_RAISE_PRICE_M3 | ||
|50 | | 50 | ||
|Default price to raise one m3 ground | | Default price to raise one m3 ground | ||
|- | |- | ||
|DEFAULT_GROUNDPRICE_M2 | | DEFAULT_GROUNDPRICE_M2 | ||
|400 | | 400 | ||
|Default price of one m2 ground | | Default price of one m2 ground | ||
|- | |- | ||
|DETAILED | | DETAILED | ||
|true | | true | ||
|High resolution project | | High resolution project | ||
|- | |- | ||
|EXPORT_CRS | | EXPORT_CRS | ||
|EPSG:3857 | | EPSG:3857 | ||
|Default export CRS for | | Default export CRS for [[#Api Model Polygon|Polygon]] data in Tygron Client | ||
|- | |- | ||
|GRID_CELL_SIZE_M | | GRID_CELL_SIZE_M | ||
|2 | | 2 | ||
|Overlay | | [[Overlay]] [[Grid]] cell size in meters | ||
|- | |- | ||
|IMPORT_CRS | | IMPORT_CRS | ||
| | | | ||
|Default import CRS for | | Default import CRS for [[#Api Model Polygon|Polygon]] data in Tygron Client | ||
|- | |- | ||
|IMPORT_CRS_FORCE_XY | | IMPORT_CRS_FORCE_XY | ||
|true | | true | ||
|Default import CRS (force XY) for | | Default import CRS (force XY) for [[#Api Model Polygon|Polygon]] data in Tygron Client | ||
|- | |- | ||
|ITERATIONS | | ITERATIONS | ||
|1 | | 1 | ||
|Amount of | | Amount of [[Simulation Core|Iteration]]s during a recalculation update | ||
|- | |- | ||
|KEEP_ALIVE | | KEEP_ALIVE | ||
|NEVER | | NEVER | ||
|Keep Project alive (active) base on this | | Keep Project alive (active) base on this [[Setting]] | ||
|- | |- | ||
|LIMIT_MAP | | LIMIT_MAP | ||
|MULTIPOLYGON EMPTY | | MULTIPOLYGON EMPTY | ||
|Limits Project map generation and later calculation to this MultiPolygon | | Limits Project map generation and later calculation to this [[#Api Model MultiPolygon|MultiPolygon]] | ||
|- | |- | ||
|MAP_SIZE_M | | MAP_SIZE_M | ||
|0 0 | | 0 0 | ||
|Project map size in X (longitude) and Y (latitude) in meters | | Project map size in X (longitude) and Y (latitude) in meters | ||
|- | |- | ||
|MAX_TOTAL_GRIDCELLS | | MAX_TOTAL_GRIDCELLS | ||
|0 | | 0 | ||
|Maximum amount of Overlay | | Maximum amount of [[Overlay]] [[Grid]] cells per Project | ||
|- | |- | ||
|MEASUREMENT_SYSTEM_TYPE | | MEASUREMENT_SYSTEM_TYPE | ||
|SI | | SI | ||
|Unit system for | | Unit system for [[Measurement]]s | ||
|- | |- | ||
|MIN_CELL_M | | MIN_CELL_M | ||
|0 | | 0 | ||
|Minimum Overlay | | Minimum [[Overlay]] [[Grid]] cell size in meters | ||
|- | |- | ||
|MODEL_STYLE | | MODEL_STYLE | ||
|TEXTURED | | TEXTURED | ||
|Model ( | | Model ([[Building]]s, bridges, tress, etc) style used for visualisation in Tygron Client | ||
|- | |- | ||
|PROJECT_NAME | | PROJECT_NAME | ||
|Project Name | | Project Name | ||
|Project name | | Project name | ||
|- | |- | ||
|RASTERIZATION | | RASTERIZATION | ||
|COMBINED | | COMBINED | ||
|Selected rasterization method to convert | | Selected rasterization method to convert [[#Api Model Polygon|Polygon]] into the [[Overlay]] [[Grid]] raster | ||
|- | |- | ||
|RECALCULATION_REQUIRED | | RECALCULATION_REQUIRED | ||
|false | | false | ||
|When true this indicates that a recalculation update is needed | | When true this indicates that a recalculation update is needed | ||
|- | |- | ||
|RECENT_CRSS | | RECENT_CRSS | ||
|EPSG:3857 EPSG:4326 | | EPSG:3857 EPSG:4326 | ||
|Recently used export CRS values in Tygron Client | | Recently used export CRS values in Tygron Client | ||
|- | |- | ||
|REGION | | REGION | ||
|NORTHWESTERN_EUROPE | | NORTHWESTERN_EUROPE | ||
|Project Region: used to define the default | | Project Region: used to define the default [[Function]]s | ||
|- | |- | ||
|RESERVED_LAND | | RESERVED_LAND | ||
|MULTIPOLYGON EMPTY | | MULTIPOLYGON EMPTY | ||
|MultiPolygon for reserved land used in sale transations | | [[#Api Model MultiPolygon|MultiPolygon]] for reserved land used in sale transations | ||
|- | |- | ||
|SATELLITE_BRIGHTNESS | | SATELLITE_BRIGHTNESS | ||
|-1 | | -1 | ||
|Satellite backgrounds can be dark, this values compensates for that in Tygron Client visualisation | | Satellite backgrounds can be dark, this values compensates for that in Tygron Client visualisation | ||
|- | |- | ||
|SATELLITE_COLOR | | SATELLITE_COLOR | ||
| | | | ||
|Instead of Satellite imagery this color (RGBA) can be used for visualisation in Tygron Client | | Instead of Satellite imagery this color (RGBA) can be used for visualisation in Tygron Client | ||
|- | |- | ||
|SATELLITE_FILE_NAME | | SATELLITE_FILE_NAME | ||
|default | | default | ||
|Name of the satellite background asset files | | Name of the satellite background asset files | ||
|- | |- | ||
|SCHEDULED_UPDATE | | SCHEDULED_UPDATE | ||
| | | | ||
|Scheduled Update moment in millis | | Scheduled Update moment in millis | ||
|- | |- | ||
|SCHEDULED_UPDATE_MAIL | | SCHEDULED_UPDATE_MAIL | ||
| | | | ||
|When the Scheduled Update has finished email this | | When the Scheduled Update has finished email this [[Address]] | ||
|- | |- | ||
|SCHEDULED_UPDATE_SMS | | SCHEDULED_UPDATE_SMS | ||
| | | | ||
|When the Scheduled Update has finished SMS this phone number | | When the Scheduled Update has finished SMS this phone number | ||
|- | |- | ||
|SECTOR_SIZE_M | | SECTOR_SIZE_M | ||
|500 | | 500 | ||
|Height | | [[Height sector]] tile size in meters | ||
|- | |- | ||
|SHOW_ACTION_LOG | | SHOW_ACTION_LOG | ||
|true | | true | ||
|Show Action | | Show [[Action Log]] [[Panel]] in Tygron Client | ||
|- | |- | ||
|SHOW_BUILDING_AND_MEASURE_POPUP | | SHOW_BUILDING_AND_MEASURE_POPUP | ||
|false | | false | ||
|When a | | When a [[Building]] is placed an inter[[Action]] [[Popup]] needs to be shown | ||
|- | |- | ||
|SHOW_WATER_POPUP | | SHOW_WATER_POPUP | ||
|false | | false | ||
|When a waterway is placed an | | When a waterway is placed an inter[[Action]] [[Popup]] (for the water authority) needs to be shown | ||
|- | |- | ||
|SKY_TYPE | | SKY_TYPE | ||
|DEFAULT | | DEFAULT | ||
|Sky visualisation type in Tygron Client | | Sky visualisation type in Tygron Client | ||
|- | |- | ||
|SOLAR_PANEL_POSITION | | SOLAR_PANEL_POSITION | ||
|0.0 -0.5 -1.0 | | 0.0 -0.5 -1.0 | ||
|Solar | | Solar [[Panel]] positioning used for visualisation in Tygron Client | ||
|- | |- | ||
|STATE | | STATE | ||
|NOTHING | | NOTHING | ||
|Simulation | | Simulation [[Timestate]] | ||
|- | |- | ||
|SUN_DATES | | SUN_DATES | ||
| | | | ||
|Project sun dates used for Sun visualisation in Tygron Client | | Project sun dates used for Sun visualisation in Tygron Client | ||
|- | |- | ||
|SUPER_USER_MESSAGE | | SUPER_USER_MESSAGE | ||
| | | | ||
|Super user message to all clients | | Super user message to all clients | ||
|- | |- | ||
|SUPPORT | | SUPPORT | ||
|PREMIUM | | PREMIUM | ||
|License support level | | License support level | ||
|- | |- | ||
|SURROUNDING_MAP_EXTEND_M | | SURROUNDING_MAP_EXTEND_M | ||
|0 0 | | 0 0 | ||
|Surrounding map extend for visualisation of Sattelite and Elevation around Project map | | Surrounding map extend for visualisation of Sattelite and Elevation around Project map | ||
|- | |- | ||
|TIME_ZONE | | TIME_ZONE | ||
| | | | ||
|Project | | Project [[Time]][[Zone]] offset | ||
|- | |- | ||
|TIMESTAMP_FORMAT | | TIMESTAMP_FORMAT | ||
|dd/MM HH:mm:ss | | dd/MM HH:mm:ss | ||
| | | timestamp format for exporting/importing date/[[Time]] values in e.g. csv files | ||
|- | |- | ||
|TRAFFIC_VISUAL_MULTIPLIER | | TRAFFIC_VISUAL_MULTIPLIER | ||
|4.0 | | 4.0 | ||
|Traffic visualisation multiplier in Tygron Client (not used in calculations) | | Traffic visualisation multiplier in Tygron Client (not used in calculations) | ||
|- | |- | ||
|WATER_HEIGHT | | WATER_HEIGHT | ||
|-20000.0 | | -20000.0 | ||
|Average water elevation reference | | Average water elevation reference [[#Api Model Point|Point]] used for visualisation in Tygron Client | ||
|- | |- | ||
|WATER_TYPE | | WATER_TYPE | ||
|CANAL | | CANAL | ||
|Water visualisation type in Tygron Client | | Water visualisation type in Tygron Client | ||
|- | |- | ||
|WEB_ALLOW_LOGIC_EVENT | | WEB_ALLOW_LOGIC_EVENT | ||
|true | | true | ||
|Allow logic endpoint execution for Web Viewers | | Allow logic endpoint execution for Web Viewers | ||
|- | |- | ||
|WEB_ALLOW_PARTICIPANT_EVENT | | WEB_ALLOW_PARTICIPANT_EVENT | ||
|true | | true | ||
|Allow participant endpoint execution for Web Viewers | | Allow participant endpoint execution for Web Viewers | ||
|- | |- | ||
|WEB_ALLOW_QUERIES | | WEB_ALLOW_QUERIES | ||
|false | | false | ||
| | | | ||
|- | |- | ||
|WEB_BASE_MAP | | WEB_BASE_MAP | ||
|SATELLITE | | SATELLITE | ||
|Background type used Web Viewers | | Background type used Web Viewers | ||
|- | |- | ||
|WEB_DEFAULT_APP | | WEB_DEFAULT_APP | ||
|2d | | 2d | ||
|Default Web Viewer type (2D or 3D) | | Default Web Viewer type (2D or 3D) | ||
|- | |- | ||
|WEB_FRONT_PANEL | | WEB_FRONT_PANEL | ||
|-1 | | -1 | ||
|Open Web Viewers with this Panel ID instead of default map | | Open Web Viewers with this [[Panel]] ID instead of default map | ||
|- | |- | ||
|WEB_MAP_CUSTOM_PANEL | | WEB_MAP_CUSTOM_PANEL | ||
|-1 | | -1 | ||
| | | [[Panel]] ID used to retrieve and replace custom content for the 2D and 3D Viewers | ||
|- | |- | ||
|WEB_MODEL_SHADOW | | WEB_MODEL_SHADOW | ||
|true | | true | ||
|3D Web Viewer shadow visualisation enabled | | 3D Web Viewer shadow visualisation enabled | ||
|- | |- | ||
|WEB_MODEL_SPACING | | WEB_MODEL_SPACING | ||
|2.0 | | 2.0 | ||
|3D Web Viewer model spacing, distance between e.g. trees | | 3D Web Viewer model spacing, distance between e.g. trees | ||
|- | |- | ||
|WEB_MODEL_STYLE | | WEB_MODEL_STYLE | ||
|WHITE | | WHITE | ||
|Web Viewer Model style (COLORED or WHITE) | | Web Viewer Model style (COLORED or WHITE) | ||
|- | |- | ||
|WEB_MODEL_TEXTURE | | WEB_MODEL_TEXTURE | ||
|MEDIUM | | MEDIUM | ||
|3D Web Viewer | | 3D Web Viewer [[Texture]] quality/size (SMALL, MEDIUM, LARGE) | ||
|- | |- | ||
|WIND_DIRECTION | | WIND_DIRECTION | ||
|135 | | 135 | ||
|Wind direction angle in degrees | | Wind direction angle in degrees | ||
|- | |- | ||
|WIND_SPEED_M_PER_S | | WIND_SPEED_M_PER_S | ||
|5.0 | | 5.0 | ||
|Wind speed in meters per second | | Wind speed in meters per second | ||
|- | |- | ||
|WIZARD_TIME_MINUTES | | WIZARD_TIME_MINUTES | ||
|-1 | | -1 | ||
|Project map generation | | Project map generation [[Time]] in minutes | ||
|- | |- | ||
|WORLD_REFERENCE_POINT | | WORLD_REFERENCE_POINT | ||
|0 0 | | 0 0 | ||
|World reference | | World reference [[#Api Model Point|Point]] (upper left corner) used to convert local coordinates to EPSG 3857 world coordinates | ||
|} | |} | ||
Latest revision as of 11:45, 8 June 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 |
| AREA_GROUPS | Group Areas based on these Attribute names in Tygron Client | |
| AUTO_CALCULATION | false | When 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 to lower one m3 ground |
| DEFAULT_GROUND_RAISE_PRICE_M3 | 50 | Default price to raise one m3 ground |
| DEFAULT_GROUNDPRICE_M2 | 400 | Default price of one m2 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 |
| KEEP_ALIVE | NEVER | Keep Project alive (active) base 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 (longitude) and Y (latitude) 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, tress, etc) style used for visualisation 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 | When true this indicates that a recalculation update is needed |
| 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 transations |
| SATELLITE_BRIGHTNESS | -1 | Satellite backgrounds can be dark, this values compensates for that in Tygron Client visualisation |
| SATELLITE_COLOR | Instead of Satellite imagery this color (RGBA) can be used for visualisation in Tygron Client | |
| SATELLITE_FILE_NAME | default | Name of the satellite background asset files |
| SCHEDULED_UPDATE | Scheduled Update moment in millis | |
| SCHEDULED_UPDATE_MAIL | When the Scheduled Update has finished email this Address | |
| SCHEDULED_UPDATE_SMS | When the Scheduled Update has finished SMS this phone number | |
| 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 | When a Building is placed an interAction Popup needs to be shown |
| SHOW_WATER_POPUP | false | When a waterway is placed an interAction Popup (for the water authority) needs to be shown |
| SKY_TYPE | DEFAULT | Sky visualisation type in Tygron Client |
| SOLAR_PANEL_POSITION | 0.0 -0.5 -1.0 | Solar Panel positioning used for visualisation in Tygron Client |
| STATE | NOTHING | Simulation Timestate |
| SUN_DATES | Project sun dates used for Sun visualisation 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 extend for visualisation of Sattelite and Elevation around Project map |
| TIME_ZONE | Project TimeZone offset | |
| TIMESTAMP_FORMAT | dd/MM HH:mm:ss | timestamp format for exporting/importing date/Time values in e.g. csv files |
| TRAFFIC_VISUAL_MULTIPLIER | 4.0 | Traffic visualisation multiplier in Tygron Client (not used in calculations) |
| WATER_HEIGHT | -20000.0 | Average water elevation reference Point used for visualisation in Tygron Client |
| WATER_TYPE | CANAL | Water visualisation 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 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 visualisation 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