This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
ivac2:firdef_presets.xml [2016/04/15 22:24] jonathan.hougaard [Example] |
ivac2:firdef_presets.xml [2017/11/24 11:25] (current) splendor.bouman |
||
---|---|---|---|
Line 7: | Line 7: | ||
* Zoom level | * Zoom level | ||
- | ''Format subject to change'' | + | ''New for 2.0.5'' |
+ | |||
+ | Presets may be all combined into a single file, or we recommend you group them in separate files. All preset files must be located in the ''fir/presets/'' directory. | ||
^Root Element|presets|| | ^Root Element|presets|| | ||
Line 15: | Line 17: | ||
|name|string|Preset Display Name| | |name|string|Preset Display Name| | ||
|group|string|Preset Group| | |group|string|Preset Group| | ||
- | |center_point|Lat/Lon|Visual Centrepoint| | + | |menu|boolean|If false, preset will not be displayed in the presets menu |
- | |range|float|Visual range from centrepoint to edge of screen, expressed in Nautical Miles| | + | |
|toolbar|boolean|Add the preset to the toolbar| | |toolbar|boolean|Add the preset to the toolbar| | ||
|clearmaps|boolean|Disable all maps before applying preset| | |clearmaps|boolean|Disable all maps before applying preset| | ||
- | |inset|boolean|Open a new preset to display preset| | ||
^Root Element|preset|| | ^Root Element|preset|| | ||
Line 28: | Line 28: | ||
|ref|string|Reference point to use as center for the main window (discards lat/lon)| | |ref|string|Reference point to use as center for the main window (discards lat/lon)| | ||
|range|int|Displayed range in the main windows in Nautical Miles| | |range|int|Displayed range in the main windows in Nautical Miles| | ||
+ | |rotation|float|Rotation to be applied in the main window (degrees). Positive angles are a clockwise rotation| | ||
+ | |magvar|float|Magnetic variation specific to this preset; over-rides the setting in config.fir if provided. "auto" may be used for automatic calculation of magvar for each lat/lon position| | ||
+ | |north|string|"mag" or "true" specifies whether magnetic-north or true-north are to be displayed upwards for this preset; ; over-rides the setting in config.fir if provided| | ||
+ | |autorotate|boolean|"true" or "false" depending on whether automatic rotation to make mag/true north point directly upwards at the centre of this preset; over-rides the setting in config.fir if provided| | ||
^Root Element|preset|| | ^Root Element|preset|| | ||
Line 33: | Line 37: | ||
^Attribute^Format^Remarks^ | ^Attribute^Format^Remarks^ | ||
|id|string|Map ID to toggle| | |id|string|Map ID to toggle| | ||
+ | |visible|boolean|Enable / disable the map| | ||
|text|boolean|Enable / disable text labels| | |text|boolean|Enable / disable text labels| | ||
Line 42: | Line 47: | ||
|lon|string|Longitude of the center point for the inset| | |lon|string|Longitude of the center point for the inset| | ||
|ref|string|Reference point to use as center for the inset (discards lat/lon)| | |ref|string|Reference point to use as center for the inset (discards lat/lon)| | ||
- | |range|int|Displayed range in the main windows in Nautical Miles| | + | |range|int|Displayed range in the inset window in Nautical Miles| |
+ | |rotation|float|Rotation to be applied in the inset window (degrees)| | ||
|width|string|Default width of the inset, expressed either in pixels (width="300" equals to 300 px), or in percentage of the primary screen width (width="25%" equals to 1/4 of the main screen width)| | |width|string|Default width of the inset, expressed either in pixels (width="300" equals to 300 px), or in percentage of the primary screen width (width="25%" equals to 1/4 of the main screen width)| | ||
|height|string|Default height of the inset, expressed either in pixels (height="300" equals to 300 px), or in percentage of the primary screen height (width="25%" equals to 1/4 of the main screen height)| | |height|string|Default height of the inset, expressed either in pixels (height="300" equals to 300 px), or in percentage of the primary screen height (width="25%" equals to 1/4 of the main screen height)| | ||
|position|string|Default inset position on the screen, possible values: TOP_LEFT, TOP_CENTER, TOP_RIGHT, CENTER_LEFT, CENTER, CENTER_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT| | |position|string|Default inset position on the screen, possible values: TOP_LEFT, TOP_CENTER, TOP_RIGHT, CENTER_LEFT, CENTER, CENTER_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT| | ||
+ | |magvar|float|Magnetic variation specific to this preset; over-rides the setting in config.fir if provided. "auto" may be used for automatic calculation of magvar for each lat/lon position| | ||
+ | |north|string|"mag" or "true" specifies whether magnetic-north or true-north are to be displayed upwards for this preset; ; over-rides the setting in config.fir if provided| | ||
+ | |autorotate|boolean|"true" or "false" depending on whether automatic rotation to make mag/true north point directly upwards at the centre of this preset; over-rides the setting in config.fir if provided| | ||
+ | |||
===== Example ===== | ===== Example ===== | ||