Changes between Initial Version and Version 1 of Widgets/Measure


Ignore:
Timestamp:
04/03/08 03:05:38 (17 years ago)
Author:
jbirch
Comment:

Automated wiki documentation upload

Legend:

Unmodified
Added
Removed
Modified
  • Widgets/Measure

    v1 v1  
     1[[PageOutline]]
     2[[BR]]
     3|| '''Automatically generated page, do not modify.  User Notes can be created at: [wiki:Widgets/MeasureUsageNotes]'''||
     4[[BR]]
     5
     6= Widget: Measure =
     7
     8A widget that allows measurements to be made on the map
     9
     10== Usage Notes ==
     11
     12See: [wiki:Widgets/MeasureUsageNotes]
     13
     14== Common Widget Properties ==
     15
     16 * '''Location''' :
     17 * '''Label''' : Measure
     18 * '''Tooltip''' : Measure distances on the map
     19 * '''StatusText''' :
     20 * '''ImageUrl''' : images/icons/measure.png
     21 * '''ImageClass''' :
     22 * '''StandardUi''' : true
     23 * '''ContainableBy''' : Any
     24
     25== Parameters ==
     26
     27=== Units ===
     28
     29 * '''Description''' : the units to display distances in
     30 * '''Type''' : String
     31 * '''Label''' : Units
     32  * '''Meters''' ''(Label: Meters)''
     33  * '''Miles''' ''(Label: Miles)''
     34  * '''Degrees''' ''(Label: Degrees)''
     35 * '''DefaultValue''' : none
     36 * '''IsMandatory''' : false
     37
     38=== DistancePrecision ===
     39
     40 * '''Description''' : Precision of the distance displayed
     41 * '''Type''' : integer
     42 * '''Label''' : DistancePrecision
     43 * '''Min''' : 1
     44 * '''Max''' : 8
     45 * '''DefaultValue''' : 4
     46 * '''IsMandatory''' : false
     47
     48=== AreaPrecision ===
     49
     50 * '''Description''' : Precision of the area displayed
     51 * '''Type''' : integer
     52 * '''Label''' : Area Precision
     53 * '''Min''' : 1
     54 * '''Max''' : 8
     55 * '''DefaultValue''' : 4
     56 * '''IsMandatory''' : false
     57
     58=== Type ===
     59
     60 * '''Description''' : The type of measurement to display
     61 * '''Type''' : String
     62 * '''Label''' : measurement type
     63  * '''Both''' ''(Label: Distance and Area)''
     64  * '''Distance''' ''(Label: Distance)''
     65  * '''Area''' ''(Label: Area)''
     66 * '''DefaultValue''' : Both
     67 * '''IsMandatory''' : false
     68
     69=== MeasureTooltipContainer ===
     70
     71 * '''Description''' : String
     72 * '''Type''' : String
     73 * '''Label''' : an HTML container to put the current distance in
     74 * '''DefaultValue''' : MeasureContainerBox
     75 * '''IsMandatory''' : false
     76
     77=== FillStyle ===
     78
     79 * '''Description''' : Style for the polygon used for area draw
     80 * '''Type''' : String
     81 * '''Label''' : Fill style
     82 * '''DefaultValue''' : rgba(0,0,255, 0.3)
     83 * '''IsMandatory''' : false
     84
     85=== LineStyleWidth ===
     86
     87 * '''Description''' : width of the line to use
     88 * '''Type''' : integer
     89 * '''Label''' : Line style width
     90 * '''Min''' : 1
     91 * '''Max''' : 6
     92 * '''DefaultValue''' : 2
     93 * '''IsMandatory''' : false
     94
     95=== LineStyleColor ===
     96
     97 * '''Description''' : color to use for drawing lines
     98 * '''Type''' : String
     99 * '''Label''' : Line style color
     100 * '''DefaultValue''' : rgba(0,0,255,0.3)
     101 * '''IsMandatory''' : false
     102
     103=== MeasureTooltipType ===
     104
     105 * '''Description''' : Type of tooltip measurement to use
     106 * '''Type''' : String
     107 * '''Label''' : Measure tooltip type
     108  * '''static''' ''(Label: static)''
     109  * '''dynamic''' ''(Label: dynamic)''
     110 * '''DefaultValue''' : static
     111 * '''IsMandatory''' : false
     112
     113=== MeasureTipPositionTop ===
     114
     115 * '''Description''' : Static position of Tooltip Box TOP
     116 * '''Type''' : String
     117 * '''Label''' : Measure Tip Top Position
     118 * '''DefaultValue''' : 100
     119 * '''IsMandatory''' : false
     120
     121=== MeasureTipPositionLeft ===
     122
     123 * '''Description''' : Static position of Tooltip Box LEFT
     124 * '''Type''' : String
     125 * '''Label''' : Measure Tip Left Position
     126 * '''DefaultValue''' : 15
     127 * '''IsMandatory''' : false
     128
     129=== Target ===
     130
     131 * '''Label''' : Target
     132 * '''Type''' : target
     133 * '''Description''' : The frame, window, or TaskPane in which to display any UI for the widget. If empty, a new window is used
     134 * '''IsMandatory''' : true
     135 * '''DefaultValue''' : TaskPane
     136