Setting: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
41,984 edits
No edit summary
No edit summary
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{stub|todo=
Setting is an item that stores configuration properties of your project.
* Article intro is very short. Where to adjust? Implications of settings being an item rather than a client application property, etc.
* A number of settings are missing descriptions
* Currently just a list of settings and very brief descriptions. Settings should have their own page for organizing relations to other data and functionalities.
}}


Setting is an item that stores configuration properties of your project.
==List of available settings==


===List of available settings===
{|class=wikitable
{|class="wikitable"
!Name
! Name
!Default Value
! Default value
!Description
! Description  
|-
|-
| <span id="ACTIVE_SCENARIO">ACTIVE_SCENARIO</span>
| ACTIVE_SCENARIO
| 0
| 0
| Stores the id of the active [[scenario]].
| Currently active [[Scenario]]
|-
|-
| <span id="AREA_GROUPS"> AREA_GROUPS</span>
| AREA_GROUPS
|  
|  
| Used to store Area attribute filters
| Group [[Area]]s based on these [[Attribute]] names in Tygron Client
|-
|-
| <span id="AUTO_CALCULATION">AUTO_CALCULATION</span>
| AUTO_CALCULATION
| true
| false
| Whether changes made to the project automatically trigger a recalculation of a project.
| When true [[Indicator]]s, [[Panel]]s and [[Overlay]]s are automatically recalculated on data changes
|-
|-
| <span id="BASE_PANELS">BASE_PANELS </span>
| BASE_PANELS
| HOVER_PANEL NAVIGATION_PANEL TOPBAR_PANEL LEFT_MENU_PANEL FEEDBACK_PANEL
| HOVER_PANEL NAVIGATION_PANEL TOPBAR_PANEL LEFT_MENU_PANEL FEEDBACK_PANEL
| Panels that are considered base panels in the [[Viewer ]]interface.
| Basic [[Panel]]s set (that are not [[Trigger]]ed by special [[Function]]ality)
|-
|-
| <span id="CAMERA_SPEED">CAMERA_SPEED </span>
| CURRENCY
| NORMAL
| Camera Speed (SLOW, NORMAL)
|-
| <span id="CURRENCY">CURRENCY </span>
| EURO
| EURO
| Currency that is used in your [[project]].
| Project currency
|-
| <span id="CUSTOM_DATA_SERVICE">CUSTOM_DATA_SERVICE </span>
|
|  My own [[CSW]] service
|-
|-
| <span id="DECIMALS">DECIMALS</span>
| DECIMALS
| 6
| 6
| Decimal accuracy used in attributes and function values
| Decimal accuracy used in [[Attribute]]s and [[Function Value]]s
|-
|-
| <span id="DEFAULT_GROUNDPRICE_M2">DEFAULT_GROUNDPRICE_M2</span>
| DEFAULT_GEOPLUGINS
| 400
|  
| Default price of one m2 ground in euro
| Default [[Geo Plugin]]s in new Project Wizard. Stored as pairs of [[Maplink]] and [[Geo Plugin]] ID, separated by spaces.
|-
|-
| <span id="DEFAULT_GROUND_LOWER_PRICE_M3" >DEFAULT_GROUND_LOWER_PRICE_M3</span>
| DEFAULT_GROUND_LOWER_PRICE_M3
| 50
| 50
| Default price in EUR to lower one m3 ground
| Default price to lower one m3 ground
|-
|-
| <span id="DEFAULT_GROUND_RAISE_PRICE_M3" >DEFAULT_GROUND_RAISE_PRICE_M3</span>
| DEFAULT_GROUND_RAISE_PRICE_M3
| 50
| 50
| Default price in EUR to raise one m3 ground
| Default price to raise one m3 ground
|-
|-
| <span id="DETAILED" >DETAILED</span>
| DEFAULT_GROUNDPRICE_M2
| 400
| Default price of one m2 ground
|-
| DETAILED
| true
| true
| High detail project.
| High resolution project
|-
|-
| <span id="EXPORT_CRS" >EXPORT_CRS</span>
| EXPORT_CRS
| EPSG:3857
| EPSG:3857
| The default export CRS for your project for situations in the {{software}} where it currently cannot be selected.
| Default export CRS for [[#Api Model Polygon|Polygon]] data in Tygron Client
|-
|-
| <span id="GRID_CELL_SIZE_M">GRID_CELL_SIZE_M</span>
| GRID_CELL_SIZE_M
| 2
| 2
| Grid cell size in meters, default is 2
| [[Overlay]] [[Grid]] cell size in meters
|-
|-
| <span id="IMPORT_CRS" >IMPORT_CRS</span>
| IMPORT_CRS
|  
|  
| The last selected import CRS, selected automatically for files imported into your project in the {{software}}
| Default import CRS for [[#Api Model Polygon|Polygon]] data in Tygron Client
|-
|-
| <span id="IMPORT_CRS_FORCE_XY" >IMPORT_CRS_FORCE_XY</span>
| IMPORT_CRS_FORCE_XY
| true
| true
| The last selected import "force xy" (=longitude first) option, selected automatically for files imported into your project in the {{software}}
| Default import CRS (force XY) for [[#Api Model Polygon|Polygon]] data in Tygron Client
|-
|-
| <span id="LIMIT_MAP" >LIMIT_MAP</span>
| ITERATIONS
| 1
| Amount of [[Simulation Core|Iteration]]s during a recalculation update
|-
| KEEP_ALIVE
| NEVER
| Keep Project alive (active) base on this [[Setting]]
|-
| LIMIT_MAP
| MULTIPOLYGON EMPTY
| MULTIPOLYGON EMPTY
| The geometry that is used to limit the data obtained during [[New_Project_Wizard|''New Project generation'']].
| Limits Project map generation and later calculation to this [[#Api Model MultiPolygon|MultiPolygon]]
|-
|-
| <span id="MAP_SIZE_M" >MAP_SIZE_M</span>
| MAP_SIZE_M
| 0 0
| 0 0
| Map size in X and Y in meters, default 0 (no map)
| Project map size in X (longitude) and Y (latitude) in meters
|-
|-
| <span id="MAX_TOTAL_GRIDCELLS" >MAX_TOTAL_GRIDCELLS</span>
| MAX_TOTAL_GRIDCELLS
| 0
| 0
| Used to communicate the maximum amount of [[grid cell]]s that your [[project]] can support.
| Maximum amount of [[Overlay]] [[Grid]] cells per Project
|-
|-
| <span id="MEASUREMENT_SYSTEM_TYPE" >MEASUREMENT_SYSTEM_TYPE</span>
| MEASUREMENT_SYSTEM_TYPE
| SI
| SI
| The [[unit system]] used in the [[{{software|client}}]] for this project.
| Unit system for [[Measurement]]s
|-
|-
| <span id="MIN_CELL_M" >MIN_CELL_M</span>
| MIN_CELL_M
| 0
| 0
| Minimum cell size in meters
| Minimum [[Overlay]] [[Grid]] cell size in meters
|-
|-
| <span id="MODEL_STYLE" >MODEL_STYLE</span>
| MODEL_STYLE
| TEXTURED
| TEXTURED
| The [[Building style|model style]] of the [[building]]'s in the [[3D Visualization]].
| Model ([[Building]]s, bridges, tress, etc) style used for visualisation in Tygron Client
|-
|-
| <span id="PROJECT_NAME" >PROJECT_NAME</span>
| PROJECT_NAME
| Project Name
| Project Name
| The Project's name
| Project name
|-
| RASTERIZATION
| COMBINED
| Selected rasterization method to convert [[#Api Model Polygon|Polygon]] into the [[Overlay]] [[Grid]] raster
|-
|-
| <span id="RECALCULATION_REQUIRED" >RECALCULATION_REQUIRED</span>
| RECALCULATION_REQUIRED
| false
| false
| A setting that is set by the {{software}} to indicate this project required a recalculation.
| When true this indicates that a recalculation update is needed
|-
|-
| <span id="RECENT_CRSS" >RECENT_CRSS</span>
| RECENT_CRSS
| EPSG:3857 EPSG:28992
| EPSG:3857 EPSG:4326
| A list of CRS's that have been used while [[editor|editing]] your project. Shows in the "recently used" part of the ''crs selection panel''.
| Recently used export CRS values in Tygron Client
|-
|-
| <span id="REGION" >REGION</span>
| REGION
| NORTHWESTERN_EUROPE
| NORTHWESTERN_EUROPE
| Stores the [[Function#Regions|Region]] your project is situated in. Can be overwritten using this setting.
| Project Region: used to define the default [[Function]]s
|-
|-
| <span id="RESERVED_LAND" >RESERVED_LAND</span>
| RESERVED_LAND
| MULTIPOLYGON EMPTY
| MULTIPOLYGON EMPTY
| Setting that stores the geometries of [[plot]]s that are currently in transition of [[ownership]].
| [[#Api Model MultiPolygon|MultiPolygon]] for reserved land used in sale transations
|-
|-
| <span id="SATELLITE_BRIGHTNESS" >SATELLITE_BRIGHTNESS</span>
| SATELLITE_BRIGHTNESS
| -1
| -1
|  
| Satellite backgrounds can be dark, this values compensates for that in Tygron Client visualisation
|-
|-
| <span id="SATELLITE_COLOR" >SATELLITE_COLOR</span>
| SATELLITE_COLOR
|
|  
|  
| Instead of Satellite imagery this color (RGBA) can be used for visualisation in Tygron Client
|-
|-
| <span id="SATELLITE_FILE_NAME" >SATELLITE_FILE_NAME</span>
| SATELLITE_FILE_NAME
| default
| default
|  
| Name of the satellite background asset files
|-
|-
| <span id="SCHEDULED_UPDATE" >SCHEDULED_UPDATE</span>
| SCHEDULED_UPDATE
|
|  
|  
| Scheduled Update moment in millis
|-
|-
| <span id="SCHEDULED_UPDATE_MAIL" >SCHEDULED_UPDATE_MAIL</span>
| SCHEDULED_UPDATE_MAIL
|
|  
|  
| When the Scheduled Update has finished email this [[Address]]
|-
|-
| <span id="SCHEDULED_UPDATE_SMS" >SCHEDULED_UPDATE_SMS</span>
| SCHEDULED_UPDATE_SMS
|  
|  
|  
| When the Scheduled Update has finished SMS this phone number
|-
| <span id="SDK_ACCESS" >SDK_ACCESS</span>
| false
| Currently not used
|-
|-
| <span id="SECTOR_SIZE_M" >SECTOR_SIZE_M</span>
| SECTOR_SIZE_M
| 500
| 500
| The width and height of a [[Height sector]] in meters.
| [[Height sector]] tile size in meters
|-
|-
| <span id="SHOW_ACTION_LOG"> SHOW_ACTION_LOG</span>
| SHOW_ACTION_LOG
| true
| true
|  
| Show [[Action Log]] [[Panel]] in Tygron Client
|-
|-
| <span id="SHOW_BUILDING_AND_MEASURE_POPUP">SHOW_BUILDING_AND_MEASURE_POPUP</span>
| SHOW_BUILDING_AND_MEASURE_POPUP
| false
| false
|  
| When a [[Building]] is placed an inter[[Action]] [[Popup]] needs to be shown
|-
|-
| <span id="SHOW_WATER_POPUP">SHOW_WATER_POPUP </span>
| SHOW_WATER_POPUP
| false
| false
|  
| When a waterway is placed an inter[[Action]] [[Popup]] (for the water authority) needs to be shown
|-
|-
| <span id="SKY_TYPE">SKY_TYPE </span>
| SKY_TYPE
| DEFAULT
| DEFAULT
| Determines the type of sky box used in the [[3D Visualization]]. Configurable in the [[Environment]] panel.
| Sky visualisation type in Tygron Client
|-
|-
| <span id="SOLAR_PANEL_POSITION">SOLAR_PANEL_POSITION </span>
| SOLAR_PANEL_POSITION
| 0.0 -0.5 -1.0
| 0.0 -0.5 -1.0
|  
| Solar [[Panel]] positioning used for visualisation in Tygron Client
|-
|-
| <span id="STATE">STATE </span>
| STATE
| NOTHING
| NOTHING
| Simulation [[Timestate]]
|-
| SUN_DATES
|  
|  
| Project sun dates used for Sun visualisation in Tygron Client
|-
|-
| <span id="SUN_DATES"> SUN_DATES</span>
| SUPER_USER_MESSAGE
|  
|  
| Dates stored as long values representing times in UTC milliseconds from the epoch. Used by [[Sun angle]].
| Super user message to all clients
|-
|-
| <span id="SUPER_USER_MESSAGE">SUPER_USER_MESSAGE</span>
| SUPPORT
|  
| PREMIUM
|  
| License support level
|-
|-
| <span id="SURROUNDING_MAP_EXTEND_M" >SURROUNDING_MAP_EXTEND_M</span>
| SURROUNDING_MAP_EXTEND_M
| 0 0
| 0 0
| Surrounding map extend for visualisation of Sattelite and Elevation around Project map
|-
| TIME_ZONE
|  
|  
| Project [[Time]][[Zone]] offset
|-
|-
| <span id="TIMESTAMP_FORMAT" >TIMESTAMP_FORMAT</span>
| 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
|-
| <span id="TIME_ZONE">TIME_ZONE</span>
| Etc/UTC
| Automatically set based on the project's location when [[New Project Wizard|creating a new project]].
|-
|-
| <span id="TRAFFIC_VISUAL_MULTIPLIER" >TRAFFIC_VISUAL_MULTIPLIER</span>
| TRAFFIC_VISUAL_MULTIPLIER
| 4.0
| 4.0
| Multiplier used by the traffic visualization system, to make it seem busier.
| Traffic visualisation multiplier in Tygron Client (not used in calculations)
|-
|-
| <span id="WATER_HEIGHT" >WATER_HEIGHT</span>
| WATER_HEIGHT
| -20000.0
| -20000.0
|  
| Average water elevation reference [[#Api Model Point|Point]] used for visualisation in Tygron Client
|-
|-
| <span id="WATER_TYPE" >WATER_TYPE</span>
| WATER_TYPE
| CANAL
| CANAL
| Used in the visualization system of water in the [[3D Visualization]]. Configurable using [[Environment#Water Type|Water Type]] in the [[Environment]] editor panel.
| Water visualisation type in Tygron Client
|-
|-
| <span id="WEB_ALLOW_LOGIC_EVENT" >WEB_ALLOW_LOGIC_EVENT</span>
| WEB_ALLOW_LOGIC_EVENT
| true
| true
|  
| Allow logic endpoint execution for Web Viewers
|-
|-
| <span id="WEB_ALLOW_PARTICIPANT_EVENT" >WEB_ALLOW_PARTICIPANT_EVENT</span>
| WEB_ALLOW_PARTICIPANT_EVENT
| true
| true
|  
| Allow participant endpoint execution for Web Viewers
|-
|-
| <span id="WEB_ALLOW_QUERIES">WEB_ALLOW_QUERIES</span>
| WEB_ALLOW_QUERIES
| false
| false
|  
|  
|-
|-
| <span id="WEB_BASE_MAP">WEB_BASE_MAP</span>
| WEB_BASE_MAP
| SATELLITE
| SATELLITE
|  
| Background type used Web Viewers
|-
| WEB_DEFAULT_APP
| 2d
| Default Web Viewer type (2D or 3D)
|-
|-
| <span id="WEB_FRONT_PANEL">WEB_FRONT_PANEL</span>
| WEB_FRONT_PANEL
| -1
| -1
|  
| Open Web Viewers with this [[Panel]] ID instead of default map
|-
|-
| <span id="WEB_MAP_CUSTOM_PANEL">WEB_MAP_CUSTOM_PANEL</span>
| WEB_MAP_CUSTOM_PANEL
| -1
| -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)
|-
|-
| <span id="WIND_DIRECTION" >WIND_DIRECTION</span>
| WIND_DIRECTION
| 135
| 135
|  
| Wind direction angle in degrees
|-
|-
| <span id="WIND_SPEED_M_PER_S">WIND_SPEED_M_PER_S</span>
| WIND_SPEED_M_PER_S
| 5.0
| 5.0
|  
| Wind speed in meters per second
|-
|-
| <span id="WIZARD_TIME_MINUTES">WIZARD_TIME_MINUTES </span>
| WIZARD_TIME_MINUTES
| -1
| -1
|  
| Project map generation [[Time]] in minutes
|-
|-
| <span id="WORLD_REFERENCE_POINT">WORLD_REFERENCE_POINT </span>
| WORLD_REFERENCE_POINT
| 0 0
| 0 0
|  
| World reference [[#Api Model Point|Point]] (upper left corner) used to convert local coordinates to EPSG 3857 world coordinates
|-
| <span id="ITERATIONS">ITERATIONS </span>
| 1
| Amount of times the [[Simulation Core]] steps are executed each update.
|}
|}


 
{{article end
{{article end}}
|api=*[[Api session items settings]]
*[[Api session event editor setting]]
}}
{{editor tools nav}}

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

Tools
Tools
Building style • Environment • Cinematics • Screenshot • Free Cam • Web Interface • API Overview • Triggers • Template • Geo Plugins • Debug Info
Environment
Sun angle • Solar Panels • Lighting • Weather
Cinematics
Special Effects • Particle Emitters
Screenshot
GIF animation • Video recording
Geo Plugins
Error Logs • Geo Links • Geo Options • Sources
Editor
Current Situation • Future Design • Multi Scenario • Tools • Community


Retrieved from "https://support.tygron.com/w/index.php?title=Setting&oldid=84445"