Setting: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary Tag: Reverted |
||
| Line 278: | Line 278: | ||
}} | }} | ||
{{editor tools nav}} | {{editor tools nav}} | ||
==List of available settings== | |||
{|class=wikitable | |||
!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 | |||
|- | |||
|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 Time State | |||
|- | |||
|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 | |||
| | |||
|- | |||
|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 | |||
|} | |||
Revision as of 08:28, 29 May 2026
Setting is an item that stores configuration properties of your project.
Values
| 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 | |
| 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 | ||
| 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 Time State |
| 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 | ||
| 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 | ||
| Open Web Viewers with this Panel ID instead of default map | ||
| WEB_MAP_CUSTOM_PANEL | ||
| 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 | ||
| 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
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 | |
| 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 | ||
| 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 Time State |
| 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 | ||
| 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 | ||
| Open Web Viewers with this Panel ID instead of default map | ||
| WEB_MAP_CUSTOM_PANEL | ||
| 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 | ||
| 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 |