[[PageOutline]]
[wiki:Documentation] > [wiki:Widgets]
[[BR]][[BR]]
|| '''Automatically generated page, do not modify.  User-contributed notes can be created at: [wiki:Widgets/MeasureUsageNotes]'''||
[[BR]]

= Widget: Measure =

A widget that allows measurements to be made on the map

== Usage Notes ==

See: [wiki:Widgets/MeasureUsageNotes]

== Common Widget Properties ==

 * '''Location''' : 
 * '''Label''' : Measure
 * '''Tooltip''' : Measure distances on the map
 * '''StatusText''' : 
 * '''ImageUrl''' : images/icons/measure.png
 * '''ImageClass''' : 
 * '''StandardUi''' : true
 * '''ContainableBy''' : Any

== Parameters ==

=== Units ===

 * '''Description''' : the units to display distances in
 * '''Type''' : String
 * '''Label''' : Units
  * '''Meters''' ''(Label: Meters)'' 
  * '''Miles''' ''(Label: Miles)'' 
  * '''Degrees''' ''(Label: Degrees)'' 
 * '''DefaultValue''' : none
 * '''IsMandatory''' : false

=== DistancePrecision ===

 * '''Description''' : Precision of the distance displayed
 * '''Type''' : integer
 * '''Label''' : DistancePrecision
 * '''Min''' : 1
 * '''Max''' : 8
 * '''DefaultValue''' : 4
 * '''IsMandatory''' : false

=== AreaPrecision ===

 * '''Description''' : Precision of the area displayed
 * '''Type''' : integer
 * '''Label''' : Area Precision
 * '''Min''' : 1
 * '''Max''' : 8
 * '''DefaultValue''' : 4
 * '''IsMandatory''' : false

=== Type ===

 * '''Description''' : The type of measurement to display
 * '''Type''' : String
 * '''Label''' : measurement type
  * '''Both''' ''(Label: Distance and Area)'' 
  * '''Distance''' ''(Label: Distance)'' 
  * '''Area''' ''(Label: Area)'' 
 * '''DefaultValue''' : Both
 * '''IsMandatory''' : false

=== MeasureTooltipContainer ===

 * '''Description''' : String
 * '''Type''' : String
 * '''Label''' : an HTML container to put the current distance in
 * '''DefaultValue''' : MeasureContainerBox
 * '''IsMandatory''' : false

=== FillStyle ===

 * '''Description''' : Style for the polygon used for area draw
 * '''Type''' : String
 * '''Label''' : Fill style
 * '''DefaultValue''' : rgba(0,0,255, 0.3)
 * '''IsMandatory''' : false

=== LineStyleWidth ===

 * '''Description''' : width of the line to use
 * '''Type''' : integer
 * '''Label''' : Line style width
 * '''Min''' : 1
 * '''Max''' : 6
 * '''DefaultValue''' : 2
 * '''IsMandatory''' : false

=== LineStyleColor ===

 * '''Description''' : color to use for drawing lines
 * '''Type''' : String
 * '''Label''' : Line style color
 * '''DefaultValue''' : rgba(0,0,255,0.3)
 * '''IsMandatory''' : false

=== MeasureTooltipType ===

 * '''Description''' : Type of tooltip measurement to use
 * '''Type''' : String
 * '''Label''' : Measure tooltip type
  * '''static''' ''(Label: static)'' 
  * '''dynamic''' ''(Label: dynamic)'' 
 * '''DefaultValue''' : static
 * '''IsMandatory''' : false

=== MeasureTipPositionTop ===

 * '''Description''' : Static position of Tooltip Box TOP
 * '''Type''' : String
 * '''Label''' : Measure Tip Top Position
 * '''DefaultValue''' : 100
 * '''IsMandatory''' : false

=== MeasureTipPositionLeft ===

 * '''Description''' : Static position of Tooltip Box LEFT
 * '''Type''' : String
 * '''Label''' : Measure Tip Left Position
 * '''DefaultValue''' : 15
 * '''IsMandatory''' : false

=== Target ===

 * '''Label''' : Target
 * '''Type''' : target
 * '''Description''' : The frame, window, or TaskPane in which to display any UI for the widget. If empty, a new window is used
 * '''IsMandatory''' : true
 * '''DefaultValue''' : TaskPane